sharedStateConfig

sharedStateConfig

Contains constants and functions for a Shared State - Versions.

The structure for a Shared State - Versions is as follows:

{
  payload: {
    ACPExtensionEventData: {
      stateowner: 'com.adobe.module.configuration'
    },
    metadata: {
      state.data: {
        build.environment: <string>,
        experienceCloud.org: <string>,
        property.id: <string>,
        rules.url: <string>,
      },
      xdm.state.data: <object>,
    },
    ACPExtensionEventSource: 'com.adobe.eventsource.sharedstate'
    ACPExtensionEventType: 'com.adobe.eventtype.hub'
    ACPExtensionEventName: <string>,
    ACPExtensionEventNumber: <integer>,
    ACPExtensionEventUniqueIdentifier: <string>,
  },
  type: 'generic'
  vendor: <string>,
  annotations: <array>,
  clientId: <string>,
  timestamp: <number>,
  uuid: <string>,
}
Source:

Members

(static, constant) EVENT_SOURCE

The value for eventSource for a Shared State - Versions.

Path is payload,ACPExtensionEventSource.

Source:

(static, constant) EVENT_TYPE

The value for eventType for a Shared State - Versions.

Path is payload,ACPExtensionEventType.

Source:

(static, constant) group

A grouping for this object

Source:

(static, constant) label

A label that can be used when describing this object

Source:

(static, constant) matcher

Matcher can be used to find matching Shared State - Versions objects.

Source:
See:
  • kit.match

(static, constant) parentDepth

Describes the number of parents this object has based off schema references. When checking for matches for example, we want to use a schema that is more specific over a more generic schema

Source:

(static, constant) path :string

Paths for the keys on a Shared State - Versions

Properties:
Name Type Description
payload string

An object with custom data describing the event.
Path is payload.
eventData string

The full list of current configuration values.
Path is payload.ACPExtensionEventData.
stateOwner string

In SDK extension that owns the shared state that is being updated.
Path is payload.ACPExtensionEventData.stateowner.
metadata string

Additional metadata that is attacked to SDK events.
Path is payload.metadata.
stateData string

The data that is being written to shared state..
Path is payload.metadata."state.data".
buildEnvironment string

In the Launch UI, the type of environment this configuration was generated for.
Path is payload.metadata."state.data"."build.environment".
experienceCloudOrg string

The IMS Org that the mobile app's config was created by.
Path is payload.metadata."state.data"."experienceCloud.org".
launchPropertyId string

The ID of the property inside launch.
Path is payload.metadata."state.data"."property.id".
rulesUrl string

The URL to download the rules configuration for the property.
Path is payload.metadata."state.data"."rules.url".
xdm string

XDM data that is being written to shared state..
Path is payload.metadata."xdm.state.data".
eventSource string

The event source.
Path is payload.ACPExtensionEventSource.
eventType string

The event type.
Path is payload.ACPExtensionEventType.
eventName string

The name of the event.
Path is payload.ACPExtensionEventName.
sdkEventNumber string

The event number generated by the SDK.
Path is payload.ACPExtensionEventNumber.
eventId string

The unique event id.
Path is payload.ACPExtensionEventUniqueIdentifier.
rootType string

The type of event.
Path is type.
vendor string

The vendor of the plugin that sent the event.
Path is vendor.
annotations string

Array of Annotation objects.
Path is annotations.
clientId string

A unique id that differentiates clients from one another.
Path is clientId.
timestamp string

When the event occurred.
Path is timestamp.
rootId string

Uniquely identifies each event.
Path is uuid.
Source:

(static, constant) ROOT_TYPE

The value for rootType for a Shared State - Versions.

Path is type.

Source:

(static, constant) STATE_OWNER

The value for stateOwner for a Shared State - Versions.

Path is payload,ACPExtensionEventData,stateowner.

Source:

Methods

(static) get(alias, data) → {*}

Retrieves a value from the object. You can provide either a path or an alias.

Parameters:
Name Type Description
alias string

Path or alias
data *

Data to search
Source:

(static) getBuildEnvironment(source) → {string}

Returns the buildEnvironment from the Shared State - Versions. This is the in the Launch UI, the type of environment this configuration was generated for.

Path is payload,metadata,state.data,build.environment.

Parameters:
Name Type Description
source object

The Shared State - Versions instance
Source:

(static) getExperienceCloudOrg(source) → {string}

Returns the experienceCloudOrg from the Shared State - Versions. This is the the IMS Org that the mobile app's config was created by.

Path is payload,metadata,state.data,experienceCloud.org.

Parameters:
Name Type Description
source object

The Shared State - Versions instance
Source:

(static) getLaunchPropertyId(source) → {string}

Returns the launchPropertyId from the Shared State - Versions. This is the the ID of the property inside launch.

Path is payload,metadata,state.data,property.id.

Parameters:
Name Type Description
source object

The Shared State - Versions instance
Source:

(static) getRulesUrl(source) → {string}

Returns the rulesUrl from the Shared State - Versions. This is the the URL to download the rules configuration for the property.

Path is payload,metadata,state.data,rules.url.

Parameters:
Name Type Description
source object

The Shared State - Versions instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Shared State - Versions event.

Parameters:
Name Type Description
source object

The Shared State - Versions instance
Source:
See:
  • kit.isMatch

(static) make(…input) → {object}

Generates a Shared State - Versions with the const values set. Can be useful in testing. Can provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source:

(static) mock(…input) → {object}

Generates a Shared State - Versions with some default values set. Can be useful in testing. Can override defaults and provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source: