nutrient/com.pspdfkit.instant.annotations/InstantAnnotationProvider

InstantAnnotationProvider

interface InstantAnnotationProvider : AnnotationProvider

Handles all annotation related operations on the owning Instant document. Retrieve it with com.pspdfkit.instant.document.InstantPdfDocument.getAnnotationProvider.

Types

NonAnnotationChange

enum NonAnnotationChange : Enum<InstantAnnotationProvider.NonAnnotationChange>

Possible non-annotation changes

OnNonAnnotationChangeListener

interface OnNonAnnotationChangeListener

Object to be notified whenever a local non-annotation change happens.

Functions

addNonAnnotationChangeListener

abstract fun addNonAnnotationChangeListener(listener: InstantAnnotationProvider.OnNonAnnotationChangeListener)

Registers the given object to be notified of non-annotation changes.

getAnnotationForIdentifier

abstract fun getAnnotationForIdentifier(identifier: String): Annotation?

Returns the annotation for the given identifier.

getIdentifierForAnnotation

abstract fun getIdentifierForAnnotation(annotation: Annotation): String

Returns the unique identifier used by Instant for the given annotation.

hasUnsavedChanges

abstract override fun hasUnsavedChanges(): Boolean

Returns whether there are unsaved changes to annotations in this document.