pspdfkit/com.pspdfkit.instant.client/InstantDocumentDescriptor

InstantDocumentDescriptor

Descriptor/handle for InstantPdfDocument that provides methods for downloading/opening instant documents.

Each descriptor describes a single Instant document layer defined by the Document id and layer name. Both of these are encoded in the JWT used for authentication provided via openDocumentAsync or downloadDocumentAsync.

Properties

internal

@NonNull

@get:NonNull

val internal: InternalInstantDocumentDescriptor

Functions

downloadDocumentAsync

@NonNull

open fun downloadDocumentAsync(@NonNull jwt: String): Flowable<InstantProgress>

Downloads document from Instant Server (PSPDFKit Document Engine) asynchronously.

getCreatorName

@Nullable

open fun getCreatorName(): String

Returns the creator name set in the JWT — if any.

getDocumentId

@NonNull

open fun getDocumentId(): String

Document Id of the managed document.

getJwt

@Nullable

open fun getJwt(): String

JWT used to authenticate access to the document.

getLayerName

@NonNull

open fun getLayerName(): String

Name of the managed document layer.

getUserId

@Nullable

open fun getUserId(): String

Id of the user the layer managed by the handle belongs to.

isDownloaded

open fun isDownloaded(): Boolean

Check whether document is already downloaded.

openDocument

@NonNull

open fun openDocument(@NonNull jwt: String): InstantPdfDocument

Downloads and opens document from Instant Server (PSPDFKit Document Engine) (synchronously).

openDocumentAsync

@NonNull

open fun openDocumentAsync(@NonNull jwt: String): Single<InstantPdfDocument>

Downloads and opens document from Instant Server (PSPDFKit Document Engine) asynchronously.

removeLocalStorage

open fun removeLocalStorage()

Removes local storage for this layer.