DBPAPERPaperDocCreateError

Objective-C

@interface DBPAPERPaperDocCreateError : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERPaperDocCreateError : NSObject, DBSerializable, NSCopying

The PaperDocCreateError 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 “content_malformed”.

    Description of the “content_malformed” tag state: The provided content was malformed and cannot be imported to Paper.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithContentMalformed;

    Swift

    init(contentMalformed: ())

    Return Value

    An initialized instance.

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

    Description of the “folder_not_found” tag state: The specified Paper folder is cannot be found.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFolderNotFound;

    Swift

    init(folderNotFound: ())

    Return Value

    An initialized instance.

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

    Description of the “doc_length_exceeded” tag state: The newly created Paper doc would be too large. Please split the content into multiple docs.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocLengthExceeded;

    Swift

    init(docLengthExceeded: ())

    Return Value

    An initialized instance.

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

    Description of the “image_size_exceeded” tag state: The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImageSizeExceeded;

    Swift

    init(imageSizeExceeded: ())

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

    Declaration

    Objective-C

    - (BOOL)isContentMalformed;

    Swift

    func isContentMalformed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isFolderNotFound;

    Swift

    func isFolderNotFound() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isDocLengthExceeded;

    Swift

    func isDocLengthExceeded() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isImageSizeExceeded;

    Swift

    func isImageSizeExceeded() -> Bool

    Return Value

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

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