React Native Module for Responsys Mobile SDK
npm install @oracle/react-native-pushiomanagerThis module makes it easy to integrate your React Native based mobile app with the Responsys SDK.
- React Native >= 0.73.6
- React Native CLI >= 2.0.1
Before installing the plugin, you must setup your app to receive push notifications.
pushio_config.json file generated from your credentials and place it in your project's android/app/src/main/assets folder. You might have to create the directory if it is not already present.pushio_config.json file generated from your credentials.CX_Mobile_SDK.xcframework and place it in YOUR_APP_DIR/ios/framework/ folder before adding plugin to project. The plugin can be installed with the React Native CLI,
``shell`
cd
yarn add @oracle/react-native-pushiomanager
inside your app's android directory.
- Download the SDK native binary from here and place the .aar file in this android/PushIOManager/ directory.
- Inside the android/PushIOManager directory, create a file build.gradle with the following code:
`gradle
configurations.maybeCreate("default")
artifacts.add("default", file('oracle-cx-mobile-base-7.0.1.aar')) //Optional
//artifacts.add("default", file('oracle-cx-mobile-location-7.0.0.aar'))
` - Add the following to your project-wide
settings.gradle file:
`gradle
include ':PushIOManager'
project(':PushIOManager').projectDir = new File(rootProject.projectDir, './PushIOManager')
`$3
After installing plugin you need to install cocoapods,- Go to
directory of you app, cd YOUR_APP_DIR/ios/
- Run
Note: This step will fail if is not available in YOUR_APP_DIR/ios/framework/ folder before adding plugin to project with npm or yarn. Copy the CX_Mobile_SDK.xcframework to YOUR_APP_DIR/ios/framework/ and perform Installation step again.Optionally add OracleCXLocationSDK.xcframework to capture location attributes in responsys.
Integration
$3
- Open the
build.gradle file located in android/app/ and add the following dependency,
`
implementation 'androidx.core:core:1.6.0'
implementation 'com.google.firebase:firebase-messaging:18.0.0'
- Open the
file located in android/app/src/main and add the following,
* Permissions above the tag,
`xml
`
* Intent-filter for launching app when the user taps on a push notification. Add it inside the tag of MainActivity,
`xml
`
* Add the following code inside tag,
`xml
`
* (Optional) Intent-filter for Android App Links setup. Add it inside the tag of MainActivity,
`xml
`
- Open the
file located at android/app/src/main/res/values and add the following properties, * Custom URI scheme for displaying In-App Messages and Rich Push content,
`xml
pio-YOUR_API_KEY
`
You can find the API key in the that was placed in android/app/src/main/assets earlier during setup.
* (Optional) If you added the for Android App Links in the steps above, then you will need to declare the domain name,
`xml
YOUR_ANDROID_APP_LINKS_DOMAIN
`$3
- Open the Xcode project workspace in your directory of cordova app.
- Drag and Drop your pushio_config.json in Xcode project.
- Select the root project and Under Capabilites add the "Push Notifications" and "Background Modes".
!Capability Image- Add below Import statements in
AppDelegate.h. `
#import
#import
- AppDelegate needs to Conform UNUserNotificationCenterDelegate protocol in ,`
@interface AppDelegate : UIResponder - Implement the below delegate methods in
. `
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:
(NSData *)deviceToken
{
[[PushIOManager sharedInstance] didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
}- (void)application:(UIApplication )application didFailToRegisterForRemoteNotificationsWithError:(NSError )error
{
[[PushIOManager sharedInstance] didFailToRegisterForRemoteNotificationsWithError:error];
}
- (void)application:(UIApplication )application didReceiveRemoteNotification:(NSDictionary )userInfo
{
[[PushIOManager sharedInstance] didReceiveRemoteNotification:userInfo];
}
- (void)application:(UIApplication *)application didReceiveRemoteNotification:
(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler
{
[[PushIOManager sharedInstance] didReceiveRemoteNotification:userInfo
fetchCompletionResult:UIBackgroundFetchResultNewData fetchCompletionHandler:completionHandler];
}
//iOS 10 or later
-(void) userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:
(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler
{
[[PushIOManager sharedInstance] userNotificationCenter:center didReceiveNotificationResponse:response
withCompletionHandler:completionHandler];
}
-(void) userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:
(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler
{
[[PushIOManager sharedInstance] userNotificationCenter:center willPresentNotification:notification
withCompletionHandler:completionHandler];
}
- (BOOL)application:(UIApplication )app openURL:(NSURL )url options:(NSDictionary *)options {
[[PushIOManager sharedInstance] openURL:url options:options];
return YES;
}
- For In-App Messages and Rich Push Content follow the below steps :
* To Enable Custom URI scheme for displaying In-App Messages and Rich Push content follow the Step 1.
You can find the API key in the
that was placed in your Xcode project earlier during setup.
* Follow Step 2 to add the required capabilites in your Xcode project for In-App messages.- For Media Attachments you can follow the following guide. Copy and paste the code provided in guide in respective files.
- For Carousel Push you can follow the following guide. Copy and paste the code provided in guide in respective files.
$3
The module can be accessed in JS code as follows,
`javascript
import PushIOManager from '@oracle/react-native-pushiomanager';
`
$3
- Configure the SDK,
javascript
PushIOManager.configure("your-pushio_config.json", (error, response) => {
});
`
- Once the SDK is configured, register the app with Responsys,
- Combine above steps and use Platform check to detect the platform.
javascript
import { Platform } from 'react-native';
if (Platform.OS === 'android') {
PushIOManager.registerAppForPush(true, true, (error, response) => {
});
} else {
PushIOManager.registerForAllRemoteNotificationTypes((error, response) => {
PushIOManager.registerApp(true, (error, response) => {
});
});
}
`
- Additional APIs (optional) iOS Only:
- You can delay registration while app is launching or coming to foreground by implementing below API.
// Implement before calls.
PushIOManager.setDelayRegistration(true);
`
$3
- Associate an app installation with a user (usually after login),
javascript
PushIOManager.registerUserId("userID");
`
- When the user logs out,
javascript
PushIOManager.unregisterUserId();
`
$3
User actions can be attributed to a push notification using,
javascript
PushIOManager.trackEngagement(3, properties, (error, response) => {
});
`$3
In-App Message (IAM) are displayed in a popup window via system-defined triggers like
or custom triggers. IAM that use system-defined triggers are displayed automatically.IAM can also be displayed on-demand using custom triggers.
- Your marketing team defines a custom trigger in Responsys system and shares the trigger-event name with you.
- Marketer launches the campaign and the IAM is delivered to the device via push or pull mechanism (depending on your Responsys Account settings)
- When you wish to display the IAM popup, use,
`javascript
PushIOManager.trackEvent("custom_event_name", properties);
`
#### For iOSThese below steps are required for iOS In-App Messages.
* To Enable Custom URI scheme for displaying In-App Messages and Rich Push content follow the Step 1.
You can find the API key in the
that was placed in your Xcode project earlier during setup.
* Follow Step 2 to add the required capabilites in your Xcode project for In-App messages.
$3
- Get the Message Center messages list using,
Each Message Center message now supports an additional property called custom key-value pairs, it is a variable sized object with key value pairs and can be accessed like any other property of that message.
`javascript
PushIOManager.fetchMessagesForMessageCenter(messageCenterName, (error, response) => {
if(error == null) {
for(message of response.messages){
console.log(message.messageID)
console.log(message.message)
console.log(message.customKeyValuePairs)
}
}
});
`
- If any message has a rich-content (HTML) then call,
javascript
PushIOManager.fetchRichContentForMessage(messageID, (error, response) => {
// 'response' is the HTML content
});
`
Remember to store these messages, since the SDK cache is purgeable.
- Add the following messageCenter listeners to get notified when messages are available. If your app uses React Class components, use lifecycle methods
and componentWillUnmount to store and clean up the listener.
`
componentDidMount() {
this.messageCenterListener = PushIOManager.addMessageCenterUpdateListener((response) =>
console.log(response);
);
}
componentWillUnmount() {
if (this.messageCenterListener) {
this.messageCenterListener.remove();
}
}
If your app uses Functional components, update the hook to store the listener`
useEffect(() => {
const messageCenterListener = PushIOManager.addMessageCenterUpdateListener((response) =>
console.log(response);
); return () => {
messageCenterListener.remove()
}; };
$3
If your app is setup to monitor geofence and beacons, you can use the following APIs to record in Responsys when a user enters/exits a geofence/beacon zone.
javascript
PushIOManager.onGeoRegionEntered(geoRegion, (error, response) => {});
PushIOManager.onGeoRegionExited(geoRegion, (error, response) => {});
PushIOManager.onBeaconRegionEntered(beaconRegion, (error, response) => {});
PushIOManager.onBeaconRegionExited(beaconRegion, (error, response) => {});
`
$3
Preferences are used to record user-choices for push notifications. The preferences should be pre-defined in Responsys before being used in your app.
- Declare the preference beforehand in the app,
javascript
PushIOManager.declarePreference(key, label, preferenceType, (error, response) => {
});
`- Once a preference is declared successfully, you may save the preference using,
javascript
PushIOManager.setPreference(key, value, (error, success) => {
});
`
Do not use this as a persistent (key/value) store since this data is purgeable.
$3
Responsys SDK uses the app icon as the icon for notifications. You can change this by using the following two APIs,
javascript
PushIOManager.setNotificationLargeIcon("ic_notification_large");
PushIOManager.setNotificationSmallIcon("ic_notification_small");
`- Icon name should be provided without the file extension.
- Icon images should be present in your app's
or mipmap directory, i.e. android/app/src/main/res/drawable or android/app/src/main/res/mipmap.
It is also possible to change the notification small icon color by using the following API,
`javascript
PushIOManager.setNotificationSmallIconColor("#d1350f");
`$3
With release 6.52.1, you can now subscribe to FCM device tokens and push notifications callbacks from the Responsys plugin.
javascript
PushIOManager.onPushTokenReceived( response => {
console.log("Device Token: " + response.deviceToken);
});PushIOManager.onPushNotificationReceived( remoteMessage => {
console.log("Push Message: " + JSON.stringify(remoteMessage));
PushIOManager.isResponsysPush(remoteMessage, (error, response) => {
if (response) {
console.log("Received Push Message from Responsys");
PushIOManager.handleMessage(remoteMessage);
} else {
// Not a Responsys Push, handle it appropriately
}
});
});
`This will allow you to handle push notifications while the app is in foreground or background.
These callbacks are also useful if you have multiple push plugins and need to decide how to process the incoming push notifications.
NOTE: When the app is in killed state (i.e. not in memory) the Responsys plugin will automatically process and display the push notifications.
$3
When the user taps on a push notification (having a deeplink), the plugin passes the deeplink to the app.
Your app must implement the following native code to handle deeplinks.
#### For iOS
Ensure that you have implemented
method in your AppDelegate.m, as follows,`objective-c
- (BOOL)application:(UIApplication )app openURL:(NSURL )url options:(NSDictionary *)options { [[PushIOManager sharedInstance] openURL:url options:options];
return YES;
}
`#### For Android
- In
, change the launchMode of MainActivity to singleTask and add the following Intent-filter,
`xml
android:launchMode="singleTask">
- Add the following code to your
,
`java
import com.facebook.react.ReactInstanceManager;
import com.facebook.react.bridge.ReactContext;
import com.facebook.react.modules.core.DeviceEventManagerModule;
import android.content.Intent;
import android.net.Uri;
@Override
protected void onCreate(Bundle savedInstanceState){
super.onCreate(savedInstanceState);
handleIntent(getIntent());
}
@Override
public void onNewIntent(Intent intent) {
super.onNewIntent(intent);
handleIntent(intent);
}
private void handleIntent(Intent intent){
if(intent != null && intent.getData() != null) {
final Uri deepLinkURL = intent.getData();
ReactInstanceManager reactInstanceManager = getReactNativeHost().getReactInstanceManager();
ReactContext reactContext = reactInstanceManager.getCurrentReactContext();
if(reactContext != null) {
reactContext.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class).emit("PIOHandleOpenURL", deepLinkURL.toString());
} else {
reactInstanceManager.addReactInstanceEventListener(new ReactInstanceManager.ReactInstanceEventListener() {
@Override
public void onReactContextInitialized(ReactContext context) {
context.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class).emit("PIOHandleOpenURL", deepLinkURL.toString());
reactInstanceManager.removeReactInstanceEventListener(this);
}
});
}
}
}
`
In your Javascript code, add the following deeplink listeners,
If your app uses React Class components, use lifecycle methods
and componentWillUnmount to store and clean up the listener.
`javascript
componentDidMount() {
this.deepLinkListener = PushIOManager.setOpenURLListener(true, deeplink =>
console.log("Deeplink: " + deeplink);
);
}componentWillUnmount() {
if (this.deepLinkListener) {
this.deepLinkListener.remove();
}
}
`If your app uses Functional components, update the
hook to store listener`javascript
useEffect(() => {
const deepLinkListener = PushIOManager.setOpenURLListener(true, deeplink =>{
console.log("Deeplink: " + deeplink);
}); return () => {
deepLinkListener.remove()
};
});
`If your app uses Functional components, update the
hook to store listener`
const [isReady, setIsReady] = useState(false);const config = {
initialRouteName: "Home",
screens: {
Home: {
path: "home",
}
}
};
const linking = {
prefixes: ["example://"],
config: config.
}
let deeplinkurl
const onReceivePushIOURL = (deeplink) => {
if (Platform.OS === "ios") {
deeplinkurl = deeplink.url;
} else {
deeplinkurl = deeplink;
}
console.log("onReceivePushIOURL deeplink: " + deeplinkurl);
if (deeplinkurl && navigationRef.isReady) {
Linking.openURL(deeplinkurl);
}
};
useEffect(() => {
const deepLinkListener = PushIOManager.setOpenURLListener(true, onReceivePushIOURL);
return () => {
deepLinkListener.remove();
};
},[]);
return (
$3
Responsys plugin version 6.48.0 and above supports reporting Revenue/Purchase events. These events attribute purchases to the push campaign that led the app user into the mobile app. This API accepts an event object which allows In-App Purchase (Digital Goods) or Retail Purchase (Physical Goods) conversion-type to be reported.
javascript
var event = {};
event['orderId'] = '1234';
event['orderTotal'] = 50;
event['orderQuantity'] = 5;
event['conversionType'] = 3; // Possible values: 3 = In-App Purchase, 7 = Retail Purchase
event['customProperties'] = {}; // optionalPushIOManager.trackConversionEvent(event, (error, response) => {
});
`
Upgrades
$3
#### For IOS
API for registration has been changed to: registerApp(useLocation, callback)
This allows your app to control when to display the location permission prompt on iOS 12 and later devices.
#### For Android
API for registration has been changed to: registerAppForPush(enablePushNotification, useLocation, callback)
$3
#### For Android
API for registration has been changed to: registerApp(enablePushNotification, useLocation, callback)
This allows your app to control when to display the push notification permission prompt on Android 13 and later devices.
Also, with this release, we have made changes to our Multiple SDK guide after reports of duplicate notifications displayed due to a bug in
plugin.Make sure you implement the updated guide as you upgrade to plugin v6.56.3.
$3
#### For Android
If you have been following our Multiple SDK guide, there are some changes with this release.
We no longer need the
@react-native-firebase/app and @react-native-firebase/messaging plugins for multiple push plugin scenarios or to receive push in the background.So, you may choose to uninstall these plugins.
`javascript
yarn remove @react-native-firebase/app
yarn remove @react-native-firebase/messaging
`$3
With the release of v6.51.0, we have simplified the plugin integration process.
Due to this change, you will need to perform the following steps one-time only.
#### For Android
- Remove the existing
file from app/src/main/libs directory.
- Follow the setup instructions given in the Installation section above.
#### For iOS
- Find and remove the following line from the
YOUR_APP_DIR/ios/Podfile,
`
pod 'PushIOManager', :path => '' - Create a
directory inside YOUR_APP_DIR/ios/ directory.
- Copy the latest CX_Mobile_SDK.xcframework inside YOUR_APP_DIR/ios/framework/
> _NOTE:_ Copy to support Location feature in iOS and add releated Privacy Location descriptiions in Info.plist, refer this for more info
Location Descriptions
- Install the latest plugin yarn add @oracle/react-native-pushiomanager`If you have access to My Oracle Support, please raise a request here, otherwise open an issue in this repository.
This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide
Please consult the security guide for our responsible security vulnerability disclosure process
Copyright (c) 2024 Oracle and/or its affiliates and released under the Universal Permissive License (UPL), Version 1.0.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.