nutrient/com.pspdfkit.document.library

Package-level declarations

Full-text search API.

Types

FileIndexItemDescriptor

data class FileIndexItemDescriptor(val documentPath: String, val documentUid: String)

Descriptor containing metadata for a file index item.

IndexingOptions

data class IndexingOptions(val ignoreAnnotations: Boolean = false, val ignoreDocumentText: Boolean = false)

Options that can be passed to PdfLibrary.enqueueDocuments.

LibraryDataSource

interface LibraryDataSource

The LibraryDataSource interface is adopted by an object that provides the documents to be indexed by a PdfLibrary. These methods will not be called on the main thread, and can take long to execute.

LibraryFileSystemDataSource

class LibraryFileSystemDataSource(library: PdfLibrary, documentsDirectory: File, documentHandler: (DocumentSource) -> Boolean? = null) : LibraryDataSource

A library data source that indexes all documents in a specified directory. This class will automatically add and remove files from the library based on changes in the directory.

LibraryIndexingListener

interface LibraryIndexingListener

Listener to monitor indexing progress.

LibraryIndexStatus

open class LibraryIndexStatus

Object representing indexing status for a document.

PdfLibrary

class PdfLibrary(path: String, tokenizer: PdfLibrary.TokenizerType? = null)

PdfLibrary implements a SQLite-based full-text-search engine. You can register documents to be indexed in the background and then search for keywords within that collection. There can be multiple libraries, although usually one is enough for the common use case.

QueryOptions

open class QueryOptions

Detailed options for querying the FTS database.

QueryPreviewResult

open class QueryPreviewResult

Result from a FTS search which includes preview entries.

QueryResultListener

interface QueryResultListener

Listener for document search query.