Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions packages/assurance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![npm version](https://img.shields.io/npm/v/@adobe/react-native-aepassurance/alpha?color=green&label=npm%20package)](https://www.npmjs.com/package/@adobe/react-native-aepassurance/v/3.0.0-alpha.1)
[![npm downloads](https://img.shields.io/npm/dm/@adobe/react-native-aepassurance)](https://www.npmjs.com/package/@adobe/react-native-aepassurance/v/3.0.0-alpha.1)

`@adobe/react-native-aepassurance` is a wrapper around the iOS and Android [Adobe Experience Platform Assurance](https://aep-sdks.gitbook.io/docs/using-mobile-extensions/adobe-experience-platform-assurance) to allow for integration with React Native applications. Functionality to start Assurance session is provided through JavaScript documented below.
`@adobe/react-native-aepassurance` is a wrapper around the iOS and Android [Adobe Experience Platform Assurance](https://developer.adobe.com/client-sdks/documentation/platform-assurance) to allow for integration with React Native applications. Functionality to start Assurance session is provided through JavaScript documented below.

## Prerequisites

Expand All @@ -26,7 +26,7 @@ npm install @adobe/react-native-aepassurance

## Usage

### [Assurance](https://aep-sdks.gitbook.io/docs/beta/project-griffon/using-project-griffon)
### [Assurance](https://developer.adobe.com/client-sdks/documentation/platform-assurance/tutorials)


### Initializing:
Expand Down
2 changes: 1 addition & 1 deletion packages/assurance/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@adobe/react-native-aepassurance",
"version": "3.0.0",
"description": "Adobe Experience Platform support for React Native apps.",
"homepage": "https://aep-sdks.gitbook.io/docs/",
"homepage": "https://developer.adobe.com/client-sdks/documentation/",
"main": "./ts/index.ts",
"scripts": {
"cleanup": "rm -rf node_modules",
Expand Down
2 changes: 1 addition & 1 deletion packages/campaignclassic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![npm version](https://badge.fury.io/js/%40adobe%2Freact-native-aepcampaignclassic.svg)](https://www.npmjs.com/package/@adobe/react-native-aepcampaignclassic)
[![npm downloads](https://img.shields.io/npm/dm/@adobe/react-native-aepcampaignclassic)](https://www.npmjs.com/package/@adobe/react-native-aepcampaignclassic)

`@adobe/react-native-aepcampaignclassic` is a wrapper around the iOS and Android [Adobe Experience Platform Campaign Classic Extension](https://aep-sdks.gitbook.io/docs/using-mobile-extensions/adobe-campaignclassic) to allow for integration with React Native applications.
`@adobe/react-native-aepcampaignclassic` is a wrapper around the iOS and Android [Adobe Experience Platform Campaign Classic Extension](https://developer.adobe.com/client-sdks/documentation/adobe-campaign-classic) to allow for integration with React Native applications.

## Peer Dependencies

Expand Down
2 changes: 1 addition & 1 deletion packages/campaignclassic/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@adobe/react-native-aepcampaignclassic",
"version": "1.0.0",
"description": "Experience Platform Campaign Classic extension for Adobe Experience Platform Mobile SDK. Written and Supported by Adobe.",
"homepage": "https://aep-sdks.gitbook.io/docs/",
"homepage": "https://developer.adobe.com/client-sdks/documentation/",
"license": "Apache-2.0",
"main": "./ts/index.ts",
"scripts": {
Expand Down
14 changes: 7 additions & 7 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![npm version](https://badge.fury.io/js/%40adobe%2Freact-native-aepcore.svg)](https://www.npmjs.com/package/@adobe/react-native-aepcore)
[![npm downloads](https://img.shields.io/npm/dm/@adobe/react-native-aepcore)](https://www.npmjs.com/package/@adobe/react-native-aepcore)

`@adobe/react-native-aepcore` is a wrapper around the iOS and Android [Adobe Experience Platform Mobile Core Extension](https://aep-sdks.gitbook.io/docs/foundation-extensions/mobile-core) to allow for integration with React Native applications.
`@adobe/react-native-aepcore` is a wrapper around the iOS and Android [Adobe Experience Platform Mobile Core Extension](https://developer.adobe.com/client-sdks/documentation/mobile-core) to allow for integration with React Native applications.

## Installation

Expand All @@ -30,7 +30,7 @@ import { MobileCore, Lifecycle, Signal, LogLevel, PrivacyStatus, Event } from '@

## API reference

### [Core](https://aep-sdks.gitbook.io/docs/foundation-extensions/mobile-core/mobile-core-api-reference)
### [Core](https://developer.adobe.com/client-sdks/documentation/mobile-core/api-reference)

- #### collectPii
The `collectPii` function lets the SDK to collect sensitive or personally identifiable information (PII).
Expand Down Expand Up @@ -264,7 +264,7 @@ clearUpdatedConfiguration()
MobileCore.clearUpdatedConfiguration();
```

### [Identity](https://aep-sdks.gitbook.io/docs/using-mobile-extensions/mobile-core/identity)
### [Identity](https://developer.adobe.com/client-sdks/documentation/mobile-core/identity)

- #### appendVisitorInfoForURL

Expand Down Expand Up @@ -439,11 +439,11 @@ import {VisitorID} from '@adobe/react-native-aepcore';
var visitorId = new VisitorID(idOrigin?: string, idType: string, id?: string, authenticationState?: MobileVisitorAuthenticationState)
```

### [Lifecycle](https://aep-sdks.gitbook.io/docs/using-mobile-extensions/mobile-core/lifecycle)
### [Lifecycle](https://developer.adobe.com/client-sdks/documentation/mobile-core/lifecycle)

> Note: Implementing Lifecycle via Javascript may lead to inaccurate Lifecycle metrics, therefore we recommend implementing Lifecycle in native [Android and iOS code](https://aep-sdks.gitbook.io/docs/using-mobile-extensions/mobile-core/lifecycle).
> Note: Implementing Lifecycle via Javascript may lead to inaccurate Lifecycle metrics, therefore we recommend implementing Lifecycle in native [Android and iOS code](https://developer.adobe.com/client-sdks/documentation/mobile-core/lifecycle).

> To enable Lifecycle metrics for the Edge workflows, see (Lifecycle for Edge Network) (https://aep-sdks.gitbook.io/docs/foundation-extensions/lifecycle-for-edge-network).
> To enable Lifecycle metrics for the Edge workflows, see (Lifecycle for Edge Network) (https://developer.adobe.com/client-sdks/documentation/lifecycle-for-edge-network).

- #### extensionVersion

Expand All @@ -461,7 +461,7 @@ extensionVersion(): Promise<string>
Lifecycle.extensionVersion().then(version => console.log("AdobeExperienceSDK: Lifecycle version: " + version));
```

### [Signal](https://aep-sdks.gitbook.io/docs/using-mobile-extensions/mobile-core/signals)
### [Signal](https://developer.adobe.com/client-sdks/documentation/mobile-core/signal)

- #### extensionVersion

Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@adobe/react-native-aepcore",
"version": "1.0.1",
"description": "Adobe Experience Platform support for React Native apps.",
"homepage": "https://aep-sdks.gitbook.io/docs/",
"homepage": "https://developer.adobe.com/client-sdks/documentation/",
"license": "Apache-2.0",
"main": "./ts/index.ts",
"scripts": {
Expand Down
67 changes: 49 additions & 18 deletions packages/edge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![npm version](https://badge.fury.io/js/%40adobe%2Freact-native-aepedge.svg)](https://www.npmjs.com/package/@adobe/react-native-aepedge)
[![npm downloads](https://img.shields.io/npm/dm/@adobe/react-native-aepedge)](https://www.npmjs.com/package/@adobe/react-native-aepedge)

`@adobe/react-native-aepedge` is a wrapper around the iOS and Android [Adobe Experience Platform Edge Network](https://aep-sdks.gitbook.io/docs/foundation-extensions/experience-platform-extension) to allow for integration with React Native applications.
`@adobe/react-native-aepedge` is a wrapper around the iOS and Android [Adobe Experience Platform Edge Network](https://developer.adobe.com/client-sdks/documentation/edge-network) to allow for integration with React Native applications.

## Prerequisites

Expand All @@ -26,7 +26,7 @@ npm install @adobe/react-native-aepedge

### Installing and registering the extension with the AEP Mobile Core

Install the Adobe Experience Platform Edge Network extension in your mobile property and configure the default Datastream ID by following the steps in the [Edge Network extension documentation](https://aep-sdks.gitbook.io/docs/foundation-extensions/experience-platform-extension).
Install the Adobe Experience Platform Edge Network extension in your mobile property and configure the default Datastream ID by following the steps in the [Edge Network extension documentation](https://developer.adobe.com/client-sdks/documentation/edge-network).

Then follow the same document for registering the Edge extension with the Mobile Core.
Note that initializing the SDK should be done in native code, additional documentation on how to initialize the SDK can be found [here](https://github.com/adobe/aepsdk-react-native#initializing).
Expand Down Expand Up @@ -94,6 +94,7 @@ import {Edge, ExperienceEvent} from '@adobe/react-native-aepedge';

## API reference
### extensionVersion
Returns the version of the client-side Edge extension.

**Syntax**
```typescript
Expand All @@ -104,6 +105,9 @@ extensionVersion(): Promise<string>;
```typescript
Edge.extensionVersion().then(version => console.log("AdobeExperienceSDK: Edge version: " + version));
```
### resetIdentity
Resets current state of the AEP Edge extension and clears previously cached content related to current identity, if any.
See [MobileCore.resetIdentities](../core/README.md#resetidentities) for more details.

### sendEvent

Expand All @@ -126,34 +130,61 @@ Edge.sendEvent(experienceEvent).then(eventHandles => console.log("Edge.sentEvent
```

### Public classes
#### ExperienceEvent

##### Create Experience Event from Dictionary:
#### EdgeEventHandle
The EdgeEventHandle is a response fragment from Adobe Experience Platform Edge Network for a sent XDM Experience Event. One event can receive none, one or multiple EdgeEventHandle(s) as response.

```typescript
var xdmData = {"eventType" : "SampleXDMEvent"};
let experienceEvent = new ExperienceEvent(xdmData);
class EdgeEventHandle {
type?: string;
payload?: Array<Record<string, any>>;

constructor(type?: string, payload?: Array<Record<string, any>>) {
this.type = type;
this.payload = payload;
}
}

export default EdgeEventHandle;
```

##### Add free form data to the Experience event:

#### ExperienceEvent

Experience Event is the event to be sent to Adobe Experience Platform Edge Network. The XDM data is required for any Experience Event being sent using the Edge extension.

**Syntax**
```typescript
var xdmData = {"eventType" : "SampleXDMEvent"};
var data = {"free": "form", "data": "example"};
let experienceEvent = new ExperienceEvent(xdmData, data);
class ExperienceEvent {
xdmData?: Record<string, any>;
data?: Record<string, any>;
datasetIdentifier?: string;

constructor(
xdmData?: Record<string, any>,
data?: Record<string, any>,
datasetIdentifier?: string
) {
this.xdmData = xdmData;
this.data = data;
this.datasetIdentifier = datasetIdentifier;
}
}

export default ExperienceEvent;
```

##### Set the destination Dataset identifier to the current Experience event:

**Example**
```typescript
//Example 1
// set freeform data to the Experience event
var xdmData = {"eventType" : "SampleXDMEvent"};
let experienceEvent = new ExperienceEvent(xdmData, null, "datasetIdExample")
var data = {"free": "form", "data": "example"};
let experienceEvent = new ExperienceEvent(xdmData, data);
```

##### Create Experience Event with xdmdata, free form data and the destination Dataset identifier:

```typescript
//Example 2
// Set the destination Dataset identifier to the current Experience event:
var xdmData = {"eventType" : "SampleXDMEvent"};
var data = {"dataKey" : "dataValue"};
let experienceEvent = new ExperienceEvent(xdmData, data, "datasetIdExample")
let experienceEvent = new ExperienceEvent(xdmData, null, "datasetIdExample")
```
2 changes: 1 addition & 1 deletion packages/edge/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@adobe/react-native-aepedge",
"version": "1.0.0",
"description": "Adobe Experience Platform Edge Network extension for Adobe Experience Platform Mobile SDK. Written and maintained by Adobe.",
"homepage": "https://aep-sdks.gitbook.io/docs/",
"homepage": "https://developer.adobe.com/client-sdks/documentation/",
"license": "Apache-2.0",
"main": "./ts/index.ts",
"scripts": {
Expand Down
4 changes: 2 additions & 2 deletions packages/edgeconsent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![npm version](https://badge.fury.io/js/%40adobe%2Freact-native-aepedgeconsent.svg)](https://www.npmjs.com/package/@adobe/react-native-aepedgeconsent)
[![npm downloads](https://img.shields.io/npm/dm/@adobe/react-native-aepedgeconsent)](https://www.npmjs.com/package/@adobe/react-native-aepedgeconsent)

`@adobe/react-native-aepedgeconsent` is a wrapper for the iOS and Android [Consent for Edge Network extension](https://aep-sdks.gitbook.io/docs/foundation-extensions/consent-for-edge-network) to allow for integration with React Native applications.
`@adobe/react-native-aepedgeconsent` is a wrapper for the iOS and Android [Consent for Edge Network extension](https://developer.adobe.com/client-sdks/documentation/consent-for-edge-network) to allow for integration with React Native applications.

## Prerequisites

Expand All @@ -25,7 +25,7 @@ npm install @adobe/react-native-aepedgeconsent
## Usage

### Installing and registering the extension with the AEP Mobile Core
Install the Consent extension in your mobile property and configure the default consent preferences by following the steps in the [Consent for Edge Network extension documentation](https://aep-sdks.gitbook.io/docs/foundation-extensions/consent-for-edge-network).
Install the Consent extension in your mobile property and configure the default consent preferences by following the steps in the [Consent for Edge Network extension documentation](https://developer.adobe.com/client-sdks/documentation/consent-for-edge-network).

Then follow the same document for registering the Consent extension with the Mobile Core.
Note that initializing the SDK should be done in native code, additional documentation on how to initialize the SDK can be found [here](https://github.com/adobe/aepsdk-react-native#initializing).
Expand Down
2 changes: 1 addition & 1 deletion packages/edgeconsent/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@adobe/react-native-aepedgeconsent",
"version": "1.0.0",
"description": "Adobe Experience Platform Consent Collection extension for AEP Mobile SDK. Written and maintained by Adobe.",
"homepage": "https://aep-sdks.gitbook.io/docs/",
"homepage": "https://developer.adobe.com/client-sdks/documentation/",
"license": "Apache-2.0",
"main": "./ts/index.ts",
"scripts": {
Expand Down
Loading