DBSHARINGJobStatus

@interface DBSHARINGJobStatus : NSObject <DBSerializable, NSCopying>

The JobStatus union.

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

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBSHARINGJobStatusTag tag;

    Swift

    var tag: DBSHARINGJobStatusTag { get }
  • The asynchronous job returned an error. - note: Ensure the isFailed method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBSHARINGJobError *_Nonnull failed;

    Swift

    var failed: DBSHARINGJobError { get }
  • Initializes union class with tag state of in_progress.

    Description of the in_progress tag state: The asynchronous job is still in progress.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInProgress;

    Swift

    init(inProgress: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of complete.

    Description of the complete tag state: The asynchronous job has finished.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithComplete;

    Swift

    init(complete: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of failed.

    Description of the failed tag state: The asynchronous job returned an error.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFailed:(nonnull DBSHARINGJobError *)failed;

    Swift

    init(failed: DBSHARINGJobError)

    Parameters

    failed

    The asynchronous job returned an error.

    Return Value

    An initialized instance.

  • Retrieves whether the union’s current tag state has value in_progress.

    Declaration

    Objective-C

    - (BOOL)isInProgress;

    Swift

    func isInProgress() -> Bool

    Return Value

    Whether the union’s current tag state has value in_progress.

  • Retrieves whether the union’s current tag state has value complete.

    Declaration

    Objective-C

    - (BOOL)isComplete;

    Swift

    func isComplete() -> Bool

    Return Value

    Whether the union’s current tag state has value complete.

  • Retrieves whether the union’s current tag state has value failed.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isFailed;

    Swift

    func isFailed() -> Bool

    Return Value

    Whether the union’s current tag state has value failed.

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