nutrient/com.pspdfkit.document/ImageDocument

ImageDocument

An image document. To create an instance use ImageDocumentLoader.openDocument (with a Context and Uri, or a DocumentSource) or related static async methods.

Properties

document

abstract val document: PdfDocument?

The converted Pdf document, or null if the image document couldn't be converted.

imageDocumentSource

abstract val imageDocumentSource: DocumentSource

The image document source, which may be a DataProvider or a file Uri.

isValidForEditing

abstract val isValidForEditing: Boolean

Whether the document is editable (comes from a file URI or from another source that supports writing).

Functions

saveIfModified

abstract fun saveIfModified(): Boolean

abstract fun saveIfModified(metadata: Boolean): Boolean

abstract fun saveIfModified(documentSaveOptions: DocumentSaveOptions, metadata: Boolean): Boolean

Saves the image document to its original location if it has been changed. If there were no changes, the image document file will not be modified. Note that this may take a while and should not be called on the main thread.

saveIfModifiedAsync

abstract suspend fun saveIfModifiedAsync(): Boolean

abstract suspend fun saveIfModifiedAsync(metadata: Boolean): Boolean

abstract suspend fun saveIfModifiedAsync(documentSaveOptions: DocumentSaveOptions, metadata: Boolean): Boolean

Saves the image document to its original location if it has been changed. If there were no changes, the image document file will not be modified.