DBSHARINGInviteeInfo

Objective-C

@interface DBSHARINGInviteeInfo : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGInviteeInfo : NSObject, DBSerializable, NSCopying

The InviteeInfo union.

Information about the recipient of a shared content invitation.

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

    Swift

    var tag: DBSHARINGInviteeInfoTag { get }

  • Email address of invited user. - note: Ensure the isEmail method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var email: String { get }

Constructors

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

    Description of the “email” tag state: Email address of invited user.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEmail:(nonnull NSString *)email;

    Swift

    init(email: String)

    Parameters

    email

    Email address of invited user.

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isEmail;

    Swift

    func isEmail() -> Bool

    Return Value

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

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