sharedState

sharedState

Contains constants and functions for a Shared State Event.

The structure for a Shared State Event is as follows:

{
  payload: {
    ACPExtensionEventData: {
      stateowner: <string>,
    },
    ACPExtensionEventSource: 'com.adobe.eventsource.sharedstate'
    ACPExtensionEventType: 'com.adobe.eventtype.hub'
    metadata: {
      state.data: <object>,
      xdm.state.data: <object>,
    },
    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 Event.

Path is payload,ACPExtensionEventSource.

Source:

(static, constant) EVENT_TYPE

The value for eventType for a Shared State Event.

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 Event 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 Event

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.
eventSource string

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

The event type.
Path is payload.ACPExtensionEventType.
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".
xdm string

XDM data that is being written to shared state..
Path is payload.metadata."xdm.state.data".
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 Event.

Path is type.

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) getStateData(source) → {object}

Returns the stateData from the Shared State Event. This is the the data that is being written to shared state..

Path is payload,metadata,state.data.

Parameters:
Name Type Description
source object

The Shared State Event instance
Source:

(static) getStateDataKey(…path, source) → {*}

Returns the data using the specified path from the stateData of the Shared State Event.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Shared State Event instance
Source:

(static) getStateOwner(source) → {string}

Returns the stateOwner from the Shared State Event. This is the in SDK extension that owns the shared state that is being updated.

Path is payload,ACPExtensionEventData,stateowner.

Parameters:
Name Type Description
source object

The Shared State Event instance
Source:

(static) getXdm(source) → {object}

Returns the xdm from the Shared State Event. This is the xDM data that is being written to shared state..

Path is payload,metadata,xdm.state.data.

Parameters:
Name Type Description
source object

The Shared State Event instance
Source:

(static) getXdmKey(…path, source) → {*}

Returns the data using the specified path from the xdm of the Shared State Event.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Shared State Event instance
Source:

(static) isMatch(source) → {boolean}

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

Parameters:
Name Type Description
source object

The Shared State Event instance
Source:
See:
  • kit.isMatch

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

Generates a Shared State Event 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 Event 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: