colibrio-reader-framework/com.colibrio.readingsystem.base/ReaderView/goTo

goTo

abstract fun goTo(locator: SimpleLocatorData, onSuccess: () -> Unit = {}, onError: (ColibrioException) -> Unit = {})

Go to a specific location in a ReaderDocument that has been added to this ReaderView.

Parameters

locator

  • Locator to which ReaderView should navigate Calls onSuccess when the active renderer has navigated to the new location. Calls onError if the locator was invalid, or the locator could not be resolved to a ReaderDocument in this ReaderView. Calls onError with errorType set to "ABORTED" if goTo() or goToStart() is called again before this call to goTo() had completed successfully.

abstract suspend fun goTo(locator: SimpleLocatorData): ColibrioResult<Unit>

Go to a specific location in a ReaderDocument that has been added to this ReaderView.

Return

Either ColibrioResult.Success when the active renderer has navigated to the new location, or ColibrioResult.Error with errorType set to "ABORTED" if goTo() or goToStart() is called again before this call to goTo() had completed successfully, or if the locator was invalid, or the locator could not be resolved to a ReaderDocument in this ReaderView

Parameters

locator

  • Locator to which ReaderView should navigate

abstract fun goTo(locator: SimpleLocatorData, options: ReaderViewGotoOptions, onSuccess: () -> Unit = {}, onError: (ColibrioException) -> Unit = {})

Go to a specific location in a ReaderDocument that has been added to this ReaderView.

Parameters

options

  • Additional options configuring how the goTo() should behave.

locator

  • Locator to which ReaderView should navigate Calls onSuccess when the active renderer has navigated to the new location. Calls onError if the locator was invalid, or the locator could not be resolved to a ReaderDocument in this ReaderView. Calls onError with errorType set to "ABORTED" if goTo() or goToStart() is called again before this call to goTo() had completed successfully.

abstract suspend fun goTo(locator: SimpleLocatorData, options: ReaderViewGotoOptions): ColibrioResult<Unit>

Go to a specific location in a ReaderDocument that has been added to this ReaderView.

Return

Either ColibrioResult.Success when the active renderer has navigated to the new location, or ColibrioResult.Error with errorType set to "ABORTED" if goTo() or goToStart() is called again before this call to goTo() had completed successfully, if the locator was invalid, or the locator could not be resolved to a ReaderDocument in this ReaderView.

Parameters

options

  • Additional options configuring how the goTo() should behave.

locator

  • Locator to which ReaderView should navigate