public class DbxTeamTeamRequests
extends java.lang.Object
Constructor and Description |
---|
DbxTeamTeamRequests(DbxRawClientV2 client) |
Modifier and Type | Method and 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.
|
DevicesListTeamDevicesBuilder |
devicesListTeamDevicesBuilder()
Deprecated.
|
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 from
groupsDelete(com.dropbox.core.v2.team.GroupSelector) , groupsMembersAdd(GroupSelector,List,boolean) , or
groupsMembersRemove(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 from
groupsList(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 from
groupsMembersList(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.
use
linkedAppsListMembersLinkedApps(String) instead. |
ListTeamAppsResult |
linkedAppsListTeamLinkedApps(java.lang.String cursor)
Deprecated.
use
linkedAppsListMembersLinkedApps(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 from
membersAdd(List,boolean) , use this to poll the
status of the asynchronous request. |
TeamMemberInfo |
membersDeleteProfilePhoto(UserSelectorArg user)
Deletes a team member's profile photo.
|
java.util.List<MembersGetInfoItem> |
membersGetInfo(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 from
membersList(com.dropbox.core.v2.team.MembersListArg) , use this to paginate through all team
members. |
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 from
membersMoveFormerMemberFiles(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 from
membersRemove(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 users
|
ResendVerificationEmailResult |
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.
|
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.
|
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 from
namespacesList(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()
Retrieves reporting data about a team's user activity.
|
ReportsGetActivityBuilder |
reportsGetActivityBuilder()
Retrieves reporting data about a team's user activity.
|
GetDevicesReport |
reportsGetDevices()
Retrieves reporting data about a team's linked devices.
|
ReportsGetDevicesBuilder |
reportsGetDevicesBuilder()
Retrieves reporting data about a team's linked devices.
|
GetMembershipReport |
reportsGetMembership()
Retrieves reporting data about a team's membership.
|
ReportsGetMembershipBuilder |
reportsGetMembershipBuilder()
Retrieves reporting data about a team's membership.
|
GetStorageReport |
reportsGetStorage()
Retrieves reporting data about a team's storage usage.
|
ReportsGetStorageBuilder |
reportsGetStorageBuilder()
Retrieves reporting data about a team's storage usage.
|
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 from
teamFolderList(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.
|
public DbxTeamTeamRequests(DbxRawClientV2 client)
public ListMemberDevicesResult devicesListMemberDevices(java.lang.String teamMemberId) throws ListMemberDevicesErrorException, DbxException
The default values for the optional request parameters will be used.
See DevicesListMemberDevicesBuilder
for more details.
teamMemberId
- The team's member id. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.ListMemberDevicesErrorException
DbxException
public DevicesListMemberDevicesBuilder devicesListMemberDevicesBuilder(java.lang.String teamMemberId)
teamMemberId
- The team's member id. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public ListMembersDevicesResult devicesListMembersDevices() throws ListMembersDevicesErrorException, DbxException
Permission : Team member file access.
The default values for the optional request parameters will be used.
See DevicesListMembersDevicesBuilder
for more details.
public DevicesListMembersDevicesBuilder devicesListMembersDevicesBuilder()
@Deprecated public ListTeamDevicesResult devicesListTeamDevices() throws ListTeamDevicesErrorException, DbxException
devicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg)
instead.Permission : Team member file access.
The default values for the optional request parameters will be used.
See DevicesListTeamDevicesBuilder
for more details.
@Deprecated public DevicesListTeamDevicesBuilder devicesListTeamDevicesBuilder()
devicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg)
instead.public void devicesRevokeDeviceSession(RevokeDeviceSessionArg arg) throws RevokeDeviceSessionErrorException, DbxException
public RevokeDeviceSessionBatchResult devicesRevokeDeviceSessionBatch(java.util.List<RevokeDeviceSessionArg> revokeDevices) throws RevokeDeviceSessionBatchErrorException, DbxException
revokeDevices
- Must not contain a null
item and not be
null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.RevokeDeviceSessionBatchErrorException
DbxException
public FeaturesGetValuesBatchResult featuresGetValues(java.util.List<Feature> features) throws FeaturesGetValuesBatchErrorException, DbxException
Permission : Team information.
features
- A list of features in Feature
. If the list is
empty, this route will return FeaturesGetValuesBatchError
.
Must not contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.FeaturesGetValuesBatchErrorException
DbxException
public TeamGetInfoResult getInfo() throws DbxApiException, DbxException
DbxApiException
DbxException
public GroupFullInfo groupsCreate(java.lang.String groupName) throws GroupCreateErrorException, DbxException
Permission : Team member management.
The default values for the optional request parameters will be used.
See GroupsCreateBuilder
for more details.
groupName
- Group name. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupCreateErrorException
DbxException
public GroupsCreateBuilder groupsCreateBuilder(java.lang.String groupName)
groupName
- Group name. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public LaunchEmptyResult groupsDelete(GroupSelector arg) throws GroupDeleteErrorException, DbxException
groupsJobStatusGet(String)
to determine whether this
process has completed. Permission : Team member management.arg
- Argument for selecting a single group, either by group_id or
by external group ID.GroupDeleteErrorException
DbxException
public java.util.List<GroupsGetInfoItem> groupsGetInfo(GroupsSelector arg) throws GroupsGetInfoErrorException, DbxException
GroupFullInfo.getMembers()
is not returned for
system-managed groups. Permission : Team Information.arg
- Argument for selecting a list of groups, either by group_ids,
or external group IDs.GroupsGetInfoErrorException
DbxException
public PollEmptyResult groupsJobStatusGet(java.lang.String asyncJobId) throws GroupsPollErrorException, DbxException
groupsDelete(com.dropbox.core.v2.team.GroupSelector)
, groupsMembersAdd(GroupSelector,List,boolean)
, or
groupsMembersRemove(GroupSelector,List,boolean)
use
this method to poll the status of granting/revoking group members' access
to group-owned resources.
Permission : Team member management.
asyncJobId
- Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupsPollErrorException
DbxException
public GroupsListResult groupsList() throws DbxApiException, DbxException
Permission : Team Information.
The limit
request parameter will default to 1000L
(see groupsList(long)
).
DbxApiException
DbxException
public GroupsListResult groupsList(long limit) throws DbxApiException, DbxException
Permission : Team Information.
limit
- Number of results to return per call. Must be greater than
or equal to 1 and be less than or equal to 1000.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.DbxApiException
DbxException
public GroupsListResult groupsListContinue(java.lang.String cursor) throws GroupsListContinueErrorException, DbxException
groupsList(long)
, use this to paginate through all
groups.
Permission : Team Information.
cursor
- Indicates from what point to get the next set of groups.
Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupsListContinueErrorException
DbxException
public GroupMembersChangeResult groupsMembersAdd(GroupSelector group, java.util.List<MemberAccess> members) throws GroupMembersAddErrorException, DbxException
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 to true
(see groupsMembersAdd(GroupSelector,List,boolean)
).
group
- Group to which users will be added. Must not be null
.members
- List of users to be added to the group. Must not contain
a null
item and not be null
.groupsMembersAdd(GroupSelector,List,boolean)
and
groupsMembersRemove(GroupSelector,List,boolean)
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupMembersAddErrorException
DbxException
public GroupMembersChangeResult groupsMembersAdd(GroupSelector group, java.util.List<MemberAccess> members, boolean returnMembers) throws GroupMembersAddErrorException, DbxException
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.
group
- Group to which users will be added. Must not be null
.members
- List of users to be added to the group. Must not contain
a null
item and not be null
.returnMembers
- Whether to return the list of members in the group.
Note that the default value will cause all the group members to be
returned in the response. This may take a long time for large groups.groupsMembersAdd(GroupSelector,List,boolean)
and
groupsMembersRemove(GroupSelector,List,boolean)
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupMembersAddErrorException
DbxException
public GroupsMembersListResult groupsMembersList(GroupSelector group) throws GroupSelectorErrorException, DbxException
Permission : Team Information.
The limit
request parameter will default to 1000L
(see groupsMembersList(GroupSelector,long)
).
group
- The group whose members are to be listed. Must not be
null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupSelectorErrorException
DbxException
public GroupsMembersListResult groupsMembersList(GroupSelector group, long limit) throws GroupSelectorErrorException, DbxException
Permission : Team Information.
group
- The group whose members are to be listed. Must not be
null
.limit
- Number of results to return per call. Must be greater than
or equal to 1 and be less than or equal to 1000.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupSelectorErrorException
DbxException
public GroupsMembersListResult groupsMembersListContinue(java.lang.String cursor) throws GroupsMembersListContinueErrorException, DbxException
groupsMembersList(GroupSelector,long)
, use this to
paginate through all members of the group.
Permission : Team information.
cursor
- Indicates from what point to get the next set of groups.
Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupsMembersListContinueErrorException
DbxException
public GroupMembersChangeResult groupsMembersRemove(GroupSelector group, java.util.List<UserSelectorArg> users) throws GroupMembersRemoveErrorException, DbxException
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 to true
(see groupsMembersRemove(GroupSelector,List,boolean)
).
group
- Group from which users will be removed. Must not be null
.users
- List of users to be removed from the group. Must not
contain a null
item and not be null
.groupsMembersAdd(GroupSelector,List,boolean)
and
groupsMembersRemove(GroupSelector,List,boolean)
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupMembersRemoveErrorException
DbxException
public GroupMembersChangeResult groupsMembersRemove(GroupSelector group, java.util.List<UserSelectorArg> users, boolean returnMembers) throws GroupMembersRemoveErrorException, DbxException
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.
group
- Group from which users will be removed. Must not be null
.users
- List of users to be removed from the group. Must not
contain a null
item and not be null
.returnMembers
- Whether to return the list of members in the group.
Note that the default value will cause all the group members to be
returned in the response. This may take a long time for large groups.groupsMembersAdd(GroupSelector,List,boolean)
and
groupsMembersRemove(GroupSelector,List,boolean)
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupMembersRemoveErrorException
DbxException
public java.util.List<GroupsGetInfoItem> groupsMembersSetAccessType(GroupSelector group, UserSelectorArg user, GroupAccessType accessType) throws GroupMemberSetAccessTypeErrorException, DbxException
Permission : Team member management.
The returnMembers
request parameter will default to true
(see groupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean)
).
group
- Specify a group. Must not be null
.user
- Identity of a user that is a member of the group
argument to groupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean)
.
Must not be null
.accessType
- New group access type the user will have. Must not be
null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupMemberSetAccessTypeErrorException
DbxException
public java.util.List<GroupsGetInfoItem> groupsMembersSetAccessType(GroupSelector group, UserSelectorArg user, GroupAccessType accessType, boolean returnMembers) throws GroupMemberSetAccessTypeErrorException, DbxException
Permission : Team member management.
group
- Specify a group. Must not be null
.user
- Identity of a user that is a member of the group
argument to groupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean)
.
Must not be null
.accessType
- New group access type the user will have. Must not be
null
.returnMembers
- Whether to return the list of members in the group.
Note that the default value will cause all the group members to be
returned in the response. This may take a long time for large groups.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupMemberSetAccessTypeErrorException
DbxException
public GroupFullInfo groupsUpdate(GroupSelector group) throws GroupUpdateErrorException, DbxException
Permission : Team member management.
The default values for the optional request parameters will be used.
See GroupsUpdateBuilder
for more details.
group
- Specify a group. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.GroupUpdateErrorException
DbxException
public GroupsUpdateBuilder groupsUpdateBuilder(GroupSelector group)
group
- Specify a group. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public LegalHoldPolicy legalHoldsCreatePolicy(java.lang.String name, java.util.List<java.lang.String> members) throws LegalHoldsPolicyCreateErrorException, DbxException
Permission : Team member file access.
name
- Policy name. Must have length of at most 140 and not be
null
.members
- List of team member IDs added to the hold. Must not
contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.LegalHoldsPolicyCreateErrorException
DbxException
public LegalHoldsCreatePolicyBuilder legalHoldsCreatePolicyBuilder(java.lang.String name, java.util.List<java.lang.String> members)
name
- Policy name. Must have length of at most 140 and not be
null
.members
- List of team member IDs added to the hold. Must not
contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public LegalHoldPolicy legalHoldsGetPolicy(java.lang.String id) throws LegalHoldsGetPolicyErrorException, DbxException
Permission : Team member file access.
id
- The legal hold Id. Must match pattern "^pid_dbhid:.+
"
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.LegalHoldsGetPolicyErrorException
DbxException
public LegalHoldsListHeldRevisionResult legalHoldsListHeldRevisions(java.lang.String id) throws LegalHoldsListHeldRevisionsErrorException, DbxException
Permission : Team member file access.
id
- The legal hold Id. Must match pattern "^pid_dbhid:.+
"
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.LegalHoldsListHeldRevisionsErrorException
DbxException
public LegalHoldsListHeldRevisionResult legalHoldsListHeldRevisionsContinue(java.lang.String id) throws LegalHoldsListHeldRevisionsErrorException, DbxException
Permission : Team member file access.
id
- The legal hold Id. Must match pattern "^pid_dbhid:.+
"
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.LegalHoldsListHeldRevisionsErrorException
DbxException
public LegalHoldsListHeldRevisionResult legalHoldsListHeldRevisionsContinue(java.lang.String id, java.lang.String cursor) throws LegalHoldsListHeldRevisionsErrorException, DbxException
Permission : Team member file access.
id
- The legal hold Id. Must match pattern "^pid_dbhid:.+
"
and not be null
.cursor
- The cursor idicates where to continue reading file
metadata entries for the next API call. When there are no more
entries, the cursor will return none. Must have length of at least 1.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.LegalHoldsListHeldRevisionsErrorException
DbxException
public LegalHoldsListPoliciesResult legalHoldsListPolicies() throws LegalHoldsListPoliciesErrorException, DbxException
Permission : Team member file access.
The includeReleased
request parameter will default to false
(see legalHoldsListPolicies(boolean)
).
public LegalHoldsListPoliciesResult legalHoldsListPolicies(boolean includeReleased) throws LegalHoldsListPoliciesErrorException, DbxException
Permission : Team member file access.
includeReleased
- Whether to return holds that were released.LegalHoldsListPoliciesErrorException
DbxException
public void legalHoldsReleasePolicy(java.lang.String id) throws LegalHoldsPolicyReleaseErrorException, DbxException
Permission : Team member file access.
id
- The legal hold Id. Must match pattern "^pid_dbhid:.+
"
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.LegalHoldsPolicyReleaseErrorException
DbxException
public LegalHoldPolicy legalHoldsUpdatePolicy(java.lang.String id) throws LegalHoldsPolicyUpdateErrorException, DbxException
Permission : Team member file access.
id
- The legal hold Id. Must match pattern "^pid_dbhid:.+
"
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.LegalHoldsPolicyUpdateErrorException
DbxException
public LegalHoldsUpdatePolicyBuilder legalHoldsUpdatePolicyBuilder(java.lang.String id)
id
- The legal hold Id. Must match pattern "^pid_dbhid:.+
"
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public ListMemberAppsResult linkedAppsListMemberLinkedApps(java.lang.String teamMemberId) throws ListMemberAppsErrorException, DbxException
Note, this endpoint does not list any team-linked applications.
teamMemberId
- The team member id. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.ListMemberAppsErrorException
DbxException
public ListMembersAppsResult linkedAppsListMembersLinkedApps() throws ListMembersAppsErrorException, DbxException
Note, this endpoint does not list any team-linked applications.
linkedAppsListMembersLinkedApps(String)
.ListMembersAppsErrorException
DbxException
public ListMembersAppsResult linkedAppsListMembersLinkedApps(java.lang.String cursor) throws ListMembersAppsErrorException, DbxException
Note, this endpoint does not list any team-linked applications.
cursor
- At the first call to the linkedAppsListMembersLinkedApps(String)
the
cursor shouldn't be passed. Then, if the result of the call includes
a cursor, the following requests should include the received cursors
in order to receive the next sub list of the team applications.linkedAppsListMembersLinkedApps(String)
.ListMembersAppsErrorException
DbxException
@Deprecated public ListTeamAppsResult linkedAppsListTeamLinkedApps() throws ListTeamAppsErrorException, DbxException
linkedAppsListMembersLinkedApps(String)
instead.Note, this endpoint doesn't list any team-linked applications.
linkedAppsListTeamLinkedApps(String)
.ListTeamAppsErrorException
DbxException
@Deprecated public ListTeamAppsResult linkedAppsListTeamLinkedApps(java.lang.String cursor) throws ListTeamAppsErrorException, DbxException
linkedAppsListMembersLinkedApps(String)
instead.Note, this endpoint doesn't list any team-linked applications.
cursor
- At the first call to the linkedAppsListTeamLinkedApps(String)
the cursor
shouldn't be passed. Then, if the result of the call includes a
cursor, the following requests should include the received cursors in
order to receive the next sub list of the team applications.linkedAppsListTeamLinkedApps(String)
.ListTeamAppsErrorException
DbxException
public void linkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId) throws RevokeLinkedAppErrorException, DbxException
The keepAppFolder
request parameter will default to true
(see linkedAppsRevokeLinkedApp(String,String,boolean)
).
appId
- The application's unique id. Must not be null
.teamMemberId
- The unique id of the member owning the device. Must
not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.RevokeLinkedAppErrorException
DbxException
public void linkedAppsRevokeLinkedApp(java.lang.String appId, java.lang.String teamMemberId, boolean keepAppFolder) throws RevokeLinkedAppErrorException, DbxException
appId
- The application's unique id. Must not be null
.teamMemberId
- The unique id of the member owning the device. Must
not be null
.keepAppFolder
- This flag is not longer supported, the application
dedicated folder (in case the application uses one) will be kept.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.RevokeLinkedAppErrorException
DbxException
public RevokeLinkedAppBatchResult linkedAppsRevokeLinkedAppBatch(java.util.List<RevokeLinkedApiAppArg> revokeLinkedApp) throws RevokeLinkedAppBatchErrorException, DbxException
revokeLinkedApp
- Must not contain a null
item and not be
null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.RevokeLinkedAppBatchErrorException
DbxException
public ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersAdd() throws ExcludedUsersUpdateErrorException, DbxException
ExcludedUsersUpdateErrorException
DbxException
public ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersAdd(java.util.List<UserSelectorArg> users) throws ExcludedUsersUpdateErrorException, DbxException
users
- List of users to be added/removed. Must not contain a
null
item.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.ExcludedUsersUpdateErrorException
DbxException
public ExcludedUsersListResult memberSpaceLimitsExcludedUsersList() throws ExcludedUsersListErrorException, DbxException
The limit
request parameter will default to 1000L
(see memberSpaceLimitsExcludedUsersList(long)
).
ExcludedUsersListErrorException
DbxException
public ExcludedUsersListResult memberSpaceLimitsExcludedUsersList(long limit) throws ExcludedUsersListErrorException, DbxException
limit
- Number of results to return per call. Must be greater than
or equal to 1 and be less than or equal to 1000.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.ExcludedUsersListErrorException
DbxException
public ExcludedUsersListResult memberSpaceLimitsExcludedUsersListContinue(java.lang.String cursor) throws ExcludedUsersListContinueErrorException, DbxException
cursor
- Indicates from what point to get the next set of users.
Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.ExcludedUsersListContinueErrorException
DbxException
public ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersRemove() throws ExcludedUsersUpdateErrorException, DbxException
ExcludedUsersUpdateErrorException
DbxException
public ExcludedUsersUpdateResult memberSpaceLimitsExcludedUsersRemove(java.util.List<UserSelectorArg> users) throws ExcludedUsersUpdateErrorException, DbxException
users
- List of users to be added/removed. Must not contain a
null
item.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.ExcludedUsersUpdateErrorException
DbxException
public java.util.List<CustomQuotaResult> memberSpaceLimitsGetCustomQuota(java.util.List<UserSelectorArg> users) throws CustomQuotaErrorException, DbxException
users
- List of users. Must not contain a null
item and not
be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.CustomQuotaErrorException
DbxException
public java.util.List<RemoveCustomQuotaResult> memberSpaceLimitsRemoveCustomQuota(java.util.List<UserSelectorArg> users) throws CustomQuotaErrorException, DbxException
users
- List of users. Must not contain a null
item and not
be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.CustomQuotaErrorException
DbxException
public java.util.List<CustomQuotaResult> memberSpaceLimitsSetCustomQuota(java.util.List<UserCustomQuotaArg> usersAndQuotas) throws SetCustomQuotaErrorException, DbxException
usersAndQuotas
- List of users and their custom quotas. Must not
contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.SetCustomQuotaErrorException
DbxException
public MembersAddLaunch membersAdd(java.util.List<MemberAddArg> newMembers) throws DbxApiException, DbxException
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 to false
(see membersAdd(List,boolean)
).
newMembers
- Details of new members to be added to the team. Must
not contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.DbxApiException
DbxException
public MembersAddLaunch membersAdd(java.util.List<MemberAddArg> newMembers, boolean forceAsync) throws DbxApiException, DbxException
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'.
newMembers
- Details of new members to be added to the team. Must
not contain a null
item and not be null
.forceAsync
- Whether to force the add to happen asynchronously.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.DbxApiException
DbxException
public MembersAddJobStatus membersAddJobStatusGet(java.lang.String asyncJobId) throws PollErrorException, DbxException
membersAdd(List,boolean)
, use this to poll the
status of the asynchronous request.
Permission : Team member management.
asyncJobId
- Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.PollErrorException
DbxException
public TeamMemberInfo membersDeleteProfilePhoto(UserSelectorArg user) throws MembersDeleteProfilePhotoErrorException, DbxException
Permission : Team member management.
user
- Identity of the user whose profile photo will be deleted.
Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersDeleteProfilePhotoErrorException
DbxException
public java.util.List<MembersGetInfoItem> membersGetInfo(java.util.List<UserSelectorArg> members) throws MembersGetInfoErrorException, DbxException
Permission : Team information
This endpoint will return MembersGetInfoItem.getIdNotFoundValue()
, for IDs (or emails) that cannot
be matched to a valid team member.
members
- List of team members. Must not contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersGetInfoErrorException
DbxException
public MembersListResult membersList() throws MembersListErrorException, DbxException
Permission : Team information.
The default values for the optional request parameters will be used.
See MembersListBuilder
for more details.
public MembersListBuilder membersListBuilder()
public MembersListResult membersListContinue(java.lang.String cursor) throws MembersListContinueErrorException, DbxException
membersList(com.dropbox.core.v2.team.MembersListArg)
, use this to paginate through all team
members.
Permission : Team information.
cursor
- Indicates from what point to get the next set of members.
Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersListContinueErrorException
DbxException
public LaunchEmptyResult membersMoveFormerMemberFiles(UserSelectorArg user, UserSelectorArg transferDestId, UserSelectorArg transferAdminId) throws MembersTransferFormerMembersFilesErrorException, DbxException
membersMoveFormerMemberFilesJobStatusCheck(String)
.
Permission : Team member management.
user
- Identity of user to remove/suspend/have their files moved.
Must not be null
.transferDestId
- Files from the deleted member account will be
transferred to this user. Must not be null
.transferAdminId
- Errors during the transfer process will be sent
via email to this user. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersTransferFormerMembersFilesErrorException
DbxException
public PollEmptyResult membersMoveFormerMemberFilesJobStatusCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException
membersMoveFormerMemberFiles(UserSelectorArg,UserSelectorArg,UserSelectorArg)
, use this to poll the status of the asynchronous request.
Permission : Team member management.
asyncJobId
- Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.PollErrorException
DbxException
public void membersRecover(UserSelectorArg user) throws MembersRecoverErrorException, DbxException
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
user
- Identity of user to recover. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersRecoverErrorException
DbxException
public LaunchEmptyResult membersRemove(UserSelectorArg user) throws MembersRemoveErrorException, DbxException
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). Calling membersAdd(List,boolean)
while a user is still
recoverable on your team will return with MemberAddResult.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.
user
- Identity of user to remove/suspend/have their files moved.
Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersRemoveErrorException
DbxException
public MembersRemoveBuilder membersRemoveBuilder(UserSelectorArg user)
membersRecover(UserSelectorArg)
for a 7 day period
or until the account has been permanently deleted or transferred to
another account (whichever comes first). Calling membersAdd(List,boolean)
while a user is still
recoverable on your team will return with MemberAddResult.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)
.user
- Identity of user to remove/suspend/have their files moved.
Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public PollEmptyResult membersRemoveJobStatusGet(java.lang.String asyncJobId) throws PollErrorException, DbxException
membersRemove(UserSelectorArg)
, use this to poll
the status of the asynchronous request.
Permission : Team member management.
asyncJobId
- Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.PollErrorException
DbxException
public AddSecondaryEmailsResult membersSecondaryEmailsAdd(java.util.List<UserSecondaryEmailsArg> newSecondaryEmails) throws AddSecondaryEmailsErrorException, DbxException
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.
newSecondaryEmails
- List of users and secondary emails to add.
Must not contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.AddSecondaryEmailsErrorException
DbxException
public DeleteSecondaryEmailsResult membersSecondaryEmailsDelete(java.util.List<UserSecondaryEmailsArg> emailsToDelete) throws DbxApiException, DbxException
Permission : Team member management.
Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email.
emailsToDelete
- List of users and their secondary emails to
delete. Must not contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.DbxApiException
DbxException
public ResendVerificationEmailResult membersSecondaryEmailsResendVerificationEmails(java.util.List<UserSecondaryEmailsArg> emailsToResend) throws DbxApiException, DbxException
Permission : Team member management.
emailsToResend
- List of users and secondary emails to resend
verification emails to. Must not contain a null
item and not
be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.DbxApiException
DbxException
public void membersSendWelcomeEmail(UserSelectorArg arg) throws MembersSendWelcomeErrorException, DbxException
arg
- Argument for selecting a single user, either by
team_member_id, external_id or email.MembersSendWelcomeErrorException
DbxException
public MembersSetPermissionsResult membersSetAdminPermissions(UserSelectorArg user, AdminTier newRole) throws MembersSetPermissionsErrorException, DbxException
Permission : Team member management.
user
- Identity of user whose role will be set. Must not be null
.newRole
- The new role of the member. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersSetPermissionsErrorException
DbxException
public TeamMemberInfo membersSetProfile(UserSelectorArg user) throws MembersSetProfileErrorException, DbxException
Permission : Team member management.
user
- Identity of user whose profile will be set. Must not be
null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersSetProfileErrorException
DbxException
public MembersSetProfileBuilder membersSetProfileBuilder(UserSelectorArg user)
user
- Identity of user whose profile will be set. Must not be
null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public TeamMemberInfo membersSetProfilePhoto(UserSelectorArg user, PhotoSourceArg photo) throws MembersSetProfilePhotoErrorException, DbxException
Permission : Team member management.
user
- Identity of the user whose profile photo will be set. Must
not be null
.photo
- Image to set as the member's new profile photo. Must not be
null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersSetProfilePhotoErrorException
DbxException
public void membersSuspend(UserSelectorArg user) throws MembersSuspendErrorException, DbxException
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 to true
(see membersSuspend(UserSelectorArg,boolean)
).
user
- Identity of user to remove/suspend/have their files moved.
Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersSuspendErrorException
DbxException
public void membersSuspend(UserSelectorArg user, boolean wipeData) throws MembersSuspendErrorException, DbxException
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
user
- Identity of user to remove/suspend/have their files moved.
Must not be null
.wipeData
- If provided, controls if the user's data will be deleted
on their linked devices.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersSuspendErrorException
DbxException
public void membersUnsuspend(UserSelectorArg user) throws MembersUnsuspendErrorException, DbxException
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
user
- Identity of user to unsuspend. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.MembersUnsuspendErrorException
DbxException
public TeamNamespacesListResult namespacesList() throws TeamNamespacesListErrorException, DbxException
The limit
request parameter will default to 1000L
(see namespacesList(long)
).
namespacesList(long)
.TeamNamespacesListErrorException
DbxException
public TeamNamespacesListResult namespacesList(long limit) throws TeamNamespacesListErrorException, DbxException
limit
- Specifying a value here has no effect. Must be greater than
or equal to 1 and be less than or equal to 1000.namespacesList(long)
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamNamespacesListErrorException
DbxException
public TeamNamespacesListResult namespacesListContinue(java.lang.String cursor) throws TeamNamespacesListContinueErrorException, DbxException
namespacesList(long)
, use this to paginate through
all team-accessible namespaces. Duplicates may occur in the list.cursor
- Indicates from what point to get the next set of
team-accessible namespaces. Must not be null
.namespacesList(long)
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamNamespacesListContinueErrorException
DbxException
@Deprecated public AddTemplateResult propertiesTemplateAdd(java.lang.String name, java.lang.String description, java.util.List<PropertyFieldTemplate> fields) throws ModifyTemplateErrorException, DbxException
name
- Display name for the template. Template names can be up to
256 bytes. Must not be null
.description
- Description for the template. Template descriptions
can be up to 1024 bytes. Must not be null
.fields
- Definitions of the property fields associated with this
template. There can be up to 32 properties in a single template. Must
not contain a null
item and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.ModifyTemplateErrorException
DbxException
@Deprecated public GetTemplateResult propertiesTemplateGet(java.lang.String templateId) throws TemplateErrorException, DbxException
templateId
- An identifier for template added by route See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)
or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List)
.
Must have length of at least 1, match pattern "(/|ptid:).*
",
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TemplateErrorException
DbxException
@Deprecated public ListTemplateResult propertiesTemplateList() throws TemplateErrorException, DbxException
TemplateErrorException
DbxException
@Deprecated public UpdateTemplateResult propertiesTemplateUpdate(java.lang.String templateId) throws ModifyTemplateErrorException, DbxException
templateId
- An identifier for template added by See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)
or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List)
.
Must have length of at least 1, match pattern "(/|ptid:).*
",
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.ModifyTemplateErrorException
DbxException
@Deprecated public PropertiesTemplateUpdateBuilder propertiesTemplateUpdateBuilder(java.lang.String templateId)
templateId
- An identifier for template added by See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)
or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List)
.
Must have length of at least 1, match pattern "(/|ptid:).*
",
and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public GetActivityReport reportsGetActivity() throws DateRangeErrorException, DbxException
DateRangeErrorException
DbxException
public ReportsGetActivityBuilder reportsGetActivityBuilder()
public GetDevicesReport reportsGetDevices() throws DateRangeErrorException, DbxException
DateRangeErrorException
DbxException
public ReportsGetDevicesBuilder reportsGetDevicesBuilder()
public GetMembershipReport reportsGetMembership() throws DateRangeErrorException, DbxException
DateRangeErrorException
DbxException
public ReportsGetMembershipBuilder reportsGetMembershipBuilder()
public GetStorageReport reportsGetStorage() throws DateRangeErrorException, DbxException
DateRangeErrorException
DbxException
public ReportsGetStorageBuilder reportsGetStorageBuilder()
public TeamFolderMetadata teamFolderActivate(java.lang.String teamFolderId) throws TeamFolderActivateErrorException, DbxException
Permission : Team member file access.
teamFolderId
- The ID of the team folder. Must match pattern
"[-_0-9a-zA-Z:]+
" and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderActivateErrorException
DbxException
public TeamFolderArchiveLaunch teamFolderArchive(java.lang.String teamFolderId) throws TeamFolderArchiveErrorException, DbxException
Permission : Team member file access.
The forceAsyncOff
request parameter will default to false
(see teamFolderArchive(String,boolean)
).
teamFolderId
- The ID of the team folder. Must match pattern
"[-_0-9a-zA-Z:]+
" and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderArchiveErrorException
DbxException
public TeamFolderArchiveLaunch teamFolderArchive(java.lang.String teamFolderId, boolean forceAsyncOff) throws TeamFolderArchiveErrorException, DbxException
Permission : Team member file access.
teamFolderId
- The ID of the team folder. Must match pattern
"[-_0-9a-zA-Z:]+
" and not be null
.forceAsyncOff
- Whether to force the archive to happen
synchronously.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderArchiveErrorException
DbxException
public TeamFolderArchiveJobStatus teamFolderArchiveCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException
Permission : Team member file access.
asyncJobId
- Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.PollErrorException
DbxException
public TeamFolderMetadata teamFolderCreate(java.lang.String name) throws TeamFolderCreateErrorException, DbxException
Permission : Team member file access.
name
- Name for the new team folder. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderCreateErrorException
DbxException
public TeamFolderMetadata teamFolderCreate(java.lang.String name, SyncSettingArg syncSetting) throws TeamFolderCreateErrorException, DbxException
Permission : Team member file access.
name
- Name for the new team folder. Must not be null
.syncSetting
- The sync setting to apply to this team folder. Only
permitted if the team has team selective sync enabled.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderCreateErrorException
DbxException
public java.util.List<TeamFolderGetInfoItem> teamFolderGetInfo(java.util.List<java.lang.String> teamFolderIds) throws DbxApiException, DbxException
Permission : Team member file access.
teamFolderIds
- The list of team folder IDs. Must contain at least
1 items, not contain a null
item, and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.DbxApiException
DbxException
public TeamFolderListResult teamFolderList() throws TeamFolderListErrorException, DbxException
Permission : Team member file access.
The limit
request parameter will default to 1000L
(see teamFolderList(long)
).
teamFolderList(long)
and
teamFolderListContinue(String)
.TeamFolderListErrorException
DbxException
public TeamFolderListResult teamFolderList(long limit) throws TeamFolderListErrorException, DbxException
Permission : Team member file access.
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.teamFolderList(long)
and
teamFolderListContinue(String)
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderListErrorException
DbxException
public TeamFolderListResult teamFolderListContinue(java.lang.String cursor) throws TeamFolderListContinueErrorException, DbxException
teamFolderList(long)
, use this to paginate through
all team folders.
Permission : Team member file access.
cursor
- Indicates from what point to get the next set of team
folders. Must not be null
.teamFolderList(long)
and
teamFolderListContinue(String)
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderListContinueErrorException
DbxException
public void teamFolderPermanentlyDelete(java.lang.String teamFolderId) throws TeamFolderPermanentlyDeleteErrorException, DbxException
Permission : Team member file access.
teamFolderId
- The ID of the team folder. Must match pattern
"[-_0-9a-zA-Z:]+
" and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderPermanentlyDeleteErrorException
DbxException
public TeamFolderMetadata teamFolderRename(java.lang.String teamFolderId, java.lang.String name) throws TeamFolderRenameErrorException, DbxException
Permission : Team member file access.
teamFolderId
- The ID of the team folder. Must match pattern
"[-_0-9a-zA-Z:]+
" and not be null
.name
- New team folder name. Must not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderRenameErrorException
DbxException
public TeamFolderMetadata teamFolderUpdateSyncSettings(java.lang.String teamFolderId) throws TeamFolderUpdateSyncSettingsErrorException, DbxException
teamFolderId
- The ID of the team folder. Must match pattern
"[-_0-9a-zA-Z:]+
" and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.TeamFolderUpdateSyncSettingsErrorException
DbxException
public TeamFolderUpdateSyncSettingsBuilder teamFolderUpdateSyncSettingsBuilder(java.lang.String teamFolderId)
teamFolderId
- The ID of the team folder. Must match pattern
"[-_0-9a-zA-Z:]+
" and not be null
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public TokenGetAuthenticatedAdminResult tokenGetAuthenticatedAdmin() throws TokenGetAuthenticatedAdminErrorException, DbxException
tokenGetAuthenticatedAdmin()
.TokenGetAuthenticatedAdminErrorException
DbxException