nutrient/com.pspdfkit.instant.client/InstantClient

InstantClient

class InstantClient

The entry point to Nutrient Instant, representing a client’s connection to the Instant Server (Nutrient Document Engine).

Properties

val dataPath: String

val serverUrl: String

Functions

open fun create(@NonNull context: Context, @NonNull serverUrl: String): InstantClient

open fun create(@NonNull context: Context, @NonNull serverUrl: URL): InstantClient

open fun create(@NonNull context: Context, @NonNull serverUrl: HttpUrl): InstantClient

Creates Instant Server (Nutrient Document Engine) client that is going to connect to server at serverUrl.

getInstantDocumentDescriptorForJwt

open fun getInstantDocumentDescriptorForJwt(@NonNull jwt: String): InstantDocumentDescriptor

Returns the document descriptor matching the data encoded in the given JWT.

getLocalDocumentDescriptors

open fun getLocalDocumentDescriptors(): List<InstantDocumentDescriptor>

Returns document descriptors for locally cached documents.

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

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

openDocumentAsync

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

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

removeLocalStorage

open fun removeLocalStorage()

Removes local storage for this client.

removeLocalStorageForDocument

open fun removeLocalStorageForDocument(@NonNull documentId: String)

Invalidates all layers of the document with the given ID and removes its local storage.