Summary: Methods | [Expand All]
public interface

InstantDocumentListener

com.pspdfkit.instant.listeners.InstantDocumentListener
Known Indirect Subclasses

Class Overview

Listener for InstantPdfDocument events.

Summary

Public Methods
abstract void onAuthenticationFailed(InstantPdfDocument instantDocument, InstantException error)
Called when authentication with Instant server has failed.
abstract void onAuthenticationFinished(InstantPdfDocument instantDocument, String validJwt)
Called when authentication with Instant server has successfully finished.
abstract void onDocumentCorrupted(InstantPdfDocument instantDocument)
Called when InstantPdfDocument has detected data corruption.
abstract void onDocumentInvalidated(InstantPdfDocument instantDocument)
Called when InstantPdfDocument becomes invalid.
abstract void onDocumentStateChanged(InstantPdfDocument instantDocument, InstantDocumentState state)
Called when the document changes its state.
abstract void onSyncError(InstantPdfDocument instantDocument, InstantException error)
Called when annotation sync has been finished with an error.
abstract void onSyncFinished(InstantPdfDocument instantDocument)
Called when annotation sync has been finished successfully.
abstract void onSyncStarted(InstantPdfDocument instantDocument)
Called when annotation sync has been started.

Public Methods

public abstract void onAuthenticationFailed (InstantPdfDocument instantDocument, InstantException error)

Called when authentication with Instant server has failed.

Parameters
instantDocument Document that we were authenticating for.
error Authentication error.

public abstract void onAuthenticationFinished (InstantPdfDocument instantDocument, String validJwt)

Called when authentication with Instant server has successfully finished.

Parameters
instantDocument Document that we were authenticating for.
validJwt JWT that was used for this authentication request.

public abstract void onDocumentCorrupted (InstantPdfDocument instantDocument)

Called when InstantPdfDocument has detected data corruption.

Receiving this callback means any further interaction with the sender’s document are destined to fail. You can copy the document package aside for forensic purposes, but you will — eventually — have to purge its storage, and download it anew.

Because this situation means the document has become unusable, it will invalidate itself immediately after this method returns.

Parameters
instantDocument Document that has detected data corruption.

public abstract void onDocumentInvalidated (InstantPdfDocument instantDocument)

Called when InstantPdfDocument becomes invalid. Any future instant operations on this document will fail.

Parameters
instantDocument Document that is becoming invalid.

public abstract void onDocumentStateChanged (InstantPdfDocument instantDocument, InstantDocumentState state)

Called when the document changes its state.

Note: After onSyncStarted(InstantPdfDocument), this method may be called multiple times during the sync process.

Parameters
instantDocument Document which state has changed.
state New document state.

public abstract void onSyncError (InstantPdfDocument instantDocument, InstantException error)

Called when annotation sync has been finished with an error.

The most likely reason is network failure REQUEST_FAILED. Other common reasons are expiration of your authentication token AUTHENTICATION_FAILED, and cancellation USER_CANCELLED.

Parameters
instantDocument Document that was syncing the annotations.
error Error thrown while syncing annotations.
See Also

public abstract void onSyncFinished (InstantPdfDocument instantDocument)

Called when annotation sync has been finished successfully.

Parameters
instantDocument Document that was syncing the annotations.

public abstract void onSyncStarted (InstantPdfDocument instantDocument)

Called when annotation sync has been started.

Parameters
instantDocument Document that is syncing the annotations.