Class isds_document¶
Class isds_document¶
-
class
isds.
isds_document
¶ ISDS document.
This class holds the document content. A document is effectively an attachment file.
When creating a message if is fine to set the dmMimeType to (empty). ISDS will determine the MIME type automatically.
If creating a message to be sent then the first document should have the FILEMETATYPE_MAIN meta-type set. Other files should have the FILEMETATYPE_ENCLOSURE meta-type. Other types are not currently supported in the wrapper code.
-
data
¶ Document data.
Note: A copy of the value is returned when read. A copy of the value is stored when written. Note: You may also use the bytes type when storing the value. Type: bytearray
-
dmFileDescr
¶ Document name (title) - I.e. file name.
Note: Mandatory. Type: string
-
dmFileGuid
¶ Message-local document identifier.
Note: Optional. Type: string
-
dmFileMetaType
¶ Document type which is needed to create attachment hierarchy.
Note: At least one document must be of the type FILEMETATYPE_MAIN when sending a message. Type: isds_FileMetaType
-
dmMimeType
¶ Document MIME type.
Note: Mandatory. If you specify an empty sting then the ISDS server will try to determine the MIME type automatically. Type: string
-
dmUpFileGuid
¶ Reference to upper document identifier (
dmFileGuid
).Note: Optional. Type: string
-
is_xml
¶ True if document is an ISDS XML (embedded) document. False if document is an ISDS binary document.
Note: The Python wrapper does not know how to handle embedded documents. The value should therefore be False. Note: You are free to treat XML documents as ordinary (binary) files. Type: bool
-