com.dropbox.core.v2.team

Class MembersRemoveBuilder

java.lang.Object

com.dropbox.core.v2.team.MembersRemoveBuilder

public class MembersRemoveBuilder
extends java.lang.Object

The request builder returned by DbxTeamTeamRequests.membersRemoveBuilder(com.dropbox.core.v2.team.UserSelectorArg).

Use this class to set optional request parameters and complete the request.

Method Summary

Modifier and Type	Method and Description
LaunchEmptyResult	start() Issues the request.
MembersRemoveBuilder	withKeepAccount(java.lang.Boolean keepAccount) Set value for optional field.
MembersRemoveBuilder	withRetainTeamShares(java.lang.Boolean retainTeamShares) Set value for optional field.
MembersRemoveBuilder	withTransferAdminId(UserSelectorArg transferAdminId) Set value for optional field.
MembersRemoveBuilder	withTransferDestId(UserSelectorArg transferDestId) Set value for optional field.
MembersRemoveBuilder	withWipeData(java.lang.Boolean wipeData) Set value for optional field.

Methods inherited from class java.lang.Object

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

Method Detail

withWipeData

public MembersRemoveBuilder withWipeData(java.lang.Boolean wipeData)

Set value for optional field.

If left unset or set to null, defaults to true.

Parameters:

wipeData - If provided, controls if the user's data will be deleted on their linked devices. Defaults to true when set to null.

Returns:

this builder

withTransferDestId

public MembersRemoveBuilder withTransferDestId(UserSelectorArg transferDestId)

Set value for optional field.

Parameters:

transferDestId - If provided, files from the deleted member account will be transferred to this user.

Returns:

this builder

withTransferAdminId

public MembersRemoveBuilder withTransferAdminId(UserSelectorArg transferAdminId)

Set value for optional field.

Parameters:

transferAdminId - If provided, errors during the transfer process will be sent via email to this user. If the transfer_dest_id argument was provided, then this argument must be provided as well.

Returns:

this builder

withKeepAccount

public MembersRemoveBuilder withKeepAccount(java.lang.Boolean keepAccount)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

keepAccount - Downgrade the member to a Basic account. The user will retain the email address associated with their Dropbox account and data in their account that is not restricted to team members. In order to keep the account the argument the wipeData argument to DbxTeamTeamRequests.membersSuspend(UserSelectorArg,boolean) should be set to false. Defaults to false when set to null.

Returns:

this builder

withRetainTeamShares

public MembersRemoveBuilder withRetainTeamShares(java.lang.Boolean retainTeamShares)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

retainTeamShares - If provided, allows removed users to keep access to Dropbox folders (not Dropbox Paper folders) already explicitly shared with them (not via a group) when they are downgraded to a Basic account. Users will not retain access to folders that do not allow external sharing. In order to keep the sharing relationships, the arguments the wipeData argument to DbxTeamTeamRequests.membersSuspend(UserSelectorArg,boolean) should be set to false and MembersRemoveArg.getKeepAccount() should be set to true. Defaults to false when set to null.

Returns:

this builder

start

public LaunchEmptyResult start()
                        throws MembersRemoveErrorException,
                               DbxException

Issues the request.

Throws:

MembersRemoveErrorException

DbxException