colibrio-reader-framework/com.colibrio.readingsystem.base/PageProgressionTimeline/fetchPositionFromLocator

fetchPositionFromLocator

abstract fun fetchPositionFromLocator(locator: SimpleLocatorData, onSuccess: (PageProgressionTimelinePositionData) -> Unit, onError: (ColibrioException) -> Unit)

Fetch a timeline position from a locator.

If timelineType is not PageProgressionTimelineType.FIXED_PAGES, the resolved PageProgressionTimelinePosition will be "volatile" and may no longer be valid after OnPageProgressionTimelineEventListener.onPageProgressionTimelineRecalculated has been called.

If a position could be fetched, onSuccess will be called. onError will be called if the passed locator cannot be resolved to a readerDocument in the ReaderView.

abstract suspend fun fetchPositionFromLocator(locator: SimpleLocatorData): ColibrioResult<PageProgressionTimelinePositionData>

Fetch a timeline position from a locator.

If timelineType is not PageProgressionTimelineType.FIXED_PAGES, the resolved PageProgressionTimelinePosition will be "volatile" and may no longer be valid after OnPageProgressionTimelineEventListener.onPageProgressionTimelineRecalculated has been called.

Return

Either ColibrioResult.Success with the result if a position could be fetched, or ColibrioResult.Error if the passed locator cannot be resolved to a readerDocument in the ReaderView.