Package com.dropbox.core.v2.team

Class MembersRemoveBuilder

java.lang.Object
com.dropbox.core.v2.team.MembersRemoveBuilder
public class MembersRemoveBuilder extends 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 Details

    • withWipeData

      public MembersRemoveBuilder withWipeData(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(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(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

    • withPermanentlyDeleteFiles

      public MembersRemoveBuilder withPermanentlyDeleteFiles(Boolean permanentlyDeleteFiles)
      Set value for optional field.

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

      Parameters:
      permanentlyDeleteFiles - Permanently delete the data in the deleted member's account. After permanent deletion, the data is no longer available to be transferred to a different user. Defaults to false when set to null.
      Returns:
      this builder

    • start

      public LaunchEmptyResult start() throws MembersRemoveErrorException, DbxException
      Issues the request.
      Throws:
      MembersRemoveErrorException
      DbxException