ABB Ability™ History UI SDK - Client API Reference
    Preparing search index...

    Interface IManualEvent<T>

    A Manual Reset Event - the event stays in signaled state until reset.

    interface IManualEvent<T> {
        get EventData(): T;
        get IsSignaled(): boolean;
        AddListener(listener: (eventdata: T) => void, onlyonce?: boolean): void;
        Fire(eventdata: T, safe?: boolean): void;
        RemoveListener(listener: (eventdata: T) => void): void;
        Reset(): void;
        Then(dothis: (eventdata: T) => void): void;
        Wait(): Promise<T>;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Accessors

    EventData IsSignaled

    Methods

    AddListener Fire RemoveListener Reset Then Wait

    Accessors

    • get EventData(): T

      Get the event data or null if the event is in unsignaled state.

      Returns T

    • get IsSignaled(): boolean

      The event signaled state.

      Returns boolean

    Methods

    • Add a listener for the event.

      Parameters

      • listener: (eventdata: T) => void

        The event listener callback, the event data passed as parameter

      • Optionalonlyonce: boolean

        The event listener callback will only be triggered the first time the event occurs. (Automatically removed after the

      Returns void

    • Signal the event.

      Parameters

      • eventdata: T

        The event data for the event.

      • Optionalsafe: boolean

        Catch exceptions from individual event listeners.

      Returns void

    • Remove a listener of the event.

      Parameters

      • listener: (eventdata: T) => void

        The event listener callback to be removed.

      Returns void

    • Reset the event to unsignaled state.

      Returns void

    • When the event is in signaled state run the specified callback. Will be only run once and then automatically removed from the event listeners.

      Parameters

      • dothis: (eventdata: T) => void

        The callback to run when the event is signaled.

      Returns void

    • Wait once for the event to be signaled

      Returns Promise<T>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods