Coveo SearchAlerts Component (CoveoSearchAlerts)

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:

It is necessary to meet certain requirements to be able to use this component (see Deploying Search Alerts on a Coveo JS Search Page).

See also the FollowItem component.

Index

Methods

Properties

Accessors

Component Options

Constructors

Methods

debugInfo

  • debugInfo(): any

disable

  • disable(): void

  • 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.

    Returns void

enable

  • enable(): void

  • 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.

    Returns void

followQuery

  • followQuery(): void

  • 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.

    Returns void

getBindings

openPanel

  • openPanel(): Promise<void>

  • 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.

    Returns Promise<void>

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent

  • 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.

    Parameters

    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent

Properties

bind

bind: ComponentEvents

Allows the component to bind events and execute them only when it is enabled.

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

Contains the state of options for different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

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.

disabled

disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

message

message: SearchAlertsMessage

A reference to a SearchAlertsMessage component that the SearchAlerts component uses to display messages.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.

root

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.

Static ID

ID: string

The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton

Accessors

usageAnalytics

Component Options

enableFollowQuery

enableFollowQuery: boolean

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.

Default

true

Markup configuration example(s) :
data-enable-follow-query='true'
data-enable-follow-query='false'

enableManagePanel

enableManagePanel: boolean

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.

Default

true

Markup configuration example(s) :
data-enable-manage-panel='true'
data-enable-manage-panel='false'

enableMessage

enableMessage: boolean

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.

Default

true

Markup configuration example(s) :
data-enable-message='true'
data-enable-message='false'

messageCloseDelay

messageCloseDelay: number

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.

Only effective when

enableMessage is truthy

Minimum

0

Default

2000

Markup configuration example(s) :
data-message-close-delay='10'

modifiedDateField

modifiedDateField: IFieldOption

Specifies which field to use to represent the modification date when sending the ISubscriptionQueryRequest.

Default value is undefined.

Markup configuration example(s) :
data-modified-date-field='@foo'

Constructors

constructor

  • Creates a new SearchAlerts component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • options: ISearchAlertsOptions

      The options for the SearchAlerts component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    • Default value ModalBox: any = ModalBoxModule

    Returns SearchAlerts