PipelineContext component injects custom contextual information into the search requests and usage analytics search events sent from a search interface.
This component is meant to be initialized on a
script HTML tag whose
type attribute is set to
text/context and whose optional JSON content defines the custom information to send (each value can be set to a string or array of strings).
See Sending Custom Context Information. Note: To customize the context sent on all usage analytics events, see Sending Custom Metadata with Search, Click, or Custom Events.
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.
Return the bindings, or environment, for the current component.
Returns the current context
Return all the context keys configured for context.
Get the context value associated to the given key.
If the global variable Coveo.context contains the requested key, this method will return the value contained in Coveo.context instead of the one contained internally.
This is especially useful in a Coveo for Salesforce context, where context values can be extracted from a backend service.
Available since the December 2017 Release.
Sets a value for a context key, replacing the previous value if applicable.
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.
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
The HTMLElement on which to create the component. Used to bind data on the element.
The unique identifier for this component. See: IComponentDefinition.ID. Used to generate the unique Coveo CSS class associated with every component.
The environment for every component. Optional, but omitting to provide one will impact performance.