Interface ClickAnalyticsActionCreators

The click analytics action creators.

interface ClickAnalyticsActionCreators {
    logDocumentOpen(result: Result): ClickAction;
    logOpenSmartSnippetInlineLink(
        payload: QuestionAnsweringInlineLinkActionCreatorPayload,
    ): ClickAction;
    logOpenSmartSnippetSource(): ClickAction;
    logOpenSmartSnippetSuggestionInlineLink(
        identifier: QuestionAnsweringUniqueIdentifierActionCreatorPayload,
        link: QuestionAnsweringInlineLinkActionCreatorPayload,
    ): ClickAction;
    logOpenSmartSnippetSuggestionSource(
        identifier: QuestionAnsweringUniqueIdentifierActionCreatorPayload,
    ): ClickAction;
}

Index

Methods

logDocumentOpen logOpenSmartSnippetInlineLink logOpenSmartSnippetSource logOpenSmartSnippetSuggestionInlineLink logOpenSmartSnippetSuggestionSource

Methods

logDocumentOpen

logDocumentOpen(result: Result): ClickAction
The event to log when a result is selected.
Parameters
- result: Result
  The selected result.
Returns ClickAction
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/analytics/click-analytics-actions-loader.d.ts:18

logOpenSmartSnippetInlineLink

logOpenSmartSnippetInlineLink(
payload: QuestionAnsweringInlineLinkActionCreatorPayload,
): ClickAction
The event to log when a link inside the snippet of a smart snippet is clicked.
Parameters
- payload: QuestionAnsweringInlineLinkActionCreatorPayload
  The action creator payload.
Returns ClickAction
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/analytics/click-analytics-actions-loader.d.ts:38

logOpenSmartSnippetSource

logOpenSmartSnippetSource(): ClickAction
The event to log when the source of a smart snippet is clicked.

Returns ClickAction
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/analytics/click-analytics-actions-loader.d.ts:24

logOpenSmartSnippetSuggestionInlineLink

logOpenSmartSnippetSuggestionInlineLink(
identifier: QuestionAnsweringUniqueIdentifierActionCreatorPayload,
link: QuestionAnsweringInlineLinkActionCreatorPayload,
): ClickAction
The event to log when the source of a smart snippet suggestion, or related question, is clicked.
Parameters
- identifier: QuestionAnsweringUniqueIdentifierActionCreatorPayload
  The identifier of the suggestion.
- link: QuestionAnsweringInlineLinkActionCreatorPayload
  The link that was opened.
Returns ClickAction
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/analytics/click-analytics-actions-loader.d.ts:46

logOpenSmartSnippetSuggestionSource

logOpenSmartSnippetSuggestionSource(
identifier: QuestionAnsweringUniqueIdentifierActionCreatorPayload,
): ClickAction
The event to log when the source of a smart snippet suggestion, or related question, is clicked.
Parameters
- identifier: QuestionAnsweringUniqueIdentifierActionCreatorPayload
  The identifier of the suggestion.
Returns ClickAction
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/analytics/click-analytics-actions-loader.d.ts:31