h5p-types
    Preparing search index...

    Class H5PContentType

    Hierarchy (View Summary)

    Index
    constructor
    off on once trigger triggerXAPI
    createXAPIEventTemplate getLibraryFilePath isRoot setActivityStarted triggerXAPICompleted triggerXAPIScored
    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

    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

    • Returns the file path of a file in the current library

      Parameters

      • filePath: string

        The path to the file relative to the library folder

      Returns string

      The full path to the file

    • Is the library standalone or not? Not being standalone, means it is included in another library

      Returns boolean

    • 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