pspdfkit/com.pspdfkit.document/ImageDocument/saveIfModified

saveIfModified

abstract fun saveIfModified(): 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.

Return

true if the file was modified and changes were saved. false if there was nothing to save.

abstract fun saveIfModified(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.

Return

true if the file was modified and changes were saved. false if there was nothing to save.

Parameters

metadata

If true image document will be saved to its original location together with the generated Pdf document in the metadata, when false Pdf in the metadata will be purged if any, and the saving will take effect persistently.

abstract fun saveIfModified(@NonNull 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.

Return

true if the file was modified and changes were saved. false if there was nothing to save.

Parameters

documentSaveOptions

Save options for the document.

metadata

If true image document will be saved to its original location together with the generated Pdf document in the metadata, when false Pdf in the metadata will be purged if any, and the saving will take effect persistently.