DBFILESFileLockMetadata

Objective-C

@interface DBFILESFileLockMetadata : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESFileLockMetadata : NSObject, DBSerializable, NSCopying

The FileLockMetadata struct.

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

Instance fields

  • True if caller holds the file lock.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *isLockholder;

    Swift

    var isLockholder: NSNumber? { get }

  • The display name of the lock holder.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *lockholderName;

    Swift

    var lockholderName: String? { get }

  • The account ID of the lock holder if known.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *lockholderAccountId;

    Swift

    var lockholderAccountId: String? { get }

  • The timestamp of the lock was created.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDate *created;

    Swift

    var created: Date? { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIsLockholder:(nullable NSNumber *)isLockholder
                              lockholderName:(nullable NSString *)lockholderName
                         lockholderAccountId:
                             (nullable NSString *)lockholderAccountId
                                     created:(nullable NSDate *)created;

    Swift

    init(isLockholder: NSNumber?, lockholderName: String?, lockholderAccountId: String?, created: Date?)

    Parameters

    isLockholder

    True if caller holds the file lock.
    lockholderName

    The display name of the lock holder.
    lockholderAccountId

    The account ID of the lock holder if known.
    created

    The timestamp of the lock was created.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initDefault;

    Swift

    init(default: ())

    Return Value

    An initialized instance.