pspdfkit/com.pspdfkit.instant.client/InstantClient

InstantClient

class InstantClient

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

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
@NonNull
open fun create(@NonNull context: Context, @NonNull serverUrl: String): InstantClient
@NonNull
open fun create(@NonNull context: Context, @NonNull serverUrl: URL): InstantClient
@NonNull
open fun create(@NonNull context: Context, @NonNull serverUrl: HttpUrl): InstantClient
Creates Instant Server (PSPDFKit Document Engine) client that is going to connect to server at serverUrl.
Link copied to clipboard
@NonNull
open fun getInstantDocumentDescriptorForJwt(@NonNull jwt: String): InstantDocumentDescriptor
Returns the document descriptor matching the data encoded in the given JWT.
Link copied to clipboard
@NonNull
open fun getLocalDocumentDescriptors(): List<InstantDocumentDescriptor>
Returns document descriptors for locally cached documents.
Link copied to clipboard
@NonNull
open fun openDocument(@NonNull jwt: String): InstantPdfDocument
Downloads and opens document from Instant Server (PSPDFKit Document Engine) synchronously.
Link copied to clipboard
@NonNull
open fun openDocumentAsync(@NonNull jwt: String): Single<InstantPdfDocument>
Downloads and opens document from Instant Server (PSPDFKit Document Engine), asynchronously.
Link copied to clipboard
open fun removeLocalStorage()
Removes local storage for this client.
Link copied to clipboard
open fun removeLocalStorageForDocument(@NonNull documentId: String)
Invalidates all layers of the document with the given ID and removes its local storage.