Options
All
  • Public
  • Public/Protected
  • All
Menu

Used for emitting EngineEvents related to Cloud License Reading Sessions.

Hierarchy

Index

Properties

Readonly cancelable

cancelable: boolean

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

Readonly defaultPrevented

defaultPrevented: boolean

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

Readonly immediatePropagationStopped

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

Readonly 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".

Readonly propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

Readonly publicationToken

publicationToken: string

The publication token of the reading session.

Readonly readerView

readerView: IReaderView

The ReaderView instance this event is related to, if any.

Readonly reason

reason: string

Additional information why the Cloud license server blocked the reading session. Only set if 'type' is 'licenseReadingSessionBlocked'

Readonly type

The type of event.

Readonly userToken

userToken: string

The user token of the reading session.

Methods

preventDefault

  • preventDefault(): void
  • Prevent the event's default action. See the respective engine event for its definition of default action.

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

stopPropagation

  • stopPropagation(): void
  • Stops this event from propagating to listeners on the ReadingSystemEngine instance, if called from a listener added to a ReaderView instance. If the event has already propagated to the ReadingSystemEngine instance, calling this method has no effect.

    Returns void

toJSON

Generated using TypeDoc