Interface SmartSnippetQuestionsList

The insight SmartSnippetQuestionsList controller allows to manage additional queries for which a SmartSnippet model can provide relevant excerpts.

interface SmartSnippetQuestionsList {
    state: SmartSnippetQuestionsListState;
    beginDelayedSelectInlineLink(identifier: string, link: InlineLink): void;
    beginDelayedSelectSource(identifier: string): void;
    cancelPendingSelectInlineLink(identifier: string, link: InlineLink): void;
    cancelPendingSelectSource(identifier: string): void;
    collapse(identifier: string): void;
    expand(identifier: string): void;
    selectInlineLink(identifier: string, link: InlineLink): void;
    selectSource(identifier: string): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

CoreSmartSnippetQuestionsList
- SmartSnippetQuestionsList

Index

Methods

beginDelayedSelectInlineLink beginDelayedSelectSource cancelPendingSelectInlineLink cancelPendingSelectSource collapse expand selectInlineLink selectSource subscribe

Properties

state

Methods

beginDelayedSelectInlineLink

beginDelayedSelectInlineLink(identifier: string, link: InlineLink): void
Prepares to select a link inside an 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
- identifier: string
  The questionAnswerId of the smart snippet containing the link.
- link: InlineLink
  The link to select.
Returns void
- Defined in packages/headless/src/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.ts:92

beginDelayedSelectSource

beginDelayedSelectSource(identifier: string): void
Prepares to select the source after a certain delay, sending analytics if it hadn't been selected before.

In a DOM context, we recommend calling this method on the touchstart event.
Parameters
- identifier: string
  The questionAnswerId of the smart snippet to collapse.
Returns void
- Defined in packages/headless/src/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.ts:62

cancelPendingSelectInlineLink

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

In a DOM context, we recommend calling this method on the touchend event.
Parameters
- identifier: string
  The questionAnswerId of the smart snippet containing the link.
- link: InlineLink
  The link to select.
Returns void
- Defined in packages/headless/src/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.ts:101

cancelPendingSelectSource

cancelPendingSelectSource(identifier: string): void
Cancels the pending selection caused by beginDelayedSelect.

In a DOM context, we recommend calling this method on the touchend event.
Parameters
- identifier: string
  The questionAnswerId of the smart snippet to collapse.
Returns void
- Defined in packages/headless/src/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.ts:70

collapse

collapse(identifier: string): void
Collapse the specified snippet suggestion.
Parameters
- identifier: string
  The questionAnswerId of the smart snippet to collapse.
Returns void
Inherited from CoreSmartSnippetQuestionsList.collapse
- Defined in packages/headless/src/controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.ts:59

expand

expand(identifier: string): void
Expand the specified snippet suggestion.
Parameters
- identifier: string
  The questionAnswerId of the smart snippet to expand.
Returns void
Inherited from CoreSmartSnippetQuestionsList.expand
- Defined in packages/headless/src/controllers/core/smart-snippet-questions-list/headless-core-smart-snippet-questions-list.ts:53

selectInlineLink

selectInlineLink(identifier: string, link: InlineLink): void
Selects a link inside an 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
- identifier: string
  The questionAnswerId of the smart snippet containing the link.
- link: InlineLink
  The link to select.
Returns void
- Defined in packages/headless/src/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.ts:83

selectSource

selectSource(identifier: string): void
Selects the source, logging a UA event to the Coveo Platform if the source hadn't been selected before.

In a DOM context, we recommend calling this method on all of the following events:
- contextmenu
- click
- mouseup
- mousedown
Parameters
- identifier: string
  The questionAnswerId of the smart snippet to collapse.
Returns void
- Defined in packages/headless/src/controllers/insight/smart-snippet-questions-list/headless-insight-smart-snippet-questions-list.ts:54

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

Properties

state

state: SmartSnippetQuestionsListState

The state of the SmartSnippetQuestionsList controller.

Interface SmartSnippetQuestionsList

Hierarchy (View Summary)

Index

Methods

Properties

Methods

beginDelayedSelectInlineLink

Parameters

Returns void

beginDelayedSelectSource

Parameters

Returns void

cancelPendingSelectInlineLink

Parameters

Returns void

cancelPendingSelectSource

Parameters

Returns void

collapse

Parameters

Returns void

expand

Parameters

Returns void

selectInlineLink

Parameters

Returns void

selectSource

Parameters

Returns void

Parameters

Returns Unsubscribe

Properties

state

Settings

On This Page