DBPAPERListUsersCursorError

Objective-C

@interface DBPAPERListUsersCursorError : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERListUsersCursorError : NSObject, DBSerializable, NSCopying

The ListUsersCursorError 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

Constructors

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

    Description of the “insufficient_permissions” tag state: Your account does not have permissions to perform this action. This may be due to it only having access to Paper as files in the Dropbox filesystem. For more information, refer to the Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsufficientPermissions;

    Swift

    init(insufficientPermissions: ())

    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.

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

    Description of the “doc_not_found” tag state: The required doc was not found.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocNotFound;

    Swift

    init(docNotFound: ())

    Return Value

    An initialized instance.

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

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isInsufficientPermissions;

    Swift

    func isInsufficientPermissions() -> Bool

    Return Value

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

  • 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 whether the union’s current tag state has value “doc_not_found”.

    Declaration

    Objective-C

    - (BOOL)isDocNotFound;

    Swift

    func isDocNotFound() -> Bool

    Return Value

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

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

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