pspdfkit/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.

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

Creates a new DocumentSource with file Uri as a source.

constructor(@Nullable fileUri: Uri, @Nullable dataProvider: DataProvider, @Nullable password: String, @Nullable contentSignature: String, @Nullable checkpointFile: File, checkpointAlreadyCreated: Boolean)

Creates a new DocumentSource with file Uri as a source.

constructor(@NonNull documentSource: DocumentSource, @NonNull checkpoint: File, checkpointAlreadyCreated: Boolean)

Creates a new DocumentSource with a File as a checkpoint source.

Properties

val checkpointFile: File

contentSignature

val contentSignature: String

val dataProvider: DataProvider

val fileUri: Uri

val password: String

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

open fun hashCode(): Int

isCheckpointAlreadyCreated

open fun isCheckpointAlreadyCreated(): Boolean

Indicates whether the checkpoint was already created.

open fun isFileSource(): Boolean

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

toDataDescriptor

open fun toDataDescriptor(): NativeDataDescriptor

Converts the DocumentSource to a NativeDataDescriptor.

open fun toString(): String