nutrient/com.pspdfkit.instant.document/InstantPdfDocument

InstantPdfDocument

interface InstantPdfDocument : PdfDocument

PDF document managed by Instant. To create an instance use openDocument or openDocumentAsync.

Properties

SYNC_LOCAL_CHANGES_DISABLED

val SYNC_LOCAL_CHANGES_DISABLED: Long = 9223372036854775807

Use in setDelayForSyncingLocalChanges to deactivate automatic pushing of local changes.

Functions

addInstantDocumentListener

abstract fun addInstantDocumentListener(@NonNull listener: InstantDocumentListener)

Adds listener for instant document events.

getAnnotationProvider

@NonNull

abstract fun getAnnotationProvider(): InstantAnnotationProvider

Returns AnnotationProvider object which handles annotations contained in this document.

getDelayForSyncingLocalChanges

abstract fun getDelayForSyncingLocalChanges(): Long

Returns delay of automatic syncing of local changes that were made to the document.

getDocumentState

@NonNull

abstract fun getDocumentState(): InstantDocumentState

Returns the current state of this Instant document.

getInstantClient

@NonNull

abstract fun getInstantClient(): InstantClient

Returns instant client managing this document.

getInstantDocumentDescriptor

@NonNull

abstract fun getInstantDocumentDescriptor(): InstantDocumentDescriptor

Returns instant document handle for this document.

isListeningToServerChanges

abstract fun isListeningToServerChanges(): Boolean

Checks whether this document listens to server changes.

notifyConnectivityChanged

abstract fun notifyConnectivityChanged(isConnected: Boolean)

Notify Instant that connection has changed.

reauthenticateWithJwt

abstract fun reauthenticateWithJwt(@NonNull jwt: String)

Updates the token used to authenticate access to the document with a new JWT.

reauthenticateWithJwtAsync

@NonNull

abstract fun reauthenticateWithJwtAsync(@NonNull jwt: String): Completable

Updates the token used to authenticate access to the document with a new JWT, asynchronously.

removeInstantDocumentListener

abstract fun removeInstantDocumentListener(@NonNull listener: InstantDocumentListener)

Removes listener, previously registered via addInstantDocumentListener.

removeLocalStorage

abstract fun removeLocalStorage()

Removes local storage for this document.

setDelayForSyncingLocalChanges

abstract fun setDelayForSyncingLocalChanges(syncDelay: Long)

Delay in milliseconds before kicking off automatic sync after local changes are made to the document.

setListenToServerChanges

abstract fun setListenToServerChanges(listenToServerChanges: Boolean)

Controls whether to listen to server changes for this document.

syncAnnotations

abstract fun syncAnnotations()

Starts annotation sync and waits for its completion.

syncAnnotationsAsync

@NonNull

abstract fun syncAnnotationsAsync(): Flowable<InstantProgress>

Syncs annotations with Instant Server (Nutrient Document Engine) asynchronously.