Options
All
  • Public
  • Public/Protected
  • All
Menu

Used for events related to Colibrio License Server validation.

licenseReadingSessionBlocked

Event fired when Colibrio License server decided to block the Reading Session. This can happen:

  • if the License API key or secret is invalid.
  • if the device is offline and there is no Offline Reading Session available on the device.

If the Reading Session is blocked continuously for a grace period exceeding 30 days, the Reading system functionality may be limited. Please refer to your Product Commercial Agreement for details.

licenseReadingSessionContinued

Event fired when Colibrio License server continued an existing Reading Session instead of registering a new one. The Offline Reading Session stored on the device is also updated.

licenseReadingSessionOffline

Event fired when device is offline, but an Offline Reading Session is available.

licenseReadingSessionStarted

Event fired when a new Reading Session has been registered with the Colibrio License server. The Reading Session is also stored on the device (Offline Reading Session) and will be valid for the duration defined in your Product Commercial Agreement.

Hierarchy

Index

Properties

cancelable

cancelable: boolean

IF this event's default action is cancelable. See respective engine event for its definition of default action.

nativeignore

defaultPrevented

defaultPrevented: boolean

If this event's default action has been canceled/prevented by a call to preventDefault()

nativeignore

immediatePropagationStopped

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

nativeignore

isTrusted

isTrusted: boolean

If this event runs in a "trusted" context, i.e. the event callback is executed during a user-generated event such as "click" or "pointerdown".

nativeignore

objectType

The type of engine event object this JSON structure represents.

default

LICENSE_ENGINE_EVENT

propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

nativeignore

publicationToken

publicationToken: string

The publication token of the reading session.

readerViewName

readerViewName: string

The name of the ReaderView this event is related to, if any.

nativeignore

reason

reason: string

Additional information why the Colibrio License Server blocked the reading session. Only set if 'type' is 'licenseReadingSessionBlocked'

type

The type of event.

userToken

userToken: string

The user token of the reading session.

Generated using TypeDoc