@empathyco/x-components/types/x-modules/history-queries/events.types.d.ts

Empathy X Components

import type { HistoryQuery } from '@empathyco/x-types';
/**
 * Dictionary of the events of HistoryQueries XModule, where each key is the event name, and the
 * value is the event payload type or `void` if it has no payload.
 *
 * @public
 */
export interface HistoryQueriesXEvents {
    /**
     * The current history queries have been displayed to the user.
     * Payload: The displayed history queries.
     */
    HistoryQueriesDisplayed: HistoryQuery[];
    /**
     * The query for searching inside the history-queries has changed.
     * Payload: The history-queries query.
     */
    HistoryQueriesQueryChanged: string;
    /**
     * The key for saving the history queries in to the browser storage has changed.
     * Payload: The new history-queries storage key.
     */
    HistoryQueriesStorageKeyChanged: string;
    /**
     * The queries made in the current session have changed
     * Payload: The session history queries.
     */
    SessionHistoryQueriesChanged: HistoryQuery[];
    /**
     * The user pressed the button for clearing all the history queries.
     * Payload: none.
     */
    UserPressedClearHistoryQueries: void;
    /**
     * The user pressed the button for removing a single
     * {@link @empathyco/x-types#HistoryQuery | history query}.
     * Payload: The `HistoryQuery` to remove.
     */
    UserPressedRemoveHistoryQuery: HistoryQuery;
    /**
     * The user has selected a history-query.
     * Payload: The {@link @empathyco/x-types#HistoryQuery | history query} selected.
     */
    UserSelectedAHistoryQuery: HistoryQuery;
    /**
     * The user has clicked a control to enable the history queries.
     * Payload: None.
     */
    UserClickedEnableHistoryQueries: void;
    /**
     * The user has clicked a control to disable the history queries.
     * Payload: None.
     */
    UserClickedDisableHistoryQueries: void;
    /**
     * The user has clicked the confirm button to disable the history queries.
     * Payload: None.
     */
    UserClickedConfirmDisableHistoryQueries: void;
    /**
     * The user has clicked the dismiss button to keep enabled the history queries.
     * Payload: None.
     */
    UserClickedDismissDisableHistoryQueries: void;
}
//# sourceMappingURL=events.types.d.ts.map