Class DbxTeamTeamRequests
- java.lang.Object
-
- com.dropbox.core.v2.team.DbxTeamTeamRequests
-
public class DbxTeamTeamRequests extends java.lang.Object
Routes in namespace "team".
-
-
Constructor Summary
Constructors Constructor Description DbxTeamTeamRequests(DbxRawClientV2 client)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ListMemberDevicesResult
devicesListMemberDevices(java.lang.String teamMemberId)
List all device sessions of a team's member.DevicesListMemberDevicesBuilder
devicesListMemberDevicesBuilder(java.lang.String teamMemberId)
List all device sessions of a team's member.ListMembersDevicesResult
devicesListMembersDevices()
List all device sessions of a team.DevicesListMembersDevicesBuilder
devicesListMembersDevicesBuilder()
List all device sessions of a team.ListTeamDevicesResult
devicesListTeamDevices()
Deprecated.usedevicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg)
instead.DevicesListTeamDevicesBuilder
devicesListTeamDevicesBuilder()
Deprecated.usedevicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg)
instead.void
devicesRevokeDeviceSession(RevokeDeviceSessionArg arg)
Revoke a device session of a team's member.RevokeDeviceSessionBatchResult
devicesRevokeDeviceSessionBatch(java.util.List<RevokeDeviceSessionArg> revokeDevices)
Revoke a list of device sessions of team members.FeaturesGetValuesBatchResult
featuresGetValues(java.util.List<Feature> features)
Get the values for one or more featues.TeamGetInfoResult
getInfo()
Retrieves information about a team.GroupFullInfo
groupsCreate(java.lang.String groupName)
Creates a new, empty group, with a requested name.GroupsCreateBuilder
groupsCreateBuilder(java.lang.String groupName)
Creates a new, empty group, with a requested name.LaunchEmptyResult
groupsDelete(GroupSelector arg)
Deletes a group.java.util.List<GroupsGetInfoItem>
groupsGetInfo(GroupsSelector arg)
Retrieves information about one or more groups.PollEmptyResult
groupsJobStatusGet(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.GroupsListResult
groupsList()
Lists groups on a team.GroupsListResult
groupsList(long limit)
Lists groups on a team.GroupsListResult
groupsListContinue(java.lang.String cursor)
Once a cursor has been retrieved fromgroupsList(long)
, use this to paginate through all groups.GroupMembersChangeResult
groupsMembersAdd(GroupSelector group, java.util.List<MemberAccess> members)
Adds members to a group.GroupMembersChangeResult
groupsMembersAdd(GroupSelector group, java.util.List<MemberAccess> members, boolean returnMembers)
Adds members to a group.GroupsMembersListResult
groupsMembersList(GroupSelector group)
Lists members of a group.GroupsMembersListResult
groupsMembersList(GroupSelector group, long limit)
Lists members of a group.GroupsMembersListResult
groupsMembersListContinue(java.lang.String cursor)
Once a cursor has been retrieved fromgroupsMembersList(GroupSelector,long)
, use this to paginate through all members of the group.GroupMembersChangeResult
groupsMembersRemove(GroupSelector group, java.util.List<UserSelectorArg> users)
Removes members from a group.GroupMembersChangeResult
groupsMembersRemove(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.GroupFullInfo
groupsUpdate(GroupSelector group)
Updates a group's name and/or external ID.GroupsUpdateBuilder
groupsUpdateBuilder(GroupSelector group)
Updates a group's name and/or external ID.LegalHoldPolicy
legalHoldsCreatePolicy(java.lang.String name, java.util.List<java.lang.String> members)
Creates new legal hold policy.LegalHoldsCreatePolicyBuilder
legalHoldsCreatePolicyBuilder(java.lang.String name, java.util.List<java.lang.String> members)
Creates new legal hold policy.LegalHoldPolicy
legalHoldsGetPolicy(java.lang.String id)
Gets a legal hold by Id.LegalHoldsListHeldRevisionResult
legalHoldsListHeldRevisions(java.lang.String id)
List the file metadata that's under the hold.LegalHoldsListHeldRevisionResult
legalHoldsListHeldRevisionsContinue(java.lang.String id)
Continue listing the file metadata that's under the hold.LegalHoldsListHeldRevisionResult
legalHoldsListHeldRevisionsContinue(java.lang.String id, java.lang.String cursor)
Continue listing the file metadata that's under the hold.LegalHoldsListPoliciesResult
legalHoldsListPolicies()
Lists legal holds on a team.LegalHoldsListPoliciesResult
legalHoldsListPolicies(boolean includeReleased)
Lists legal holds on a team.void
legalHoldsReleasePolicy(java.lang.String id)
Releases a legal hold by Id.LegalHoldPolicy
legalHoldsUpdatePolicy(java.lang.String id)
Updates a legal hold.LegalHoldsUpdatePolicyBuilder
legalHoldsUpdatePolicyBuilder(java.lang.String id)
Updates a legal hold.ListMemberAppsResult
linkedAppsListMemberLinkedApps(java.lang.String teamMemberId)
List all linked applications of the team member.ListMembersAppsResult
linkedAppsListMembersLinkedApps()
List all applications linked to the team members' accounts.ListMembersAppsResult
linkedAppsListMembersLinkedApps(java.lang.String cursor)
List all applications linked to the team members' accounts.ListTeamAppsResult
linkedAppsListTeamLinkedApps()
Deprecated.uselinkedAppsListMembersLinkedApps(String)
instead.ListTeamAppsResult
linkedAppsListTeamLinkedApps(java.lang.String cursor)
Deprecated.uselinkedAppsListMembersLinkedApps(String)
instead.void
linkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId)
Revoke a linked application of the team member.void
linkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId, boolean keepAppFolder)
Revoke a linked application of the team member.RevokeLinkedAppBatchResult
linkedAppsRevokeLinkedAppBatch(java.util.List<RevokeLinkedApiAppArg> revokeLinkedApp)
Revoke a list of linked applications of the team members.MembersAddLaunch
membersAdd(java.util.List<MemberAddArg> newMembers)
Adds members to a team.MembersAddLaunch
membersAdd(java.util.List<MemberAddArg> newMembers, boolean forceAsync)
Adds members to a team.MembersAddJobStatus
membersAddJobStatusGet(java.lang.String asyncJobId)
Once an async_job_id is returned frommembersAdd(List,boolean)
, use this to poll the status of the asynchronous request.MembersAddJobStatusV2Result
membersAddJobStatusGetV2(java.lang.String asyncJobId)
Once an async_job_id is returned frommembersAddV2(List,boolean)
, use this to poll the status of the asynchronous request.MembersAddLaunchV2Result
membersAddV2(java.util.List<MemberAddV2Arg> newMembers)
Adds members to a team.MembersAddLaunchV2Result
membersAddV2(java.util.List<MemberAddV2Arg> newMembers, boolean forceAsync)
Adds members to a team.TeamMemberInfo
membersDeleteProfilePhoto(UserSelectorArg user)
Deletes a team member's profile photo.TeamMemberInfoV2Result
membersDeleteProfilePhotoV2(UserSelectorArg user)
Deletes a team member's profile photo.MembersGetAvailableTeamMemberRolesResult
membersGetAvailableTeamMemberRoles()
Get available TeamMemberRoles for the connected team.java.util.List<MembersGetInfoItem>
membersGetInfo(java.util.List<UserSelectorArg> members)
Returns information about multiple team members.MembersGetInfoV2Result
membersGetInfoV2(java.util.List<UserSelectorArg> members)
Returns information about multiple team members.MembersListResult
membersList()
Lists members of a team.MembersListBuilder
membersListBuilder()
Lists members of a team.MembersListResult
membersListContinue(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.MembersListV2Result
membersListContinueV2(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.MembersListV2Result
membersListV2()
Lists members of a team.MembersListV2Builder
membersListV2Builder()
Lists members of a team.LaunchEmptyResult
membersMoveFormerMemberFiles(UserSelectorArg user, UserSelectorArg transferDestId, UserSelectorArg transferAdminId)
Moves removed member's files to a different member.PollEmptyResult
membersMoveFormerMemberFilesJobStatusCheck(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.ExcludedUsersUpdateResult
memberSpaceLimitsExcludedUsersAdd()
Add users to member space limits excluded users list.ExcludedUsersUpdateResult
memberSpaceLimitsExcludedUsersAdd(java.util.List<UserSelectorArg> users)
Add users to member space limits excluded users list.ExcludedUsersListResult
memberSpaceLimitsExcludedUsersList()
List member space limits excluded users.ExcludedUsersListResult
memberSpaceLimitsExcludedUsersList(long limit)
List member space limits excluded users.ExcludedUsersListResult
memberSpaceLimitsExcludedUsersListContinue(java.lang.String cursor)
Continue listing member space limits excluded users.ExcludedUsersUpdateResult
memberSpaceLimitsExcludedUsersRemove()
Remove users from member space limits excluded users list.ExcludedUsersUpdateResult
memberSpaceLimitsExcludedUsersRemove(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.void
membersRecover(UserSelectorArg user)
Recover a deleted member.LaunchEmptyResult
membersRemove(UserSelectorArg user)
Removes a member from a team.MembersRemoveBuilder
membersRemoveBuilder(UserSelectorArg user)
Removes a member from a team.PollEmptyResult
membersRemoveJobStatusGet(java.lang.String asyncJobId)
Once an async_job_id is returned frommembersRemove(UserSelectorArg)
, use this to poll the status of the asynchronous request.AddSecondaryEmailsResult
membersSecondaryEmailsAdd(java.util.List<UserSecondaryEmailsArg> newSecondaryEmails)
Add secondary emails to users.DeleteSecondaryEmailsResult
membersSecondaryEmailsDelete(java.util.List<UserSecondaryEmailsArg> emailsToDelete)
Delete secondary emails from usersResendVerificationEmailResult
membersSecondaryEmailsResendVerificationEmails(java.util.List<UserSecondaryEmailsArg> emailsToResend)
Resend secondary email verification emails.void
membersSendWelcomeEmail(UserSelectorArg arg)
Sends welcome email to pending team member.MembersSetPermissionsResult
membersSetAdminPermissions(UserSelectorArg user, AdminTier newRole)
Updates a team member's permissions.MembersSetPermissions2Result
membersSetAdminPermissionsV2(UserSelectorArg user)
Updates a team member's permissions.MembersSetPermissions2Result
membersSetAdminPermissionsV2(UserSelectorArg user, java.util.List<java.lang.String> newRoles)
Updates a team member's permissions.TeamMemberInfo
membersSetProfile(UserSelectorArg user)
Updates a team member's profile.MembersSetProfileBuilder
membersSetProfileBuilder(UserSelectorArg user)
Updates a team member's profile.TeamMemberInfo
membersSetProfilePhoto(UserSelectorArg user, PhotoSourceArg photo)
Updates a team member's profile photo.TeamMemberInfoV2Result
membersSetProfilePhotoV2(UserSelectorArg user, PhotoSourceArg photo)
Updates a team member's profile photo.TeamMemberInfoV2Result
membersSetProfileV2(UserSelectorArg user)
Updates a team member's profile.MembersSetProfileV2Builder
membersSetProfileV2Builder(UserSelectorArg user)
Updates a team member's profile.void
membersSuspend(UserSelectorArg user)
Suspend a member from a team.void
membersSuspend(UserSelectorArg user, boolean wipeData)
Suspend a member from a team.void
membersUnsuspend(UserSelectorArg user)
Unsuspend a member from a team.TeamNamespacesListResult
namespacesList()
Returns a list of all team-accessible namespaces.TeamNamespacesListResult
namespacesList(long limit)
Returns a list of all team-accessible namespaces.TeamNamespacesListResult
namespacesListContinue(java.lang.String cursor)
Once a cursor has been retrieved fromnamespacesList(long)
, use this to paginate through all team-accessible namespaces.AddTemplateResult
propertiesTemplateAdd(java.lang.String name, java.lang.String description, java.util.List<PropertyFieldTemplate> fields)
Deprecated.GetTemplateResult
propertiesTemplateGet(java.lang.String templateId)
Deprecated.ListTemplateResult
propertiesTemplateList()
Deprecated.UpdateTemplateResult
propertiesTemplateUpdate(java.lang.String templateId)
Deprecated.PropertiesTemplateUpdateBuilder
propertiesTemplateUpdateBuilder(java.lang.String templateId)
Deprecated.GetActivityReport
reportsGetActivity()
Deprecated.ReportsGetActivityBuilder
reportsGetActivityBuilder()
Deprecated.GetDevicesReport
reportsGetDevices()
Deprecated.ReportsGetDevicesBuilder
reportsGetDevicesBuilder()
Deprecated.GetMembershipReport
reportsGetMembership()
Deprecated.ReportsGetMembershipBuilder
reportsGetMembershipBuilder()
Deprecated.GetStorageReport
reportsGetStorage()
Deprecated.ReportsGetStorageBuilder
reportsGetStorageBuilder()
Deprecated.SharingAllowlistAddResponse
sharingAllowlistAdd()
Endpoint adds Approve List entries.SharingAllowlistAddBuilder
sharingAllowlistAddBuilder()
Endpoint adds Approve List entries.SharingAllowlistListResponse
sharingAllowlistList()
Lists Approve List entries for given team, from newest to oldest, returning up to `limit` entries at a time.SharingAllowlistListResponse
sharingAllowlistList(long limit)
Lists Approve List entries for given team, from newest to oldest, returning up to `limit` entries at a time.SharingAllowlistListResponse
sharingAllowlistListContinue(java.lang.String cursor)
Lists entries associated with given team, starting from a the cursor.SharingAllowlistRemoveResponse
sharingAllowlistRemove()
Endpoint removes Approve List entries.SharingAllowlistRemoveBuilder
sharingAllowlistRemoveBuilder()
Endpoint removes Approve List entries.TeamFolderMetadata
teamFolderActivate(java.lang.String teamFolderId)
Sets an archived team folder's status to active.TeamFolderArchiveLaunch
teamFolderArchive(java.lang.String teamFolderId)
Sets an active team folder's status to archived and removes all folder and file members.TeamFolderArchiveLaunch
teamFolderArchive(java.lang.String teamFolderId, boolean forceAsyncOff)
Sets an active team folder's status to archived and removes all folder and file members.TeamFolderArchiveJobStatus
teamFolderArchiveCheck(java.lang.String asyncJobId)
Returns the status of an asynchronous job for archiving a team folder.TeamFolderMetadata
teamFolderCreate(java.lang.String name)
Creates a new, active, team folder with no members.TeamFolderMetadata
teamFolderCreate(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.TeamFolderListResult
teamFolderList()
Lists all team folders.TeamFolderListResult
teamFolderList(long limit)
Lists all team folders.TeamFolderListResult
teamFolderListContinue(java.lang.String cursor)
Once a cursor has been retrieved fromteamFolderList(long)
, use this to paginate through all team folders.void
teamFolderPermanentlyDelete(java.lang.String teamFolderId)
Permanently deletes an archived team folder.TeamFolderMetadata
teamFolderRename(java.lang.String teamFolderId, java.lang.String name)
Changes an active team folder's name.TeamFolderMetadata
teamFolderUpdateSyncSettings(java.lang.String teamFolderId)
Updates the sync settings on a team folder or its contents.TeamFolderUpdateSyncSettingsBuilder
teamFolderUpdateSyncSettingsBuilder(java.lang.String teamFolderId)
Updates the sync settings on a team folder or its contents.TokenGetAuthenticatedAdminResult
tokenGetAuthenticatedAdmin()
Returns the member profile of the admin who generated the team access token used to make the call.
-
-
-
Constructor Detail
-
DbxTeamTeamRequests
public DbxTeamTeamRequests(DbxRawClientV2 client)
-
-
Method Detail
-
devicesListMemberDevices
public 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
DevicesListMemberDevicesBuilder
for more details.- Parameters:
teamMemberId
- The team's member id. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.ListMemberDevicesErrorException
DbxException
-
devicesListMemberDevicesBuilder
public DevicesListMemberDevicesBuilder devicesListMemberDevicesBuilder(java.lang.String teamMemberId)
List all device sessions of a team's member.- Parameters:
teamMemberId
- The team's member id. Must not benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
devicesListMembersDevices
public 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
DevicesListMembersDevicesBuilder
for more details.
-
devicesListMembersDevicesBuilder
public 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.usedevicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg)
instead.List all device sessions of a team.Permission : Team member file access.
The default values for the optional request parameters will be used. See
DevicesListTeamDevicesBuilder
for more details.
-
devicesListTeamDevicesBuilder
@Deprecated public DevicesListTeamDevicesBuilder devicesListTeamDevicesBuilder()
Deprecated.usedevicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg)
instead.List all device sessions of a team. Permission : Team member file access.- Returns:
- Request builder for configuring request parameters and completing the request.
-
devicesRevokeDeviceSession
public void devicesRevokeDeviceSession(RevokeDeviceSessionArg arg) throws RevokeDeviceSessionErrorException, DbxException
Revoke a device session of a team's member.
-
devicesRevokeDeviceSessionBatch
public RevokeDeviceSessionBatchResult devicesRevokeDeviceSessionBatch(java.util.List<RevokeDeviceSessionArg> revokeDevices) throws RevokeDeviceSessionBatchErrorException, DbxException
Revoke a list of device sessions of team members.- Parameters:
revokeDevices
- Must not contain anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.RevokeDeviceSessionBatchErrorException
DbxException
-
featuresGetValues
public 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 inFeature
. If the list is empty, this route will returnFeaturesGetValuesBatchError
. Must not contain anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.FeaturesGetValuesBatchErrorException
DbxException
-
getInfo
public TeamGetInfoResult getInfo() throws DbxApiException, DbxException
Retrieves information about a team.- Throws:
DbxApiException
DbxException
-
groupsCreate
public 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
GroupsCreateBuilder
for more details.- Parameters:
groupName
- Group name. Must not benull
.- Returns:
- Full description of a group.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.GroupCreateErrorException
DbxException
-
groupsCreateBuilder
public 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 benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
groupsDelete
public 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
-
groupsGetInfo
public 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
-
groupsJobStatusGet
public 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 benull
.- 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
-
groupsList
public GroupsListResult groupsList() throws DbxApiException, DbxException
Lists groups on a team.Permission : Team Information.
The
limit
request parameter will default to1000L
(seegroupsList(long)
).- Throws:
DbxApiException
DbxException
-
groupsList
public 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
-
groupsListContinue
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.GroupsListContinueErrorException
DbxException
-
groupsMembersAdd
public 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
returnMembers
request parameter will default totrue
(seegroupsMembersAdd(GroupSelector,List,boolean)
).- Parameters:
group
- Group to which users will be added. Must not benull
.members
- List of users to be added to the group. Must not contain anull
item and not benull
.- 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
-
groupsMembersAdd
public 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 benull
.members
- List of users to be added to the group. Must not contain anull
item and not benull
.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
-
groupsMembersList
public GroupsMembersListResult groupsMembersList(GroupSelector group) throws GroupSelectorErrorException, DbxException
Lists members of a group.Permission : Team Information.
The
limit
request parameter will default to1000L
(seegroupsMembersList(GroupSelector,long)
).- Parameters:
group
- The group whose members are to be listed. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.GroupSelectorErrorException
DbxException
-
groupsMembersList
public 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 benull
.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
-
groupsMembersListContinue
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.GroupsMembersListContinueErrorException
DbxException
-
groupsMembersRemove
public 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
returnMembers
request parameter will default totrue
(seegroupsMembersRemove(GroupSelector,List,boolean)
).- Parameters:
group
- Group from which users will be removed. Must not benull
.users
- List of users to be removed from the group. Must not contain anull
item and not benull
.- 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
-
groupsMembersRemove
public 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 benull
.users
- List of users to be removed from the group. Must not contain anull
item and not benull
.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
-
groupsMembersSetAccessType
public 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
returnMembers
request parameter will default totrue
(seegroupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean)
).- Parameters:
group
- Specify a group. Must not benull
.user
- Identity of a user that is a member of thegroup
argument togroupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean)
. Must not benull
.accessType
- New group access type the user will have. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.GroupMemberSetAccessTypeErrorException
DbxException
-
groupsMembersSetAccessType
public 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 benull
.user
- Identity of a user that is a member of thegroup
argument togroupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean)
. Must not benull
.accessType
- New group access type the user will have. Must not benull
.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
-
groupsUpdate
public 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
GroupsUpdateBuilder
for more details.- Parameters:
group
- Specify a group. Must not benull
.- Returns:
- Full description of a group.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.GroupUpdateErrorException
DbxException
-
groupsUpdateBuilder
public GroupsUpdateBuilder groupsUpdateBuilder(GroupSelector group)
Updates a group's name and/or external ID. Permission : Team member management.- Parameters:
group
- Specify a group. Must not benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
legalHoldsCreatePolicy
public 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 benull
.members
- List of team member IDs added to the hold. Must not contain anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.LegalHoldsPolicyCreateErrorException
DbxException
-
legalHoldsCreatePolicyBuilder
public 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 benull
.members
- List of team member IDs added to the hold. Must not contain anull
item and not benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
legalHoldsGetPolicy
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.LegalHoldsGetPolicyErrorException
DbxException
-
legalHoldsListHeldRevisions
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.LegalHoldsListHeldRevisionsErrorException
DbxException
-
legalHoldsListHeldRevisionsContinue
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.LegalHoldsListHeldRevisionsErrorException
DbxException
-
legalHoldsListHeldRevisionsContinue
public 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 benull
.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
-
legalHoldsListPolicies
public 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
includeReleased
request parameter will default tofalse
(seelegalHoldsListPolicies(boolean)
).
-
legalHoldsListPolicies
public 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
-
legalHoldsReleasePolicy
public void legalHoldsReleasePolicy(java.lang.String id) throws LegalHoldsPolicyReleaseErrorException, DbxException
Releases 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.LegalHoldsPolicyReleaseErrorException
DbxException
-
legalHoldsUpdatePolicy
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.LegalHoldsPolicyUpdateErrorException
DbxException
-
legalHoldsUpdatePolicyBuilder
public 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 benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
linkedAppsListMemberLinkedApps
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.ListMemberAppsErrorException
DbxException
-
linkedAppsListMembersLinkedApps
public 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
-
linkedAppsListMembersLinkedApps
public 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 thelinkedAppsListMembersLinkedApps(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 thelinkedAppsListTeamLinkedApps(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
-
linkedAppsRevokeLinkedApp
public void linkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId) throws RevokeLinkedAppErrorException, DbxException
Revoke a linked application of the team member.The
keepAppFolder
request parameter will default totrue
(seelinkedAppsRevokeLinkedApp(String,String,boolean)
).- Parameters:
appId
- The application's unique id. Must not benull
.teamMemberId
- The unique id of the member owning the device. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.RevokeLinkedAppErrorException
DbxException
-
linkedAppsRevokeLinkedApp
public void linkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId, boolean keepAppFolder) throws RevokeLinkedAppErrorException, DbxException
Revoke a linked application of the team member.- Parameters:
appId
- The application's unique id. Must not benull
.teamMemberId
- The unique id of the member owning the device. Must not benull
.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
-
linkedAppsRevokeLinkedAppBatch
public 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 anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.RevokeLinkedAppBatchErrorException
DbxException
-
memberSpaceLimitsExcludedUsersAdd
public ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersAdd() throws ExcludedUsersUpdateErrorException, DbxException
Add users to member space limits excluded users list.- Returns:
- Excluded users update result.
- Throws:
ExcludedUsersUpdateErrorException
DbxException
-
memberSpaceLimitsExcludedUsersAdd
public 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 anull
item.- Returns:
- Excluded users update result.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.ExcludedUsersUpdateErrorException
DbxException
-
memberSpaceLimitsExcludedUsersList
public ExcludedUsersListResult memberSpaceLimitsExcludedUsersList() throws ExcludedUsersListErrorException, DbxException
List member space limits excluded users.The
limit
request parameter will default to1000L
(seememberSpaceLimitsExcludedUsersList(long)
).- Returns:
- Excluded users list result.
- Throws:
ExcludedUsersListErrorException
DbxException
-
memberSpaceLimitsExcludedUsersList
public 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
-
memberSpaceLimitsExcludedUsersListContinue
public 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 benull
.- Returns:
- Excluded users list result.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.ExcludedUsersListContinueErrorException
DbxException
-
memberSpaceLimitsExcludedUsersRemove
public ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersRemove() throws ExcludedUsersUpdateErrorException, DbxException
Remove users from member space limits excluded users list.- Returns:
- Excluded users update result.
- Throws:
ExcludedUsersUpdateErrorException
DbxException
-
memberSpaceLimitsExcludedUsersRemove
public 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 anull
item.- Returns:
- Excluded users update result.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.ExcludedUsersUpdateErrorException
DbxException
-
memberSpaceLimitsGetCustomQuota
public java.util.List<CustomQuotaResult> memberSpaceLimitsGetCustomQuota(java.util.List<UserSelectorArg> users) throws CustomQuotaErrorException, DbxException
Get users custom quota. A maximum of 1000 members can be specified in a single call. Note: to apply a custom space limit, a team admin needs to set a member space limit for the team first. (the team admin can check the settings here: https://www.dropbox.com/team/admin/settings/space).- Parameters:
users
- List of users. Must not contain anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.CustomQuotaErrorException
DbxException
-
memberSpaceLimitsRemoveCustomQuota
public 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. Note: to apply a custom space limit, a team admin needs to set a member space limit for the team first. (the team admin can check the settings here: https://www.dropbox.com/team/admin/settings/space).- Parameters:
users
- List of users. Must not contain anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.CustomQuotaErrorException
DbxException
-
memberSpaceLimitsSetCustomQuota
public 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. Note: to apply a custom space limit, a team admin needs to set a member space limit for the team first. (the team admin can check the settings here: https://www.dropbox.com/team/admin/settings/space).- Parameters:
usersAndQuotas
- List of users and their custom quotas. Must not contain anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.SetCustomQuotaErrorException
DbxException
-
membersAddV2
public 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
forceAsync
request parameter will default tofalse
(seemembersAddV2(List,boolean)
).- Parameters:
newMembers
- Details of new members to be added to the team. Must not contain anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.DbxApiException
DbxException
-
membersAddV2
public 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 anull
item and not benull
.forceAsync
- Whether to force the add to happen asynchronously.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.DbxApiException
DbxException
-
membersAdd
public 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
forceAsync
request parameter will default tofalse
(seemembersAdd(List,boolean)
).- Parameters:
newMembers
- Details of new members to be added to the team. Must not contain anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.DbxApiException
DbxException
-
membersAdd
public 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 anull
item and not benull
.forceAsync
- Whether to force the add to happen asynchronously.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.DbxApiException
DbxException
-
membersAddJobStatusGetV2
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.PollErrorException
DbxException
-
membersAddJobStatusGet
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.PollErrorException
DbxException
-
membersDeleteProfilePhotoV2
public 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 benull
.- 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
-
membersDeleteProfilePhoto
public 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 benull
.- Returns:
- Information about a team member.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersDeleteProfilePhotoErrorException
DbxException
-
membersGetAvailableTeamMemberRoles
public 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
-
membersGetInfoV2
public 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 anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersGetInfoErrorException
DbxException
-
membersGetInfo
public 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 anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersGetInfoErrorException
DbxException
-
membersListV2
public 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
MembersListV2Builder
for more details.
-
membersListV2Builder
public MembersListV2Builder membersListV2Builder()
Lists members of a team. Permission : Team information.- Returns:
- Request builder for configuring request parameters and completing the request.
-
membersList
public 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
MembersListBuilder
for more details.
-
membersListBuilder
public MembersListBuilder membersListBuilder()
Lists members of a team. Permission : Team information.- Returns:
- Request builder for configuring request parameters and completing the request.
-
membersListContinueV2
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersListContinueErrorException
DbxException
-
membersListContinue
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersListContinueErrorException
DbxException
-
membersMoveFormerMemberFiles
public 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 benull
.transferDestId
- Files from the deleted member account will be transferred to this user. Must not benull
.transferAdminId
- Errors during the transfer process will be sent via email to this user. Must not benull
.- 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
-
membersMoveFormerMemberFilesJobStatusCheck
public 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 benull
.- 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
-
membersRecover
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersRecoverErrorException
DbxException
-
membersRemove
public 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
MembersRemoveBuilder
for more details.- Parameters:
user
- Identity of user to remove/suspend/have their files moved. Must not benull
.- 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
-
membersRemoveBuilder
public 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 benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
membersRemoveJobStatusGet
public 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 benull
.- 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
-
membersSecondaryEmailsAdd
public 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 anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.AddSecondaryEmailsErrorException
DbxException
-
membersSecondaryEmailsDelete
public 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 anull
item and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.DbxApiException
DbxException
-
membersSecondaryEmailsResendVerificationEmails
public 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 anull
item and not benull
.- Returns:
- List of users and resend results.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.DbxApiException
DbxException
-
membersSendWelcomeEmail
public 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
-
membersSetAdminPermissionsV2
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersSetPermissions2ErrorException
DbxException
-
membersSetAdminPermissionsV2
public 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 benull
.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 anull
item.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersSetPermissions2ErrorException
DbxException
-
membersSetAdminPermissions
public 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 benull
.newRole
- The new role of the member. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersSetPermissionsErrorException
DbxException
-
membersSetProfileV2
public 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 benull
.- 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
-
membersSetProfileV2Builder
public 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 benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
membersSetProfile
public 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 benull
.- Returns:
- Information about a team member.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersSetProfileErrorException
DbxException
-
membersSetProfileBuilder
public 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 benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
membersSetProfilePhotoV2
public 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 benull
.photo
- Image to set as the member's new profile photo. Must not benull
.- 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
-
membersSetProfilePhoto
public 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 benull
.photo
- Image to set as the member's new profile photo. Must not benull
.- Returns:
- Information about a team member.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersSetProfilePhotoErrorException
DbxException
-
membersSuspend
public 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
wipeData
request parameter will default totrue
(seemembersSuspend(UserSelectorArg,boolean)
).- Parameters:
user
- Identity of user to remove/suspend/have their files moved. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersSuspendErrorException
DbxException
-
membersSuspend
public 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 benull
.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
-
membersUnsuspend
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.MembersUnsuspendErrorException
DbxException
-
namespacesList
public 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
limit
request parameter will default to1000L
(seenamespacesList(long)
).- Returns:
- Result for
namespacesList(long)
. - Throws:
TeamNamespacesListErrorException
DbxException
-
namespacesList
public 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
-
namespacesListContinue
public 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 benull
.- 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 benull
.description
- Description for the template. Template descriptions can be up to 1024 bytes. Must not benull
.fields
- Definitions of the property fields associated with this template. There can be up to 32 properties in a single template. Must not contain anull
item and not benull
.- 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 SeeDbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)
orDbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List)
. Must have length of at least 1, match pattern "(/|ptid:).*
", and not benull
.- 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 SeeDbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)
orDbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List)
. Must have length of at least 1, match pattern "(/|ptid:).*
", and not benull
.- 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 SeeDbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)
orDbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List)
. Must have length of at least 1, match pattern "(/|ptid:).*
", and not benull
.- 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.
-
sharingAllowlistAdd
public SharingAllowlistAddResponse sharingAllowlistAdd() throws SharingAllowlistAddErrorException, DbxException
Endpoint adds Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Added entries cannot overflow limit of 10000 entries per team. Maximum 100 entries per call is allowed.- Returns:
- This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone.
- Throws:
SharingAllowlistAddErrorException
DbxException
-
sharingAllowlistAddBuilder
public SharingAllowlistAddBuilder sharingAllowlistAddBuilder()
Endpoint adds Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Added entries cannot overflow limit of 10000 entries per team. Maximum 100 entries per call is allowed.- Returns:
- Request builder for configuring request parameters and completing the request.
-
sharingAllowlistList
public SharingAllowlistListResponse sharingAllowlistList() throws SharingAllowlistListErrorException, DbxException
Lists Approve List entries for given team, from newest to oldest, returning up to `limit` entries at a time. If there are more than `limit` entries associated with the current team, more can be fetched by passing the returned `cursor` tosharingAllowlistListContinue(String)
.The
limit
request parameter will default to1000L
(seesharingAllowlistList(long)
).
-
sharingAllowlistList
public SharingAllowlistListResponse sharingAllowlistList(long limit) throws SharingAllowlistListErrorException, DbxException
Lists Approve List entries for given team, from newest to oldest, returning up to `limit` entries at a time. If there are more than `limit` entries associated with the current team, more can be fetched by passing the returned `cursor` tosharingAllowlistListContinue(String)
.- Parameters:
limit
- The number of entries to fetch at one time. 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.SharingAllowlistListErrorException
DbxException
-
sharingAllowlistListContinue
public SharingAllowlistListResponse sharingAllowlistListContinue(java.lang.String cursor) throws SharingAllowlistListContinueErrorException, DbxException
Lists entries associated with given team, starting from a the cursor. SeesharingAllowlistList(long)
.- Parameters:
cursor
- The cursor returned from a previous call tosharingAllowlistList(long)
orsharingAllowlistListContinue(String)
. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.SharingAllowlistListContinueErrorException
DbxException
-
sharingAllowlistRemove
public SharingAllowlistRemoveResponse sharingAllowlistRemove() throws SharingAllowlistRemoveErrorException, DbxException
Endpoint removes Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Entries being removed have to be present on the list. Maximum 1000 entries per call is allowed.- Returns:
- This struct is empty. The comment here is intentionally emitted to avoid indentation issues with Stone.
- Throws:
SharingAllowlistRemoveErrorException
DbxException
-
sharingAllowlistRemoveBuilder
public SharingAllowlistRemoveBuilder sharingAllowlistRemoveBuilder()
Endpoint removes Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Entries being removed have to be present on the list. Maximum 1000 entries per call is allowed.- Returns:
- Request builder for configuring request parameters and completing the request.
-
teamFolderActivate
public 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 benull
.- Returns:
- Properties of a team folder.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.TeamFolderActivateErrorException
DbxException
-
teamFolderArchive
public 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
forceAsyncOff
request parameter will default tofalse
(seeteamFolderArchive(String,boolean)
).- Parameters:
teamFolderId
- The ID of the team folder. Must match pattern "[-_0-9a-zA-Z:]+
" and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.TeamFolderArchiveErrorException
DbxException
-
teamFolderArchive
public 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 benull
.forceAsyncOff
- Whether to force the archive to happen synchronously.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.TeamFolderArchiveErrorException
DbxException
-
teamFolderArchiveCheck
public 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.PollErrorException
DbxException
-
teamFolderCreate
public 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 benull
.- Returns:
- Properties of a team folder.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.TeamFolderCreateErrorException
DbxException
-
teamFolderCreate
public 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 benull
.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
-
teamFolderGetInfo
public 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 anull
item, and not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.DbxApiException
DbxException
-
teamFolderList
public TeamFolderListResult teamFolderList() throws TeamFolderListErrorException, DbxException
Lists all team folders.Permission : Team member file access.
The
limit
request parameter will default to1000L
(seeteamFolderList(long)
).- Returns:
- Result for
teamFolderList(long)
andteamFolderListContinue(String)
. - Throws:
TeamFolderListErrorException
DbxException
-
teamFolderList
public 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
-
teamFolderListContinue
public 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 benull
.- Returns:
- Result for
teamFolderList(long)
andteamFolderListContinue(String)
. - Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.TeamFolderListContinueErrorException
DbxException
-
teamFolderPermanentlyDelete
public void teamFolderPermanentlyDelete(java.lang.String teamFolderId) throws TeamFolderPermanentlyDeleteErrorException, DbxException
Permanently 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 benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.TeamFolderPermanentlyDeleteErrorException
DbxException
-
teamFolderRename
public 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 benull
.name
- New team folder name. Must not benull
.- Returns:
- Properties of a team folder.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.TeamFolderRenameErrorException
DbxException
-
teamFolderUpdateSyncSettings
public 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 benull
.- Returns:
- Properties of a team folder.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.TeamFolderUpdateSyncSettingsErrorException
DbxException
-
teamFolderUpdateSyncSettingsBuilder
public 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 benull
.- Returns:
- Request builder for configuring request parameters and completing the request.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
tokenGetAuthenticatedAdmin
public 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
-
-