SearchResultItem

data class SearchResultItem(val locator: SimpleLocatorData, val matchingText: String, val readerDocumentIndexInSpine: Int, val textAfter: String, val textBefore: String)

Represents a search result item containing a search match.

Constructors

fun SearchResultItem(locator: SimpleLocatorData, matchingText: String, readerDocumentIndexInSpine: Int, textAfter: String, textBefore: String)

fun serialize(generator: JsonGenerator)

The locator pointing to the matching text in the publication.

The matching text as found in the ReaderDocument.

The index of the ReaderDocument in the ReaderPublication spine where the match was found.

The text in the ReaderDocument just after the matching text. To configure this field, see TextSearchResultOptions.numberOfCharactersAfter.

The text in the ReaderDocument just before the matching text. To configure this field, see TextSearchResultOptions.numberOfCharactersBefore.