nutrient/com.pspdfkit.document/DocumentSource

DocumentSource

class DocumentSource

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

Constructors

DocumentSource

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

checkpointFile

@Nullable

val checkpointFile: File

contentSignature

@Nullable

@get:Nullable

val contentSignature: String

dataProvider

@Nullable

@get:Nullable

val dataProvider: DataProvider

fileUri

@Nullable

@get:Nullable

val fileUri: Uri

password

@Nullable

@get:Nullable

val password: String

uid

@Nullable

@get:NonNull

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.

equals

open fun equals(o: Any): Boolean

hashCode

open fun hashCode(): Int

isFileSource

open fun isFileSource(): Boolean

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

isRemoteSource

open fun isRemoteSource(): Boolean

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

toString

open fun toString(): String