DBFILESPaperCreateError

Objective-C

@interface DBFILESPaperCreateError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESPaperCreateError : NSObject, DBSerializable, NSCopying

The PaperCreateError 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 edit Paper docs.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsufficientPermissions;

    Swift

    init(insufficientPermissions: ())

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

    Description of the “doc_length_exceeded” tag state: The Paper doc would be too large, 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.

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

    Description of the “invalid_path” tag state: The file could not be saved to the specified location.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidPath;

    Swift

    init(invalidPath: ())

    Return Value

    An initialized instance.

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

    Description of the “email_unverified” tag state: The user’s email must be verified to create Paper docs.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEmailUnverified;

    Swift

    init(emailUnverified: ())

    Return Value

    An initialized instance.

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

    Description of the “invalid_file_extension” tag state: The file path must end in .paper.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidFileExtension;

    Swift

    init(invalidFileExtension: ())

    Return Value

    An initialized instance.

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

    Description of the “paper_disabled” tag state: Paper is disabled for your team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPaperDisabled;

    Swift

    init(paperDisabled: ())

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

    Declaration

    Objective-C

    - (BOOL)isInvalidPath;

    Swift

    func isInvalidPath() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isEmailUnverified;

    Swift

    func isEmailUnverified() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInvalidFileExtension;

    Swift

    func isInvalidFileExtension() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isPaperDisabled;

    Swift

    func isPaperDisabled() -> Bool

    Return Value

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

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