Interface SmartSnippetQuestionsList

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

Example: smart-snippet-questions-list.fn.tsx

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)

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

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

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

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

collapse

  • collapse(identifier: string): void

    Collapse the specified snippet suggestion.

    Parameters

    • identifier: string

      The questionAnswerId of the smart snippet to collapse.

    Returns void

expand

  • expand(identifier: string): void

    Expand the specified snippet suggestion.

    Parameters

    • identifier: string

      The questionAnswerId of the smart snippet to expand.

    Returns void

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

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

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.

Properties

state

state: SmartSnippetQuestionsListState

The state of the SmartSnippetQuestionsList controller.

Settings

Member Visibility

On This Page

Methods
Properties