DBTEAMUserAddResult

Objective-C

@interface DBTEAMUserAddResult : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMUserAddResult : NSObject, DBSerializable, NSCopying

The UserAddResult union.

Result of trying to add secondary emails to a user. ‘success’ is the only value indicating that a user was successfully retrieved for adding secondary emails. The other values explain the type of error that occurred, and include the user for which the error occurred.

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) DBTEAMUserAddResultTag tag;

    Swift

    var tag: DBTEAMUserAddResultTag { get }

  • Describes a user and the results for each attempt to add a secondary email.

    Note

    Ensure the isSuccess method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var success: DBTEAMUserSecondaryEmailsResult { get }

  • Specified user is not a valid target for adding secondary emails. @note Ensure the isInvalidUser method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var invalidUser: DBTEAMUserSelectorArg { get }

  • Secondary emails can only be added to verified users. - note: Ensure the isUnverified method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var unverified: DBTEAMUserSelectorArg { get }

  • Secondary emails cannot be added to placeholder users. - note: Ensure the isPlaceholderUser method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var placeholderUser: DBTEAMUserSelectorArg { get }

Constructors

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

    Description of the “success” tag state: Describes a user and the results for each attempt to add a secondary email.

    Declaration

    Objective-C

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

    Swift

    init(success: DBTEAMUserSecondaryEmailsResult)

    Parameters

    success

    Describes a user and the results for each attempt to add a secondary email.

    Return Value

    An initialized instance.

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

    Description of the “invalid_user” tag state: Specified user is not a valid target for adding secondary emails.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidUser:
    (nonnull DBTEAMUserSelectorArg *)invalidUser;

    Swift

    init(invalidUser: DBTEAMUserSelectorArg)

    Parameters

    invalidUser

    Specified user is not a valid target for adding secondary emails.

    Return Value

    An initialized instance.

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

    Description of the “unverified” tag state: Secondary emails can only be added to verified users.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnverified:
    (nonnull DBTEAMUserSelectorArg *)unverified;

    Swift

    init(unverified: DBTEAMUserSelectorArg)

    Parameters

    unverified

    Secondary emails can only be added to verified users.

    Return Value

    An initialized instance.

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

    Description of the “placeholder_user” tag state: Secondary emails cannot be added to placeholder users.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPlaceholderUser:
    (nonnull DBTEAMUserSelectorArg *)placeholderUser;

    Swift

    init(placeholderUser: DBTEAMUserSelectorArg)

    Parameters

    placeholderUser

    Secondary emails cannot be added to placeholder users.

    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 “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 “invalid_user”.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isInvalidUser;

    Swift

    func isInvalidUser() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isUnverified;

    Swift

    func isUnverified() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isPlaceholderUser;

    Swift

    func isPlaceholderUser() -> Bool

    Return Value

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

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