Update event reference doc#48
Conversation
Codecov Report
@@ Coverage Diff @@
## dev-v2.0.1 #48 +/- ##
=============================================
Coverage 83.28% 83.28%
Complexity 367 367
=============================================
Files 29 29
Lines 1555 1555
Branches 219 219
=============================================
Hits 1295 1295
Misses 161 161
Partials 99 99
Flags with carried forward coverage won't be shown. Click here to find out more. |
Remove whitespace padding from tables
Use non breaking space for map type to improve styling - required removing code styling from type
| @@ -23,31 +23,32 @@ The following events are handled by the Edge extension client-side. | |||
|
|
|||
There was a problem hiding this comment.
Edge request content
This event is a request to process and deliver an Experience event to Edge Network. This event is captured by the Edge Network extension's event listener in the Event Hub for processing and sent to Edge Network.
If the required xdm key is not present in the event data payload, the event is not sent to Edge Network. To learn more about Experience Data Model (XDM), please read the XDM system overview.
Event dispatched by
Event details
| Event type | Event source |
|---|---|
| com.adobe.eventType.edge | com.adobe.eventSource.requestContent |
Event data payload definition
| Key | Value type | Required | Description |
|---|---|---|---|
| xdm | Map<String, Object> |
Yes | XDM formatted data; use an XDMSchema implementation for better XDM data ingestion and data format control. |
| data | Map<String, Object> |
No | Optional free-form data associated with this event. |
| datasetId | String |
No | Optional custom dataset ID. If not set, the event uses the default Experience dataset ID set in the datastream configuration. |
Note
Events of this type and source are only processed if the data collection consent status stored in thecollectproperty is notn(no); that is, eithery(yes) orp(pending).
Update ordering of subsections for each event type with dispatched by api
Documentation/event-reference.md
Outdated
| | --- | ---------- | -------- | ----------- | | ||
| | scope | `String` | No | The scope that the location hint applies to, for example `EdgeNetwork`. | | ||
| | hint | `String` | No | The location hint string. | | ||
| | ttlSeconds | `Integer` | No | The time period the location hint should be valid for. | |
There was a problem hiding this comment.
edit: never mind, the return type is int haha
In this case I used Integer because the DataReader.getInt implementation uses that type; should it be int instead?:
public static int getInt(Map<String, ?> map, String key) throws DataReaderException {
Integer ret = (Integer)getTypedObject(Integer.class, map, key);
if (ret == null) {
throw new DataReaderException("Map contains null value for key");
} else {
return ret;
}
}
Documentation/event-reference.md
Outdated
| ### Edge event response | ||
| ### Edge response content | ||
|
|
||
| This event is a response to an event. |
There was a problem hiding this comment.
can we add which event: ex: edgerequestcontent
update data type to int
Description
This PR updates:
Required(the context is already data payload keys)Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: