DBPAPERPaperApiCursorError

@interface DBPAPERPaperApiCursorError : NSObject <DBSerializable, NSCopying>

The PaperApiCursorError union.

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

  • Initializes union class with tag state of expired_cursor.

    Description of the expired_cursor tag state: The provided cursor is expired.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithExpiredCursor;

    Swift

    init(expiredCursor: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of invalid_cursor.

    Description of the invalid_cursor tag state: The provided cursor is invalid.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidCursor;

    Swift

    init(invalidCursor: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of wrong_user_in_cursor.

    Description of the wrong_user_in_cursor tag state: The provided cursor contains invalid user.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithWrongUserInCursor;

    Swift

    init(wrongUserInCursor: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of reset.

    Description of the reset tag state: Indicates that the cursor has been invalidated. Call the corresponding non-continue endpoint to obtain a new cursor.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithReset;

    Swift

    init(reset: ())

    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.

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

    Declaration

    Objective-C

    - (BOOL)isExpiredCursor;

    Swift

    func isExpiredCursor() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInvalidCursor;

    Swift

    func isInvalidCursor() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isWrongUserInCursor;

    Swift

    func isWrongUserInCursor() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isReset;

    Swift

    func isReset() -> Bool

    Return Value

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

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