Skip to content

Document Identity.removeAllIdentities() in the API reference #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
harsheenkohli wants to merge 1 commit into
base: feature/remove-all-identities-testapp
Choose a base branch
from
Open

Document Identity.removeAllIdentities() in the API reference #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion Documentation/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Refer to the [Getting Started Guide](getting-started.md)
| [getExperienceCloudId](#getExperienceCloudId) |
| [getIdentities](#getIdentities) |
| [getUrlVariables](#getUrlVariables) |
| [removeAllIdentities](#removeAllIdentities) |
| [removeIdentity](#removeIdentity) |
| [resetIdentities](#resetIdentities) |
| [setAdvertisingIdentifier](#setAdvertisingIdentifier) |
Expand Down Expand Up @@ -166,6 +167,39 @@ Identity.getUrlVariables { urlVariablesString ->

------

### removeAllIdentities

Remove all customer identifiers from the stored client-side [IdentityMap](#identitymap). The Identity extension will stop sending these identifiers to the Edge Network. Using this API does not remove the identifiers from the server-side User Profile Graph or Identity Graph.

Identifiers in the following reserved namespaces are retained:

* ECID
* IDFA
* GAID

To also generate a new ECID, use [`resetIdentities`](#resetidentities) instead.

#### Java

##### Syntax
```java
public static void removeAllIdentities();
```

##### Example
```java
Identity.removeAllIdentities();
```

#### Kotlin

##### Example
```kotlin
Identity.removeAllIdentities()
```

------

### removeIdentity

Remove the identity from the stored client-side [IdentityMap](#identitymap). The Identity extension will stop sending the identifier to the Edge Network. Using this API does not remove the identifier from the server-side User Profile Graph or Identity Graph.
Expand Down Expand Up @@ -213,7 +247,7 @@ Some example use cases for this API are:

This API is not recommended for:
* Resetting a user's consent and privacy settings; see [Privacy and GDPR](https://developer.adobe.com/client-sdks/documentation/privacy-and-gdpr).
* Removing existing custom identifiers; use the [`removeIdentity`](#removeidentity) API instead.
* Removing existing custom identifiers; use the [`removeIdentity`](#removeidentity) or [`removeAllIdentities`](#removeallidentities) API instead.
* Removing a previously synced advertising identifier after the advertising tracking settings were changed by the user; use the [`setAdvertisingIdentifier`](#setadvertisingidentifier) API instead.

> **Warning**
Expand Down
Loading