Interface SmartSnippet

The SmartSnippet controller lets you display the excerpt of a document that would be most likely to answer a particular query.

Example: smart-snippet.fn.tsx

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

Hierarchy (View Summary)

SmartSnippetCore
- SmartSnippet

Index

Methods

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

Properties

state

Methods

beginDelayedSelectInlineLink

beginDelayedSelectInlineLink(link: InlineLink): void
Prepares to select a link inside the answer 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.
Parameters
- link: InlineLink
  The link to select.
Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:146

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
Inherited from SmartSnippetCore.beginDelayedSelectSource
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:109

cancelPendingSelectInlineLink

cancelPendingSelectInlineLink(link: InlineLink): void
Cancels the pending selection caused by beginDelayedSelectInlineLink.

In a DOM context, we recommend calling this method on the touchend event.
Parameters
- link: InlineLink
  The link to select.
Returns void
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:154

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
Inherited from SmartSnippetCore.cancelPendingSelectSource
- 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
Inherited from SmartSnippetCore.closeFeedbackModal
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:83

collapse

collapse(): void
Collapse the snippet.

Returns void
Inherited from SmartSnippetCore.collapse
- 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
Inherited from SmartSnippetCore.dislike
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:75

expand

expand(): void
Expand the snippet.

Returns void
Inherited from SmartSnippetCore.expand
- 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
Inherited from SmartSnippetCore.like
- 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
Inherited from SmartSnippetCore.openFeedbackModal
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:79

selectInlineLink

selectInlineLink(link: InlineLink): void
Selects a link inside the answer, logging a UA event to the Coveo Platform if it was never selected before.

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

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
Inherited from SmartSnippetCore.selectSource
- 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
Inherited from SmartSnippetCore.sendDetailedFeedback
- 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
Inherited from SmartSnippetCore.sendFeedback
- Defined in packages/headless/src/controllers/core/smart-snippet/headless-core-smart-snippet.ts:88

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 SmartSnippetCore.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

state

state: SmartSnippetState

The state of the SmartSnippet controller.

Interface SmartSnippet

Hierarchy (View Summary)

Index

Methods

Properties

Methods

beginDelayedSelectInlineLink

Parameters

Returns void

beginDelayedSelectSource

Returns void

cancelPendingSelectInlineLink

Parameters

Returns void

cancelPendingSelectSource

Returns void

closeFeedbackModal

Returns void

collapse

Returns void

dislike

Returns void

expand

Returns void

like

Returns void

openFeedbackModal

Returns void

selectInlineLink

Parameters

Returns void

selectSource

Returns void

sendDetailedFeedback

Parameters

Returns void

sendFeedback

Parameters

Returns void

subscribe

Parameters

Returns Unsubscribe

Properties

state

Settings

On This Page