Interface IH5PContentType<TParams>

interface IH5PContentType<TParams> {
    off: (<TData>(type: string, listener?: ((event: TData) => void)) => void);
    on: (<TData, TType>(type: TType, listener: EventListener<TData, TType>, thisArg?: ThisType<unknown>) => void);
    once: (<TData, TType>(type: TType, listener: EventListener<TData, TType>, thisArg?: ThisType<unknown>) => void);
    params?: TParams;
    trigger: (<TData>(event: unknown, eventData?: TData, extras?: {
        bubbles?: boolean;
        external?: boolean;
    }) => void);
    triggerXAPI: ((verb: XAPIVerb, extra: unknown) => void);
    attach($wrapper: JQuery<HTMLElement>): void;
    createXAPIEventTemplate<TVerb>(verb: TVerb, extra: unknown): XAPIEvent;
}

Type Parameters

  • TParams = unknown

Hierarchy (view full)

Properties

off on once params? trigger triggerXAPI

Methods

attach createXAPIEventTemplate

Properties

off

off: (<TData>(type: string, listener?: ((event: TData) => void)) => void)

Remove event listener If no listener is specified, all listeners will be removed

Type declaration

    • <TData>(type, listener?): void

    • Type Parameters

      • TData = unknown

      Parameters

      • type: string

        Event type

      • Optionallistener: ((event: TData) => void)

        Event listener

          • (event): void

          • Parameters

            Returns void

      Returns void

Throws

listener must be a function

on

on: (<TData, TType>(type: TType, listener: EventListener<TData, TType>, thisArg?: ThisType<unknown>) => void)

Add new event listener

Type declaration

    • <TData, TType>(type, listener, thisArg?): void

    • Type Parameters

      • TData = unknown
      • TType extends string = string

      Parameters

      • type: TType

        Event type. If the event type is xAPI, the listener's event parameter will be of type XAPIEvent. Any dispatched XAPIEvent will trigger the xAPI event.

      • listener: EventListener<TData, TType>

        Event listener

      • OptionalthisArg: ThisType<unknown>

        Optionally specify the listener's this value

      Returns void

Throws

listener must be a function

once

once: (<TData, TType>(type: TType, listener: EventListener<TData, TType>, thisArg?: ThisType<unknown>) => void)

Add new event listener that will be fired only once

Type declaration

    • <TData, TType>(type, listener, thisArg?): void

    • Type Parameters

      • TData = unknown
      • TType extends string = string

      Parameters

      • type: TType

        Event type. If the event type is xAPI, the listener's event parameter will be of type XAPIEvent. Any dispatched XAPIEvent will trigger the xAPI event.

      • listener: EventListener<TData, TType>

        Event listener

      • OptionalthisArg: ThisType<unknown>

        Optionally specify the listener's this value

      Returns void

Throws

listener must be a function

Optionalparams

params?: TParams

trigger

trigger: (<TData>(event: unknown, eventData?: TData, extras?: {
    bubbles?: boolean;
    external?: boolean;
}) => void)

Dispatch event

Type declaration

    • <TData>(event, eventData?, extras?): void

    • Type Parameters

      • TData = unknown

      Parameters

      • event: unknown

        Event object or event type as string

      • OptionaleventData: TData

        Custom event data (used when event type as string is used as first argument)

      • Optionalextras: {
            bubbles?: boolean;
            external?: boolean;
        }
        • Optionalbubbles?: boolean
        • Optionalexternal?: boolean

      Returns void

triggerXAPI

triggerXAPI: ((verb: XAPIVerb, extra: unknown) => void)

Methods

attach

  • attach($wrapper): void

  • Parameters

    Returns void

createXAPIEventTemplate

Settings

Member Visibility

On This Page

Properties
Methods