DBTEAMMembersRemoveArg

@interface DBTEAMMembersRemoveArg
    : DBTEAMMembersDeactivateArg <DBSerializable, NSCopying>

The MembersRemoveArg struct.

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

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

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) DBTEAMUserSelectorArg *transferDestId;

    Swift

    var transferDestId: DBTEAMUserSelectorArg? { get }
  • 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.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) DBTEAMUserSelectorArg *transferAdminId;

    Swift

    var transferAdminId: DBTEAMUserSelectorArg? { get }
  • 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 wipe_data should be set to False.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSNumber *_Nonnull keepAccount;

    Swift

    var keepAccount: NSNumber { get }
  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
       initWithUser:(nonnull DBTEAMUserSelectorArg *)user
           wipeData:(nullable NSNumber *)wipeData
     transferDestId:(nullable DBTEAMUserSelectorArg *)transferDestId
    transferAdminId:(nullable DBTEAMUserSelectorArg *)transferAdminId
        keepAccount:(nullable NSNumber *)keepAccount;

    Swift

    init(user: DBTEAMUserSelectorArg, wipeData: NSNumber?, transferDestId: DBTEAMUserSelectorArg?, transferAdminId: DBTEAMUserSelectorArg?, keepAccount: NSNumber?)

    Parameters

    user

    Identity of user to remove/suspend.

    wipeData

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

    transferDestId

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

    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.

    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 wipe_data should be set to False.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUser:(nonnull DBTEAMUserSelectorArg *)user;

    Swift

    init(user: DBTEAMUserSelectorArg)

    Parameters

    user

    Identity of user to remove/suspend.

    Return Value

    An initialized instance.