nutrient/com.pspdfkit.document/DocumentSource

DocumentSource

class DocumentSource

Represents a document source which may be a DataProvider or a file Uri.

Constructors

constructor(@NonNull fileUri: Uri)

Creates a new DocumentSource with file Uri as a source.

constructor(@NonNull fileUri: Uri, @Nullable password: String)

Creates a new DocumentSource with file Uri as a source.

constructor(@NonNull fileUri: Uri, @Nullable password: String, @Nullable contentSignature: String)

Creates a new DocumentSource with file Uri as a source.

constructor(@NonNull dataProvider: DataProvider)

Creates a new DocumentSource with a DataProvider as a source.

constructor(@NonNull dataProvider: DataProvider, @Nullable password: String)

Creates a new DocumentSource with a DataProvider as a source.

constructor(@NonNull dataProvider: DataProvider, @Nullable password: String, @Nullable contentSignature: String)

Creates a new DocumentSource with a DataProvider as a source.

Properties

val checkpointFile: File

The checkpoint file for incremental loading.

contentSignature

val contentSignature: String

The RSA encrypted SHA256 hash of the document if required by license.

val dataProvider: DataProvider

The data provider if this source uses a custom data provider.

val fileUri: Uri

The file URI if this source is a file-based source.

val password: String

The password to unlock the document.

open val uid: String

Holds the UID of the URI-based or file-based source.

Functions

cloneWithPassword

open fun cloneWithPassword(@Nullable newPassword: String): DocumentSource

Returns a copy of this source with new password set.

open fun equals(o: Any): Boolean

Compares this document source to another object for equality.

getDataProviderFromDocumentSource

fun DocumentSource.getDataProviderFromDocumentSource(): ERROR CLASS: Symbol not found for DataProvider

This function returns the data provider from the DocumentSource. If the document source is a file, it creates a data provider from the file. If the document source is not a file, it returns the data provider from the document source.

open fun hashCode(): Int

Returns a hash code value for this document source.

open fun isFileSource(): Boolean

Returns true if the source is a file URI not a data provider.

open fun isRemoteSource(): Boolean

Returns true if the source is remote (http/https) URL.

open fun toString(): String

Returns a string representation of this document source.