DBFILESLockFileResultEntry

Objective-C

@interface DBFILESLockFileResultEntry : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESLockFileResultEntry : NSObject, DBSerializable, NSCopying

The LockFileResultEntry union.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSuccess:
        (nonnull DBFILESLockFileResult *)success;

    Swift

    init(success: DBFILESLockFileResult)

    Parameters

    success

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFailure:(nonnull DBFILESLockFileError *)failure;

    Swift

    init(failure: DBFILESLockFileError)

    Parameters

    failure

    (no description).

    Return Value

    An initialized instance.

Tag state methods

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isSuccess;

    Swift

    func isSuccess() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isFailure;

    Swift

    func isFailure() -> Bool

    Return Value

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

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