DBFILESSingleUserLock

Objective-C

@interface DBFILESSingleUserLock : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSingleUserLock : NSObject, DBSerializable, NSCopying

The SingleUserLock 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

  • The time the lock was created.

    Declaration

    Objective-C

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

    Swift

    var created: Date { get }

  • The account ID of the lock holder if known.

    Declaration

    Objective-C

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

    Swift

    var lockHolderAccountId: String { get }

  • The id of the team of the account holder if it exists.

    Declaration

    Objective-C

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

    Swift

    var lockHolderTeamId: String? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCreated:(nonnull NSDate *)created
                    lockHolderAccountId:(nonnull NSString *)lockHolderAccountId
                       lockHolderTeamId:(nullable NSString *)lockHolderTeamId;

    Swift

    init(created: Date, lockHolderAccountId: String, lockHolderTeamId: String?)

    Parameters

    created

    The time the lock was created.
    lockHolderAccountId

    The account ID of the lock holder if known.
    lockHolderTeamId

    The id of the team of the account holder if it exists.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCreated:(nonnull NSDate *)created
                    lockHolderAccountId:(nonnull NSString *)lockHolderAccountId;

    Swift

    init(created: Date, lockHolderAccountId: String)

    Parameters

    created

    The time the lock was created.
    lockHolderAccountId

    The account ID of the lock holder if known.

    Return Value

    An initialized instance.