DBTEAMMembersRemoveError

Objective-C

@interface DBTEAMMembersRemoveError : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMMembersRemoveError : NSObject, DBSerializable, NSCopying

The MembersRemoveError union.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

Constructors

  • Initializes union class with tag state of “user_not_found”.

    Description of the “user_not_found” tag state: No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserNotFound;

    Swift

    init(userNotFound: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “user_not_in_team”.

    Description of the “user_not_in_team” tag state: The user is not a member of the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserNotInTeam;

    Swift

    init(userNotInTeam: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “other”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “removed_and_transfer_dest_should_differ”.

    Description of the “removed_and_transfer_dest_should_differ” tag state: Expected removed user and transfer_dest user to be different.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRemovedAndTransferDestShouldDiffer;

    Swift

    init(removedAndTransferDestShouldDiffer: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “removed_and_transfer_admin_should_differ”.

    Description of the “removed_and_transfer_admin_should_differ” tag state: Expected removed user and transfer_admin user to be different.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRemovedAndTransferAdminShouldDiffer;

    Swift

    init(removedAndTransferAdminShouldDiffer: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “transfer_dest_user_not_found”.

    Description of the “transfer_dest_user_not_found” tag state: No matching user found for the argument transfer_dest_id.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTransferDestUserNotFound;

    Swift

    init(transferDestUserNotFound: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “transfer_dest_user_not_in_team”.

    Description of the “transfer_dest_user_not_in_team” tag state: The provided transfer_dest_id does not exist on this team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTransferDestUserNotInTeam;

    Swift

    init(transferDestUserNotInTeam: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “transfer_admin_user_not_in_team”.

    Description of the “transfer_admin_user_not_in_team” tag state: The provided transfer_admin_id does not exist on this team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTransferAdminUserNotInTeam;

    Swift

    init(transferAdminUserNotInTeam: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “transfer_admin_user_not_found”.

    Description of the “transfer_admin_user_not_found” tag state: No matching user found for the argument transfer_admin_id.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTransferAdminUserNotFound;

    Swift

    init(transferAdminUserNotFound: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “unspecified_transfer_admin_id”.

    Description of the “unspecified_transfer_admin_id” tag state: The transfer_admin_id argument must be provided when file transfer is requested.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnspecifiedTransferAdminId;

    Swift

    init(unspecifiedTransferAdminId: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “transfer_admin_is_not_admin”.

    Description of the “transfer_admin_is_not_admin” tag state: Specified transfer_admin user is not a team admin.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTransferAdminIsNotAdmin;

    Swift

    init(transferAdminIsNotAdmin: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “recipient_not_verified”.

    Description of the “recipient_not_verified” tag state: The recipient user’s email is not verified.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRecipientNotVerified;

    Swift

    init(recipientNotVerified: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “remove_last_admin”.

    Description of the “remove_last_admin” tag state: The user is the last admin of the team, so it cannot be removed from it.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRemoveLastAdmin;

    Swift

    init(removeLastAdmin: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_keep_account_and_transfer”.

    Description of the “cannot_keep_account_and_transfer” tag state: Cannot keep account and transfer the data to another user at the same time.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotKeepAccountAndTransfer;

    Swift

    init(cannotKeepAccountAndTransfer: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_keep_account_and_delete_data”.

    Description of the “cannot_keep_account_and_delete_data” tag state: Cannot keep account and delete the data at the same time. To keep the account the argument wipe_data should be set to false.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotKeepAccountAndDeleteData;

    Swift

    init(cannotKeepAccountAndDeleteData: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “email_address_too_long_to_be_disabled”.

    Description of the “email_address_too_long_to_be_disabled” tag state: The email address of the user is too long to be disabled.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEmailAddressTooLongToBeDisabled;

    Swift

    init(emailAddressTooLongToBeDisabled: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_keep_invited_user_account”.

    Description of the “cannot_keep_invited_user_account” tag state: Cannot keep account of an invited user.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotKeepInvitedUserAccount;

    Swift

    init(cannotKeepInvitedUserAccount: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_retain_shares_when_data_wiped”.

    Description of the “cannot_retain_shares_when_data_wiped” tag state: Cannot retain team shares when the user’s data is marked for deletion on their linked devices. The argument wipe_data should be set to false.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotRetainSharesWhenDataWiped;

    Swift

    init(cannotRetainSharesWhenDataWiped: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_retain_shares_when_no_account_kept”.

    Description of the “cannot_retain_shares_when_no_account_kept” tag state: The user’s account must be kept in order to retain team shares. The argument keep_account should be set to true.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotRetainSharesWhenNoAccountKept;

    Swift

    init(cannotRetainSharesWhenNoAccountKept: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_retain_shares_when_team_external_sharing_off”.

    Description of the “cannot_retain_shares_when_team_external_sharing_off” tag state: Externally sharing files, folders, and links must be enabled in team settings in order to retain team shares for the user.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotRetainSharesWhenTeamExternalSharingOff;

    Swift

    init(cannotRetainSharesWhenTeamExternalSharingOff: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_keep_account”.

    Description of the “cannot_keep_account” tag state: Only a team admin, can convert this account to a Basic account.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotKeepAccount;

    Swift

    init(cannotKeepAccount: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_keep_account_under_legal_hold”.

    Description of the “cannot_keep_account_under_legal_hold” tag state: This user content is currently being held. To convert this member’s account to a Basic account, you’ll first need to remove them from the hold.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotKeepAccountUnderLegalHold;

    Swift

    init(cannotKeepAccountUnderLegalHold: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cannot_keep_account_required_to_sign_tos”.

    Description of the “cannot_keep_account_required_to_sign_tos” tag state: To convert this member to a Basic account, they’ll first need to sign in to Dropbox and agree to the terms of service.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCannotKeepAccountRequiredToSignTos;

    Swift

    init(cannotKeepAccountRequiredToSignTos: ())

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “user_not_found”.

    Declaration

    Objective-C

    - (BOOL)isUserNotFound;

    Swift

    func isUserNotFound() -> Bool

    Return Value

    Whether the union’s current tag state has value “user_not_found”.

  • Retrieves whether the union’s current tag state has value “user_not_in_team”.

    Declaration

    Objective-C

    - (BOOL)isUserNotInTeam;

    Swift

    func isUserNotInTeam() -> Bool

    Return Value

    Whether the union’s current tag state has value “user_not_in_team”.

  • Retrieves whether the union’s current tag state has value “other”.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value “other”.

  • Retrieves whether the union’s current tag state has value “removed_and_transfer_dest_should_differ”.

    Declaration

    Objective-C

    - (BOOL)isRemovedAndTransferDestShouldDiffer;

    Swift

    func isRemovedAndTransferDestShouldDiffer() -> Bool

    Return Value

    Whether the union’s current tag state has value “removed_and_transfer_dest_should_differ”.

  • Retrieves whether the union’s current tag state has value “removed_and_transfer_admin_should_differ”.

    Declaration

    Objective-C

    - (BOOL)isRemovedAndTransferAdminShouldDiffer;

    Swift

    func isRemovedAndTransferAdminShouldDiffer() -> Bool

    Return Value

    Whether the union’s current tag state has value “removed_and_transfer_admin_should_differ”.

  • Retrieves whether the union’s current tag state has value “transfer_dest_user_not_found”.

    Declaration

    Objective-C

    - (BOOL)isTransferDestUserNotFound;

    Swift

    func isTransferDestUserNotFound() -> Bool

    Return Value

    Whether the union’s current tag state has value “transfer_dest_user_not_found”.

  • Retrieves whether the union’s current tag state has value “transfer_dest_user_not_in_team”.

    Declaration

    Objective-C

    - (BOOL)isTransferDestUserNotInTeam;

    Swift

    func isTransferDestUserNotInTeam() -> Bool

    Return Value

    Whether the union’s current tag state has value “transfer_dest_user_not_in_team”.

  • Retrieves whether the union’s current tag state has value “transfer_admin_user_not_in_team”.

    Declaration

    Objective-C

    - (BOOL)isTransferAdminUserNotInTeam;

    Swift

    func isTransferAdminUserNotInTeam() -> Bool

    Return Value

    Whether the union’s current tag state has value “transfer_admin_user_not_in_team”.

  • Retrieves whether the union’s current tag state has value “transfer_admin_user_not_found”.

    Declaration

    Objective-C

    - (BOOL)isTransferAdminUserNotFound;

    Swift

    func isTransferAdminUserNotFound() -> Bool

    Return Value

    Whether the union’s current tag state has value “transfer_admin_user_not_found”.

  • Retrieves whether the union’s current tag state has value “unspecified_transfer_admin_id”.

    Declaration

    Objective-C

    - (BOOL)isUnspecifiedTransferAdminId;

    Swift

    func isUnspecifiedTransferAdminId() -> Bool

    Return Value

    Whether the union’s current tag state has value “unspecified_transfer_admin_id”.

  • Retrieves whether the union’s current tag state has value “transfer_admin_is_not_admin”.

    Declaration

    Objective-C

    - (BOOL)isTransferAdminIsNotAdmin;

    Swift

    func isTransferAdminIsNotAdmin() -> Bool

    Return Value

    Whether the union’s current tag state has value “transfer_admin_is_not_admin”.

  • Retrieves whether the union’s current tag state has value “recipient_not_verified”.

    Declaration

    Objective-C

    - (BOOL)isRecipientNotVerified;

    Swift

    func isRecipientNotVerified() -> Bool

    Return Value

    Whether the union’s current tag state has value “recipient_not_verified”.

  • Retrieves whether the union’s current tag state has value “remove_last_admin”.

    Declaration

    Objective-C

    - (BOOL)isRemoveLastAdmin;

    Swift

    func isRemoveLastAdmin() -> Bool

    Return Value

    Whether the union’s current tag state has value “remove_last_admin”.

  • Retrieves whether the union’s current tag state has value “cannot_keep_account_and_transfer”.

    Declaration

    Objective-C

    - (BOOL)isCannotKeepAccountAndTransfer;

    Swift

    func isCannotKeepAccountAndTransfer() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_keep_account_and_transfer”.

  • Retrieves whether the union’s current tag state has value “cannot_keep_account_and_delete_data”.

    Declaration

    Objective-C

    - (BOOL)isCannotKeepAccountAndDeleteData;

    Swift

    func isCannotKeepAccountAndDeleteData() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_keep_account_and_delete_data”.

  • Retrieves whether the union’s current tag state has value “email_address_too_long_to_be_disabled”.

    Declaration

    Objective-C

    - (BOOL)isEmailAddressTooLongToBeDisabled;

    Swift

    func isEmailAddressTooLongToBeDisabled() -> Bool

    Return Value

    Whether the union’s current tag state has value “email_address_too_long_to_be_disabled”.

  • Retrieves whether the union’s current tag state has value “cannot_keep_invited_user_account”.

    Declaration

    Objective-C

    - (BOOL)isCannotKeepInvitedUserAccount;

    Swift

    func isCannotKeepInvitedUserAccount() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_keep_invited_user_account”.

  • Retrieves whether the union’s current tag state has value “cannot_retain_shares_when_data_wiped”.

    Declaration

    Objective-C

    - (BOOL)isCannotRetainSharesWhenDataWiped;

    Swift

    func isCannotRetainSharesWhenDataWiped() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_retain_shares_when_data_wiped”.

  • Retrieves whether the union’s current tag state has value “cannot_retain_shares_when_no_account_kept”.

    Declaration

    Objective-C

    - (BOOL)isCannotRetainSharesWhenNoAccountKept;

    Swift

    func isCannotRetainSharesWhenNoAccountKept() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_retain_shares_when_no_account_kept”.

  • Retrieves whether the union’s current tag state has value “cannot_retain_shares_when_team_external_sharing_off”.

    Declaration

    Objective-C

    - (BOOL)isCannotRetainSharesWhenTeamExternalSharingOff;

    Swift

    func isCannotRetainSharesWhenTeamExternalSharingOff() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_retain_shares_when_team_external_sharing_off”.

  • Retrieves whether the union’s current tag state has value “cannot_keep_account”.

    Declaration

    Objective-C

    - (BOOL)isCannotKeepAccount;

    Swift

    func isCannotKeepAccount() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_keep_account”.

  • Retrieves whether the union’s current tag state has value “cannot_keep_account_under_legal_hold”.

    Declaration

    Objective-C

    - (BOOL)isCannotKeepAccountUnderLegalHold;

    Swift

    func isCannotKeepAccountUnderLegalHold() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_keep_account_under_legal_hold”.

  • Retrieves whether the union’s current tag state has value “cannot_keep_account_required_to_sign_tos”.

    Declaration

    Objective-C

    - (BOOL)isCannotKeepAccountRequiredToSignTos;

    Swift

    func isCannotKeepAccountRequiredToSignTos() -> Bool

    Return Value

    Whether the union’s current tag state has value “cannot_keep_account_required_to_sign_tos”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.