DBTEAMResendSecondaryEmailResult

Objective-C

@interface DBTEAMResendSecondaryEmailResult
    : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMResendSecondaryEmailResult : NSObject, DBSerializable, NSCopying

The ResendSecondaryEmailResult union.

Result of trying to resend verification email to a secondary email address. ‘success’ is the only value indicating that a verification email was successfully sent. The other values explain the type of error that occurred, and include the email 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) DBTEAMResendSecondaryEmailResultTag tag;

    Swift

    var tag: DBTEAMResendSecondaryEmailResultTag { get }

  • A verification email was successfully sent to the secondary email address.

    Note

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

    Declaration

    Objective-C

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

    Swift

    var success: String { get }

  • This secondary email address is not pending for the user. - note: Ensure the isNotPending method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var notPending: String { get }

  • Too many emails are being sent to this email address. Please try again later. - note: Ensure the isRateLimited method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var rateLimited: String { get }

Constructors

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

    Description of the “success” tag state: A verification email was successfully sent to the secondary email address.

    Declaration

    Objective-C

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

    Swift

    init(success: String)

    Parameters

    success

    A verification email was successfully sent to the secondary email address.

    Return Value

    An initialized instance.

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

    Description of the “not_pending” tag state: This secondary email address is not pending for the user.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNotPending:(nonnull NSString *)notPending;

    Swift

    init(notPending: String)

    Parameters

    notPending

    This secondary email address is not pending for the user.

    Return Value

    An initialized instance.

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

    Description of the “rate_limited” tag state: Too many emails are being sent to this email address. Please try again later.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRateLimited:(nonnull NSString *)rateLimited;

    Swift

    init(rateLimited: String)

    Parameters

    rateLimited

    Too many emails are being sent to this email address. Please try again later.

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isNotPending;

    Swift

    func isNotPending() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isRateLimited;

    Swift

    func isRateLimited() -> Bool

    Return Value

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

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