DBPAPERListDocsCursorError

Objective-C

@interface DBPAPERListDocsCursorError : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERListDocsCursorError : NSObject, DBSerializable, NSCopying

The ListDocsCursorError union.

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

Swift

var tag: DBPAPERListDocsCursorErrorTag { get }

cursorError
(no description). - note: Ensure the isCursorError method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBPAPERPaperApiCursorError *_Nonnull cursorError;
Swift

var cursorError: DBPAPERPaperApiCursorError { get }

Constructors


                    
                    
                    -initWithCursorError:

Initializes union class with tag state of “cursor_error”.

Declaration

Objective-C

- (nonnull instancetype)initWithCursorError:
    (nonnull DBPAPERPaperApiCursorError *)cursorError;

Swift

init(cursorError: DBPAPERPaperApiCursorError)

Parameters


                                cursorError

(no description).

Return Value

An initialized instance.

-initWithOther
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

-isCursorError
Retrieves whether the union’s current tag state has value “cursor_error”.

Note

Call this method and ensure it returns true before accessing the cursorError property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isCursorError;
Swift

func isCursorError() -> Bool
Return Value

Whether the union’s current tag state has value “cursor_error”.
-isOther
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”.
-tagName
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.