InstantPdfDocument

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

Properties

Link copied to clipboard
val SYNC_LOCAL_CHANGES_DISABLED: Long = 9223372036854775807
Use in setDelayForSyncingLocalChanges to deactivate automatic pushing of local changes.

Functions

Link copied to clipboard
Adds listener for instant document events.
Link copied to clipboard
Returns AnnotationProvider object which handles annotations contained in this document.
Link copied to clipboard
Returns delay of automatic syncing of local changes that were made to the document.
Link copied to clipboard
Returns the current state of this Instant document.
Link copied to clipboard
Returns instant client managing this document.
Link copied to clipboard
Returns instant document handle for this document.
Link copied to clipboard
Checks whether this document listens to server changes.
Link copied to clipboard
abstract fun notifyConnectivityChanged(isConnected: Boolean)
Notify Instant that connection has changed.
Link copied to clipboard
abstract fun reauthenticateWithJwt(@NonNull jwt: String)
Updates the token used to authenticate access to the document with a new JWT.
Link copied to clipboard
abstract fun reauthenticateWithJwtAsync(@NonNull jwt: String): Completable
Updates the token used to authenticate access to the document with a new JWT, asynchronously.
Link copied to clipboard
Removes listener, previously registered via addInstantDocumentListener.
Link copied to clipboard
abstract fun removeLocalStorage()
Removes local storage for this document.
Link copied to clipboard
abstract fun setDelayForSyncingLocalChanges(syncDelay: Long)
Delay in milliseconds before kicking off automatic sync after local changes are made to the document.
Link copied to clipboard
abstract fun setListenToServerChanges(listenToServerChanges: Boolean)
Controls whether to listen to server changes for this document.
Link copied to clipboard
abstract fun syncAnnotations()
Starts annotation sync and waits for its completion.
Link copied to clipboard
abstract fun syncAnnotationsAsync(): Flowable<InstantProgress>
Syncs annotations with Instant Server (PSPDFKit Document Engine) asynchronously.