DBASYNCLaunchEmptyResult

@interface DBASYNCLaunchEmptyResult : NSObject <DBSerializable, NSCopying>

The LaunchEmptyResult union.

Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.

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

    Swift

    var tag: DBASYNCLaunchEmptyResultTag { get }
  • This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job. @note Ensure the isAsyncJobId method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var asyncJobId: String { get }
  • Initializes union class with tag state of async_job_id.

    Description of the async_job_id tag state: This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAsyncJobId:(nonnull NSString *)asyncJobId;

    Swift

    init(asyncJobId: String)

    Parameters

    asyncJobId

    This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of complete.

    Description of the complete tag state: The job finished synchronously and successfully.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithComplete;

    Swift

    init(complete: ())

    Return Value

    An initialized instance.

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isAsyncJobId;

    Swift

    func isAsyncJobId() -> Bool

    Return Value

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

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