class documentation

class PaperDocUpdateError(DocLookupError): (source)

View In Hierarchy

This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar paper.PaperDocUpdateError.content_malformed: The provided content was malformed and cannot be imported to Paper. :ivar paper.PaperDocUpdateError.revision_mismatch: The provided revision does not match the document head. :ivar paper.PaperDocUpdateError.doc_length_exceeded: The newly created Paper doc would be too large, split the content into multiple docs. :ivar paper.PaperDocUpdateError.image_size_exceeded: The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI. :ivar paper.PaperDocUpdateError.doc_archived: This operation is not allowed on archived Paper docs. :ivar paper.PaperDocUpdateError.doc_deleted: This operation is not allowed on deleted Paper docs.

Method is_content_malformed Check if the union tag is ``content_malformed``.
Method is_doc_archived Check if the union tag is ``doc_archived``.
Method is_doc_deleted Check if the union tag is ``doc_deleted``.
Method is_doc_length_exceeded Check if the union tag is ``doc_length_exceeded``.
Method is_image_size_exceeded Check if the union tag is ``image_size_exceeded``.
Method is_revision_mismatch Check if the union tag is ``revision_mismatch``.
Class Variable content_malformed Undocumented
Class Variable doc_archived Undocumented
Class Variable doc_deleted Undocumented
Class Variable doc_length_exceeded Undocumented
Class Variable image_size_exceeded Undocumented
Class Variable revision_mismatch Undocumented
Method _process_custom_annotations Undocumented

Inherited from DocLookupError:

Method is_doc_not_found Check if the union tag is ``doc_not_found``.
Class Variable doc_not_found Undocumented

Inherited from PaperApiBaseError (via DocLookupError):

Method is_insufficient_permissions Check if the union tag is ``insufficient_permissions``.
Method is_other Check if the union tag is ``other``.
Class Variable insufficient_permissions Undocumented
Class Variable other Undocumented
Class Variable _catch_all Undocumented
def is_content_malformed(self): (source)

Check if the union tag is ``content_malformed``. :rtype: bool

def is_doc_archived(self): (source)

Check if the union tag is ``doc_archived``. :rtype: bool

def is_doc_deleted(self): (source)

Check if the union tag is ``doc_deleted``. :rtype: bool

def is_doc_length_exceeded(self): (source)

Check if the union tag is ``doc_length_exceeded``. :rtype: bool

def is_image_size_exceeded(self): (source)

Check if the union tag is ``image_size_exceeded``. :rtype: bool

def is_revision_mismatch(self): (source)

Check if the union tag is ``revision_mismatch``. :rtype: bool

content_malformed = (source)

Undocumented

doc_archived = (source)

Undocumented

doc_deleted = (source)

Undocumented

doc_length_exceeded = (source)

Undocumented

image_size_exceeded = (source)

Undocumented

revision_mismatch = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)