eligius
    Preparing search index...

    Interface IEventbus

    interface IEventbus {
        broadcast<
            E extends
                | "before-request-timeline-uri"
                | "before-request-video-url"
                | "dom-mutation"
                | "highlight-navigation"
                | "language-change"
                | "navigate-to-video-url"
                | "push-history-state"
                | "request-action"
                | "request-current-language"
                | "request-current-navigation"
                | "request-current-timeline-position"
                | "request-current-video-position"
                | "request-engine-root"
                | "request-function"
                | "request-instance"
                | "request-label-collection"
                | "request-label-collections"
                | "request-timeline-cleanup"
                | "request-timeline-uri"
                | "request-video-cleanup"
                | "request-video-url"
                | "timeline-complete"
                | "timeline-container-request"
                | "timeline-current-timeline-change"
                | "timeline-duration"
                | "timeline-duration-request"
                | "timeline-firstframe"
                | "timeline-pause"
                | "timeline-pause-request"
                | "timeline-play"
                | "timeline-play-request"
                | "timeline-play-toggle-request"
                | "timeline-request-current-timeline"
                | "timeline-resize"
                | "timeline-resize-request"
                | "timeline-restart"
                | "timeline-seek"
                | "timeline-seek-request"
                | "timeline-seeked"
                | "timeline-stop"
                | "timeline-stop-request"
                | "timeline-time"
                | "video-complete",
        >(
            eventName: E,
            args: EventMap[E],
        ): void;
        broadcastForTopic<
            E extends
                | "before-request-timeline-uri"
                | "before-request-video-url"
                | "dom-mutation"
                | "highlight-navigation"
                | "language-change"
                | "navigate-to-video-url"
                | "push-history-state"
                | "request-action"
                | "request-current-language"
                | "request-current-navigation"
                | "request-current-timeline-position"
                | "request-current-video-position"
                | "request-engine-root"
                | "request-function"
                | "request-instance"
                | "request-label-collection"
                | "request-label-collections"
                | "request-timeline-cleanup"
                | "request-timeline-uri"
                | "request-video-cleanup"
                | "request-video-url"
                | "timeline-complete"
                | "timeline-container-request"
                | "timeline-current-timeline-change"
                | "timeline-duration"
                | "timeline-duration-request"
                | "timeline-firstframe"
                | "timeline-pause"
                | "timeline-pause-request"
                | "timeline-play"
                | "timeline-play-request"
                | "timeline-play-toggle-request"
                | "timeline-request-current-timeline"
                | "timeline-resize"
                | "timeline-resize-request"
                | "timeline-restart"
                | "timeline-seek"
                | "timeline-seek-request"
                | "timeline-seeked"
                | "timeline-stop"
                | "timeline-stop-request"
                | "timeline-time"
                | "video-complete",
        >(
            eventName: E,
            eventTopic: string,
            args: EventMap[E],
        ): void;
        clear(): void;
        off<
            E extends
                | "before-request-timeline-uri"
                | "before-request-video-url"
                | "dom-mutation"
                | "highlight-navigation"
                | "language-change"
                | "navigate-to-video-url"
                | "push-history-state"
                | "request-action"
                | "request-current-language"
                | "request-current-navigation"
                | "request-current-timeline-position"
                | "request-current-video-position"
                | "request-engine-root"
                | "request-function"
                | "request-instance"
                | "request-label-collection"
                | "request-label-collections"
                | "request-timeline-cleanup"
                | "request-timeline-uri"
                | "request-video-cleanup"
                | "request-video-url"
                | "timeline-complete"
                | "timeline-container-request"
                | "timeline-current-timeline-change"
                | "timeline-duration"
                | "timeline-duration-request"
                | "timeline-firstframe"
                | "timeline-pause"
                | "timeline-pause-request"
                | "timeline-play"
                | "timeline-play-request"
                | "timeline-play-toggle-request"
                | "timeline-request-current-timeline"
                | "timeline-resize"
                | "timeline-resize-request"
                | "timeline-restart"
                | "timeline-seek"
                | "timeline-seek-request"
                | "timeline-seeked"
                | "timeline-stop"
                | "timeline-stop-request"
                | "timeline-time"
                | "video-complete",
        >(
            eventName: E,
            eventHandler: (...args: EventMap[E]) => void,
            eventTopic?: string,
        ): void;
        on<
            E extends
                | "before-request-timeline-uri"
                | "before-request-video-url"
                | "dom-mutation"
                | "highlight-navigation"
                | "language-change"
                | "navigate-to-video-url"
                | "push-history-state"
                | "request-action"
                | "request-current-language"
                | "request-current-navigation"
                | "request-current-timeline-position"
                | "request-current-video-position"
                | "request-engine-root"
                | "request-function"
                | "request-instance"
                | "request-label-collection"
                | "request-label-collections"
                | "request-timeline-cleanup"
                | "request-timeline-uri"
                | "request-video-cleanup"
                | "request-video-url"
                | "timeline-complete"
                | "timeline-container-request"
                | "timeline-current-timeline-change"
                | "timeline-duration"
                | "timeline-duration-request"
                | "timeline-firstframe"
                | "timeline-pause"
                | "timeline-pause-request"
                | "timeline-play"
                | "timeline-play-request"
                | "timeline-play-toggle-request"
                | "timeline-request-current-timeline"
                | "timeline-resize"
                | "timeline-resize-request"
                | "timeline-restart"
                | "timeline-seek"
                | "timeline-seek-request"
                | "timeline-seeked"
                | "timeline-stop"
                | "timeline-stop-request"
                | "timeline-time"
                | "video-complete",
        >(
            eventName: E,
            eventHandler: (...args: EventMap[E]) => void,
            eventTopic?: string,
        ): TEventbusRemover;
        once<
            E extends
                | "before-request-timeline-uri"
                | "before-request-video-url"
                | "dom-mutation"
                | "highlight-navigation"
                | "language-change"
                | "navigate-to-video-url"
                | "push-history-state"
                | "request-action"
                | "request-current-language"
                | "request-current-navigation"
                | "request-current-timeline-position"
                | "request-current-video-position"
                | "request-engine-root"
                | "request-function"
                | "request-instance"
                | "request-label-collection"
                | "request-label-collections"
                | "request-timeline-cleanup"
                | "request-timeline-uri"
                | "request-video-cleanup"
                | "request-video-url"
                | "timeline-complete"
                | "timeline-container-request"
                | "timeline-current-timeline-change"
                | "timeline-duration"
                | "timeline-duration-request"
                | "timeline-firstframe"
                | "timeline-pause"
                | "timeline-pause-request"
                | "timeline-play"
                | "timeline-play-request"
                | "timeline-play-toggle-request"
                | "timeline-request-current-timeline"
                | "timeline-resize"
                | "timeline-resize-request"
                | "timeline-restart"
                | "timeline-seek"
                | "timeline-seek-request"
                | "timeline-seeked"
                | "timeline-stop"
                | "timeline-stop-request"
                | "timeline-time"
                | "video-complete",
        >(
            eventName: E,
            eventHandler: (...args: EventMap[E]) => void,
            eventTopic?: string,
        ): TEventbusRemover;
        onRequest<T>(
            eventName: string,
            responder: TRequestResponder<T>,
            eventTopic?: string,
        ): TEventbusRemover;
        registerEventlistener(
            eventbusListener: IEventbusListener,
        ): TEventbusRemover;
        registerInterceptor(
            eventName: string,
            interceptor: IEventbusInterceptor,
            eventTopic?: string,
        ): TEventbusRemover;
        request<T>(eventName: string, ...args: unknown[]): T | undefined;
        requestForTopic<T>(
            eventName: string,
            eventTopic: string,
            ...args: unknown[],
        ): T | undefined;
    }

    Implemented by

    Index

    Methods

    broadcast broadcastForTopic clear off on once onRequest registerEventlistener registerInterceptor request requestForTopic

    Methods

    • Type Parameters

      • E extends
            | "before-request-timeline-uri"
            | "before-request-video-url"
            | "dom-mutation"
            | "highlight-navigation"
            | "language-change"
            | "navigate-to-video-url"
            | "push-history-state"
            | "request-action"
            | "request-current-language"
            | "request-current-navigation"
            | "request-current-timeline-position"
            | "request-current-video-position"
            | "request-engine-root"
            | "request-function"
            | "request-instance"
            | "request-label-collection"
            | "request-label-collections"
            | "request-timeline-cleanup"
            | "request-timeline-uri"
            | "request-video-cleanup"
            | "request-video-url"
            | "timeline-complete"
            | "timeline-container-request"
            | "timeline-current-timeline-change"
            | "timeline-duration"
            | "timeline-duration-request"
            | "timeline-firstframe"
            | "timeline-pause"
            | "timeline-pause-request"
            | "timeline-play"
            | "timeline-play-request"
            | "timeline-play-toggle-request"
            | "timeline-request-current-timeline"
            | "timeline-resize"
            | "timeline-resize-request"
            | "timeline-restart"
            | "timeline-seek"
            | "timeline-seek-request"
            | "timeline-seeked"
            | "timeline-stop"
            | "timeline-stop-request"
            | "timeline-time"
            | "video-complete"

      Parameters

      Returns void

    • Type Parameters

      • E extends
            | "before-request-timeline-uri"
            | "before-request-video-url"
            | "dom-mutation"
            | "highlight-navigation"
            | "language-change"
            | "navigate-to-video-url"
            | "push-history-state"
            | "request-action"
            | "request-current-language"
            | "request-current-navigation"
            | "request-current-timeline-position"
            | "request-current-video-position"
            | "request-engine-root"
            | "request-function"
            | "request-instance"
            | "request-label-collection"
            | "request-label-collections"
            | "request-timeline-cleanup"
            | "request-timeline-uri"
            | "request-video-cleanup"
            | "request-video-url"
            | "timeline-complete"
            | "timeline-container-request"
            | "timeline-current-timeline-change"
            | "timeline-duration"
            | "timeline-duration-request"
            | "timeline-firstframe"
            | "timeline-pause"
            | "timeline-pause-request"
            | "timeline-play"
            | "timeline-play-request"
            | "timeline-play-toggle-request"
            | "timeline-request-current-timeline"
            | "timeline-resize"
            | "timeline-resize-request"
            | "timeline-restart"
            | "timeline-seek"
            | "timeline-seek-request"
            | "timeline-seeked"
            | "timeline-stop"
            | "timeline-stop-request"
            | "timeline-time"
            | "video-complete"

      Parameters

      Returns void

    • Type Parameters

      • E extends
            | "before-request-timeline-uri"
            | "before-request-video-url"
            | "dom-mutation"
            | "highlight-navigation"
            | "language-change"
            | "navigate-to-video-url"
            | "push-history-state"
            | "request-action"
            | "request-current-language"
            | "request-current-navigation"
            | "request-current-timeline-position"
            | "request-current-video-position"
            | "request-engine-root"
            | "request-function"
            | "request-instance"
            | "request-label-collection"
            | "request-label-collections"
            | "request-timeline-cleanup"
            | "request-timeline-uri"
            | "request-video-cleanup"
            | "request-video-url"
            | "timeline-complete"
            | "timeline-container-request"
            | "timeline-current-timeline-change"
            | "timeline-duration"
            | "timeline-duration-request"
            | "timeline-firstframe"
            | "timeline-pause"
            | "timeline-pause-request"
            | "timeline-play"
            | "timeline-play-request"
            | "timeline-play-toggle-request"
            | "timeline-request-current-timeline"
            | "timeline-resize"
            | "timeline-resize-request"
            | "timeline-restart"
            | "timeline-seek"
            | "timeline-seek-request"
            | "timeline-seeked"
            | "timeline-stop"
            | "timeline-stop-request"
            | "timeline-time"
            | "video-complete"

      Parameters

      • eventName: E
      • eventHandler: (...args: EventMap[E]) => void
      • OptionaleventTopic: string

      Returns void

    • Type Parameters

      • E extends
            | "before-request-timeline-uri"
            | "before-request-video-url"
            | "dom-mutation"
            | "highlight-navigation"
            | "language-change"
            | "navigate-to-video-url"
            | "push-history-state"
            | "request-action"
            | "request-current-language"
            | "request-current-navigation"
            | "request-current-timeline-position"
            | "request-current-video-position"
            | "request-engine-root"
            | "request-function"
            | "request-instance"
            | "request-label-collection"
            | "request-label-collections"
            | "request-timeline-cleanup"
            | "request-timeline-uri"
            | "request-video-cleanup"
            | "request-video-url"
            | "timeline-complete"
            | "timeline-container-request"
            | "timeline-current-timeline-change"
            | "timeline-duration"
            | "timeline-duration-request"
            | "timeline-firstframe"
            | "timeline-pause"
            | "timeline-pause-request"
            | "timeline-play"
            | "timeline-play-request"
            | "timeline-play-toggle-request"
            | "timeline-request-current-timeline"
            | "timeline-resize"
            | "timeline-resize-request"
            | "timeline-restart"
            | "timeline-seek"
            | "timeline-seek-request"
            | "timeline-seeked"
            | "timeline-stop"
            | "timeline-stop-request"
            | "timeline-time"
            | "video-complete"

      Parameters

      • eventName: E
      • eventHandler: (...args: EventMap[E]) => void
      • OptionaleventTopic: string

      Returns TEventbusRemover

    • Type Parameters

      • E extends
            | "before-request-timeline-uri"
            | "before-request-video-url"
            | "dom-mutation"
            | "highlight-navigation"
            | "language-change"
            | "navigate-to-video-url"
            | "push-history-state"
            | "request-action"
            | "request-current-language"
            | "request-current-navigation"
            | "request-current-timeline-position"
            | "request-current-video-position"
            | "request-engine-root"
            | "request-function"
            | "request-instance"
            | "request-label-collection"
            | "request-label-collections"
            | "request-timeline-cleanup"
            | "request-timeline-uri"
            | "request-video-cleanup"
            | "request-video-url"
            | "timeline-complete"
            | "timeline-container-request"
            | "timeline-current-timeline-change"
            | "timeline-duration"
            | "timeline-duration-request"
            | "timeline-firstframe"
            | "timeline-pause"
            | "timeline-pause-request"
            | "timeline-play"
            | "timeline-play-request"
            | "timeline-play-toggle-request"
            | "timeline-request-current-timeline"
            | "timeline-resize"
            | "timeline-resize-request"
            | "timeline-restart"
            | "timeline-seek"
            | "timeline-seek-request"
            | "timeline-seeked"
            | "timeline-stop"
            | "timeline-stop-request"
            | "timeline-time"
            | "video-complete"

      Parameters

      • eventName: E
      • eventHandler: (...args: EventMap[E]) => void
      • OptionaleventTopic: string

      Returns TEventbusRemover

    • Register a responder for synchronous request/response queries. Only the first registered responder for an event will be called.

      Type Parameters

      • T

      Parameters

      • eventName: string

        The request event name

      • responder: TRequestResponder<T>

        Function that returns the response value

      • OptionaleventTopic: string

        Optional topic for topic-specific responders

      Returns TEventbusRemover

      Function to unregister the responder

    • Send a synchronous request and get an immediate response. Returns undefined if no responder is registered.

      Type Parameters

      • T

      Parameters

      • eventName: string

        The request event name

      • ...args: unknown[]

        Arguments to pass to the responder

      Returns T | undefined

      The response value, or undefined if no responder

    • Send a synchronous request for a specific topic. Returns undefined if no responder is registered for that topic.

      Type Parameters

      • T

      Parameters

      • eventName: string

        The request event name

      • eventTopic: string

        The topic to target

      • ...args: unknown[]

        Arguments to pass to the responder

      Returns T | undefined

      The response value, or undefined if no responder

    Settings

    Member Visibility

    On This Page

    Methods