Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides functionality to index publications and run queries against them.

deprecated

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

Hierarchy

  • IReadingSystemIndexEngine

Implemented by

Index

Methods

dismountReaderPublication

  • Dismounts an IReaderPublication previously mounted with mountReaderPublication(). If the passed readerPublication was not previously mounted, this method does nothing.

    deprecated

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

    Parameters

    Returns void

mountReaderPublication

  • Indexes content and metadata from an IReaderPublication. You can immediately start executing queries on the publication after this method returns.

    deprecated

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

    Parameters

    Returns void

queryPublications

  • Run a query to retrieve a subset of publications that is known by the index engine.

    deprecated

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

    Parameters

    • Optional query: IPublicationQuery

      The query to run. If omitted, the result set will contain all publications known by the index engine.

    Returns IPublicationQueryResultSet

queryReaderDocument

Generated using TypeDoc