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

ColibrioReaderFramework

Process-wide configuration for the Colibrio Reader Framework: license credentials, logging and debugging.

Event listeners

Registering the same listener twice has no effect. Removing a listener that is not registered has no effect.

Each event goes to the listeners registered when its dispatch began. You may therefore add or remove listeners from inside a callback. A listener removed during a callback still receives the event being dispatched, and no event after it. A listener added during a callback first receives the next event.

Properties

debugEnabled

var debugEnabled: Boolean

Enable this option to allow remote WebView debugging and to enable logging of WebView console messages to the device log.

diagnosticsEnabled

var diagnosticsEnabled: Boolean

Enable logging of performance diagnostics to the device log.

useNativeResourceProvider

var useNativeResourceProvider: Boolean

This flag controls how the ReadingSystemEngine loads publications when you pass a RandomAccessDataSource.

versionCode

const val versionCode: <Error class: unknown class>

Version code of Colibrio Reader Framework

versionName

const val versionName: <Error class: unknown class>

The semver version name of the Colibrio Reader Framework. For example: "2.0.0-rc.1"

webViewLogLevel

var webViewLogLevel: WebViewLogLevel

Controls which WebView console messages that are logged based on severity.

Functions

addOnLicenseEventListener

fun addOnLicenseEventListener(listener: OnLicenseEventListener)

Adds an instance of OnLicenseEventListener to receive events related to Colibrio License Server validation.

removeOnLicenseEventListener

fun removeOnLicenseEventListener(listener: OnLicenseEventListener)

Removes a previously added instance of OnLicenseEventListener.

setLicenseOptions

fun setLicenseOptions(licenseApiKey: String, licenseApiSecret: String)

Sets the Colibrio License API key and secret to use. This information is provided to you by Colibrio. You MUST call this method before instantiating a ColibrioReadingSystemView.