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

tag

Represents the union’s current tag state.

Declaration

Objective-C

@property (nonatomic, readonly) DBUSERSUserFeatureValueTag tag;

Swift

var tag: DBUSERSUserFeatureValueTag { get }

paperAsFiles
(no description). - note: Ensure the isPaperAsFiles method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBUSERSPaperAsFilesValue *_Nonnull paperAsFiles;
Swift

var paperAsFiles: DBUSERSPaperAsFilesValue { get }
fileLocking
(no description). - note: Ensure the isFileLocking method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBUSERSFileLockingValue *_Nonnull fileLocking;
Swift

var fileLocking: DBUSERSFileLockingValue { get }

Constructors


                    
                    
                    -initWithPaperAsFiles:

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.


                    
                    
                    -initWithFileLocking:

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.

-initWithOther
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

-isPaperAsFiles
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”.
-isFileLocking
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”.
-isOther
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”.
-tagName
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.