h5p-types
    Preparing search index...

    Class H5PRequestQueue

    A queue for requests, will be automatically processed when regaining connection

    Hierarchy (View Summary)

    Index
    constructor
    off on once processingQueue trigger triggerXAPI
    add clearQueue createXAPIEventTemplate displayToastMessage getStoredRequests processQueue resumeQueue setActivityStarted triggerXAPICompleted triggerXAPIScored

    • Parameters

      • Optionaloptions: { showToast?: boolean }
        • OptionalshowToast?: boolean

          Show toast when losing or regaining connection

      Returns H5PRequestQueue

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

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

    Type Declaration

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

      • Type Parameters

        • TData = unknown

        Parameters

        • type: string

          Event type

        • Optionallistener: (event: TData) => void

          Event listener

        Returns void

    listener must be a function

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

    Add new event listener

    Type Declaration

      • <TData = unknown, TType extends string = string>(
            type: TType,
            listener: EventListener<TData, TType>,
            thisArg?: ThisType<unknown>,
        ): 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

    listener must be a function

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

    Add new event listener that will be fired only once

    Type Declaration

      • <TData = unknown, TType extends string = string>(
            type: TType,
            listener: EventListener<TData, TType>,
            thisArg?: ThisType<unknown>,
        ): 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

    listener must be a function

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

    Dispatch event

    Type Declaration

      • <TData = unknown>(
            event: unknown,
            eventData?: TData,
            extras?: { bubbles?: boolean; external?: boolean },
        ): 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 }

        Returns void

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

    • Add request to queue. Only supports posts currently.

      Parameters

      • url: string
      • data: unknown

      Returns boolean

    • Clear stored requests

      Returns boolean

      True if the storage was successfully cleared

    • Display toast message on the first content of current page

      Parameters

      • msg: string

        Message to display

      • OptionalforceShow: boolean

        Force override showing the toast

      • OptionalconfigOverride: unknown

        Override toast message config

      Returns void

    • Get stored requests

      Returns false | StoredRequest[]

      Stored requests, or false if localStorage is unavailable

    • Process first item in the request queue

      Parameters

      • queue: StoredRequest[]

      Returns void

    • Start processing of requests queue

      Returns boolean

      False if it was not possible to resume processing queue

    • Mark the activity as started. Triggers the attempted xAPI event the first time it's called for an instance.

      Returns void

    • Helper function to create xAPI completed events.

      Parameters

      • score: number
      • maxScore: number
      • success: boolean

      Returns void

      Use triggerXAPIScored instead

    • Helper function to create scored xAPI events

      Parameters

      • score: number

        Will be set as the 'raw' value of the score object

      • maxScore: number

        Will be set as the "max" value of the score object

      • verb: XAPIVerb

        Short form of adl verb

      • completion: boolean

        Is this a statement from a completed activity?

      • success: boolean

        Is this a statement from an activity that was done successfully?

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods