README.md

React Native AEP User Profile Extension

Notice of deprecation

Since April 25, 2023, Apple has required apps submitted to the App Store to be built with Xcode 14.1 or later. The Experience Platform Mobile SDKs and extensions outlined below were built with prior versions of Xcode and are no longer compatible with iOS and iPadOS given Apple’s current App Store requirements. Consequently, on August 31, 2023, Adobe will be deprecating support for the following Experience Platform Mobile SDKs and wrapper extensions:

• ACP iOS SDK
• Cordova
• Flutter for ACP
• React Native for ACP
• Xamarin

After August 31, 2023, applications already submitted to the App Store that contain these SDKs and wrapper extensions will continue to operate, however, Adobe will not be providing security updates or bug fixes, and these SDKs and wrapper extensions will be provided as-is exclusive of any warranty, due to the App Store policy outlined above.

We encourage all customers to migrate to the latest Adobe Experience Platform versions of the Mobile SDK to ensure continued compatibility and support. Documentation for the latest versions of the Adobe Experience Platform Mobile SDKs can be found here. The iOS migration guide can be found here.

---

@adobe/react-native-acpuserprofile is a wrapper around the iOS and Android AEP User Profile SDK to allow for integration with React Native applications. Functionality to enable Adobe User Profile is provided entirely through JavaScript documented below.

Installation

You need to install the SDK with npm and configure the native Android/iOS project in your react native project. Before installing the UserProfile extension it is recommended to begin by installing the Core extension.

Note: If you are new to React Native we suggest you follow the React Native Getting Started page before continuing.

1. Create React Native project

First create a React Native project:

react-native init MyReactApp

2. Install JavaScript packages

Install and link the @adobe/react-native-acpuserprofile package:

cd MyReactApp
npm install @adobe/react-native-acpuserprofile

2.1 Link

• React Native 0.60+

CLI autolink feature links the module while building the app.

• React Native <= 0.59

react-native link @adobe/react-native-acpuserprofile

Note For iOS using cocoapods, run:

cd ios/ && pod install

Usage

User Profile

Importing the extension:

import {ACPUserProfile} from '@adobe/react-native-acpuserprofile';

Getting the extension version:

ACPUserProfile.extensionVersion().then(version => console.log("AdobeExperienceSDK: ACPUserProfile version: " + version));

Registering the extension with ACPCore:

It is recommended to initialize the SDK via native code inside your AppDelegate and MainApplication in iOS and Android respectively.

iOS

#import <ACPUserProfile.h>

[ACPUserProfile registerExtension];

Android:

import com.adobe.marketing.mobile.UserProfile;

UserProfile.registerExtension();

Update user attributes:

let attrMap = {"mapKey": "mapValue", "mapKey1": "mapValue1"};
ACPUserProfile.updateUserAttributes(attrMap);

Updating a user attribute:

let attributeName = "attrNameTest";
let attributeValue = "attrValueTest";
ACPUserProfile.updateUserAttribute(attributeName, attributeValue);

Remove a user attribute:

let attributeName = "attrNameTest";
ACPUserProfile.removeUserAttribute(attributeName);

Contributing

See CONTRIBUTING

License

See LICENSE