@adobe/react-native-aepedge
Version:
Adobe Experience Platform Edge Network extension for Adobe Experience Platform Mobile SDK. Written and maintained by Adobe.
232 lines (173 loc) • 8.29 kB
Markdown
[](https://www.npmjs.com/package/@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://developer.adobe.com/client-sdks/documentation/edge-network) to allow for integration with React Native applications.
The Edge Network extension has the following peer dependencies, which must be installed prior to installing the Edge extension:
- [Core](../core/README.md)
- [Identity for Edge Network](../edgeidentity/README.md)
See [Requirements and Installation](https://github.com/adobe/aepsdk-react-native#requirements) instructions on the main page
Install the `@adobe/react-native-aepedge` package:
NPM:
```bash
npm install @adobe/react-native-aepedge
```
Yarn:
```bash
yarn add@adobe/react-native-aepedge
```
To initialize the SDK, use the following methods:
- [MobileCore.initializeWithAppId(appId)](https://github.com/adobe/aepsdk-react-native/tree/main/packages/core#initializewithappid)
- [MobileCore.initialize(initOptions)](https://github.com/adobe/aepsdk-react-native/tree/main/packages/core#initialize)
Refer to the root [Readme](https://github.com/adobe/aepsdk-react-native/blob/main/README.md) for more information about the SDK setup.
In your React Native application, import the Edge extension as follows:
```typescript
import {Edge, ExperienceEvent} from '@adobe/react-native-aepedge';
```
Returns the version of the client-side Edge extension.
**Syntax**
```typescript
extensionVersion(): Promise<string>
```
**Example**
```typescript
Edge.extensionVersion().then(version => console.log("AdobeExperienceSDK: Edge version: " + version));
```
Gets the Edge Network location hint used in requests to the Adobe Experience Platform Edge Network. The Edge Network location hint may be used when building the URL for Adobe Experience Platform Edge Network requests to hint at the server cluster to use.
**Syntax**
```typescript
getLocationHint(): Promise<string|null>
```
**Example**
```typescript
Edge.getLocationHint().then(hint =>
console.log('AdobeExperienceSDK: location hint = ' + hint),
);
```
Sets the Edge Network location hint used in requests to the Adobe Experience Platform Edge Network. Passing null or an empty string clears the existing location hint. Edge Network responses may overwrite the location hint to a new value when necessary to manage network traffic.
>Warning: Use caution when setting the location hint. Only use location hints for the "EdgeNetwork" scope. An incorrect location hint value will cause all Edge Network requests to fail with 404 response code.
**Syntax**
```typescript
setLocationHint(hint?: string)
```
**Example**
```typescript
Edge.setLocationHint('va6');
```
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
Sends an Experience event to Edge Network.
Starting with **@adobe/react-native-aepedge v5.1.0**, the sendEvent API supports optional Datastream overrides. This allows you to adjust your datastreams without the need for new ones or modifications to existing settings. The process involves two steps:
1. Define your Datastream configuration overrides on the [datastream configuration page](https://experienceleague.adobe.com/docs/experience-platform/datastreams/overrides.html).
2. Send these overrides to the Edge Network using the sendEvent API.
>Note: You can find a tutorial for Datastream config overrides using rules [here](https://developer.adobe.com/client-sdks/edge/edge-network/tutorials/datastream-config-override-rules/).
**Syntax**
```typescript
sendEvent(experienceEvent: ExperienceEvent): Promise<Array<EdgeEventHandle>>
```
**Example**
```typescript
const sampleXdmData = {"eventType" : "SampleXDMEvent"};
const freeFormData = {"free": "form", "data": "example"};
let experienceEvent = new ExperienceEvent({xdmData: sampleXdmData , data: freeFormData});
// send ExperienceEvent ignoring the promise
Edge.sendEvent(experienceEvent);
// send ExperienceEvent with promise
Edge.sendEvent(experienceEvent).then(eventHandles => console.log("Edge.sentEvent returned EdgeEventHandles = " + JSON.stringify(eventHandles)));
```
**Example with Datastream ID override**
```typescript
const sampleXdmData = {"eventType" : "SampleXDMEvent"};
let experienceEvent = new ExperienceEvent({xdmData: sampleXdmData, datastreamIdOverride: 'SampleDataStreamId'});
// send ExperienceEvent ignoring the promise
Edge.sendEvent(experienceEvent);
```
**Example with Datastream config override**
```typescript
const sampleXdmData = { eventType: 'SampleXDMEvent' };
const configOverrides = {
com_adobe_experience_platform: {
datasets: {
event: {
datasetId: 'SampleEventDatasetIdOverride',
},
},
},
com_adobe_analytics: {
reportSuites: ['sampleRSID'],
}
};
let experienceEvent = new ExperienceEvent({xdmData: sampleXdmData, datastreamConfigOverride: configOverrides});
// send ExperienceEvent ignoring the promise
Edge.sendEvent(experienceEvent);
```
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
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;
```
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.
**Usage**
```typescript
//Experience Event setting with objects, recommended way to create experience event
ExperienceEvent({xdmData: xdmData, data: data, datasetIdentifier: datasetIdentifier});
ExperienceEvent({xdmData: xdmData, data: data, datastreamIdOverride: datastreamIdOverride});
ExperienceEvent({xdmData: xdmData, data: data, datastreamConfigOverride: datastreamConfigOverride});
//Experience Event setting with parameters, previously supported
ExperienceEvent(xdmData, data, datasetIdentifier);
```
**Example**
```typescript
//Example 1
// set free form data to the Experience event
const sampleXdmData = {"eventType" : "SampleXDMEvent"};
const freeFormData = {"free": "form", "data": "example"};
let experienceEvent = new ExperienceEvent({xdmData: sampleXdmData, data: freeFormData});
```
```typescript
//Example 2
// Set free form data and datastream id override to the current Experience event:
const sampleXdmData = { eventType: 'SampleXDMEvent' };
const freeFormData = {"free": "form", "data": "example"};
let experienceEvent = new ExperienceEvent({xdmData: sampleXdmData, data: freeFormData, datastreamIdOverride: 'SampleDataStreamId'});
```
```typescript
//Example 3
// Set datastream config override to the current Experience event:
const sampleXdmData = { eventType: 'SampleXDMEvent' };
const configOverrides = {
com_adobe_experience_platform: {
datasets: {
event: {
datasetId: 'SampleEventDatasetIdOverride',
},
},
},
com_adobe_analytics: {
reportSuites: ['sampleRSID'],
}
};
let experienceEvent = new ExperienceEvent({xdmData: sampleXdmData, datastreamConfigOverride: configOverrides});
```
For examples on XDM schemas and datasets setup and tips on validating with Assurance, refer to the [Edge Network tutorial](https://github.com/adobe/aepsdk-edge-ios/blob/main/Documentation/Tutorials).