Interface SmartSnippetCore

interface SmartSnippetCore {
    state: SmartSnippetState;
    beginDelayedSelectSource(): void;
    cancelPendingSelectSource(): void;
    closeFeedbackModal(): void;
    collapse(): void;
    dislike(): void;
    expand(): void;
    like(): void;
    openFeedbackModal(): void;
    selectSource(): void;
    sendDetailedFeedback(details: string): void;
    sendFeedback(feedback: SmartSnippetFeedback): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- SmartSnippetCore
  - SmartSnippet

Index

Methods

beginDelayedSelectSource cancelPendingSelectSource closeFeedbackModal collapse dislike expand like openFeedbackModal selectSource sendDetailedFeedback sendFeedback subscribe

Properties

Methods

beginDelayedSelectSource

beginDelayedSelectSource(): void
Prepares to select the source after a certain delay, sending analytics if it was never selected before.

In a DOM context, we recommend calling this method on the touchstart event.

Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:109

cancelPendingSelectSource

cancelPendingSelectSource(): void
Cancels the pending selection caused by beginDelayedSelectSource.

In a DOM context, we recommend calling this method on the touchend event.

Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:115

closeFeedbackModal

closeFeedbackModal(): void
Allows the user to signal that they no longer wish to send feedback about why a particular answer was not relevant.

Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:83

collapse

collapse(): void
Collapse the snippet.

Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:67

dislike

dislike(): void
Allows the user to signal that a particular answer was not relevant.

Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:75

expand

expand(): void
Expand the snippet.

Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:63

like

like(): void
Allows the user to signal that a particular answer was relevant.

Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:71

openFeedbackModal

openFeedbackModal(): void
Allows the user to signal that they wish to send feedback about why a particular answer was not relevant.

Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:79

selectSource

selectSource(): void
Selects the source, logging a UA event to the Coveo Platform if the source wasn't already selected before.

In a DOM context, we recommend calling this method on all of the following events:
- contextmenu
- click
- mouseup
- mousedown
Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:103

sendDetailedFeedback

sendDetailedFeedback(details: string): void
Allows the user to send detailed feedback about why a particular answer was not relevant.
Parameters
- details: string
  A personalized message from the end user about the relevance of the answer.
Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:93

sendFeedback

sendFeedback(feedback: SmartSnippetFeedback): void
Allows the user to send feedback about why a particular answer was not relevant.
Parameters
- feedback: SmartSnippetFeedback
  The generic feedback that the end user wishes to send.
Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:88

subscribe

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

state

state: SmartSnippetState

The state of the SmartSnippet controller.