GithubHelp home page GithubHelp logo

classicvalues / pushiomanager-cordova-plugin Goto Github PK

View Code? Open in Web Editor NEW

This project forked from oracle/pushiomanager-cordova-plugin

0.0 1.0 0.0 1.34 MB

Cordova Plugin for Oracle Responsys Mobile SDK

License: Universal Permissive License v1.0

Java 40.31% Objective-C 31.94% JavaScript 27.75%

pushiomanager-cordova-plugin's Introduction

Cordova Plugin for Responsys SDK

This plugin makes it easy to integrate your Cordova based mobile app with the Responsys SDK.

Table of Contents

Requirements

  • Cordova CLI >= 9.0.1

If using Ionic,

  • Ionic CLI >= 6.7.0
  • Ionic Framework >= 5.0.5 (@ionic/angular)

For Android

  • Android SDK Tools >= 26.1.1
  • Cordova Android >= 8.1.0

For iOS

  • iOS 11 or later
  • Cordova iOS >= 5.1.1

Setup

Before installing the plugin, you must setup your app to receive push notifications.

For Android

  • 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.
  • Download the pushio_config.json file generated from your credentials and include it in your project's platforms/android/src/main/assets folder.
  • Copy PushIOManager-6.45.aar and place it in the project's platforms/android/src/main/libs folder.

For iOS

  • 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.
  • Open the Xcode project workspace in your platforms/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". Capabilty Image
  • Download and copy PushIOManager.framework and place it in the plugin PATH_TO_pushiomanager-cordova-plugin_DIRECTORY/frameworks/ folder before adding plugin to project.

Installation

Download the plugin,

git clone https://github.com/oracle/cordova-plugin-pushiomanager

For iOS - Copy PushIOManager.framework and place it in the plugin PATH_TO_cordova-plugin-pushiomanager_DIRECTORY/frameworks/ folder before adding plugin to project.

The plugin can be installed with the Cordova CLI,

cordova plugin add PATH_TO_pushiomanager-cordova-plugin_DIRECTORY

For Ionic,

ionic cordova plugin add PATH_TO_pushiomanager-cordova-plugin_DIRECTORY

Integration

For Android

  • Open the AndroidManifest.xml file located at platforms/android/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 of MainActivity,

       <intent-filter>
 	<action android:name="${applicationId}.NOTIFICATIONPRESSED" />
		<category android:name="android.intent.category.DEFAULT" />
 </intent-filter>

    • (Optional) Intent-filter for Android App Links setup. Add it inside the <activity> tag of MainActivity,

       <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>

    • Add the following code inside <application> tag,

        <receiver android:enabled="true" android:exported="false" android:name="com.pushio.manager.PushIOUriReceiver" tools:node="replace">
     <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 tools:ignore="AppLinkUrlError">
         <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>

  • Open the strings.xml file located at platforms/android/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 in platforms/android/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>

For iOS

  • 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 reuired 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.

Usage

The plugin can be accessed in JS code using the namespace cordova.plugins.PushIOManager. The following code samples use a shorthand - PushIOManager for the namespace.

Configure And Register

  • Configure the SDK,

     PushIOManager.configure("pushio_config.json", (success) => {
       
 }, (error) => {
       
 });

  • Once the SDK is configured, register the app with Responsys,

     PushIOManager.registerApp(true, (success) => {
 
 }, (error) => {     
 
 });

User Identification

  • Associate an app installation with a user (usually after login),

     PushIOManager.registerUserId("[email protected]", (success) => {
       
 }, (error) => {
     
 });

  • When the user logs out,

     PushIOManager.unregisterUserId((success) => {
       
 }, (error) => {
     
 });

Engagements And Conversion

User actions can be attributed to a push notification using,

PushIOManager.trackEngagement(PushIOManager.engagementType.PUSHIO_ENGAGEMENT_METRIC_INAPP_PURCHASE,
(success) => {
	      
}, (error) => {
	    
});

In-App Messages

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, (success) => {
       
 }, (error) => {
       
 });

Message Center

  • Get the Message Center messages list using,

     PushIOManager.fetchMessagesForMessageCenter("Primary", (response) => {
 
 }, (error) => {
       
 });

  • If any message has a rich-content (HTML) then call,

     PushIOManager.fetchRichContentForMessage(messageID, (response) => {
       // `response` is the HTML content
 }, (error) => {
       
 });

    Remember to store these messages, since the SDK cache is purgeable.

Geofences And Beacons

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, (response) => {}, (error) => {});
PushIOManager.onGeoRegionExited(geoRegion, (response) => {}, (error) => {});
PushIOManager.onBeaconRegionEntered(beaconRegion, (response) => {}, (error) => {});
PushIOManager.onBeaconRegionExited(beaconRegion, (response) => {}, (error) => {});

Notification Preferences

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, (response) => {
 
 }, (error) => {
       
 });

  • Once a preference is declared successfully, you may save the preference using,

     PushIOManager.setPreference(key, value, (response) => {
 
 }, (error) => {
       
 });

Do not use this as a key/value store as this data is purgeable.

Support

If you have access to My Oracle Support, please raise a request here, otherwise open an issue in this repository.

License

Copyright (c) 2021 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.

pushiomanager-cordova-plugin's People

Contributors

classicvalues avatar mend-bolt-for-github[bot] avatar neerhaj avatar s-wasan avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.