Constructor Detail

Method Detail

• onAuthenticationFailed

   abstract void onAuthenticationFailed(@NonNull() InstantPdfDocument instantDocument, @NonNull() InstantException error)

  Called when authentication with Instant Server (PSPDFKit Document Engine) has failed.

  Parameters:

  instantDocument - Document that we were authenticating for.

  error - Authentication error.

• onAuthenticationFinished

   abstract void onAuthenticationFinished(@NonNull() InstantPdfDocument instantDocument, @NonNull() String validJwt)

  Called when authentication with Instant Server (PSPDFKit Document Engine) has successfully finished.

  Parameters:

  instantDocument - Document that we were authenticating for.

  validJwt - JWT that was used for this authentication request.

• onSyncStarted

   abstract void onSyncStarted(@NonNull() InstantPdfDocument instantDocument)

  Called when annotation sync has been started.

  Parameters:

  instantDocument - Document that is syncing the annotations.

• onSyncError

   abstract void onSyncError(@NonNull() InstantPdfDocument instantDocument, @NonNull() 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.

• onSyncFinished

   abstract void onSyncFinished(@NonNull() InstantPdfDocument instantDocument)

  Called when annotation sync has been finished successfully.

  Parameters:

  instantDocument - Document that was syncing the annotations.

• onDocumentStateChanged

   abstract void onDocumentStateChanged(@NonNull() InstantPdfDocument instantDocument, @NonNull() InstantDocumentState state)

  Called when the document changes its state.

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

  Parameters:

  instantDocument - Document which state has changed.

  state - New document state.

• onDocumentCorrupted

   abstract void onDocumentCorrupted(@NonNull() 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.

• onDocumentInvalidated

   abstract void onDocumentInvalidated(@NonNull() InstantPdfDocument instantDocument)

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

  Parameters:

  instantDocument - Document that is becoming invalid.