Contains constants and functions for a AEP Edge Error Response.
The structure for a AEP Edge Error Response is as follows:
{
payload: {
ACPExtensionEventData: {
requestId: <string>,
type: <string>,
payload: <array>,
},
ACPExtensionEventSource: 'com.adobe.eventsource.errorresponsecontent'
ACPExtensionEventType: 'com.adobe.eventtype.edge'
ACPExtensionEventName: <string>,
ACPExtensionEventNumber: <integer>,
ACPExtensionEventUniqueIdentifier: <string>,
},
type: 'generic'
vendor: <string>,
annotations: <array>,
clientId: <string>,
timestamp: <number>,
uuid: <string>,
}
Members
(static, constant) EVENT_SOURCE
The value for eventSource
for a AEP Edge Error Response.
Path is payload,ACPExtensionEventSource
.
(static, constant) EVENT_TYPE
The value for eventType
for a AEP Edge Error Response.
Path is payload,ACPExtensionEventType
.
(static, constant) group
A grouping for this object
(static, constant) label
A label that can be used when describing this object
(static, constant) matcher
Matcher can be used to find matching AEP Edge Error 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
(static, constant) path :string
Paths for the keys on a AEP Edge Error Response
Properties:
Name | Type | Description |
---|---|---|
payload |
string |
An object with custom data describing the event. |
eventData |
string |
An object with the custom data describing the event. |
requestId |
string |
The request ID of the edge service request. |
requestType |
string |
The type of request that was made. |
requestPayload |
string |
The information received in the response. |
eventSource |
string |
The event source. |
eventType |
string |
The event type. |
eventName |
string |
The name of the event. |
sdkEventNumber |
string |
The event number generated by the SDK. |
eventId |
string |
The unique event id. |
rootType |
string |
The type of event. |
vendor |
string |
The vendor of the plugin that sent the event. |
annotations |
string |
Array of Annotation objects. |
clientId |
string |
A unique id that differentiates clients from one another. |
timestamp |
string |
When the event occurred. |
rootId |
string |
Uniquely identifies each event. |
(static, constant) ROOT_TYPE
The value for rootType
for a AEP Edge Error Response.
Path is type
.
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 |
(static) getRequestId(source) → {string}
Returns the requestId
from the AEP Edge Error 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 Error Response instance |
(static) getRequestPayload(source) → {Array}
Returns the requestPayload
from the AEP Edge Error Response.
This is the the information received in the response.
Path is payload,ACPExtensionEventData,payload
.
Parameters:
Name | Type | Description |
---|---|---|
source |
object |
The AEP Edge Error Response instance |
(static) getRequestType(source) → {string}
Returns the requestType
from the AEP Edge Error 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 Error Response instance |
(static) isMatch(source) → {boolean}
Tests the provided source against the matcher to see if it's AEP Edge Error Response event.
Parameters:
Name | Type | Description |
---|---|---|
source |
object |
The AEP Edge Error Response instance |
- Source:
- See:
-
- kit.isMatch
(static) make(…input) → {object}
Generates a AEP Edge Error 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 |
(static) mock(…input) → {object}
Generates a AEP Edge Error 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 |