@empathyco/x-components
Version:
Empathy X Components
249 lines (107 loc) • 3.91 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)
## HistoryQueriesXEvents interface
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.
**Signature:**
```typescript
export interface HistoryQueriesXEvents
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[HistoryQueriesDisplayed](./x-components.historyqueriesxevents.historyqueriesdisplayed.md)
</td><td>
</td><td>
HistoryQuery\[\]
</td><td>
The current history queries have been displayed to the user. Payload: The displayed history queries.
</td></tr>
<tr><td>
[HistoryQueriesQueryChanged](./x-components.historyqueriesxevents.historyqueriesquerychanged.md)
</td><td>
</td><td>
string
</td><td>
The query for searching inside the history-queries has changed. Payload: The history-queries query.
</td></tr>
<tr><td>
[HistoryQueriesStorageKeyChanged](./x-components.historyqueriesxevents.historyqueriesstoragekeychanged.md)
</td><td>
</td><td>
string
</td><td>
The key for saving the history queries in to the browser storage has changed. Payload: The new history-queries storage key.
</td></tr>
<tr><td>
[SessionHistoryQueriesChanged](./x-components.historyqueriesxevents.sessionhistoryquerieschanged.md)
</td><td>
</td><td>
HistoryQuery\[\]
</td><td>
The queries made in the current session have changed Payload: The session history queries.
</td></tr>
<tr><td>
[UserClickedConfirmDisableHistoryQueries](./x-components.historyqueriesxevents.userclickedconfirmdisablehistoryqueries.md)
</td><td>
</td><td>
void
</td><td>
The user has clicked the confirm button to disable the history queries. Payload: None.
</td></tr>
<tr><td>
[UserClickedDisableHistoryQueries](./x-components.historyqueriesxevents.userclickeddisablehistoryqueries.md)
</td><td>
</td><td>
void
</td><td>
The user has clicked a control to disable the history queries. Payload: None.
</td></tr>
<tr><td>
[UserClickedDismissDisableHistoryQueries](./x-components.historyqueriesxevents.userclickeddismissdisablehistoryqueries.md)
</td><td>
</td><td>
void
</td><td>
The user has clicked the dismiss button to keep enabled the history queries. Payload: None.
</td></tr>
<tr><td>
[UserClickedEnableHistoryQueries](./x-components.historyqueriesxevents.userclickedenablehistoryqueries.md)
</td><td>
</td><td>
void
</td><td>
The user has clicked a control to enable the history queries. Payload: None.
</td></tr>
<tr><td>
[UserPressedClearHistoryQueries](./x-components.historyqueriesxevents.userpressedclearhistoryqueries.md)
</td><td>
</td><td>
void
</td><td>
The user pressed the button for clearing all the history queries. Payload: none.
</td></tr>
<tr><td>
[UserPressedRemoveHistoryQuery](./x-components.historyqueriesxevents.userpressedremovehistoryquery.md)
</td><td>
</td><td>
HistoryQuery
</td><td>
The user pressed the button for removing a single [history query](./x-types.historyquery.md)<!-- -->. Payload: The `HistoryQuery` to remove.
</td></tr>
<tr><td>
[UserSelectedAHistoryQuery](./x-components.historyqueriesxevents.userselectedahistoryquery.md)
</td><td>
</td><td>
HistoryQuery
</td><td>
The user has selected a history-query. Payload: The [history query](./x-types.historyquery.md) selected.
</td></tr>
</tbody></table>