DBTEAMMemberAddV2Result

Objective-C

@interface DBTEAMMemberAddV2Result : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMMemberAddV2Result : NSObject, DBSerializable, NSCopying

The MemberAddV2Result union.

Describes the result of attempting to add a single user to the team. ‘success’ is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed.

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

Instance fields

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMMemberAddV2ResultTag tag;

    Swift

    var tag: DBTEAMMemberAddV2ResultTag { get }

  • Team is already full. The organization has no available licenses. @note Ensure the isTeamLicenseLimit method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull teamLicenseLimit;

    Swift

    var teamLicenseLimit: String { get }

  • Team is already full. The free team member limit has been reached. @note Ensure the isFreeTeamMemberLimitReached method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull freeTeamMemberLimitReached;

    Swift

    var freeTeamMemberLimitReached: String { get }

  • User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team. - note: Ensure the isUserAlreadyOnTeam method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull userAlreadyOnTeam;

    Swift

    var userAlreadyOnTeam: String { get }

  • User is already on another team. The provided email address is associated with a user that is already a member or invited to another team. @note Ensure the isUserOnAnotherTeam method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull userOnAnotherTeam;

    Swift

    var userOnAnotherTeam: String { get }

  • User is already paired. - note: Ensure the isUserAlreadyPaired method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull userAlreadyPaired;

    Swift

    var userAlreadyPaired: String { get }

  • User migration has failed. - note: Ensure the isUserMigrationFailed method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull userMigrationFailed;

    Swift

    var userMigrationFailed: String { get }

  • A user with the given external member ID already exists on the team (including in recoverable state). - note: Ensure the isDuplicateExternalMemberId method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull duplicateExternalMemberId;

    Swift

    var duplicateExternalMemberId: String { get }

  • A user with the given persistent ID already exists on the team (including in recoverable state). - note: Ensure the isDuplicateMemberPersistentId method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull duplicateMemberPersistentId;

    Swift

    var duplicateMemberPersistentId: String { get }

  • Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information. - note: Ensure the isPersistentIdDisabled method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull persistentIdDisabled;

    Swift

    var persistentIdDisabled: String { get }

  • User creation has failed. - note: Ensure the isUserCreationFailed method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull userCreationFailed;

    Swift

    var userCreationFailed: String { get }

  • Describes a user that was successfully added to the team. - note: Ensure the isSuccess method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMTeamMemberInfoV2 *_Nonnull success;

    Swift

    var success: DBTEAMTeamMemberInfoV2 { get }

Constructors

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

    Description of the “team_license_limit” tag state: Team is already full. The organization has no available licenses.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamLicenseLimit:
    (nonnull NSString *)teamLicenseLimit;

    Swift

    init(teamLicenseLimit: String)

    Parameters

    teamLicenseLimit

    Team is already full. The organization has no available licenses.

    Return Value

    An initialized instance.

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

    Description of the “free_team_member_limit_reached” tag state: Team is already full. The free team member limit has been reached.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFreeTeamMemberLimitReached:
    (nonnull NSString *)freeTeamMemberLimitReached;

    Swift

    init(freeTeamMemberLimitReached: String)

    Parameters

    freeTeamMemberLimitReached

    Team is already full. The free team member limit has been reached.

    Return Value

    An initialized instance.

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

    Description of the “user_already_on_team” tag state: User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserAlreadyOnTeam:
    (nonnull NSString *)userAlreadyOnTeam;

    Swift

    init(userAlreadyOnTeam: String)

    Parameters

    userAlreadyOnTeam

    User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.

    Return Value

    An initialized instance.

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

    Description of the “user_on_another_team” tag state: User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserOnAnotherTeam:
    (nonnull NSString *)userOnAnotherTeam;

    Swift

    init(userOnAnotherTeam: String)

    Parameters

    userOnAnotherTeam

    User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.

    Return Value

    An initialized instance.

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

    Description of the “user_already_paired” tag state: User is already paired.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserAlreadyPaired:
    (nonnull NSString *)userAlreadyPaired;

    Swift

    init(userAlreadyPaired: String)

    Parameters

    userAlreadyPaired

    User is already paired.

    Return Value

    An initialized instance.

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

    Description of the “user_migration_failed” tag state: User migration has failed.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserMigrationFailed:
    (nonnull NSString *)userMigrationFailed;

    Swift

    init(userMigrationFailed: String)

    Parameters

    userMigrationFailed

    User migration has failed.

    Return Value

    An initialized instance.

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

    Description of the “duplicate_external_member_id” tag state: A user with the given external member ID already exists on the team (including in recoverable state).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDuplicateExternalMemberId:
    (nonnull NSString *)duplicateExternalMemberId;

    Swift

    init(duplicateExternalMemberId: String)

    Parameters

    duplicateExternalMemberId

    A user with the given external member ID already exists on the team (including in recoverable state).

    Return Value

    An initialized instance.

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

    Description of the “duplicate_member_persistent_id” tag state: A user with the given persistent ID already exists on the team (including in recoverable state).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDuplicateMemberPersistentId:
    (nonnull NSString *)duplicateMemberPersistentId;

    Swift

    init(duplicateMemberPersistentId: String)

    Parameters

    duplicateMemberPersistentId

    A user with the given persistent ID already exists on the team (including in recoverable state).

    Return Value

    An initialized instance.

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

    Description of the “persistent_id_disabled” tag state: Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPersistentIdDisabled:
    (nonnull NSString *)persistentIdDisabled;

    Swift

    init(persistentIdDisabled: String)

    Parameters

    persistentIdDisabled

    Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.

    Return Value

    An initialized instance.

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

    Description of the “user_creation_failed” tag state: User creation has failed.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserCreationFailed:
    (nonnull NSString *)userCreationFailed;

    Swift

    init(userCreationFailed: String)

    Parameters

    userCreationFailed

    User creation has failed.

    Return Value

    An initialized instance.

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

    Description of the “success” tag state: Describes a user that was successfully added to the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSuccess:
    (nonnull DBTEAMTeamMemberInfoV2 *)success;

    Swift

    init(success: DBTEAMTeamMemberInfoV2)

    Parameters

    success

    Describes a user that was successfully added to the team.

    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.

Tag state methods

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

    Note

    Call this method and ensure it returns true before accessing the teamLicenseLimit property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isTeamLicenseLimit;

    Swift

    func isTeamLicenseLimit() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the freeTeamMemberLimitReached property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isFreeTeamMemberLimitReached;

    Swift

    func isFreeTeamMemberLimitReached() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the userAlreadyOnTeam property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isUserAlreadyOnTeam;

    Swift

    func isUserAlreadyOnTeam() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the userOnAnotherTeam property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isUserOnAnotherTeam;

    Swift

    func isUserOnAnotherTeam() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the userAlreadyPaired property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isUserAlreadyPaired;

    Swift

    func isUserAlreadyPaired() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the userMigrationFailed property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isUserMigrationFailed;

    Swift

    func isUserMigrationFailed() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the duplicateExternalMemberId property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isDuplicateExternalMemberId;

    Swift

    func isDuplicateExternalMemberId() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the duplicateMemberPersistentId property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isDuplicateMemberPersistentId;

    Swift

    func isDuplicateMemberPersistentId() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the persistentIdDisabled property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isPersistentIdDisabled;

    Swift

    func isPersistentIdDisabled() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the userCreationFailed property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isUserCreationFailed;

    Swift

    func isUserCreationFailed() -> Bool

    Return Value

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

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

    Note

    Call this method and ensure it returns true before accessing the success property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isSuccess;

    Swift

    func isSuccess() -> Bool

    Return Value

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

  • 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 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.