DBASYNCPollError

Objective-C

@interface DBASYNCPollError : NSObject <DBSerializable, NSCopying>

Swift

class DBASYNCPollError : NSObject, DBSerializable, NSCopying

The PollError union.

Error returned by methods for polling the status of asynchronous job.

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

    Description of the “invalid_async_job_id” tag state: The job ID is invalid.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidAsyncJobId;

    Swift

    init(invalidAsyncJobId: ())

    Return Value

    An initialized instance.

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

    Description of the “internal_error” tag state: Something went wrong with the job on Dropbox’s end. You’ll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInternalError;

    Swift

    init(internalError: ())

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isInvalidAsyncJobId;

    Swift

    func isInvalidAsyncJobId() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInternalError;

    Swift

    func isInternalError() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

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

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