Coveo PipelineContext Component (CoveoPipelineContext)

A PipelineContext is used to add custom context information to a query (see Adding Custom Context Information to Queries).

This component is meant to be initialized with a script tag, possibly configuring it with JSON content.

The values can be either string or string array.

<script class='CoveoPipelineContext' type='text/context'>
  {
     "foo" : "bar",
     "foobar" : ["foo", "bar"]
  }
</script>

Configuring the component within a script tag implies you will be able to leverage the interface editor.

Once the component is created, you can also use JavaScript code to set/overwrite context values, using the setContext and setContextValue methods.

Whether you configure the component within a script tag or using JavaScript code, the data is added to the Query.Context parameter.

Note:

This component also ensures that the framework properly determines the context in all corner cases, including when a standalone search box (initSearchbox) is displaying query suggestions.

In most cases, if you do not use this component, the context will not be resolved and leveraged properly in the query pipeline (see What Is a Query Pipeline?).

Index

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). Component 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

getBindings

getContext

getContextKeys

  • getContextKeys(): string[]

getContextValue

  • getContextValue(key: string): string | string[]
  • 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.

    Parameters

    • key: string

    Returns string | string[]

setContext

  • setContext(newContext: string | Context): void

setContextValue

  • setContextValue(contextKey: string, contextValue: string | string[]): 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

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.

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 need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton

Accessors

usageAnalytics

Constructors

constructor

  • Create a new Component. Resolve all IComponentBindings if not provided.
    Create a new Logger for this component. Attach the component to the SearchInterface.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to create the component. Used to bind data on the element.

    • type: string

      The unique identifier for this component. See : IComponentDefinition.ID. Used to generate the unique Coveo CSS class associated with every component.

    • Default value bindings: IComponentBindings = {}

      The environment for every component. Optional, but omitting to provide one will impact performance.

    Returns PipelineContext

Implements

  • IPipelineContextProvider