DBUSERSUserFeatureValue

Objective-C

@interface DBUSERSUserFeatureValue : NSObject <DBSerializable, NSCopying>

Swift

class DBUSERSUserFeatureValue : NSObject, DBSerializable, NSCopying

The UserFeatureValue union.

Values that correspond to entries in UserFeature.

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

Instance fields

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPaperAsFiles:
        (nonnull DBUSERSPaperAsFilesValue *)paperAsFiles;

    Swift

    init(paperAsFiles: DBUSERSPaperAsFilesValue)

    Parameters

    paperAsFiles

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFileLocking:
        (nonnull DBUSERSFileLockingValue *)fileLocking;

    Swift

    init(fileLocking: DBUSERSFileLockingValue)

    Parameters

    fileLocking

    (no description).

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isPaperAsFiles;

    Swift

    func isPaperAsFiles() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isFileLocking;

    Swift

    func isFileLocking() -> Bool

    Return Value

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

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