Skip to content
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.

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

Update doc for v.2.0.0 and use Core MapUtils #89

Merged
merged 16 commits into from
Jan 30, 2023
Merged
2 changes: 1 addition & 1 deletion Documentation/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ This API is not recommended for:
* Removing a previously synced advertising identifier after the advertising tracking settings were changed by the user; use the [`setAdvertisingIdentifier`](#setadvertisingidentifier) API instead.

> **Warning**
>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. See [`MobileCore.resetIdentities`](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/MobileCore.md) for more details.
>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. See [`MobileCore.resetIdentities`](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md) for more details.

------

Expand Down
18 changes: 9 additions & 9 deletions Documentation/frequently-asked-questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Download and import the Identity and Identity for Edge Network extensions
implementation 'com.adobe.marketing.mobile:edgeidentity:2.+'
```
> **Warning**
> Using dynamic dependency versions is not recommended for production apps. Refer to this [page](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/GradleDependencies.md) for managing gradle dependencies.
> Using dynamic dependency versions is not recommended for production apps. Refer to this [page](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/gradle-dependencies.md) for managing gradle dependencies.

2. Import the Mobile Core and Edge extensions in your application class.

Expand All @@ -45,7 +45,7 @@ A: The Identity for Edge Network extension and the Identity for Experience Cloud

At first launch of the application after upgrading to the Identity for Edge Network extension, the existing ECID from the Identity for Experience Cloud ID Service extension is migrated to the Identity for Edge Network extension. In this case both extensions will have the same ECID value.

The [resetIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/MobileCore.md) API regenerates a new ECID used by the Identity for Edge Network extension. This API call does not change the ECID used by the Identity for Experience Cloud ID Service extension. After calling this API, the ECID used by each identity extension will be different.
The [resetIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md) API regenerates a new ECID used by the Identity for Edge Network extension. This API call does not change the ECID used by the Identity for Experience Cloud ID Service extension. After calling this API, the ECID used by each identity extension will be different.

Changing the privacy status to optedOut will clear the ECID value used by the Identity for Experience Cloud ID Service extension. Changing the privacy status back to optedIn will generate a new ECID used by the Identity for Experience Cloud ID Service extension. Privacy status changes do not change the ECID used by the Identity for Edge Network extension. Changing the privacy status will cause the ECID used by each identity extension to be different.

Expand Down Expand Up @@ -76,23 +76,23 @@ A: The Identity for Edge Network extension does not change its ECID based on pri
**Note**
The Identity for Edge Network extension and the Identity for Experience Cloud ID Service extension each manage their own ECID value and are generated independently of each other.

The Identity for Edge Network extension does not clear its stored identities or regenerate the ECID due to privacy status changes. Instead, use the [MobileCore.resetIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/MobileCore.md) API. Note this API does not clear the ECID but instead generates a new ECID.
The Identity for Edge Network extension does not clear its stored identities or regenerate the ECID due to privacy status changes. Instead, use the [MobileCore.resetIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md) API. Note this API does not clear the ECID but instead generates a new ECID.

Each identity extension has its own API to retrieve their respective ECIDs as well. Use [Identity.getExperienceCloudId](api-reference.md) to get the Identity for Edge Network extension's ECID, and [Identity.getExperienceCloudId](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/Identity.md) to get the Identity for Experience Cloud ID Service extension's ECID.
Each identity extension has its own API to retrieve their respective ECIDs as well. Use [Identity.getExperienceCloudId](api-reference.md) to get the Identity for Edge Network extension's ECID, and [Identity.getExperienceCloudId](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Identity/api-reference.md) to get the Identity for Experience Cloud ID Service extension's ECID.

### Q: How can I get all the identifiers used by the SDK when using both AEP Edge extensions and Adobe Solutions extensions?

A: Use both `getSdkIdentities` and `getIdentities`.
To get the identifiers used by the Adobe Solutions extensions, call [getSdkIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/MobileCore.md).
To get the identifiers used by the Adobe Solutions extensions, call [getSdkIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md).
To get the identifiers used by the AEP Edge extensions, call [getIdentities](api-reference.md).

### Q: How can I clear all the identifiers from the SDK when using both AEP Edge extensions and Adobe Solutions extensions?

A: Set privacy status to `optedOut` and call `resetIdentities`.

To clear the identifiers used by the Adobe Solutions extensions, call [setPrivacyStatus](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/MobileCore.md) and set the privacy status to optedOut.
To clear the identifiers used by the Adobe Solutions extensions, call [setPrivacyStatus](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md) and set the privacy status to optedOut.

To clear the identifiers used by the AEP Edge extensions, call [resetIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/MobileCore.md)
To clear the identifiers used by the AEP Edge extensions, call [resetIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md)

### Q: What steps are needed to generate a new Experience Cloud ID (ECID) for a user when using both AEP Edge extensions and Adobe Solutions extensions?

Expand All @@ -101,8 +101,8 @@ A: Both identity extensions' ECID must be regenerated in sequence to avoid linki
When using Real-time Customer Profile and Identity Service, the ECIDs from both identity extensions are linked together in the customer's Identity Graph. Care must be taken when regenerating new ECIDs such that the old and new ECIDs are not linked within the same Identity Graph.

Perform the following API calls to regenerate the ECIDs in sequence:
1. Set [privacy status](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/MobileCore.md) to `optedOut` to clear the ECID from the AEP Identity direct service extension.
2. Call [resetIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/Usage/MobileCore.md) to regenerate a new ECID in the Identity for Edge Network extension.
1. Set [privacy status](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md) to `optedOut` to clear the ECID from the AEP Identity direct service extension.
2. Call [resetIdentities](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md) to regenerate a new ECID in the Identity for Edge Network extension.
3. Call [getExperienceCloudId](api-reference.md) on the Identity for Edge Network extension. This ensures the new ECID is generated before continuing.
4. Set privacy status `to optedIn` to generate a new ECID in the AEP Identity direct service extension.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ implementation 'com.adobe.marketing.mobile:edge:2.+'
implementation 'com.adobe.marketing.mobile:edgeidentity:2.+'
```
> **Warning**
> Using dynamic dependency versions is not recommended for production apps. Refer to this [page](https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/GradleDependencies.md) for managing gradle dependencies.
> Using dynamic dependency versions is not recommended for production apps. Refer to this [page](https://github.com/adobe/aepsdk-core-android/blob/dev-v2.0.0/Documentation/MobileCore/gradle-dependencies.md) for managing gradle dependencies.
emdobrin marked this conversation as resolved.
Show resolved Hide resolved

2. Import the libraries:
#### Java
Expand Down