Interface ConfigurationActionCreators

The configuration action creators.

See Dispatch actions.

interface ConfigurationActionCreators {
    disableAnalytics(): { payload: void; type: string };
    enableAnalytics(): { payload: void; type: string };
    setOriginLevel2(
        payload: SetOriginLevel2ActionCreatorPayload,
    ): { payload: SetOriginLevel2ActionCreatorPayload; type: string };
    setOriginLevel3(
        payload: SetOriginLevel3ActionCreatorPayload,
    ): { payload: SetOriginLevel3ActionCreatorPayload; type: string };
    updateAnalyticsConfiguration(
        payload: UpdateAnalyticsConfigurationActionCreatorPayload,
    ): {
        payload: UpdateAnalyticsConfigurationActionCreatorPayload;
        type: string;
    };
    updateBasicConfiguration(
        payload: UpdateBasicConfigurationActionCreatorPayload,
    ): { payload: UpdateBasicConfigurationActionCreatorPayload; type: string };
}

Index

Methods

disableAnalytics enableAnalytics setOriginLevel2 setOriginLevel3 updateAnalyticsConfiguration updateBasicConfiguration

Methods

disableAnalytics

disableAnalytics(): { payload: void; type: string }
Disables analytics tracking.

Returns { payload: void; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/configuration/configuration-actions-loader.ts:38

enableAnalytics

enableAnalytics(): { payload: void; type: string }
Enables analytics tracking.

Returns { payload: void; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/configuration/configuration-actions-loader.ts:45

setOriginLevel2

setOriginLevel2(
payload: SetOriginLevel2ActionCreatorPayload,
): { payload: SetOriginLevel2ActionCreatorPayload; type: string }
Sets originLevel2 for analytics tracking.
Parameters
- payload: SetOriginLevel2ActionCreatorPayload
  The action creator payload.
Returns { payload: SetOriginLevel2ActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/configuration/configuration-actions-loader.ts:53

setOriginLevel3

setOriginLevel3(
payload: SetOriginLevel3ActionCreatorPayload,
): { payload: SetOriginLevel3ActionCreatorPayload; type: string }
Sets originLevel3 for analytics tracking.
Parameters
- payload: SetOriginLevel3ActionCreatorPayload
  The action creator payload.
Returns { payload: SetOriginLevel3ActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/configuration/configuration-actions-loader.ts:63

updateAnalyticsConfiguration

updateAnalyticsConfiguration(
    payload: UpdateAnalyticsConfigurationActionCreatorPayload,
): {
    payload: UpdateAnalyticsConfigurationActionCreatorPayload;
    type: string;
}
Updates the analytics configuration.
Parameters
- payload: UpdateAnalyticsConfigurationActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateAnalyticsConfigurationActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/configuration/configuration-actions-loader.ts:73

updateBasicConfiguration

updateBasicConfiguration(
payload: UpdateBasicConfigurationActionCreatorPayload,
): { payload: UpdateBasicConfigurationActionCreatorPayload; type: string }
Updates the global headless engine configuration.
Parameters
- payload: UpdateBasicConfigurationActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateBasicConfigurationActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/configuration/configuration-actions-loader.ts:83