Create Edge event reference & update API docs#306
Merged
timkimadobe merged 15 commits intoadobe:devfrom Feb 22, 2023
Merged
Conversation
Types should reflect swift types links updated to equivalent ios versions
addb
reviewed
Feb 17, 2023
Documentation/event-reference.md
Outdated
|
|
||
| | Key | Value type | Key Required | Description | | ||
| | --------- | ------------- | -------- | --------------------- | | ||
| | locationHint | `String` | Yes | Location hint value. Passing `null` or an empty string (`""`) clears the existing location hint. See the [list of valid location hints for the `EdgeNetwork` scope](https://experienceleague.adobe.com/docs/experience-platform/edge-network-server-api/location-hints.html). | |
addb
reviewed
Feb 17, 2023
Documentation/event-reference.md
Outdated
|
|
||
| | Event type | Event source | | ||
| | --------------------------------- | ------------------------------------- | | ||
| | com.adobe.eventType.edge | This value is copied from the event being responded to; if not set or `null`, has a default value of com.adobe.eventSource.responseContent | |
Contributor
There was a problem hiding this comment.
Update this to just com.adobe.eventSource.responseContent as discussed previously for Android.
addb
reviewed
Feb 17, 2023
Documentation/event-reference.md
Outdated
|
|
||
| #### Data payload definition<!-- omit in toc --> | ||
|
|
||
| | Key | Value type | Key Required | Description | |
Contributor
There was a problem hiding this comment.
Key Required -> Required everywhere
Codecov Report
@@ Coverage Diff @@
## dev #306 +/- ##
======================================
Coverage ? 95.35%
======================================
Files ? 28
Lines ? 1183
Branches ? 0
======================================
Hits ? 1128
Misses ? 55
Partials ? 0 |
Fix null to nil Update source to just responseContent like android
addb
reviewed
Feb 17, 2023
Documentation/event-reference.md
Outdated
|
|
||
| | API | Event type | Event source | | ||
| | ------------------------------- | -------------------------- | ------------------------------------ | | ||
| | [`Consent.update(with:)`] | com.adobe.eventType.edge | com.adobe.eventSource.updateConsent | |
addb
reviewed
Feb 17, 2023
Documentation/event-reference.md
Outdated
|
|
||
| ----- | ||
|
|
||
| ### Edge content response error |
separate api from event type and source update links
update dictionary types to use non breaking space to improve styling
Update subsection ordering
Contributor
Author
|
@addb I did a text diff between this version and the android one; the only differences are:
Everything else should have the latest updates based on the feedback for the android version! |
Remove usage of AEP Remove extra usage of Adobe Experience Platform Update comment formatting Update wording grammar to treat Edge Network as proper noun Match wording and style from android version of doc
Use Edge Network name
addb
approved these changes
Feb 22, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR creates the Edge event reference, mirrored from the Android version with the following updates:
It also updates the API docs to align with the updated Android version:
See adobe/aepsdk-edge-android#44 for reference
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: