DBASYNCPollResultBase

Objective-C

@interface DBASYNCPollResultBase : NSObject <DBSerializable, NSCopying>

Swift

class DBASYNCPollResultBase : NSObject, DBSerializable, NSCopying

The PollResultBase union.

Result returned by methods that poll for the status of an asynchronous job. Unions that extend this union should add a ‘complete’ field with a type of the information returned upon job completion. See PollEmptyResult 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

Constructors

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

Tag state methods

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