Contains constants and functions for a Start Monitor Event.
The structure for a Start Monitor Event is as follows:
{
payload: {
ACPExtensionEventSource: 'com.adobe.eventsource.requestcontent'
ACPExtensionEventType: 'com.adobe.eventtype.placesmonitor'
ACPExtensionEventData: <object>,
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 Start Monitor Event.
Path is payload,ACPExtensionEventSource
.
(static, constant) EVENT_TYPE
The value for eventType
for a Start Monitor Event.
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 Start Monitor 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
(static, constant) path :string
Paths for the keys on a Start Monitor Event
Properties:
Name | Type | Description |
---|---|---|
payload |
string |
An object with custom data describing the event. |
eventSource |
string |
The event source. |
eventType |
string |
The event type. |
eventData |
string |
An object with the custom data describing the event. |
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 Start Monitor Event.
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) isMatch(source) → {boolean}
Tests the provided source against the matcher to see if it's Start Monitor Event event.
Parameters:
Name | Type | Description |
---|---|---|
source |
object |
The Start Monitor Event instance |
- Source:
- See:
-
- kit.isMatch
(static) make(…input) → {object}
Generates a Start Monitor 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 |
(static) mock(…input) → {object}
Generates a Start Monitor 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 |