Support Menu

Coveo component FollowItem

The FollowItem component renders a widget that the end user can click to follow a particular item (document). A user following an item receives email notifications when the item changes.

Note:

A SearchAlerts component must be present in the page for this component to work. It is also necessary to meet certain requirements to be able to use this component (see Deploying Search Alerts on a Coveo JS Search Page).

This component is a result template component (see Result Templates).

Index

Component Options

modifiedDateField

modifiedDateField: string

Default value is undefined.

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

watchedFields

watchedFields: Array<IFieldOption>

Specifies the ISubscriptionItemRequest.watchedFields to use when sending the ISubscriptionItemRequest.

Default value is undefined.

Markup configuration example(s) :
data-watched-fields='@foo,@foo2'

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

toggleFollow

  • toggleFollow(): void
  • Follows the item if not already following it. Stops following the item otherwise.

    Also logs the appropriate event in the usage analytics (either searchAlertsFollowDocument or searchAlertsUnfollowDocument).

    Returns 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 differents component. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger 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.

usageAnalytics

usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

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

Constructors

constructor

  • Creates a new FollowItem component.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: IFollowItemOptions

      The options for the FollowItem component.

    • Optional bindings: IResultsComponentBindings

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

    • Optional result: IQueryResult

      The result to associate the component with.

    Returns FollowItem