Interface GenericAnalyticsActionCreators

The generic analytics action creators.

interface GenericAnalyticsActionCreators {
    logClickEvent(payload: LogClickEventActionCreatorPayload): ClickAction;
    logCustomEvent(payload: LogCustomEventActionCreatorPayload): CustomAction;
    logSearchEvent(
        payload: LogSearchEventActionCreatorPayload,
    ): LegacySearchAction;
}

Index

Methods

logClickEvent logCustomEvent logSearchEvent

Methods

logClickEvent

logClickEvent(payload: LogClickEventActionCreatorPayload): ClickAction
Creates a click analytics event.
Parameters
- payload: LogClickEventActionCreatorPayload
  The action creator payload.
Returns ClickAction
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/analytics/generic-analytics-actions-loader.d.ts:25

logCustomEvent

logCustomEvent(payload: LogCustomEventActionCreatorPayload): CustomAction
Creates a custom analytics event.
Parameters
- payload: LogCustomEventActionCreatorPayload
  The action creator payload.
Returns CustomAction
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/analytics/generic-analytics-actions-loader.d.ts:32

logSearchEvent

logSearchEvent(payload: LogSearchEventActionCreatorPayload): LegacySearchAction
Creates a search analytics event.
Parameters
- payload: LogSearchEventActionCreatorPayload
  The action creator payload.
Returns LegacySearchAction
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/analytics/generic-analytics-actions-loader.d.ts:18