DBTEAMMembersDeactivateArg

@interface DBTEAMMembersDeactivateArg : NSObject <DBSerializable, NSCopying>

The MembersDeactivateArg struct.

Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

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

  • Identity of user to remove/suspend.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBTEAMUserSelectorArg *_Nonnull user;

    Swift

    var user: DBTEAMUserSelectorArg { get }
  • If provided, controls if the user’s data will be deleted on their linked devices.

    Declaration

    Objective-C

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

    Swift

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

    Declaration

    Objective-C

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

    Swift

    init(user: DBTEAMUserSelectorArg, wipeData: 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.

    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.