Skip to content

Commit

Permalink
Add additional documentation for resetIdentities API for Edge Identity (
Browse files Browse the repository at this point in the history
#735)

* Add additional documentation for resetIdentities API for edge identity
Fix some typos and styling

* Update wording and styling
Relocate not recommended use case
Update bullet style to match document

* Fix typo

* Update not recommended use cases with links

* Add periods at the end of sentence bullets

* Fixed typo

* Add code styling for API link

* Update wording consistency

* Remove code styling from API links

* Add missing "the"
Add code styling for API links

* Rewording on resetIdentities based on review

Co-authored-by: Emilia Dobrin <dobrin@adobe.com>
  • Loading branch information
timkimadobe and emdobrin authored Mar 30, 2022
1 parent 4557a33 commit 699a66e
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions foundation-extensions/identity-for-edge-network/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,13 +339,25 @@ AEPIdentityItem *item = [[AEPIdentityItem alloc] initWithId:@"user@example.com"
## resetIdentities
Clears all identities stored in the Identity extension and generates a new Experience Cloud ID \(ECID\) . Using this API does not remove the identifiers from the server-side User Profile Graph or Identity Graph.
Clears all identities stored in the Identity extension and generates a new Experience Cloud ID (ECID). Using this API does not remove the identifiers from the server-side User Profile Graph or Identity Graph.
This is a destructive action, since once an ECID is removed it cannot be reused. The new ECID generated by this API can increase metrics like unique visitors when a new user profile is created.
Some example use cases for this API are:
* During debugging, to see how new ECIDs (and other identifiers paired with it) behave with existing rules and metrics.
* A last-resort reset for when an ECID should no longer be used.
This API is not recommended for:
* Resetting a user's consent and privacy settings; see [Privacy and GDPR](../../resources/privacy-and-gdpr.md).
* Removing existing custom identifiers; use the [`removeIdentity`](#removeidentity) API instead.
* Removing a previously synced advertising identifier after the advertising tracking settings were changed by the user; use the [`setAdvertisingIdentifier`](../mobile-core/identity/identity-api-reference.md#setadvertisingidentifier) API instead.
{% hint style="warning" %}
The Identity for Edge Network extension does not read the Mobile SDK's privacy status and therefor setting the SDK's privacy status to opt-out will not clear the identities from the Identity for Edge Network extension.
The Identity for Edge Network extension does not read the Mobile SDK's privacy status, and therefore setting the SDK's privacy status to opt-out will not automatically clear the identities from the Identity for Edge Network extension.
{% endhint %}
See [MobileCore.resetIdentities](../mobile-core/mobile-core-api-reference.md#resetidentities) for more details.
See [`MobileCore.resetIdentities`](../mobile-core/mobile-core-api-reference.md#resetidentities) for more details.
## updateIdentities
Expand Down

0 comments on commit 699a66e

Please sign in to comment.