Return the debug info about this component.
Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Follows the last query. The user will start receiving email notifications when the query results change.
Also logs the searchAlertsFollowQuery
event in the usage analytics with the name of the request as meta data.
Return the bindings, or environment, for the current component.
Opens the Manage Alerts panel. This panel allows the end user to stop following queries or items. It also allows the end user to specify email notification frequency for each followed query or item.
Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
If there is multiple component bound to the current HTMLElement, you must specify the component class.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for different components. Mainly used by ResultLink.
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
A reference to a SearchAlertsMessage component that the SearchAlerts component uses to display messages.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
A reference to the Analytics.client.
Specifies whether to add the Follow Query item in the Settings menu to allow the end user to follow the last query.
Clicking the Follow Query item calls the SearchAlerts.followQuery method.
Default value is true
.
data-enable-follow-query='true' data-enable-follow-query='false'
Specifies whether to add the Manage Alerts item in the Settings menu to allow the end user to manage search alerts.
Clicking the Manage Alerts item calls the SearchAlerts.openPanel method.
Default value is true
.
data-enable-manage-panel='true' data-enable-manage-panel='false'
Specifies whether to display info and error messages when performing search alerts actions.
If this options is true
, the SearchAlerts constructor will automatically instantiate a
SearchAlertsMessage component and set it to the SearchAlerts.message attribute.
See also SearchAlerts.options.messageCloseDelay.
Default value is true
.
data-enable-message='true' data-enable-message='false'
If SearchAlerts.options.enableMessage is true
, specifies how long to display the search alert messages
(in milliseconds).
Default value is 2000
. Minimum value is 0
.
data-message-close-delay='10'
Specifies which field to use to represent the modification date when sending the ISubscriptionQueryRequest.
Default value is undefined
.
data-modified-date-field='@foo'
Creates a new SearchAlerts component.
The HTMLElement on which to instantiate the component.
The options for the SearchAlerts component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).
The Search Alerts component renders items in the Settings menu that allow the end user to follow queries and to manage search alerts. A user following a query receives email notifications when the query results change.
Note:
See also the FollowItem component.