Interface InteractiveProduct

The InteractiveProduct sub-controller provides an interface for handling long presses, multiple clicks, etc. to ensure analytics events are logged properly when a user selects a product.

interface InteractiveProduct {
    warningMessage?: string;
    beginDelayedSelect(): void;
    cancelPendingSelect(): void;
    select(): void;
}

Hierarchy

  • InteractiveResultCore
    • InteractiveProduct

Methods

beginDelayedSelect cancelPendingSelect select

Properties

warningMessage?

Methods

beginDelayedSelect

  • beginDelayedSelect(): void

    Prepares to select the result after a certain delay, logging an analytics event if the result wasn't selected before.

    In a DOM context, it's recommended to call this method on the touchstart event.

    Returns void

cancelPendingSelect

  • cancelPendingSelect(): void

    Cancels the pending selection caused by beginDelayedSelect.

    In a DOM context, it's recommended to call this method on the touchend event.

    Returns void

select

  • select(): void

    Selects the result, logging an analytics event to the Coveo Platform if the result wasn't selected before.

    In a DOM context, it's recommended to call this method on all of the following events:

    • contextmenu
    • click
    • mouseup
    • mousedown

    Returns void

Properties

OptionalwarningMessage

warningMessage?: string

Settings

Member Visibility

On This Page

Methods
Properties