nutrient/com.pspdfkit.document.files/EmbeddedFilesProvider

EmbeddedFilesProvider

interface EmbeddedFilesProvider

Handles all embedded files related operations on the owning document. Retrieve it with getEmbeddedFilesProvider.

Types

Link copied to clipboard
interface EmbeddedFilesCallback
Callback interface for progressive embedded files loading.

Functions

Link copied to clipboard
@NonNull
abstract fun getEmbeddedFiles(includeFileAnnotations: Boolean): List<EmbeddedFile>
Returns the list of embedded files in the document.
Link copied to clipboard
@NonNull
abstract fun getEmbeddedFilesAsync(includeFileAnnotations: Boolean): Single<List<EmbeddedFile>>
Returns the list of embedded files in the document, async.
Link copied to clipboard
abstract fun getEmbeddedFilesProgressive(includeFileAnnotations: Boolean, @NonNull callback: EmbeddedFilesProvider.EmbeddedFilesCallback)
Retrieves embedded files progressively, calling the provided callback with files organized by page.
Link copied to clipboard
@NonNull
abstract fun getEmbeddedFileWithFileNameAsync(@NonNull fileName: String, includeFileAnnotations: Boolean): Maybe<EmbeddedFile>
Returns embedded file with file name if it exists, asynchronously.
Link copied to clipboard
@NonNull
abstract fun getEmbeddedFileWithIdAsync(@NonNull id: String, includeFileAnnotations: Boolean): Maybe<EmbeddedFile>
Returns embedded file with given identifier if it exists, asynchronously.
Link copied to clipboard
abstract fun hasEmbeddedFiles(): Boolean
Returns whether the document has any embedded files.