edgeResponse

edgeResponse

Contains constants and functions for a AEP Edge Response.

The structure for a AEP Edge Response is as follows:

{
  payload: {
    ACPExtensionEventData: {
      requestId: <string>,
      requestEventId: <string>,
      type: <string>,
      payload: <array>,
    },
    ACPExtensionEventSource: <string>,
    ACPExtensionEventType: 'com.adobe.eventtype.edge'
    ACPExtensionEventName: <string>,
    ACPExtensionEventNumber: <integer>,
    ACPExtensionEventUniqueIdentifier: <string>,
  },
  type: 'generic'
  vendor: <string>,
  annotations: <array>,
  clientId: <string>,
  timestamp: <number>,
  uuid: <string>,
}
Source:

Members

(static, constant) EVENT_TYPE

The value for eventType for a AEP Edge Response.

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 AEP Edge Response 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 AEP Edge Response

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

The request ID of the edge service request.
Path is payload.ACPExtensionEventData.requestId.
requestEventId string

The event ID of the event that this is a response to.
Path is payload.ACPExtensionEventData.requestEventId.
requestType string

The type of request that was made.
Path is payload.ACPExtensionEventData.type.
requestPayload string

The information received in the response.
Path is payload.ACPExtensionEventData.payload.
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 AEP Edge Response.

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) getRequestEventId(source) → {string}

Returns the requestEventId from the AEP Edge Response. This is the the event ID of the event that this is a response to.

Path is payload,ACPExtensionEventData,requestEventId.

Parameters:
Name Type Description
source object

The AEP Edge Response instance
Source:

(static) getRequestId(source) → {string}

Returns the requestId from the AEP Edge Response. This is the the request ID of the edge service request.

Path is payload,ACPExtensionEventData,requestId.

Parameters:
Name Type Description
source object

The AEP Edge Response instance
Source:

(static) getRequestPayload(source) → {Array}

Returns the requestPayload from the AEP Edge Response. This is the the information received in the response.

Path is payload,ACPExtensionEventData,payload.

Parameters:
Name Type Description
source object

The AEP Edge Response instance
Source:

(static) getRequestType(source) → {string}

Returns the requestType from the AEP Edge Response. This is the the type of request that was made.

Path is payload,ACPExtensionEventData,type.

Parameters:
Name Type Description
source object

The AEP Edge Response instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's AEP Edge Response event.

Parameters:
Name Type Description
source object

The AEP Edge Response instance
Source:
See:
  • kit.isMatch

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

Generates a AEP Edge Response 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 AEP Edge Response 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: