DBFILESPaperUpdateError

Objective-C

@interface DBFILESPaperUpdateError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESPaperUpdateError : NSObject, DBSerializable, NSCopying

The PaperUpdateError 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 “path”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull DBFILESLookupError *)path;

    Swift

    init(path: DBFILESLookupError)

    Parameters

    path

    (no description).

    Return Value

    An initialized instance.

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

    Description of the “revision_mismatch” tag state: The provided revision does not match the document head.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRevisionMismatch;

    Swift

    init(revisionMismatch: ())

    Return Value

    An initialized instance.

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

    Description of the “doc_archived” tag state: This operation is not allowed on archived Paper docs.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocArchived;

    Swift

    init(docArchived: ())

    Return Value

    An initialized instance.

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

    Description of the “doc_deleted” tag state: This operation is not allowed on deleted Paper docs.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocDeleted;

    Swift

    init(docDeleted: ())

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

    Note

    Call this method and ensure it returns true before accessing the path property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isPath;

    Swift

    func isPath() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isRevisionMismatch;

    Swift

    func isRevisionMismatch() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isDocArchived;

    Swift

    func isDocArchived() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isDocDeleted;

    Swift

    func isDocDeleted() -> Bool

    Return Value

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

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