This module makes it easy to integrate your React Native based mobile app with the Responsys SDK.
- React Native >= 0.61.5
- React Native CLI >= 2.0.1
- Android SDK Tools >= 28.0.3
- iOS 11 or later
Before installing the plugin, you must setup your app to receive push notifications.
- Get FCM Credentials
- Log in to the Responsys Mobile App Developer Console and enter your FCM credentials (Project ID and Server API Key) for your Android app.
- Get the
pushio_config.json
file generated from your credentials and place it in your project'sandroid/app/src/main/assets
folder. You might have to create the directory if it is not already present. - Download the SDK native binary from here and place it in the project's
android/app/src/main/libs
folder.
- Generate Auth Key
- Log in to the Responsys Mobile App Developer Console and enter your Auth Key and other details for your iOS app.
- Download the
pushio_config.json
file generated from your credentials. - After adding the plugin in your app, copy
PushIOManager.framework
and place it in the pluginnode_modules/react-native-pushiomanager/PushIOManager/
folder.
The plugin can be installed with the React Native CLI,
cd <your_react_native_app>
yarn add @oracle/react-native-pushiomanager
-
After installing plugin you need to link
PushIOManager
dependency to your projectPodfile
. Please follow below steps:- Open your React Native App Project
Podfile.
Add the below line
pod 'PushIOManager', :path => '<PATH_TO_node_modules/react-native-pushiomanager/PushIOManager/_Directory>'
afteruse_native_modules!
.Eg:
use_native_modules! pod 'PushIOManager', :path => '../node_modules/react-native-pushiomanager/PushIOManager/'
- Run
pod install
- Open your React Native App Project
-
Open the
build.gradle
file located inandroid/app/
and add the following dependency,implementation 'com.google.firebase:firebase-messaging:17.3.0'
-
Open the
AndroidManifest.xml
file located inandroid/app/src/main
and add the following,-
Permissions above the
<application>
tag,<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="${applicationId}.permission.PUSHIO_MESSAGE" /> <uses-permission android:name="${applicationId}.permission.RSYS_SHOW_IAM" /> <permission android:name=".permission.PUSHIO_MESSAGE" android:protectionLevel="signature" /> <permission android:name="${applicationId}.permission.RSYS_SHOW_IAM" android:protectionLevel="signature" />
-
Intent-filter for launching app when the user taps on a push notification. Add it inside the
<activity>
tag ofMainActivity
,<intent-filter> <action android:name="${applicationId}.NOTIFICATIONPRESSED" /> <category android:name="android.intent.category.DEFAULT" /> </intent-filter>
-
Add the following code inside
<application>
tag,<receiver android:enabled="true" android:exported="false" android:name="com.pushio.manager.PushIOUriReceiver"> <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <data android:scheme="@string/uri_identifier" /> </intent-filter> </receiver> <activity android:name="com.pushio.manager.iam.ui.PushIOMessageViewActivity" android:permission="${applicationId}.permission.SHOW_IAM" android:theme="@android:style/Theme.Translucent.NoTitleBar"> <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.BROWSABLE" /> <category android:name="android.intent.category.DEFAULT" /> <data android:scheme="@string/uri_identifier" /> </intent-filter> </activity>
-
(Optional) Intent-filter for Android App Links setup. Add it inside the
<activity>
tag ofMainActivity
,<intent-filter android:autoVerify="true"> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:host="@string/app_links_url_host" android:pathPrefix="/pub/acc" android:scheme="https" /> </intent-filter>
-
-
Open the
strings.xml
file located atandroid/app/src/main/res/values
and add the following properties,-
Custom URI scheme for displaying In-App Messages and Rich Push content,
<string name="uri_identifier">pio-YOUR_API_KEY</string>
You can find the API key in the
pushio_config.json
that was placed inandroid/app/src/main/assets
earlier during setup.-
(Optional) If you added the
<intent-filter>
for Android App Links in the steps above, then you will need to declare the domain name,<string name="app_links_url_host">YOUR_ANDROID_APP_LINKS_DOMAIN</string>
-
-
Open the Xcode project workspace in your
ios
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".
-
Implement the below delegate methods in
AppDelegate.m
.
- (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];
}
-
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 don't need to add the code. You can find the API key in the
pushio_config.json
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. You don't need to add the code.
-
-
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.
The module can be accessed in JS code as follows,
import PushIOManager from '@oracle/react-native-pushiomanager';
-
Configure the SDK,
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.
import { Platform } from 'react-native'; if (Platform.OS === 'android') { PushIOManager.registerApp(true, (error, response) => { }); } else { PushIOManager.registerForAllRemoteNotificationTypes((error, response) => { PushIOManager.registerApp(true, (error, response) => { }); }); }
-
Associate an app installation with a user (usually after login),
PushIOManager.registerUserId("userID");
-
When the user logs out,
PushIOManager.unregisterUserId();
User actions can be attributed to a push notification using,
PushIOManager.trackEngagement(3, properties, (error, response) => {
});
In-App Message (IAM) are displayed in a popup window via system-defined triggers like $ExplicitAppOpen
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,
PushIOManager.trackEvent("custom_event_name", properties);
-
Get the Message Center messages list using,
PushIOManager.fetchMessagesForMessageCenter(messageCenterName, (error, response) => { });
-
If any message has a rich-content (HTML) then call,
PushIOManager.fetchRichContentForMessage(messageID, (error, response) => { // 'response' is the HTML content });
Remember to store these messages, since the SDK cache is purgeable.
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.
PushIOManager.onGeoRegionEntered(geoRegion, (error, response) => {});
PushIOManager.onGeoRegionExited(geoRegion, (error, response) => {});
PushIOManager.onBeaconRegionEntered(beaconRegion, (error, response) => {});
PushIOManager.onBeaconRegionExited(beaconRegion, (error, response) => {});
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,
PushIOManager.declarePreference(key, label, preferenceType, (error, response) => { });
-
Once a preference is declared successfully, you may save the preference using,
PushIOManager.setPreference(key, value, (error, success) => { });
Do not use this as a persistent (key/value) store since this data is purgeable.
If you have access to My Oracle Support, please raise a request here, otherwise open an issue in this repository.
Copyright (c) 2020 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.