Interface InteractiveResultCore

The InteractiveResultCore manages common functionality for interactive result controllers.

interface InteractiveResultCore {
    beginDelayedSelect(): void;
    cancelPendingSelect(): void;
    select(): void;
}

Hierarchy (View Summary)

InteractiveResultCore
- InteractiveCitation
- InteractiveResult

Index

Methods

beginDelayedSelect cancelPendingSelect select

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
- Defined in packages/headless/src/controllers/core/interactive-result/headless-core-interactive-result.ts:51

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
- Defined in packages/headless/src/controllers/core/interactive-result/headless-core-interactive-result.ts:58

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
- Defined in packages/headless/src/controllers/core/interactive-result/headless-core-interactive-result.ts:44