Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IEpubCfiResolver

    Used for resolving an EPUB CFI against XML-based documents. Only intended for internal framework usage. Framework users should use ReaderPublication.fetchContentLocation() to resolve EPUB CFI locators to publication content.

    interface IEpubCfiResolver {
        continueResolving(
            targetNode: Element | Document,
            documentUrl: URL,
        ): IEpubCfiIndirectionResult;
        getResolvedTarget(): IEpubCfiResolvedTarget;
        skipNextIndirection(): IEpubCfiIndirectionResult;
    }

    Implemented by

    Methods

    • Resolves a path in the EPUB CFI one document at a time, stopping each time it reaches an indirection instruction.

      Start the resolving by passing the OPF document and its URL. Each time the resolver reaches an indirection instruction, this function returns with an IEpubCfiIndirectionResult with the element containing the reference to the next document. In order to continue the process, pass the document referenced by the element to continueResolving(), or call skipNextIndirection() to not follow the indirection path.

      The resolving is finished when this method returns null.

      Use getResolvedTarget() to get the current state of the resolving process.

      Parameters

      • targetNode: Element | Document

        The document where the resolving should continue.

      • documentUrl: URL

        The URL of the document.

      Returns IEpubCfiIndirectionResult

    Methods