Class DbxTeamTeamRequests
- java.lang.Object
- 
- com.dropbox.core.v2.team.DbxTeamTeamRequests
 
- 
 public class DbxTeamTeamRequests extends java.lang.ObjectRoutes in namespace "team".
- 
- 
Constructor SummaryConstructors Constructor Description DbxTeamTeamRequests(DbxRawClientV2 client)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ListMemberDevicesResultdevicesListMemberDevices(java.lang.String teamMemberId)List all device sessions of a team's member.DevicesListMemberDevicesBuilderdevicesListMemberDevicesBuilder(java.lang.String teamMemberId)List all device sessions of a team's member.ListMembersDevicesResultdevicesListMembersDevices()List all device sessions of a team.DevicesListMembersDevicesBuilderdevicesListMembersDevicesBuilder()List all device sessions of a team.ListTeamDevicesResultdevicesListTeamDevices()Deprecated.DevicesListTeamDevicesBuilderdevicesListTeamDevicesBuilder()Deprecated.voiddevicesRevokeDeviceSession(RevokeDeviceSessionArg arg)Revoke a device session of a team's member.RevokeDeviceSessionBatchResultdevicesRevokeDeviceSessionBatch(java.util.List<RevokeDeviceSessionArg> revokeDevices)Revoke a list of device sessions of team members.FeaturesGetValuesBatchResultfeaturesGetValues(java.util.List<Feature> features)Get the values for one or more featues.TeamGetInfoResultgetInfo()Retrieves information about a team.GroupFullInfogroupsCreate(java.lang.String groupName)Creates a new, empty group, with a requested name.GroupsCreateBuildergroupsCreateBuilder(java.lang.String groupName)Creates a new, empty group, with a requested name.LaunchEmptyResultgroupsDelete(GroupSelector arg)Deletes a group.java.util.List<GroupsGetInfoItem>groupsGetInfo(GroupsSelector arg)Retrieves information about one or more groups.PollEmptyResultgroupsJobStatusGet(java.lang.String asyncJobId)Once an async_job_id is returned fromgroupsDelete(com.dropbox.core.v2.team.GroupSelector),groupsMembersAdd(GroupSelector,List,boolean), orgroupsMembersRemove(GroupSelector,List,boolean)use this method to poll the status of granting/revoking group members' access to group-owned resources.GroupsListResultgroupsList()Lists groups on a team.GroupsListResultgroupsList(long limit)Lists groups on a team.GroupsListResultgroupsListContinue(java.lang.String cursor)Once a cursor has been retrieved fromgroupsList(long), use this to paginate through all groups.GroupMembersChangeResultgroupsMembersAdd(GroupSelector group, java.util.List<MemberAccess> members)Adds members to a group.GroupMembersChangeResultgroupsMembersAdd(GroupSelector group, java.util.List<MemberAccess> members, boolean returnMembers)Adds members to a group.GroupsMembersListResultgroupsMembersList(GroupSelector group)Lists members of a group.GroupsMembersListResultgroupsMembersList(GroupSelector group, long limit)Lists members of a group.GroupsMembersListResultgroupsMembersListContinue(java.lang.String cursor)Once a cursor has been retrieved fromgroupsMembersList(GroupSelector,long), use this to paginate through all members of the group.GroupMembersChangeResultgroupsMembersRemove(GroupSelector group, java.util.List<UserSelectorArg> users)Removes members from a group.GroupMembersChangeResultgroupsMembersRemove(GroupSelector group, java.util.List<UserSelectorArg> users, boolean returnMembers)Removes members from a group.java.util.List<GroupsGetInfoItem>groupsMembersSetAccessType(GroupSelector group, UserSelectorArg user, GroupAccessType accessType)Sets a member's access type in a group.java.util.List<GroupsGetInfoItem>groupsMembersSetAccessType(GroupSelector group, UserSelectorArg user, GroupAccessType accessType, boolean returnMembers)Sets a member's access type in a group.GroupFullInfogroupsUpdate(GroupSelector group)Updates a group's name and/or external ID.GroupsUpdateBuildergroupsUpdateBuilder(GroupSelector group)Updates a group's name and/or external ID.LegalHoldPolicylegalHoldsCreatePolicy(java.lang.String name, java.util.List<java.lang.String> members)Creates new legal hold policy.LegalHoldsCreatePolicyBuilderlegalHoldsCreatePolicyBuilder(java.lang.String name, java.util.List<java.lang.String> members)Creates new legal hold policy.LegalHoldPolicylegalHoldsGetPolicy(java.lang.String id)Gets a legal hold by Id.LegalHoldsListHeldRevisionResultlegalHoldsListHeldRevisions(java.lang.String id)List the file metadata that's under the hold.LegalHoldsListHeldRevisionResultlegalHoldsListHeldRevisionsContinue(java.lang.String id)Continue listing the file metadata that's under the hold.LegalHoldsListHeldRevisionResultlegalHoldsListHeldRevisionsContinue(java.lang.String id, java.lang.String cursor)Continue listing the file metadata that's under the hold.LegalHoldsListPoliciesResultlegalHoldsListPolicies()Lists legal holds on a team.LegalHoldsListPoliciesResultlegalHoldsListPolicies(boolean includeReleased)Lists legal holds on a team.voidlegalHoldsReleasePolicy(java.lang.String id)Releases a legal hold by Id.LegalHoldPolicylegalHoldsUpdatePolicy(java.lang.String id)Updates a legal hold.LegalHoldsUpdatePolicyBuilderlegalHoldsUpdatePolicyBuilder(java.lang.String id)Updates a legal hold.ListMemberAppsResultlinkedAppsListMemberLinkedApps(java.lang.String teamMemberId)List all linked applications of the team member.ListMembersAppsResultlinkedAppsListMembersLinkedApps()List all applications linked to the team members' accounts.ListMembersAppsResultlinkedAppsListMembersLinkedApps(java.lang.String cursor)List all applications linked to the team members' accounts.ListTeamAppsResultlinkedAppsListTeamLinkedApps()Deprecated.uselinkedAppsListMembersLinkedApps(String)instead.ListTeamAppsResultlinkedAppsListTeamLinkedApps(java.lang.String cursor)Deprecated.uselinkedAppsListMembersLinkedApps(String)instead.voidlinkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId)Revoke a linked application of the team member.voidlinkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId, boolean keepAppFolder)Revoke a linked application of the team member.RevokeLinkedAppBatchResultlinkedAppsRevokeLinkedAppBatch(java.util.List<RevokeLinkedApiAppArg> revokeLinkedApp)Revoke a list of linked applications of the team members.MembersAddLaunchmembersAdd(java.util.List<MemberAddArg> newMembers)Adds members to a team.MembersAddLaunchmembersAdd(java.util.List<MemberAddArg> newMembers, boolean forceAsync)Adds members to a team.MembersAddJobStatusmembersAddJobStatusGet(java.lang.String asyncJobId)Once an async_job_id is returned frommembersAdd(List,boolean), use this to poll the status of the asynchronous request.MembersAddJobStatusV2ResultmembersAddJobStatusGetV2(java.lang.String asyncJobId)Once an async_job_id is returned frommembersAddV2(List,boolean), use this to poll the status of the asynchronous request.MembersAddLaunchV2ResultmembersAddV2(java.util.List<MemberAddV2Arg> newMembers)Adds members to a team.MembersAddLaunchV2ResultmembersAddV2(java.util.List<MemberAddV2Arg> newMembers, boolean forceAsync)Adds members to a team.TeamMemberInfomembersDeleteProfilePhoto(UserSelectorArg user)Deletes a team member's profile photo.TeamMemberInfoV2ResultmembersDeleteProfilePhotoV2(UserSelectorArg user)Deletes a team member's profile photo.MembersGetAvailableTeamMemberRolesResultmembersGetAvailableTeamMemberRoles()Get available TeamMemberRoles for the connected team.java.util.List<MembersGetInfoItem>membersGetInfo(java.util.List<UserSelectorArg> members)Returns information about multiple team members.MembersGetInfoV2ResultmembersGetInfoV2(java.util.List<UserSelectorArg> members)Returns information about multiple team members.MembersListResultmembersList()Lists members of a team.MembersListBuildermembersListBuilder()Lists members of a team.MembersListResultmembersListContinue(java.lang.String cursor)Once a cursor has been retrieved frommembersList(com.dropbox.core.v2.team.MembersListArg), use this to paginate through all team members.MembersListV2ResultmembersListContinueV2(java.lang.String cursor)Once a cursor has been retrieved frommembersListV2(com.dropbox.core.v2.team.MembersListArg), use this to paginate through all team members.MembersListV2ResultmembersListV2()Lists members of a team.MembersListV2BuildermembersListV2Builder()Lists members of a team.LaunchEmptyResultmembersMoveFormerMemberFiles(UserSelectorArg user, UserSelectorArg transferDestId, UserSelectorArg transferAdminId)Moves removed member's files to a different member.PollEmptyResultmembersMoveFormerMemberFilesJobStatusCheck(java.lang.String asyncJobId)Once an async_job_id is returned frommembersMoveFormerMemberFiles(UserSelectorArg,UserSelectorArg,UserSelectorArg), use this to poll the status of the asynchronous request.ExcludedUsersUpdateResultmemberSpaceLimitsExcludedUsersAdd()Add users to member space limits excluded users list.ExcludedUsersUpdateResultmemberSpaceLimitsExcludedUsersAdd(java.util.List<UserSelectorArg> users)Add users to member space limits excluded users list.ExcludedUsersListResultmemberSpaceLimitsExcludedUsersList()List member space limits excluded users.ExcludedUsersListResultmemberSpaceLimitsExcludedUsersList(long limit)List member space limits excluded users.ExcludedUsersListResultmemberSpaceLimitsExcludedUsersListContinue(java.lang.String cursor)Continue listing member space limits excluded users.ExcludedUsersUpdateResultmemberSpaceLimitsExcludedUsersRemove()Remove users from member space limits excluded users list.ExcludedUsersUpdateResultmemberSpaceLimitsExcludedUsersRemove(java.util.List<UserSelectorArg> users)Remove users from member space limits excluded users list.java.util.List<CustomQuotaResult>memberSpaceLimitsGetCustomQuota(java.util.List<UserSelectorArg> users)Get users custom quota.java.util.List<RemoveCustomQuotaResult>memberSpaceLimitsRemoveCustomQuota(java.util.List<UserSelectorArg> users)Remove users custom quota.java.util.List<CustomQuotaResult>memberSpaceLimitsSetCustomQuota(java.util.List<UserCustomQuotaArg> usersAndQuotas)Set users custom quota.voidmembersRecover(UserSelectorArg user)Recover a deleted member.LaunchEmptyResultmembersRemove(UserSelectorArg user)Removes a member from a team.MembersRemoveBuildermembersRemoveBuilder(UserSelectorArg user)Removes a member from a team.PollEmptyResultmembersRemoveJobStatusGet(java.lang.String asyncJobId)Once an async_job_id is returned frommembersRemove(UserSelectorArg), use this to poll the status of the asynchronous request.AddSecondaryEmailsResultmembersSecondaryEmailsAdd(java.util.List<UserSecondaryEmailsArg> newSecondaryEmails)Add secondary emails to users.DeleteSecondaryEmailsResultmembersSecondaryEmailsDelete(java.util.List<UserSecondaryEmailsArg> emailsToDelete)Delete secondary emails from usersResendVerificationEmailResultmembersSecondaryEmailsResendVerificationEmails(java.util.List<UserSecondaryEmailsArg> emailsToResend)Resend secondary email verification emails.voidmembersSendWelcomeEmail(UserSelectorArg arg)Sends welcome email to pending team member.MembersSetPermissionsResultmembersSetAdminPermissions(UserSelectorArg user, AdminTier newRole)Updates a team member's permissions.MembersSetPermissions2ResultmembersSetAdminPermissionsV2(UserSelectorArg user)Updates a team member's permissions.MembersSetPermissions2ResultmembersSetAdminPermissionsV2(UserSelectorArg user, java.util.List<java.lang.String> newRoles)Updates a team member's permissions.TeamMemberInfomembersSetProfile(UserSelectorArg user)Updates a team member's profile.MembersSetProfileBuildermembersSetProfileBuilder(UserSelectorArg user)Updates a team member's profile.TeamMemberInfomembersSetProfilePhoto(UserSelectorArg user, PhotoSourceArg photo)Updates a team member's profile photo.TeamMemberInfoV2ResultmembersSetProfilePhotoV2(UserSelectorArg user, PhotoSourceArg photo)Updates a team member's profile photo.TeamMemberInfoV2ResultmembersSetProfileV2(UserSelectorArg user)Updates a team member's profile.MembersSetProfileV2BuildermembersSetProfileV2Builder(UserSelectorArg user)Updates a team member's profile.voidmembersSuspend(UserSelectorArg user)Suspend a member from a team.voidmembersSuspend(UserSelectorArg user, boolean wipeData)Suspend a member from a team.voidmembersUnsuspend(UserSelectorArg user)Unsuspend a member from a team.TeamNamespacesListResultnamespacesList()Returns a list of all team-accessible namespaces.TeamNamespacesListResultnamespacesList(long limit)Returns a list of all team-accessible namespaces.TeamNamespacesListResultnamespacesListContinue(java.lang.String cursor)Once a cursor has been retrieved fromnamespacesList(long), use this to paginate through all team-accessible namespaces.AddTemplateResultpropertiesTemplateAdd(java.lang.String name, java.lang.String description, java.util.List<PropertyFieldTemplate> fields)Deprecated.GetTemplateResultpropertiesTemplateGet(java.lang.String templateId)Deprecated.ListTemplateResultpropertiesTemplateList()Deprecated.UpdateTemplateResultpropertiesTemplateUpdate(java.lang.String templateId)Deprecated.PropertiesTemplateUpdateBuilderpropertiesTemplateUpdateBuilder(java.lang.String templateId)Deprecated.GetActivityReportreportsGetActivity()Deprecated.ReportsGetActivityBuilderreportsGetActivityBuilder()Deprecated.GetDevicesReportreportsGetDevices()Deprecated.ReportsGetDevicesBuilderreportsGetDevicesBuilder()Deprecated.GetMembershipReportreportsGetMembership()Deprecated.ReportsGetMembershipBuilderreportsGetMembershipBuilder()Deprecated.GetStorageReportreportsGetStorage()Deprecated.ReportsGetStorageBuilderreportsGetStorageBuilder()Deprecated.TeamFolderMetadatateamFolderActivate(java.lang.String teamFolderId)Sets an archived team folder's status to active.TeamFolderArchiveLaunchteamFolderArchive(java.lang.String teamFolderId)Sets an active team folder's status to archived and removes all folder and file members.TeamFolderArchiveLaunchteamFolderArchive(java.lang.String teamFolderId, boolean forceAsyncOff)Sets an active team folder's status to archived and removes all folder and file members.TeamFolderArchiveJobStatusteamFolderArchiveCheck(java.lang.String asyncJobId)Returns the status of an asynchronous job for archiving a team folder.TeamFolderMetadatateamFolderCreate(java.lang.String name)Creates a new, active, team folder with no members.TeamFolderMetadatateamFolderCreate(java.lang.String name, SyncSettingArg syncSetting)Creates a new, active, team folder with no members.java.util.List<TeamFolderGetInfoItem>teamFolderGetInfo(java.util.List<java.lang.String> teamFolderIds)Retrieves metadata for team folders.TeamFolderListResultteamFolderList()Lists all team folders.TeamFolderListResultteamFolderList(long limit)Lists all team folders.TeamFolderListResultteamFolderListContinue(java.lang.String cursor)Once a cursor has been retrieved fromteamFolderList(long), use this to paginate through all team folders.voidteamFolderPermanentlyDelete(java.lang.String teamFolderId)Permanently deletes an archived team folder.TeamFolderMetadatateamFolderRename(java.lang.String teamFolderId, java.lang.String name)Changes an active team folder's name.TeamFolderMetadatateamFolderUpdateSyncSettings(java.lang.String teamFolderId)Updates the sync settings on a team folder or its contents.TeamFolderUpdateSyncSettingsBuilderteamFolderUpdateSyncSettingsBuilder(java.lang.String teamFolderId)Updates the sync settings on a team folder or its contents.TokenGetAuthenticatedAdminResulttokenGetAuthenticatedAdmin()Returns the member profile of the admin who generated the team access token used to make the call.
 
- 
- 
- 
Constructor Detail- 
DbxTeamTeamRequestspublic DbxTeamTeamRequests(DbxRawClientV2 client) 
 
- 
 - 
Method Detail- 
devicesListMemberDevicespublic ListMemberDevicesResult devicesListMemberDevices(java.lang.String teamMemberId) throws ListMemberDevicesErrorException, DbxException List all device sessions of a team's member.The default values for the optional request parameters will be used. See DevicesListMemberDevicesBuilderfor more details.- Parameters:
- teamMemberId- The team's member id. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- ListMemberDevicesErrorException
- DbxException
 
 - 
devicesListMemberDevicesBuilderpublic DevicesListMemberDevicesBuilder devicesListMemberDevicesBuilder(java.lang.String teamMemberId) List all device sessions of a team's member.- Parameters:
- teamMemberId- The team's member id. Must not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
devicesListMembersDevicespublic ListMembersDevicesResult devicesListMembersDevices() throws ListMembersDevicesErrorException, DbxException List all device sessions of a team.Permission : Team member file access. The default values for the optional request parameters will be used. See DevicesListMembersDevicesBuilderfor more details.
 - 
devicesListMembersDevicesBuilderpublic DevicesListMembersDevicesBuilder devicesListMembersDevicesBuilder() List all device sessions of a team. Permission : Team member file access.- Returns:
- Request builder for configuring request parameters and completing the request.
 
 - 
devicesListTeamDevices@Deprecated public ListTeamDevicesResult devicesListTeamDevices() throws ListTeamDevicesErrorException, DbxException Deprecated.List all device sessions of a team.Permission : Team member file access. The default values for the optional request parameters will be used. See DevicesListTeamDevicesBuilderfor more details.
 - 
devicesListTeamDevicesBuilder@Deprecated public DevicesListTeamDevicesBuilder devicesListTeamDevicesBuilder() Deprecated.List all device sessions of a team. Permission : Team member file access.- Returns:
- Request builder for configuring request parameters and completing the request.
 
 - 
devicesRevokeDeviceSessionpublic void devicesRevokeDeviceSession(RevokeDeviceSessionArg arg) throws RevokeDeviceSessionErrorException, DbxException Revoke a device session of a team's member.
 - 
devicesRevokeDeviceSessionBatchpublic RevokeDeviceSessionBatchResult devicesRevokeDeviceSessionBatch(java.util.List<RevokeDeviceSessionArg> revokeDevices) throws RevokeDeviceSessionBatchErrorException, DbxException Revoke a list of device sessions of team members.- Parameters:
- revokeDevices- Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- RevokeDeviceSessionBatchErrorException
- DbxException
 
 - 
featuresGetValuespublic FeaturesGetValuesBatchResult featuresGetValues(java.util.List<Feature> features) throws FeaturesGetValuesBatchErrorException, DbxException Get the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features.Permission : Team information. - Parameters:
- features- A list of features in- Feature. If the list is empty, this route will return- FeaturesGetValuesBatchError. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- FeaturesGetValuesBatchErrorException
- DbxException
 
 - 
getInfopublic TeamGetInfoResult getInfo() throws DbxApiException, DbxException Retrieves information about a team.- Throws:
- DbxApiException
- DbxException
 
 - 
groupsCreatepublic GroupFullInfo groupsCreate(java.lang.String groupName) throws GroupCreateErrorException, DbxException Creates a new, empty group, with a requested name.Permission : Team member management. The default values for the optional request parameters will be used. See GroupsCreateBuilderfor more details.- Parameters:
- groupName- Group name. Must not be- null.
- Returns:
- Full description of a group.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupCreateErrorException
- DbxException
 
 - 
groupsCreateBuilderpublic GroupsCreateBuilder groupsCreateBuilder(java.lang.String groupName) Creates a new, empty group, with a requested name. Permission : Team member management.- Parameters:
- groupName- Group name. Must not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
groupsDeletepublic LaunchEmptyResult groupsDelete(GroupSelector arg) throws GroupDeleteErrorException, DbxException Deletes a group. The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use thegroupsJobStatusGet(String)to determine whether this process has completed. Permission : Team member management.- Parameters:
- arg- Argument for selecting a single group, either by group_id or by external group ID.
- Returns:
- Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
- Throws:
- GroupDeleteErrorException
- DbxException
 
 - 
groupsGetInfopublic java.util.List<GroupsGetInfoItem> groupsGetInfo(GroupsSelector arg) throws GroupsGetInfoErrorException, DbxException Retrieves information about one or more groups. Note that the optional fieldGroupFullInfo.getMembers()is not returned for system-managed groups. Permission : Team Information.- Parameters:
- arg- Argument for selecting a list of groups, either by group_ids, or external group IDs.
- Throws:
- GroupsGetInfoErrorException
- DbxException
 
 - 
groupsJobStatusGetpublic PollEmptyResult groupsJobStatusGet(java.lang.String asyncJobId) throws GroupsPollErrorException, DbxException Once an async_job_id is returned fromgroupsDelete(com.dropbox.core.v2.team.GroupSelector),groupsMembersAdd(GroupSelector,List,boolean), orgroupsMembersRemove(GroupSelector,List,boolean)use this method to poll the status of granting/revoking group members' access to group-owned resources.Permission : Team member management. - Parameters:
- asyncJobId- Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be- null.
- Returns:
- Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupsPollErrorException
- DbxException
 
 - 
groupsListpublic GroupsListResult groupsList() throws DbxApiException, DbxException Lists groups on a team.Permission : Team Information. The limitrequest parameter will default to1000L(seegroupsList(long)).- Throws:
- DbxApiException
- DbxException
 
 - 
groupsListpublic GroupsListResult groupsList(long limit) throws DbxApiException, DbxException Lists groups on a team.Permission : Team Information. - Parameters:
- limit- Number of results to return per call. Must be greater than or equal to 1 and be less than or equal to 1000.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- DbxApiException
- DbxException
 
 - 
groupsListContinuepublic GroupsListResult groupsListContinue(java.lang.String cursor) throws GroupsListContinueErrorException, DbxException Once a cursor has been retrieved fromgroupsList(long), use this to paginate through all groups.Permission : Team Information. - Parameters:
- cursor- Indicates from what point to get the next set of groups. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupsListContinueErrorException
- DbxException
 
 - 
groupsMembersAddpublic GroupMembersChangeResult groupsMembersAdd(GroupSelector group, java.util.List<MemberAccess> members) throws GroupMembersAddErrorException, DbxException Adds members to a group.The members are added immediately. However the granting of group-owned resources may take additional time. Use the groupsJobStatusGet(String)to determine whether this process has completed.Permission : Team member management. The returnMembersrequest parameter will default totrue(seegroupsMembersAdd(GroupSelector,List,boolean)).- Parameters:
- group- Group to which users will be added. Must not be- null.
- members- List of users to be added to the group. Must not contain a- nullitem and not be- null.
- Returns:
- Result returned by groupsMembersAdd(GroupSelector,List,boolean)andgroupsMembersRemove(GroupSelector,List,boolean).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupMembersAddErrorException
- DbxException
 
 - 
groupsMembersAddpublic GroupMembersChangeResult groupsMembersAdd(GroupSelector group, java.util.List<MemberAccess> members, boolean returnMembers) throws GroupMembersAddErrorException, DbxException Adds members to a group.The members are added immediately. However the granting of group-owned resources may take additional time. Use the groupsJobStatusGet(String)to determine whether this process has completed.Permission : Team member management. - Parameters:
- group- Group to which users will be added. Must not be- null.
- members- List of users to be added to the group. Must not contain a- nullitem and not be- null.
- returnMembers- Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups.
- Returns:
- Result returned by groupsMembersAdd(GroupSelector,List,boolean)andgroupsMembersRemove(GroupSelector,List,boolean).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupMembersAddErrorException
- DbxException
 
 - 
groupsMembersListpublic GroupsMembersListResult groupsMembersList(GroupSelector group) throws GroupSelectorErrorException, DbxException Lists members of a group.Permission : Team Information. The limitrequest parameter will default to1000L(seegroupsMembersList(GroupSelector,long)).- Parameters:
- group- The group whose members are to be listed. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupSelectorErrorException
- DbxException
 
 - 
groupsMembersListpublic GroupsMembersListResult groupsMembersList(GroupSelector group, long limit) throws GroupSelectorErrorException, DbxException Lists members of a group.Permission : Team Information. - Parameters:
- group- The group whose members are to be listed. Must not be- null.
- limit- Number of results to return per call. Must be greater than or equal to 1 and be less than or equal to 1000.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupSelectorErrorException
- DbxException
 
 - 
groupsMembersListContinuepublic GroupsMembersListResult groupsMembersListContinue(java.lang.String cursor) throws GroupsMembersListContinueErrorException, DbxException Once a cursor has been retrieved fromgroupsMembersList(GroupSelector,long), use this to paginate through all members of the group.Permission : Team information. - Parameters:
- cursor- Indicates from what point to get the next set of groups. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupsMembersListContinueErrorException
- DbxException
 
 - 
groupsMembersRemovepublic GroupMembersChangeResult groupsMembersRemove(GroupSelector group, java.util.List<UserSelectorArg> users) throws GroupMembersRemoveErrorException, DbxException Removes members from a group.The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groupsJobStatusGet(String)to determine whether this process has completed.This method permits removing the only owner of a group, even in cases where this is not possible via the web client. Permission : Team member management. The returnMembersrequest parameter will default totrue(seegroupsMembersRemove(GroupSelector,List,boolean)).- Parameters:
- group- Group from which users will be removed. Must not be- null.
- users- List of users to be removed from the group. Must not contain a- nullitem and not be- null.
- Returns:
- Result returned by groupsMembersAdd(GroupSelector,List,boolean)andgroupsMembersRemove(GroupSelector,List,boolean).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupMembersRemoveErrorException
- DbxException
 
 - 
groupsMembersRemovepublic GroupMembersChangeResult groupsMembersRemove(GroupSelector group, java.util.List<UserSelectorArg> users, boolean returnMembers) throws GroupMembersRemoveErrorException, DbxException Removes members from a group.The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groupsJobStatusGet(String)to determine whether this process has completed.This method permits removing the only owner of a group, even in cases where this is not possible via the web client. Permission : Team member management. - Parameters:
- group- Group from which users will be removed. Must not be- null.
- users- List of users to be removed from the group. Must not contain a- nullitem and not be- null.
- returnMembers- Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups.
- Returns:
- Result returned by groupsMembersAdd(GroupSelector,List,boolean)andgroupsMembersRemove(GroupSelector,List,boolean).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupMembersRemoveErrorException
- DbxException
 
 - 
groupsMembersSetAccessTypepublic java.util.List<GroupsGetInfoItem> groupsMembersSetAccessType(GroupSelector group, UserSelectorArg user, GroupAccessType accessType) throws GroupMemberSetAccessTypeErrorException, DbxException Sets a member's access type in a group.Permission : Team member management. The returnMembersrequest parameter will default totrue(seegroupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean)).- Parameters:
- group- Specify a group. Must not be- null.
- user- Identity of a user that is a member of the- groupargument to- groupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean). Must not be- null.
- accessType- New group access type the user will have. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupMemberSetAccessTypeErrorException
- DbxException
 
 - 
groupsMembersSetAccessTypepublic java.util.List<GroupsGetInfoItem> groupsMembersSetAccessType(GroupSelector group, UserSelectorArg user, GroupAccessType accessType, boolean returnMembers) throws GroupMemberSetAccessTypeErrorException, DbxException Sets a member's access type in a group.Permission : Team member management. - Parameters:
- group- Specify a group. Must not be- null.
- user- Identity of a user that is a member of the- groupargument to- groupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean). Must not be- null.
- accessType- New group access type the user will have. Must not be- null.
- returnMembers- Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupMemberSetAccessTypeErrorException
- DbxException
 
 - 
groupsUpdatepublic GroupFullInfo groupsUpdate(GroupSelector group) throws GroupUpdateErrorException, DbxException Updates a group's name and/or external ID.Permission : Team member management. The default values for the optional request parameters will be used. See GroupsUpdateBuilderfor more details.- Parameters:
- group- Specify a group. Must not be- null.
- Returns:
- Full description of a group.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- GroupUpdateErrorException
- DbxException
 
 - 
groupsUpdateBuilderpublic GroupsUpdateBuilder groupsUpdateBuilder(GroupSelector group) Updates a group's name and/or external ID. Permission : Team member management.- Parameters:
- group- Specify a group. Must not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
legalHoldsCreatePolicypublic LegalHoldPolicy legalHoldsCreatePolicy(java.lang.String name, java.util.List<java.lang.String> members) throws LegalHoldsPolicyCreateErrorException, DbxException Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. - Parameters:
- name- Policy name. Must have length of at most 140 and not be- null.
- members- List of team member IDs added to the hold. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- LegalHoldsPolicyCreateErrorException
- DbxException
 
 - 
legalHoldsCreatePolicyBuilderpublic LegalHoldsCreatePolicyBuilder legalHoldsCreatePolicyBuilder(java.lang.String name, java.util.List<java.lang.String> members) Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.- Parameters:
- name- Policy name. Must have length of at most 140 and not be- null.
- members- List of team member IDs added to the hold. Must not contain a- nullitem and not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
legalHoldsGetPolicypublic LegalHoldPolicy legalHoldsGetPolicy(java.lang.String id) throws LegalHoldsGetPolicyErrorException, DbxException Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. - Parameters:
- id- The legal hold Id. Must match pattern "- ^pid_dbhid:.+" and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- LegalHoldsGetPolicyErrorException
- DbxException
 
 - 
legalHoldsListHeldRevisionspublic LegalHoldsListHeldRevisionResult legalHoldsListHeldRevisions(java.lang.String id) throws LegalHoldsListHeldRevisionsErrorException, DbxException List the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. - Parameters:
- id- The legal hold Id. Must match pattern "- ^pid_dbhid:.+" and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- LegalHoldsListHeldRevisionsErrorException
- DbxException
 
 - 
legalHoldsListHeldRevisionsContinuepublic LegalHoldsListHeldRevisionResult legalHoldsListHeldRevisionsContinue(java.lang.String id) throws LegalHoldsListHeldRevisionsErrorException, DbxException Continue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. - Parameters:
- id- The legal hold Id. Must match pattern "- ^pid_dbhid:.+" and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- LegalHoldsListHeldRevisionsErrorException
- DbxException
 
 - 
legalHoldsListHeldRevisionsContinuepublic LegalHoldsListHeldRevisionResult legalHoldsListHeldRevisionsContinue(java.lang.String id, java.lang.String cursor) throws LegalHoldsListHeldRevisionsErrorException, DbxException Continue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. - Parameters:
- id- The legal hold Id. Must match pattern "- ^pid_dbhid:.+" and not be- null.
- cursor- The cursor idicates where to continue reading file metadata entries for the next API call. When there are no more entries, the cursor will return none. Must have length of at least 1.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- LegalHoldsListHeldRevisionsErrorException
- DbxException
 
 - 
legalHoldsListPoliciespublic LegalHoldsListPoliciesResult legalHoldsListPolicies() throws LegalHoldsListPoliciesErrorException, DbxException Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. The includeReleasedrequest parameter will default tofalse(seelegalHoldsListPolicies(boolean)).
 - 
legalHoldsListPoliciespublic LegalHoldsListPoliciesResult legalHoldsListPolicies(boolean includeReleased) throws LegalHoldsListPoliciesErrorException, DbxException Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. - Parameters:
- includeReleased- Whether to return holds that were released.
- Throws:
- LegalHoldsListPoliciesErrorException
- DbxException
 
 - 
legalHoldsReleasePolicypublic void legalHoldsReleasePolicy(java.lang.String id) throws LegalHoldsPolicyReleaseErrorException, DbxExceptionReleases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. - Parameters:
- id- The legal hold Id. Must match pattern "- ^pid_dbhid:.+" and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- LegalHoldsPolicyReleaseErrorException
- DbxException
 
 - 
legalHoldsUpdatePolicypublic LegalHoldPolicy legalHoldsUpdatePolicy(java.lang.String id) throws LegalHoldsPolicyUpdateErrorException, DbxException Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature.Permission : Team member file access. - Parameters:
- id- The legal hold Id. Must match pattern "- ^pid_dbhid:.+" and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- LegalHoldsPolicyUpdateErrorException
- DbxException
 
 - 
legalHoldsUpdatePolicyBuilderpublic LegalHoldsUpdatePolicyBuilder legalHoldsUpdatePolicyBuilder(java.lang.String id) Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.- Parameters:
- id- The legal hold Id. Must match pattern "- ^pid_dbhid:.+" and not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
linkedAppsListMemberLinkedAppspublic ListMemberAppsResult linkedAppsListMemberLinkedApps(java.lang.String teamMemberId) throws ListMemberAppsErrorException, DbxException List all linked applications of the team member.Note, this endpoint does not list any team-linked applications. - Parameters:
- teamMemberId- The team member id. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- ListMemberAppsErrorException
- DbxException
 
 - 
linkedAppsListMembersLinkedAppspublic ListMembersAppsResult linkedAppsListMembersLinkedApps() throws ListMembersAppsErrorException, DbxException List all applications linked to the team members' accounts.Note, this endpoint does not list any team-linked applications. - Returns:
- Information returned by linkedAppsListMembersLinkedApps(String).
- Throws:
- ListMembersAppsErrorException
- DbxException
 
 - 
linkedAppsListMembersLinkedAppspublic ListMembersAppsResult linkedAppsListMembersLinkedApps(java.lang.String cursor) throws ListMembersAppsErrorException, DbxException List all applications linked to the team members' accounts.Note, this endpoint does not list any team-linked applications. - Parameters:
- cursor- At the first call to the- linkedAppsListMembersLinkedApps(String)the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications.
- Returns:
- Information returned by linkedAppsListMembersLinkedApps(String).
- Throws:
- ListMembersAppsErrorException
- DbxException
 
 - 
linkedAppsListTeamLinkedApps@Deprecated public ListTeamAppsResult linkedAppsListTeamLinkedApps() throws ListTeamAppsErrorException, DbxException Deprecated.uselinkedAppsListMembersLinkedApps(String)instead.List all applications linked to the team members' accounts.Note, this endpoint doesn't list any team-linked applications. - Returns:
- Information returned by linkedAppsListTeamLinkedApps(String).
- Throws:
- ListTeamAppsErrorException
- DbxException
 
 - 
linkedAppsListTeamLinkedApps@Deprecated public ListTeamAppsResult linkedAppsListTeamLinkedApps(java.lang.String cursor) throws ListTeamAppsErrorException, DbxException Deprecated.uselinkedAppsListMembersLinkedApps(String)instead.List all applications linked to the team members' accounts.Note, this endpoint doesn't list any team-linked applications. - Parameters:
- cursor- At the first call to the- linkedAppsListTeamLinkedApps(String)the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications.
- Returns:
- Information returned by linkedAppsListTeamLinkedApps(String).
- Throws:
- ListTeamAppsErrorException
- DbxException
 
 - 
linkedAppsRevokeLinkedApppublic void linkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId) throws RevokeLinkedAppErrorException, DbxExceptionRevoke a linked application of the team member.The keepAppFolderrequest parameter will default totrue(seelinkedAppsRevokeLinkedApp(String,String,boolean)).- Parameters:
- appId- The application's unique id. Must not be- null.
- teamMemberId- The unique id of the member owning the device. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- RevokeLinkedAppErrorException
- DbxException
 
 - 
linkedAppsRevokeLinkedApppublic void linkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId, boolean keepAppFolder) throws RevokeLinkedAppErrorException, DbxExceptionRevoke a linked application of the team member.- Parameters:
- appId- The application's unique id. Must not be- null.
- teamMemberId- The unique id of the member owning the device. Must not be- null.
- keepAppFolder- This flag is not longer supported, the application dedicated folder (in case the application uses one) will be kept.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- RevokeLinkedAppErrorException
- DbxException
 
 - 
linkedAppsRevokeLinkedAppBatchpublic RevokeLinkedAppBatchResult linkedAppsRevokeLinkedAppBatch(java.util.List<RevokeLinkedApiAppArg> revokeLinkedApp) throws RevokeLinkedAppBatchErrorException, DbxException Revoke a list of linked applications of the team members.- Parameters:
- revokeLinkedApp- Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- RevokeLinkedAppBatchErrorException
- DbxException
 
 - 
memberSpaceLimitsExcludedUsersAddpublic ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersAdd() throws ExcludedUsersUpdateErrorException, DbxException Add users to member space limits excluded users list.- Returns:
- Excluded users update result.
- Throws:
- ExcludedUsersUpdateErrorException
- DbxException
 
 - 
memberSpaceLimitsExcludedUsersAddpublic ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersAdd(java.util.List<UserSelectorArg> users) throws ExcludedUsersUpdateErrorException, DbxException Add users to member space limits excluded users list.- Parameters:
- users- List of users to be added/removed. Must not contain a- nullitem.
- Returns:
- Excluded users update result.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- ExcludedUsersUpdateErrorException
- DbxException
 
 - 
memberSpaceLimitsExcludedUsersListpublic ExcludedUsersListResult memberSpaceLimitsExcludedUsersList() throws ExcludedUsersListErrorException, DbxException List member space limits excluded users.The limitrequest parameter will default to1000L(seememberSpaceLimitsExcludedUsersList(long)).- Returns:
- Excluded users list result.
- Throws:
- ExcludedUsersListErrorException
- DbxException
 
 - 
memberSpaceLimitsExcludedUsersListpublic ExcludedUsersListResult memberSpaceLimitsExcludedUsersList(long limit) throws ExcludedUsersListErrorException, DbxException List member space limits excluded users.- Parameters:
- limit- Number of results to return per call. Must be greater than or equal to 1 and be less than or equal to 1000.
- Returns:
- Excluded users list result.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- ExcludedUsersListErrorException
- DbxException
 
 - 
memberSpaceLimitsExcludedUsersListContinuepublic ExcludedUsersListResult memberSpaceLimitsExcludedUsersListContinue(java.lang.String cursor) throws ExcludedUsersListContinueErrorException, DbxException Continue listing member space limits excluded users.- Parameters:
- cursor- Indicates from what point to get the next set of users. Must not be- null.
- Returns:
- Excluded users list result.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- ExcludedUsersListContinueErrorException
- DbxException
 
 - 
memberSpaceLimitsExcludedUsersRemovepublic ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersRemove() throws ExcludedUsersUpdateErrorException, DbxException Remove users from member space limits excluded users list.- Returns:
- Excluded users update result.
- Throws:
- ExcludedUsersUpdateErrorException
- DbxException
 
 - 
memberSpaceLimitsExcludedUsersRemovepublic ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersRemove(java.util.List<UserSelectorArg> users) throws ExcludedUsersUpdateErrorException, DbxException Remove users from member space limits excluded users list.- Parameters:
- users- List of users to be added/removed. Must not contain a- nullitem.
- Returns:
- Excluded users update result.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- ExcludedUsersUpdateErrorException
- DbxException
 
 - 
memberSpaceLimitsGetCustomQuotapublic java.util.List<CustomQuotaResult> memberSpaceLimitsGetCustomQuota(java.util.List<UserSelectorArg> users) throws CustomQuotaErrorException, DbxException Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.- Parameters:
- users- List of users. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- CustomQuotaErrorException
- DbxException
 
 - 
memberSpaceLimitsRemoveCustomQuotapublic java.util.List<RemoveCustomQuotaResult> memberSpaceLimitsRemoveCustomQuota(java.util.List<UserSelectorArg> users) throws CustomQuotaErrorException, DbxException Remove users custom quota. A maximum of 1000 members can be specified in a single call.- Parameters:
- users- List of users. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- CustomQuotaErrorException
- DbxException
 
 - 
memberSpaceLimitsSetCustomQuotapublic java.util.List<CustomQuotaResult> memberSpaceLimitsSetCustomQuota(java.util.List<UserCustomQuotaArg> usersAndQuotas) throws SetCustomQuotaErrorException, DbxException Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.- Parameters:
- usersAndQuotas- List of users and their custom quotas. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- SetCustomQuotaErrorException
- DbxException
 
 - 
membersAddV2public MembersAddLaunchV2Result membersAddV2(java.util.List<MemberAddV2Arg> newMembers) throws DbxApiException, DbxException Adds members to a team.Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'. The forceAsyncrequest parameter will default tofalse(seemembersAddV2(List,boolean)).- Parameters:
- newMembers- Details of new members to be added to the team. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- DbxApiException
- DbxException
 
 - 
membersAddV2public MembersAddLaunchV2Result membersAddV2(java.util.List<MemberAddV2Arg> newMembers, boolean forceAsync) throws DbxApiException, DbxException Adds members to a team.Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'. - Parameters:
- newMembers- Details of new members to be added to the team. Must not contain a- nullitem and not be- null.
- forceAsync- Whether to force the add to happen asynchronously.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- DbxApiException
- DbxException
 
 - 
membersAddpublic MembersAddLaunch membersAdd(java.util.List<MemberAddArg> newMembers) throws DbxApiException, DbxException Adds members to a team.Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'. The forceAsyncrequest parameter will default tofalse(seemembersAdd(List,boolean)).- Parameters:
- newMembers- Details of new members to be added to the team. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- DbxApiException
- DbxException
 
 - 
membersAddpublic MembersAddLaunch membersAdd(java.util.List<MemberAddArg> newMembers, boolean forceAsync) throws DbxApiException, DbxException Adds members to a team.Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'. - Parameters:
- newMembers- Details of new members to be added to the team. Must not contain a- nullitem and not be- null.
- forceAsync- Whether to force the add to happen asynchronously.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- DbxApiException
- DbxException
 
 - 
membersAddJobStatusGetV2public MembersAddJobStatusV2Result membersAddJobStatusGetV2(java.lang.String asyncJobId) throws PollErrorException, DbxException Once an async_job_id is returned frommembersAddV2(List,boolean), use this to poll the status of the asynchronous request.Permission : Team member management. - Parameters:
- asyncJobId- Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- PollErrorException
- DbxException
 
 - 
membersAddJobStatusGetpublic MembersAddJobStatus membersAddJobStatusGet(java.lang.String asyncJobId) throws PollErrorException, DbxException Once an async_job_id is returned frommembersAdd(List,boolean), use this to poll the status of the asynchronous request.Permission : Team member management. - Parameters:
- asyncJobId- Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- PollErrorException
- DbxException
 
 - 
membersDeleteProfilePhotoV2public TeamMemberInfoV2Result membersDeleteProfilePhotoV2(UserSelectorArg user) throws MembersDeleteProfilePhotoErrorException, DbxException Deletes a team member's profile photo.Permission : Team member management. - Parameters:
- user- Identity of the user whose profile photo will be deleted. Must not be- null.
- Returns:
- Information about a team member, after the change, like at membersSetProfileV2(UserSelectorArg).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersDeleteProfilePhotoErrorException
- DbxException
 
 - 
membersDeleteProfilePhotopublic TeamMemberInfo membersDeleteProfilePhoto(UserSelectorArg user) throws MembersDeleteProfilePhotoErrorException, DbxException Deletes a team member's profile photo.Permission : Team member management. - Parameters:
- user- Identity of the user whose profile photo will be deleted. Must not be- null.
- Returns:
- Information about a team member.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersDeleteProfilePhotoErrorException
- DbxException
 
 - 
membersGetAvailableTeamMemberRolespublic MembersGetAvailableTeamMemberRolesResult membersGetAvailableTeamMemberRoles() throws DbxApiException, DbxException Get available TeamMemberRoles for the connected team. To be used withmembersSetAdminPermissionsV2(UserSelectorArg,List). Permission : Team member management.- Returns:
- Available TeamMemberRole for the connected team. To be used with
     membersSetAdminPermissionsV2(UserSelectorArg,List).
- Throws:
- DbxApiException
- DbxException
 
 - 
membersGetInfoV2public MembersGetInfoV2Result membersGetInfoV2(java.util.List<UserSelectorArg> members) throws MembersGetInfoErrorException, DbxException Returns information about multiple team members.Permission : Team information This endpoint will return MembersGetInfoItem.getIdNotFoundValue(), for IDs (or emails) that cannot be matched to a valid team member.- Parameters:
- members- List of team members. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersGetInfoErrorException
- DbxException
 
 - 
membersGetInfopublic java.util.List<MembersGetInfoItem> membersGetInfo(java.util.List<UserSelectorArg> members) throws MembersGetInfoErrorException, DbxException Returns information about multiple team members.Permission : Team information This endpoint will return MembersGetInfoItem.getIdNotFoundValue(), for IDs (or emails) that cannot be matched to a valid team member.- Parameters:
- members- List of team members. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersGetInfoErrorException
- DbxException
 
 - 
membersListV2public MembersListV2Result membersListV2() throws MembersListErrorException, DbxException Lists members of a team.Permission : Team information. The default values for the optional request parameters will be used. See MembersListV2Builderfor more details.
 - 
membersListV2Builderpublic MembersListV2Builder membersListV2Builder() Lists members of a team. Permission : Team information.- Returns:
- Request builder for configuring request parameters and completing the request.
 
 - 
membersListpublic MembersListResult membersList() throws MembersListErrorException, DbxException Lists members of a team.Permission : Team information. The default values for the optional request parameters will be used. See MembersListBuilderfor more details.
 - 
membersListBuilderpublic MembersListBuilder membersListBuilder() Lists members of a team. Permission : Team information.- Returns:
- Request builder for configuring request parameters and completing the request.
 
 - 
membersListContinueV2public MembersListV2Result membersListContinueV2(java.lang.String cursor) throws MembersListContinueErrorException, DbxException Once a cursor has been retrieved frommembersListV2(com.dropbox.core.v2.team.MembersListArg), use this to paginate through all team members.Permission : Team information. - Parameters:
- cursor- Indicates from what point to get the next set of members. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersListContinueErrorException
- DbxException
 
 - 
membersListContinuepublic MembersListResult membersListContinue(java.lang.String cursor) throws MembersListContinueErrorException, DbxException Once a cursor has been retrieved frommembersList(com.dropbox.core.v2.team.MembersListArg), use this to paginate through all team members.Permission : Team information. - Parameters:
- cursor- Indicates from what point to get the next set of members. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersListContinueErrorException
- DbxException
 
 - 
membersMoveFormerMemberFilespublic LaunchEmptyResult membersMoveFormerMemberFiles(UserSelectorArg user, UserSelectorArg transferDestId, UserSelectorArg transferAdminId) throws MembersTransferFormerMembersFilesErrorException, DbxException Moves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically pollmembersMoveFormerMemberFilesJobStatusCheck(String).Permission : Team member management. - Parameters:
- user- Identity of user to remove/suspend/have their files moved. Must not be- null.
- transferDestId- Files from the deleted member account will be transferred to this user. Must not be- null.
- transferAdminId- Errors during the transfer process will be sent via email to this user. Must not be- null.
- Returns:
- Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersTransferFormerMembersFilesErrorException
- DbxException
 
 - 
membersMoveFormerMemberFilesJobStatusCheckpublic PollEmptyResult membersMoveFormerMemberFilesJobStatusCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException Once an async_job_id is returned frommembersMoveFormerMemberFiles(UserSelectorArg,UserSelectorArg,UserSelectorArg), use this to poll the status of the asynchronous request.Permission : Team member management. - Parameters:
- asyncJobId- Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be- null.
- Returns:
- Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- PollErrorException
- DbxException
 
 - 
membersRecoverpublic void membersRecover(UserSelectorArg user) throws MembersRecoverErrorException, DbxException Recover a deleted member.Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. - Parameters:
- user- Identity of user to recover. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersRecoverErrorException
- DbxException
 
 - 
membersRemovepublic LaunchEmptyResult membersRemove(UserSelectorArg user) throws MembersRemoveErrorException, DbxException Removes a member from a team.Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. Accounts can be recovered via membersRecover(UserSelectorArg)for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). CallingmembersAdd(List,boolean)while a user is still recoverable on your team will return withMemberAddResult.getUserAlreadyOnTeamValue().Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams). This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll membersRemoveJobStatusGet(String).The default values for the optional request parameters will be used. See MembersRemoveBuilderfor more details.- Parameters:
- user- Identity of user to remove/suspend/have their files moved. Must not be- null.
- Returns:
- Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersRemoveErrorException
- DbxException
 
 - 
membersRemoveBuilderpublic MembersRemoveBuilder membersRemoveBuilder(UserSelectorArg user) Removes a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. Accounts can be recovered viamembersRecover(UserSelectorArg)for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). CallingmembersAdd(List,boolean)while a user is still recoverable on your team will return withMemberAddResult.getUserAlreadyOnTeamValue(). Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams). This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically pollmembersRemoveJobStatusGet(String).- Parameters:
- user- Identity of user to remove/suspend/have their files moved. Must not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
membersRemoveJobStatusGetpublic PollEmptyResult membersRemoveJobStatusGet(java.lang.String asyncJobId) throws PollErrorException, DbxException Once an async_job_id is returned frommembersRemove(UserSelectorArg), use this to poll the status of the asynchronous request.Permission : Team member management. - Parameters:
- asyncJobId- Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be- null.
- Returns:
- Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- PollErrorException
- DbxException
 
 - 
membersSecondaryEmailsAddpublic AddSecondaryEmailsResult membersSecondaryEmailsAdd(java.util.List<UserSecondaryEmailsArg> newSecondaryEmails) throws AddSecondaryEmailsErrorException, DbxException Add secondary emails to users.Permission : Team member management. Emails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent. - Parameters:
- newSecondaryEmails- List of users and secondary emails to add. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- AddSecondaryEmailsErrorException
- DbxException
 
 - 
membersSecondaryEmailsDeletepublic DeleteSecondaryEmailsResult membersSecondaryEmailsDelete(java.util.List<UserSecondaryEmailsArg> emailsToDelete) throws DbxApiException, DbxException Delete secondary emails from usersPermission : Team member management. Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email. - Parameters:
- emailsToDelete- List of users and their secondary emails to delete. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- DbxApiException
- DbxException
 
 - 
membersSecondaryEmailsResendVerificationEmailspublic ResendVerificationEmailResult membersSecondaryEmailsResendVerificationEmails(java.util.List<UserSecondaryEmailsArg> emailsToResend) throws DbxApiException, DbxException Resend secondary email verification emails.Permission : Team member management. - Parameters:
- emailsToResend- List of users and secondary emails to resend verification emails to. Must not contain a- nullitem and not be- null.
- Returns:
- List of users and resend results.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- DbxApiException
- DbxException
 
 - 
membersSendWelcomeEmailpublic void membersSendWelcomeEmail(UserSelectorArg arg) throws MembersSendWelcomeErrorException, DbxException Sends welcome email to pending team member. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. No-op if team member is not pending.- Parameters:
- arg- Argument for selecting a single user, either by team_member_id, external_id or email.
- Throws:
- MembersSendWelcomeErrorException
- DbxException
 
 - 
membersSetAdminPermissionsV2public MembersSetPermissions2Result membersSetAdminPermissionsV2(UserSelectorArg user) throws MembersSetPermissions2ErrorException, DbxException Updates a team member's permissions.Permission : Team member management. - Parameters:
- user- Identity of user whose role will be set. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSetPermissions2ErrorException
- DbxException
 
 - 
membersSetAdminPermissionsV2public MembersSetPermissions2Result membersSetAdminPermissionsV2(UserSelectorArg user, java.util.List<java.lang.String> newRoles) throws MembersSetPermissions2ErrorException, DbxException Updates a team member's permissions.Permission : Team member management. - Parameters:
- user- Identity of user whose role will be set. Must not be- null.
- newRoles- The new roles for the member. Send empty list to make user member only. For now, only up to one role is allowed. Must contain at most 1 items and not contain a- nullitem.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSetPermissions2ErrorException
- DbxException
 
 - 
membersSetAdminPermissionspublic MembersSetPermissionsResult membersSetAdminPermissions(UserSelectorArg user, AdminTier newRole) throws MembersSetPermissionsErrorException, DbxException Updates a team member's permissions.Permission : Team member management. - Parameters:
- user- Identity of user whose role will be set. Must not be- null.
- newRole- The new role of the member. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSetPermissionsErrorException
- DbxException
 
 - 
membersSetProfileV2public TeamMemberInfoV2Result membersSetProfileV2(UserSelectorArg user) throws MembersSetProfileErrorException, DbxException Updates a team member's profile.Permission : Team member management. - Parameters:
- user- Identity of user whose profile will be set. Must not be- null.
- Returns:
- Information about a team member, after the change, like at membersSetProfileV2(UserSelectorArg).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSetProfileErrorException
- DbxException
 
 - 
membersSetProfileV2Builderpublic MembersSetProfileV2Builder membersSetProfileV2Builder(UserSelectorArg user) Updates a team member's profile. Permission : Team member management.- Parameters:
- user- Identity of user whose profile will be set. Must not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
membersSetProfilepublic TeamMemberInfo membersSetProfile(UserSelectorArg user) throws MembersSetProfileErrorException, DbxException Updates a team member's profile.Permission : Team member management. - Parameters:
- user- Identity of user whose profile will be set. Must not be- null.
- Returns:
- Information about a team member.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSetProfileErrorException
- DbxException
 
 - 
membersSetProfileBuilderpublic MembersSetProfileBuilder membersSetProfileBuilder(UserSelectorArg user) Updates a team member's profile. Permission : Team member management.- Parameters:
- user- Identity of user whose profile will be set. Must not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
membersSetProfilePhotoV2public TeamMemberInfoV2Result membersSetProfilePhotoV2(UserSelectorArg user, PhotoSourceArg photo) throws MembersSetProfilePhotoErrorException, DbxException Updates a team member's profile photo.Permission : Team member management. - Parameters:
- user- Identity of the user whose profile photo will be set. Must not be- null.
- photo- Image to set as the member's new profile photo. Must not be- null.
- Returns:
- Information about a team member, after the change, like at membersSetProfileV2(UserSelectorArg).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSetProfilePhotoErrorException
- DbxException
 
 - 
membersSetProfilePhotopublic TeamMemberInfo membersSetProfilePhoto(UserSelectorArg user, PhotoSourceArg photo) throws MembersSetProfilePhotoErrorException, DbxException Updates a team member's profile photo.Permission : Team member management. - Parameters:
- user- Identity of the user whose profile photo will be set. Must not be- null.
- photo- Image to set as the member's new profile photo. Must not be- null.
- Returns:
- Information about a team member.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSetProfilePhotoErrorException
- DbxException
 
 - 
membersSuspendpublic void membersSuspend(UserSelectorArg user) throws MembersSuspendErrorException, DbxException Suspend a member from a team.Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. The wipeDatarequest parameter will default totrue(seemembersSuspend(UserSelectorArg,boolean)).- Parameters:
- user- Identity of user to remove/suspend/have their files moved. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSuspendErrorException
- DbxException
 
 - 
membersSuspendpublic void membersSuspend(UserSelectorArg user, boolean wipeData) throws MembersSuspendErrorException, DbxException Suspend a member from a team.Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. - Parameters:
- user- Identity of user to remove/suspend/have their files moved. Must not be- null.
- wipeData- If provided, controls if the user's data will be deleted on their linked devices.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersSuspendErrorException
- DbxException
 
 - 
membersUnsuspendpublic void membersUnsuspend(UserSelectorArg user) throws MembersUnsuspendErrorException, DbxException Unsuspend a member from a team.Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. - Parameters:
- user- Identity of user to unsuspend. Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- MembersUnsuspendErrorException
- DbxException
 
 - 
namespacesListpublic TeamNamespacesListResult namespacesList() throws TeamNamespacesListErrorException, DbxException Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.The limitrequest parameter will default to1000L(seenamespacesList(long)).- Returns:
- Result for namespacesList(long).
- Throws:
- TeamNamespacesListErrorException
- DbxException
 
 - 
namespacesListpublic TeamNamespacesListResult namespacesList(long limit) throws TeamNamespacesListErrorException, DbxException Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.- Parameters:
- limit- Specifying a value here has no effect. Must be greater than or equal to 1 and be less than or equal to 1000.
- Returns:
- Result for namespacesList(long).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamNamespacesListErrorException
- DbxException
 
 - 
namespacesListContinuepublic TeamNamespacesListResult namespacesListContinue(java.lang.String cursor) throws TeamNamespacesListContinueErrorException, DbxException Once a cursor has been retrieved fromnamespacesList(long), use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.- Parameters:
- cursor- Indicates from what point to get the next set of team-accessible namespaces. Must not be- null.
- Returns:
- Result for namespacesList(long).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamNamespacesListContinueErrorException
- DbxException
 
 - 
propertiesTemplateAdd@Deprecated public AddTemplateResult propertiesTemplateAdd(java.lang.String name, java.lang.String description, java.util.List<PropertyFieldTemplate> fields) throws ModifyTemplateErrorException, DbxException Deprecated.Permission : Team member file access.- Parameters:
- name- Display name for the template. Template names can be up to 256 bytes. Must not be- null.
- description- Description for the template. Template descriptions can be up to 1024 bytes. Must not be- null.
- fields- Definitions of the property fields associated with this template. There can be up to 32 properties in a single template. Must not contain a- nullitem and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- ModifyTemplateErrorException
- DbxException
 
 - 
propertiesTemplateGet@Deprecated public GetTemplateResult propertiesTemplateGet(java.lang.String templateId) throws TemplateErrorException, DbxException Deprecated.Permission : Team member file access. The scope for the route is files.team_metadata.write.- Parameters:
- templateId- An identifier for template added by route See- DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)or- DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "- (/|ptid:).*", and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TemplateErrorException
- DbxException
 
 - 
propertiesTemplateList@Deprecated public ListTemplateResult propertiesTemplateList() throws TemplateErrorException, DbxException Deprecated.Permission : Team member file access. The scope for the route is files.team_metadata.write.- Throws:
- TemplateErrorException
- DbxException
 
 - 
propertiesTemplateUpdate@Deprecated public UpdateTemplateResult propertiesTemplateUpdate(java.lang.String templateId) throws ModifyTemplateErrorException, DbxException Deprecated.Permission : Team member file access.- Parameters:
- templateId- An identifier for template added by See- DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)or- DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "- (/|ptid:).*", and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- ModifyTemplateErrorException
- DbxException
 
 - 
propertiesTemplateUpdateBuilder@Deprecated public PropertiesTemplateUpdateBuilder propertiesTemplateUpdateBuilder(java.lang.String templateId) Deprecated.Permission : Team member file access.- Parameters:
- templateId- An identifier for template added by See- DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)or- DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "- (/|ptid:).*", and not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
reportsGetActivity@Deprecated public GetActivityReport reportsGetActivity() throws DateRangeErrorException, DbxException Deprecated.Retrieves reporting data about a team's user activity. Deprecated: Will be removed on July 1st 2021.- Returns:
- Activity Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.
- Throws:
- DateRangeErrorException
- DbxException
 
 - 
reportsGetActivityBuilder@Deprecated public ReportsGetActivityBuilder reportsGetActivityBuilder() Deprecated.Retrieves reporting data about a team's user activity. Deprecated: Will be removed on July 1st 2021.- Returns:
- Request builder for configuring request parameters and completing the request.
 
 - 
reportsGetDevices@Deprecated public GetDevicesReport reportsGetDevices() throws DateRangeErrorException, DbxException Deprecated.Retrieves reporting data about a team's linked devices. Deprecated: Will be removed on July 1st 2021.- Returns:
- Devices Report Result. Contains subsections for different time ranges of activity. Each of the items in each subsection of the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.
- Throws:
- DateRangeErrorException
- DbxException
 
 - 
reportsGetDevicesBuilder@Deprecated public ReportsGetDevicesBuilder reportsGetDevicesBuilder() Deprecated.Retrieves reporting data about a team's linked devices. Deprecated: Will be removed on July 1st 2021.- Returns:
- Request builder for configuring request parameters and completing the request.
 
 - 
reportsGetMembership@Deprecated public GetMembershipReport reportsGetMembership() throws DateRangeErrorException, DbxException Deprecated.Retrieves reporting data about a team's membership. Deprecated: Will be removed on July 1st 2021.- Returns:
- Membership Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.
- Throws:
- DateRangeErrorException
- DbxException
 
 - 
reportsGetMembershipBuilder@Deprecated public ReportsGetMembershipBuilder reportsGetMembershipBuilder() Deprecated.Retrieves reporting data about a team's membership. Deprecated: Will be removed on July 1st 2021.- Returns:
- Request builder for configuring request parameters and completing the request.
 
 - 
reportsGetStorage@Deprecated public GetStorageReport reportsGetStorage() throws DateRangeErrorException, DbxException Deprecated.Retrieves reporting data about a team's storage usage. Deprecated: Will be removed on July 1st 2021.- Returns:
- Storage Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.
- Throws:
- DateRangeErrorException
- DbxException
 
 - 
reportsGetStorageBuilder@Deprecated public ReportsGetStorageBuilder reportsGetStorageBuilder() Deprecated.Retrieves reporting data about a team's storage usage. Deprecated: Will be removed on July 1st 2021.- Returns:
- Request builder for configuring request parameters and completing the request.
 
 - 
teamFolderActivatepublic TeamFolderMetadata teamFolderActivate(java.lang.String teamFolderId) throws TeamFolderActivateErrorException, DbxException Sets an archived team folder's status to active.Permission : Team member file access. - Parameters:
- teamFolderId- The ID of the team folder. Must match pattern "- [-_0-9a-zA-Z:]+" and not be- null.
- Returns:
- Properties of a team folder.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderActivateErrorException
- DbxException
 
 - 
teamFolderArchivepublic TeamFolderArchiveLaunch teamFolderArchive(java.lang.String teamFolderId) throws TeamFolderArchiveErrorException, DbxException Sets an active team folder's status to archived and removes all folder and file members. This endpoint cannot be used for teams that have a shared team space.Permission : Team member file access. The forceAsyncOffrequest parameter will default tofalse(seeteamFolderArchive(String,boolean)).- Parameters:
- teamFolderId- The ID of the team folder. Must match pattern "- [-_0-9a-zA-Z:]+" and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderArchiveErrorException
- DbxException
 
 - 
teamFolderArchivepublic TeamFolderArchiveLaunch teamFolderArchive(java.lang.String teamFolderId, boolean forceAsyncOff) throws TeamFolderArchiveErrorException, DbxException Sets an active team folder's status to archived and removes all folder and file members. This endpoint cannot be used for teams that have a shared team space.Permission : Team member file access. - Parameters:
- teamFolderId- The ID of the team folder. Must match pattern "- [-_0-9a-zA-Z:]+" and not be- null.
- forceAsyncOff- Whether to force the archive to happen synchronously.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderArchiveErrorException
- DbxException
 
 - 
teamFolderArchiveCheckpublic TeamFolderArchiveJobStatus teamFolderArchiveCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException Returns the status of an asynchronous job for archiving a team folder.Permission : Team member file access. - Parameters:
- asyncJobId- Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- PollErrorException
- DbxException
 
 - 
teamFolderCreatepublic TeamFolderMetadata teamFolderCreate(java.lang.String name) throws TeamFolderCreateErrorException, DbxException Creates a new, active, team folder with no members. This endpoint can only be used for teams that do not already have a shared team space.Permission : Team member file access. - Parameters:
- name- Name for the new team folder. Must not be- null.
- Returns:
- Properties of a team folder.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderCreateErrorException
- DbxException
 
 - 
teamFolderCreatepublic TeamFolderMetadata teamFolderCreate(java.lang.String name, SyncSettingArg syncSetting) throws TeamFolderCreateErrorException, DbxException Creates a new, active, team folder with no members. This endpoint can only be used for teams that do not already have a shared team space.Permission : Team member file access. - Parameters:
- name- Name for the new team folder. Must not be- null.
- syncSetting- The sync setting to apply to this team folder. Only permitted if the team has team selective sync enabled.
- Returns:
- Properties of a team folder.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderCreateErrorException
- DbxException
 
 - 
teamFolderGetInfopublic java.util.List<TeamFolderGetInfoItem> teamFolderGetInfo(java.util.List<java.lang.String> teamFolderIds) throws DbxApiException, DbxException Retrieves metadata for team folders.Permission : Team member file access. - Parameters:
- teamFolderIds- The list of team folder IDs. Must contain at least 1 items, not contain a- nullitem, and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- DbxApiException
- DbxException
 
 - 
teamFolderListpublic TeamFolderListResult teamFolderList() throws TeamFolderListErrorException, DbxException Lists all team folders.Permission : Team member file access. The limitrequest parameter will default to1000L(seeteamFolderList(long)).- Returns:
- Result for teamFolderList(long)andteamFolderListContinue(String).
- Throws:
- TeamFolderListErrorException
- DbxException
 
 - 
teamFolderListpublic TeamFolderListResult teamFolderList(long limit) throws TeamFolderListErrorException, DbxException Lists all team folders.Permission : Team member file access. - Parameters:
- limit- The maximum number of results to return per request. Must be greater than or equal to 1 and be less than or equal to 1000.
- Returns:
- Result for teamFolderList(long)andteamFolderListContinue(String).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderListErrorException
- DbxException
 
 - 
teamFolderListContinuepublic TeamFolderListResult teamFolderListContinue(java.lang.String cursor) throws TeamFolderListContinueErrorException, DbxException Once a cursor has been retrieved fromteamFolderList(long), use this to paginate through all team folders.Permission : Team member file access. - Parameters:
- cursor- Indicates from what point to get the next set of team folders. Must not be- null.
- Returns:
- Result for teamFolderList(long)andteamFolderListContinue(String).
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderListContinueErrorException
- DbxException
 
 - 
teamFolderPermanentlyDeletepublic void teamFolderPermanentlyDelete(java.lang.String teamFolderId) throws TeamFolderPermanentlyDeleteErrorException, DbxExceptionPermanently deletes an archived team folder. This endpoint cannot be used for teams that have a shared team space.Permission : Team member file access. - Parameters:
- teamFolderId- The ID of the team folder. Must match pattern "- [-_0-9a-zA-Z:]+" and not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderPermanentlyDeleteErrorException
- DbxException
 
 - 
teamFolderRenamepublic TeamFolderMetadata teamFolderRename(java.lang.String teamFolderId, java.lang.String name) throws TeamFolderRenameErrorException, DbxException Changes an active team folder's name.Permission : Team member file access. - Parameters:
- teamFolderId- The ID of the team folder. Must match pattern "- [-_0-9a-zA-Z:]+" and not be- null.
- name- New team folder name. Must not be- null.
- Returns:
- Properties of a team folder.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderRenameErrorException
- DbxException
 
 - 
teamFolderUpdateSyncSettingspublic TeamFolderMetadata teamFolderUpdateSyncSettings(java.lang.String teamFolderId) throws TeamFolderUpdateSyncSettingsErrorException, DbxException Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.- Parameters:
- teamFolderId- The ID of the team folder. Must match pattern "- [-_0-9a-zA-Z:]+" and not be- null.
- Returns:
- Properties of a team folder.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
- TeamFolderUpdateSyncSettingsErrorException
- DbxException
 
 - 
teamFolderUpdateSyncSettingsBuilderpublic TeamFolderUpdateSyncSettingsBuilder teamFolderUpdateSyncSettingsBuilder(java.lang.String teamFolderId) Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.- Parameters:
- teamFolderId- The ID of the team folder. Must match pattern "- [-_0-9a-zA-Z:]+" and not be- null.
- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
tokenGetAuthenticatedAdminpublic TokenGetAuthenticatedAdminResult tokenGetAuthenticatedAdmin() throws TokenGetAuthenticatedAdminErrorException, DbxException Returns the member profile of the admin who generated the team access token used to make the call.- Returns:
- Results for tokenGetAuthenticatedAdmin().
- Throws:
- TokenGetAuthenticatedAdminErrorException
- DbxException
 
 
- 
 
-