Interface IDocumentIndexProvider

Provides methods to fetch index data about a document within a publication.

deprecated: Use the new API available at ReadingSystemEngine.getReaderDocumentSearch() instead.

Hierarchy

IDocumentIndexProvider

Index

Methods

Methods

fetchContentBlockTree

fetchContentBlockTree(): Promise<IContentBlockTree>

Fetch all content blocks in this document.

Returns Promise<IContentBlockTree>

fetchDocumentIndex

fetchDocumentIndex(): Promise<IDocumentIndex>

Fetch the full document index which is a serializable JSON object of this instance.

Returns Promise<IDocumentIndex>

fetchDocumentIndexedMetadata

fetchDocumentIndexedMetadata(): Promise<IDocumentIndexedMetadata>

Fetch all metadata about this document. This does not include metadata that is inlined with content blocks.

Returns Promise<IDocumentIndexedMetadata>

getLocator

getLocator(): Locator

Get the Locator for this document.

Returns Locator

Generated using TypeDoc