colibrio-reader-framework/com.colibrio.readingsystem.base/NavigationStartedEngineEventData

NavigationStartedEngineEventData

class NavigationStartedEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.NAVIGATION_STARTED_ENGINE_EVENT, val type: EngineEventDataType, val dueToRenderingConfigChanged: Boolean, val navigationAction: NavigationAction, val replacedOngoingNavigation: Boolean) : ReaderViewEngineEventData

Constructors

Link copied to clipboard
fun NavigationStartedEngineEventData(objectType: EngineEventDataObjectType = EngineEventDataObjectType.NAVIGATION_STARTED_ENGINE_EVENT, type: EngineEventDataType, dueToRenderingConfigChanged: Boolean, navigationAction: NavigationAction, replacedOngoingNavigation: Boolean)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun serialize(generator: JsonGenerator)

Properties

Link copied to clipboard
val dueToRenderingConfigChanged: Boolean

The navigation started due to a rendering configuration change such such as updated ReaderViewOptions or Renderer switch.

Link copied to clipboard
val navigationAction: NavigationAction

The type of navigation action that started.

Link copied to clipboard
val objectType: EngineEventDataObjectType

The type of engine event object this JSON structure represents.

Link copied to clipboard
val replacedOngoingNavigation: Boolean

If this navigation replaced an already ongoing navigation action.

Link copied to clipboard
val type: EngineEventDataType

The type of event.