DBASYNCLaunchResultBase

Objective-C

@interface DBASYNCLaunchResultBase : NSObject <DBSerializable, NSCopying>

Swift

class DBASYNCLaunchResultBase : NSObject, DBSerializable, NSCopying

The LaunchResultBase union.

Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a ‘complete’ field with the type of the synchronous response. See LaunchEmptyResult for an example.

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

Instance fields

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBASYNCLaunchResultBaseTag tag;

    Swift

    var tag: DBASYNCLaunchResultBaseTag { 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 (nonatomic, copy, readonly) NSString *_Nonnull asyncJobId;

    Swift

    var asyncJobId: String { get }

Constructors

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

Tag state methods

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