Contains constants and functions for a Places Exit Event.
The structure for a Places Exit Event is as follows:
{
payload: {
ACPExtensionEventData: {
triggeringregion: {
latitude: <number>,
libraryid: <string>,
longitude: <number>,
regionname: <string>,
regionmetadata: {
category: <string>,
city: <string>,
country: <string>,
state: <string>,
street: <string>,
},
radius: <number>,
regionid: <string>,
useriswithin: <boolean>,
weight: <number>,
},
regioneventtype: 'exit'
},
ACPExtensionEventSource: 'com.adobe.eventsource.responsecontent'
ACPExtensionEventType: 'com.adobe.eventtype.places'
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 Places Exit Event.
Path is payload,ACPExtensionEventSource
.
- Source:
(static, constant) EVENT_TYPE
The value for eventType
for a Places Exit 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 Places Exit 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 Places Exit Event
Properties:
Name | Type | Description |
---|---|---|
payload |
string |
An object with custom data describing the event. |
data |
string |
An object with the custom data describing the event. |
POI |
string |
The POI that the user exited. |
latitude |
string |
The POI latitude. |
libraryId |
string |
The Places library the POI belongs to. |
longitude |
string |
The POI longitude. |
name |
string |
The POI name. |
metadata |
string |
An object with some defined items and custom data items.. |
category |
string |
The POI category. |
city |
string |
The POI city. |
country |
string |
The POI country. |
state |
string |
The POI state. |
street |
string |
The POI street. |
radius |
string |
The POI radius. |
id |
string |
The unique region id. |
within |
string |
Is the user currently in the POI. |
weight |
string |
The weight of the POI. It is used to prioritze POIs when a user is inside multile POIS. |
regionEventType |
string |
The type of action that took place. In this case it is exit. |
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. |
- Source:
(static, constant) REGION_EVENT_TYPE
The value for regionEventType
for a Places Exit Event.
Path is payload,ACPExtensionEventData,regioneventtype
.
- Source:
(static, constant) ROOT_TYPE
The value for rootType
for a Places Exit 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) getData(source) → {object}
Returns the data
from the Places Exit Event.
This is the .
Path is payload,ACPExtensionEventData
.
Parameters:
Name | Type | Description |
---|---|---|
source |
object |
The Places Exit Event instance |
- Source:
(static) getDataKey(…path, source) → {*}
Returns the data using the specified path from the data of the Places Exit Event.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
path |
string |
<repeatable> |
key in object |
source |
object |
The Places Exit Event instance |
- Source:
(static) getPOI(source) → {undefined}
Returns the POI
from the Places Exit Event.
This is the the POI that the user exited.
Path is payload,ACPExtensionEventData,triggeringregion
.
Parameters:
Name | Type | Description |
---|---|---|
source |
object |
The Places Exit Event instance |
- Source:
(static) getRegionEventType(source) → {string}
Returns the regionEventType
from the Places Exit Event.
This is the the type of action that took place. In this case it is exit.
Path is payload,ACPExtensionEventData,regioneventtype
.
Parameters:
Name | Type | Description |
---|---|---|
source |
object |
The Places Exit Event instance |
- Source:
(static) isMatch(source) → {boolean}
Tests the provided source against the matcher to see if it's Places Exit Event event.
Parameters:
Name | Type | Description |
---|---|---|
source |
object |
The Places Exit Event instance |
- Source:
- See:
-
- kit.isMatch
(static) make(…input) → {object}
Generates a Places Exit 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 Places Exit 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: