DBUSERSFileLockingValue

Objective-C

@interface DBUSERSFileLockingValue : NSObject <DBSerializable, NSCopying>

Swift

class DBUSERSFileLockingValue : NSObject, DBSerializable, NSCopying

The FileLockingValue union.

The value for fileLocking in DBUSERSUserFeature.

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

    Swift

    var tag: DBUSERSFileLockingValueTag { get }

  • When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others. - note: Ensure the isEnabled method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull enabled;

    Swift

    var enabled: NSNumber { get }

Constructors

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

    Description of the “enabled” tag state: When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEnabled:(nonnull NSNumber *)enabled;

    Swift

    init(enabled: NSNumber)

    Parameters

    enabled

    When this value is True, the user can lock files in shared directories. When the value is False the user can unlock the files they have locked or request to unlock files locked by others.

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isEnabled;

    Swift

    func isEnabled() -> Bool

    Return Value

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

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