configurationUpdate

configurationUpdate

Contains constants and functions for a Configuration Update.

The structure for a Configuration Update is as follows:

{
  payload: {
    ACPExtensionEventData: {
      config.update: <object>,
    },
    ACPExtensionEventSource: 'com.adobe.eventsource.requestcontent'
    ACPExtensionEventType: 'com.adobe.eventtype.configuration'
    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 Configuration Update.

Path is payload,ACPExtensionEventSource.

Source:

(static, constant) EVENT_TYPE

The value for eventType for a Configuration Update.

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 Configuration Update 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 Configuration Update

Properties:
Name Type Description
payload string

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

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

The configuration values to write.
Path is payload.ACPExtensionEventData."config.update".
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 Configuration Update.

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

Returns the configData from the Configuration Update. This is the the configuration values to write.

Path is payload,ACPExtensionEventData,config.update.

Parameters:
Name Type Description
source object

The Configuration Update instance
Source:

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

Returns the data using the specified path from the configData of the Configuration Update.

Parameters:
Name Type Attributes Description
path string <repeatable>

key in object
source object

The Configuration Update instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Configuration Update event.

Parameters:
Name Type Description
source object

The Configuration Update instance
Source:
See:
  • kit.isMatch

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

Generates a Configuration Update 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 Configuration Update 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: