Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface ILicenseEngineEvent

    Used for emitting EngineEvents related to Cloud License Reading Sessions.

    interface ILicenseEngineEvent {
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        propagationStopped: boolean;
        publicationToken: string;
        readerView: IReaderView;
        reason: string;
        type: keyof IEngineEventTypeMap;
        userToken: string;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): ILicenseEngineEventData;
    }

    Hierarchy (View Summary)

    Properties

    cancelable: boolean

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

    defaultPrevented: boolean

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

    immediatePropagationStopped: boolean

    True if stopImmediatePropagation() was called on this event.

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

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    publicationToken: string

    The publication token of the reading session.

    readerView: IReaderView

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

    reason: string

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

    type: keyof IEngineEventTypeMap

    The type of event.

    userToken: string

    The user token of the reading session.

    Methods

    • Prevent the event's default action. See the respective engine event for its definition of default action.

      Returns 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

    Properties
    Methods