com.dropbox.core.v2.team

Class DbxTeamTeamRequests

java.lang.Object

com.dropbox.core.v2.team.DbxTeamTeamRequests

public class DbxTeamTeamRequests
extends Object

Routes in namespace "team".

Constructor Summary

Constructors

Constructor and Description
DbxTeamTeamRequests(DbxRawClientV2 client)

Method Summary

Modifier and Type	Method and Description
ListMemberDevicesResult	devicesListMemberDevices(String teamMemberId) List all device sessions of a team's member.
DevicesListMemberDevicesBuilder	devicesListMemberDevicesBuilder(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. use devicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg) instead.
DevicesListTeamDevicesBuilder	devicesListTeamDevicesBuilder() Deprecated. use devicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg) instead.
void	devicesRevokeDeviceSession(RevokeDeviceSessionArg arg) Revoke a device session of a team's member
RevokeDeviceSessionBatchResult	devicesRevokeDeviceSessionBatch(List<RevokeDeviceSessionArg> revokeDevices) Revoke a list of device sessions of team members
TeamGetInfoResult	getInfo() Retrieves information about a team.
GroupFullInfo	groupsCreate(String groupName) Creates a new, empty group, with a requested name.
GroupsCreateBuilder	groupsCreateBuilder(String groupName) Creates a new, empty group, with a requested name.
LaunchEmptyResult	groupsDelete(GroupSelector arg) Deletes a group.
List<GroupsGetInfoItem>	groupsGetInfo(GroupsSelector arg) Retrieves information about one or more groups.
PollEmptyResult	groupsJobStatusGet(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(String cursor) Once a cursor has been retrieved from groupsList(long), use this to paginate through all groups.
GroupMembersChangeResult	groupsMembersAdd(GroupSelector group, List<MemberAccess> members) Adds members to a group.
GroupMembersChangeResult	groupsMembersAdd(GroupSelector group, 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(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, List<UserSelectorArg> users) Removes members from a group.
GroupMembersChangeResult	groupsMembersRemove(GroupSelector group, List<UserSelectorArg> users, boolean returnMembers) Removes members from a group.
List<GroupsGetInfoItem>	groupsMembersSetAccessType(GroupSelector group, UserSelectorArg user, GroupAccessType accessType) Sets a member's access type in a group.
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.
ListMemberAppsResult	linkedAppsListMemberLinkedApps(String teamMemberId) List all linked applications of the team member.
ListMembersAppsResult	linkedAppsListMembersLinkedApps() List all applications linked to the team members' accounts.
ListMembersAppsResult	linkedAppsListMembersLinkedApps(String cursor) List all applications linked to the team members' accounts.
ListTeamAppsResult	linkedAppsListTeamLinkedApps() Deprecated. use linkedAppsListMembersLinkedApps(String) instead.
ListTeamAppsResult	linkedAppsListTeamLinkedApps(String cursor) Deprecated. use linkedAppsListMembersLinkedApps(String) instead.
void	linkedAppsRevokeLinkedApp(String appId, String teamMemberId) Revoke a linked application of the team member
void	linkedAppsRevokeLinkedApp(String appId, String teamMemberId, boolean keepAppFolder) Revoke a linked application of the team member
RevokeLinkedAppBatchResult	linkedAppsRevokeLinkedAppBatch(List<RevokeLinkedApiAppArg> revokeLinkedApp) Revoke a list of linked applications of the team members
MembersAddLaunch	membersAdd(List<MemberAddArg> newMembers) Adds members to a team.
MembersAddLaunch	membersAdd(List<MemberAddArg> newMembers, boolean forceAsync) Adds members to a team.
MembersAddJobStatus	membersAddJobStatusGet(String asyncJobId) Once an async_job_id is returned from membersAdd(List,boolean) , use this to poll the status of the asynchronous request.
List<MembersGetInfoItem>	membersGetInfo(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(String cursor) Once a cursor has been retrieved from membersList(com.dropbox.core.v2.team.MembersListArg), use this to paginate through all team members.
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(String asyncJobId) Once an async_job_id is returned from membersRemove(UserSelectorArg) , use this to poll the status of the asynchronous request.
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.
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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbxTeamTeamRequests

public DbxTeamTeamRequests(DbxRawClientV2 client)

Method Detail

devicesListMemberDevices

public ListMemberDevicesResult devicesListMemberDevices(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 be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

ListMemberDevicesErrorException

DbxException

devicesListMemberDevicesBuilder

public DevicesListMemberDevicesBuilder devicesListMemberDevicesBuilder(String teamMemberId)

List all device sessions of a team's member.

Parameters:

teamMemberId - The team's member id. Must not be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

devicesListMembersDevices

public ListMembersDevicesResult devicesListMembersDevices()
                                                   throws ListMembersDevicesErrorException,
                                                          DbxException

List all device sessions of a team.

The default values for the optional request parameters will be used. See DevicesListMembersDevicesBuilder for more details.

Throws:

ListMembersDevicesErrorException

DbxException

devicesListMembersDevicesBuilder

public DevicesListMembersDevicesBuilder devicesListMembersDevicesBuilder()

List all device sessions of a team.

Returns:

Request builder for configuring request parameters and completing the request.

devicesListTeamDevices

@Deprecated
public ListTeamDevicesResult devicesListTeamDevices()
                                                         throws ListTeamDevicesErrorException,
                                                                DbxException

Deprecated. use devicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg) instead.

List all device sessions of a team.

The default values for the optional request parameters will be used. See DevicesListTeamDevicesBuilder for more details.

Throws:

ListTeamDevicesErrorException

DbxException

devicesListTeamDevicesBuilder

@Deprecated
public DevicesListTeamDevicesBuilder devicesListTeamDevicesBuilder()

Deprecated. use devicesListMembersDevices(com.dropbox.core.v2.team.ListMembersDevicesArg) instead.

List all device sessions of a team.

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

Throws:

RevokeDeviceSessionErrorException

DbxException

devicesRevokeDeviceSessionBatch

public RevokeDeviceSessionBatchResult devicesRevokeDeviceSessionBatch(List<RevokeDeviceSessionArg> revokeDevices)
                                                               throws RevokeDeviceSessionBatchErrorException,
                                                                      DbxException

Revoke a list of device sessions of team members

Parameters:

revokeDevices - Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

RevokeDeviceSessionBatchErrorException

DbxException

getInfo

public TeamGetInfoResult getInfo()
                          throws DbxApiException,
                                 DbxException

Retrieves information about a team.

Throws:

DbxApiException

DbxException

groupsCreate

public GroupFullInfo groupsCreate(String groupName)
                           throws GroupCreateErrorException,
                                  DbxException

Creates a new, empty group, with a requested name. Permission : Team member management

Parameters:

groupName - Group name. Must not be null.

Returns:

Full description of a group.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GroupCreateErrorException

DbxException

groupsCreateBuilder

public GroupsCreateBuilder groupsCreateBuilder(String groupName)

Creates a new, empty group, with a requested name. Permission : Team member management

Parameters:

groupName - Group name. Must not be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

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 the groupsJobStatusGet(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 List<GroupsGetInfoItem> groupsGetInfo(GroupsSelector arg)
                                      throws GroupsGetInfoErrorException,
                                             DbxException

Retrieves information about one or more 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(String asyncJobId)
                                   throws GroupsPollErrorException,
                                          DbxException

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. Permission : Team member management

Parameters:

asyncJobId - Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be null.

Returns:

Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.

Throws:

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 to 1000L (see groupsList(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:

IllegalArgumentException - If any argument does not meet its preconditions.

DbxApiException

DbxException

groupsListContinue

public GroupsListResult groupsListContinue(String cursor)
                                    throws GroupsListContinueErrorException,
                                           DbxException

Once a cursor has been retrieved from groupsList(long), use this to paginate through all groups. Permission : Team information

Parameters:

cursor - Indicates from what point to get the next set of groups. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GroupsListContinueErrorException

DbxException

groupsMembersAdd

public GroupMembersChangeResult groupsMembersAdd(GroupSelector group,
                                                 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 to true (see groupsMembersAdd(GroupSelector,List,boolean)).

Parameters:

group - Group to which users will be added. Must not be null.

members - List of users to be added to the group. Must not contain a null item and not be null.

Returns:

Result returned by groupsMembersAdd(GroupSelector,List,boolean) and groupsMembersRemove(GroupSelector,List,boolean).

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GroupMembersAddErrorException

DbxException

groupsMembersAdd

public GroupMembersChangeResult groupsMembersAdd(GroupSelector group,
                                                 List<MemberAccess> members,
                                                 boolean returnMembers)
                                          throws GroupMembersAddErrorException,
                                                 DbxException

Adds members to a group. The members are added immediately. However the granting of group-owned resources may take additional time. Use the groupsJobStatusGet(String) to determine whether this process has completed. Permission : Team member management

Parameters:

group - Group to which users will be added. Must not be null.

members - List of users to be added to the group. Must not contain a 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.

Returns:

Result returned by groupsMembersAdd(GroupSelector,List,boolean) and groupsMembersRemove(GroupSelector,List,boolean).

Throws:

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 to 1000L (see groupsMembersList(GroupSelector,long)).

Parameters:

group - The group whose members are to be listed. Must not be null.

Throws:

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 be null.

limit - Number of results to return per call. Must be greater than or equal to 1 and be less than or equal to 1000.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GroupSelectorErrorException

DbxException

groupsMembersListContinue

public GroupsMembersListResult groupsMembersListContinue(String cursor)
                                                  throws GroupsMembersListContinueErrorException,
                                                         DbxException

Once a cursor has been retrieved from groupsMembersList(GroupSelector,long), use this to paginate through all members of the group. Permission : Team information

Parameters:

cursor - Indicates from what point to get the next set of groups. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GroupsMembersListContinueErrorException

DbxException

groupsMembersRemove

public GroupMembersChangeResult groupsMembersRemove(GroupSelector group,
                                                    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 to true (see groupsMembersRemove(GroupSelector,List,boolean)).

Parameters:

group - Group from which users will be removed. Must not be null.

users - List of users to be removed from the group. Must not contain a null item and not be null.

Returns:

Result returned by groupsMembersAdd(GroupSelector,List,boolean) and groupsMembersRemove(GroupSelector,List,boolean).

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GroupMembersRemoveErrorException

DbxException

groupsMembersRemove

public GroupMembersChangeResult groupsMembersRemove(GroupSelector group,
                                                    List<UserSelectorArg> users,
                                                    boolean returnMembers)
                                             throws GroupMembersRemoveErrorException,
                                                    DbxException

Removes members from a group. The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groupsJobStatusGet(String) to determine whether this process has completed. This method permits removing the only owner of a group, even in cases where this is not possible via the web client. Permission : Team member management

Parameters:

group - Group from which users will be removed. Must not be null.

users - List of users to be removed from the group. Must not contain a 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.

Returns:

Result returned by groupsMembersAdd(GroupSelector,List,boolean) and groupsMembersRemove(GroupSelector,List,boolean).

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GroupMembersRemoveErrorException

DbxException

groupsMembersSetAccessType

public 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 to true (see groupsMembersSetAccessType(GroupSelector,UserSelectorArg,GroupAccessType,boolean)).

Parameters:

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.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GroupMemberSetAccessTypeErrorException

DbxException

groupsMembersSetAccessType

public List<GroupsGetInfoItem> groupsMembersSetAccessType(GroupSelector group,
                                                          UserSelectorArg user,
                                                          GroupAccessType accessType,
                                                          boolean returnMembers)
                                                   throws GroupMemberSetAccessTypeErrorException,
                                                          DbxException

Sets a member's access type in a group. Permission : Team member management

Parameters:

group - Specify a group. Must not be null.

user - Identity of a user that is a member of the 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.

Throws:

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 be null.

Returns:

Full description of a group.

Throws:

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 be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

linkedAppsListMemberLinkedApps

public ListMemberAppsResult linkedAppsListMemberLinkedApps(String teamMemberId)
                                                    throws ListMemberAppsErrorException,
                                                           DbxException

List all linked applications of the team member. Note, this endpoint does not list any team-linked applications.

Parameters:

teamMemberId - The team member id. Must not be null.

Throws:

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(String cursor)
                                                      throws ListMembersAppsErrorException,
                                                             DbxException

List all applications linked to the team members' accounts. Note, this endpoint does not list any team-linked applications.

Parameters:

cursor - At the first call to the linkedAppsListMembersLinkedApps(String) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications.

Returns:

Information returned by linkedAppsListMembersLinkedApps(String).

Throws:

ListMembersAppsErrorException

DbxException

linkedAppsListTeamLinkedApps

@Deprecated
public ListTeamAppsResult linkedAppsListTeamLinkedApps()
                                                            throws ListTeamAppsErrorException,
                                                                   DbxException

Deprecated. use linkedAppsListMembersLinkedApps(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(String cursor)
                                                            throws ListTeamAppsErrorException,
                                                                   DbxException

Deprecated. use linkedAppsListMembersLinkedApps(String) instead.

List all applications linked to the team members' accounts. Note, this endpoint doesn't list any team-linked applications.

Parameters:

cursor - At the first call to the linkedAppsListTeamLinkedApps(String) the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications.

Returns:

Information returned by linkedAppsListTeamLinkedApps(String).

Throws:

ListTeamAppsErrorException

DbxException

linkedAppsRevokeLinkedApp

public void linkedAppsRevokeLinkedApp(String appId,
                                      String teamMemberId)
                               throws RevokeLinkedAppErrorException,
                                      DbxException

Revoke a linked application of the team member

The keepAppFolder request parameter will default to true (see linkedAppsRevokeLinkedApp(String,String,boolean)).

Parameters:

appId - The application's unique id. Must not be null.

teamMemberId - The unique id of the member owning the device. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

RevokeLinkedAppErrorException

DbxException

linkedAppsRevokeLinkedApp

public void linkedAppsRevokeLinkedApp(String appId,
                                      String teamMemberId,
                                      boolean keepAppFolder)
                               throws RevokeLinkedAppErrorException,
                                      DbxException

Revoke a linked application of the team member

Parameters:

appId - The application's unique id. Must not be null.

teamMemberId - The unique id of the member owning the device. Must not be null.

keepAppFolder - Whether to keep the application dedicated folder (in case the application uses one).

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

RevokeLinkedAppErrorException

DbxException

linkedAppsRevokeLinkedAppBatch

public RevokeLinkedAppBatchResult linkedAppsRevokeLinkedAppBatch(List<RevokeLinkedApiAppArg> revokeLinkedApp)
                                                          throws RevokeLinkedAppBatchErrorException,
                                                                 DbxException

Revoke a list of linked applications of the team members

Parameters:

revokeLinkedApp - Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

RevokeLinkedAppBatchErrorException

DbxException

membersAdd

public MembersAddLaunch membersAdd(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 to false (see membersAdd(List,boolean)).

Parameters:

newMembers - Details of new members to be added to the team. Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

DbxApiException

DbxException

membersAdd

public MembersAddLaunch membersAdd(List<MemberAddArg> newMembers,
                                   boolean forceAsync)
                            throws DbxApiException,
                                   DbxException

Adds members to a team. Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.

Parameters:

newMembers - Details of new members to be added to the team. Must not contain a null item and not be null.

forceAsync - Whether to force the add to happen asynchronously.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

DbxApiException

DbxException

membersAddJobStatusGet

public MembersAddJobStatus membersAddJobStatusGet(String asyncJobId)
                                           throws PollErrorException,
                                                  DbxException

Once an async_job_id is returned from membersAdd(List,boolean) , use this to poll the status of the asynchronous request. Permission : Team member management

Parameters:

asyncJobId - Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

PollErrorException

DbxException

membersGetInfo

public List<MembersGetInfoItem> membersGetInfo(List<UserSelectorArg> members)
                                        throws MembersGetInfoErrorException,
                                               DbxException

Returns information about multiple team members. Permission : Team information This endpoint will return MembersGetInfoItem.getIdNotFoundValue(), for IDs (or emails) that cannot be matched to a valid team member.

Parameters:

members - List of team members. Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

MembersGetInfoErrorException

DbxException

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.

Throws:

MembersListErrorException

DbxException

membersListBuilder

public MembersListBuilder membersListBuilder()

Lists members of a team. Permission : Team information

Returns:

Request builder for configuring request parameters and completing the request.

membersListContinue

public MembersListResult membersListContinue(String cursor)
                                      throws MembersListContinueErrorException,
                                             DbxException

Once a cursor has been retrieved from membersList(com.dropbox.core.v2.team.MembersListArg), use this to paginate through all team members. Permission : Team information

Parameters:

cursor - Indicates from what point to get the next set of members. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

MembersListContinueErrorException

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 be null.

Throws:

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. This is not a deactivation where the account can be re-activated again. Calling membersAdd(List,boolean) with the removed user's email address will create a new account with a new team_member_id that will not have access to any content that was shared with the initial account. 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. Must not be null.

Returns:

Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.

Throws:

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. This is not a deactivation where the account can be re-activated again. Calling membersAdd(List,boolean) with the removed user's email address will create a new account with a new team_member_id that will not have access to any content that was shared with the initial account. This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll membersRemoveJobStatusGet(String).

Parameters:

user - Identity of user to remove/suspend. Must not be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

membersRemoveJobStatusGet

public PollEmptyResult membersRemoveJobStatusGet(String asyncJobId)
                                          throws PollErrorException,
                                                 DbxException

Once an async_job_id is returned from membersRemove(UserSelectorArg) , use this to poll the status of the asynchronous request. Permission : Team member management

Parameters:

asyncJobId - Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be null.

Returns:

Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

PollErrorException

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

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 be null.

newRole - The new role of the member. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

MembersSetPermissionsErrorException

DbxException

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 be null.

Returns:

Information about a team member.

Throws:

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 be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

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 to true (see membersSuspend(UserSelectorArg,boolean)).

Parameters:

user - Identity of user to remove/suspend. Must not be null.

Throws:

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. Must not be null.

wipeData - If provided, controls if the user's data will be deleted on their linked devices.

Throws:

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 be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

MembersUnsuspendErrorException

DbxException

reportsGetActivity

public GetActivityReport reportsGetActivity()
                                     throws DateRangeErrorException,
                                            DbxException

Retrieves reporting data about a team's user activity.

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

public ReportsGetActivityBuilder reportsGetActivityBuilder()

Retrieves reporting data about a team's user activity.

Returns:

Request builder for configuring request parameters and completing the request.

reportsGetDevices

public GetDevicesReport reportsGetDevices()
                                   throws DateRangeErrorException,
                                          DbxException

Retrieves reporting data about a team's linked devices.

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

public ReportsGetDevicesBuilder reportsGetDevicesBuilder()

Retrieves reporting data about a team's linked devices.

Returns:

Request builder for configuring request parameters and completing the request.

reportsGetMembership

public GetMembershipReport reportsGetMembership()
                                         throws DateRangeErrorException,
                                                DbxException

Retrieves reporting data about a team's membership.

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

public ReportsGetMembershipBuilder reportsGetMembershipBuilder()

Retrieves reporting data about a team's membership.

Returns:

Request builder for configuring request parameters and completing the request.

reportsGetStorage

public GetStorageReport reportsGetStorage()
                                   throws DateRangeErrorException,
                                          DbxException

Retrieves reporting data about a team's storage usage.

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

public ReportsGetStorageBuilder reportsGetStorageBuilder()

Retrieves reporting data about a team's storage usage.

Returns:

Request builder for configuring request parameters and completing the request.