nutrient/com.pspdfkit.document.library/LibraryDataSource

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.

See LibraryFileSystemDataSource for a file system-based implementation.

Inheritors

LibraryFileSystemDataSource

Functions

documentSourceForLibrary

abstract fun documentSourceForLibrary(uid: String): DocumentSource?

Asks the data source for a document source with the specified UID.

libraryDidFinishIndexingDocument

open fun libraryDidFinishIndexingDocument(uid: String, success: Boolean)

Called after the library indexes a document.

libraryDidRemoveDocument

open fun libraryDidRemoveDocument(uid: String)

Called after the library removes a document from its index.

libraryWillBeginIndexing

open fun libraryWillBeginIndexing()

Notifies the data source that the library is about to begin the indexing process. Perform any required setup here.

uidsOfDocumentsToBeIndexedByLibrary

abstract fun uidsOfDocumentsToBeIndexedByLibrary(): List<String>

Asks the data source for the UIDs of the documents to be indexed by the library. This method should not return any UIDs that are already indexed, or they will be reindexed. This is useful in cases when the document was modified, and its contents changed and therefore need the index to be updated as well.

uidsOfDocumentsToBeRemovedFromLibrary

abstract fun uidsOfDocumentsToBeRemovedFromLibrary(): List<String>

Asks the data source for the UIDs for documents to be removed. This method will be called by the library at the start of its indexing process to allow for removal of any non-existing documents.