IDocumentIndex | Colibrio Reader Framework API

A JSON object represents an indexed document.

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

Hierarchy

IDocumentIndex

Index

Properties

contentBlocks

contentBlocks: IContentBlockData[]

List of content blocks that this document represents. The blocks are ordered in document order.

documentMetadata

documentMetadata: IDocumentIndexedMetadata

Content document metadata.

hasIndexingErrors

hasIndexingErrors: boolean

If there was any error while indexing.

locator

locator: Locator

Locator that identifies the content document.

revision

revision: string

A unique string identifying the revision of this indexed document.

It is RECOMMENDED to create this string by creating a SHA-1 hash of all content in this object and all descendants. The input to the SHA-1 digest algorithm is created by performing a JSON.stringify on all properties in this object (except the 'revision' property itself) in alphabetic order. To get a deterministic result, properties of child objects should be created in alphabetic order as well.