IMIconnect Developer Hub

Welcome to the IMIconnect Developer Hub. You'll find all the resources to help you get started with IMIconnect quickly. We are here to support you if you get stuck. Let's jump right in!

Get Started    API Reference

Quickstart Guide for SDK Lite

This Quickstart guide explains the necessary steps required to integrate the Cordova plugin into your Android app using SDK Lite. It also provides the steps to set-up an app asset corresponding to your app on the IMIconnect platform.


  1. npm and Node
  2. A Cordova App
  3. An Active IMIconnect account
  4. An IMIconnect App Asset
  5. IMIconnect Cordova Plugin

Android Specific

  1. Android Studio
  2. Firebase Project

iOS Specific

  1. Mac OS
  2. iOS 9 or higher
  3. Xcode 8 or higher
  4. Active Apple developer account
  5. APNS or Firebase Project

Jetpack/Android X

This plugin requires modern Jetpack libraries (AndroidX). If the application includes plugins that are still on the old Android Support libraries, you will face build issues. The quickest way to work around the issue is to install cordova-plugin-androidx and cordova-plugin-androidx-adapter, which will automatically enable Jetpack and migrate plugins in the application:

cordova plugin add cordova-plugin-androidx-adapter
cordova plugin add cordova-plugin-androidx

Add IMIconnect Cordova Plugin

Run the following command in your terminal to add the IMIconnect Cordova Plugin to your app project:

$ cordova plugin add <local plugin dir>

eg: $ cordova plugin add IMIconnectPlugin

Project Set-Up

For iOS App Development

  1. Open the workspace file (../platforms/ios/MyApp.xcworkspace) in Xcode.
  2. After opening the workspace file, Make sure the MyApp project is selected in the left panel.
  3. Create a p12 file. Follow this link
  4. After Creating the P12 file, in Application, switch on the PushNotifications from Capabilities tab on the main window.
  1. Switch ON the Background Modes, and checkmark the 'Remote notifications' in the capabilities tab.
  1. On the main window, select the General tab and provide the Bundle Identifier(you can change this as per your requirement) and Signing Details.
  1. Set the status of the following Frameworks as optional in Linked Frameworks and Libraries section in the same General tab:
    1. FileProvider.Framework
    2. IOSurface.framework
    3. UserNotificationUI.framework
    4. UserNotifications.framework
    5. IMIconnectNotificationServiceExtension.framework
  1. Remove IMIconnectNotificationServiceExtension.framework from Linked Frameworks and Libraries, and add it on Embedded Binaries
  2. In order to receive Rich Push Notifications, Press "(+)" icon which is available on the target section and add NotificationService Extension in order to receive Rich Push Notifications.
  1. When adding Extension, you will notice a New Folder in your project hierarchy containing three new files NotificationService.h, NotificationService.m and Info.plist.
    1. Add IMIconnectNotificationServiceExtension.framework (available at plugin/src/ios/lib) manually in the new Folder.
    2. In Info.Plist of your new notificationextension Target , add App Transport Security Setting Dictionary with Allow Arbitrary Loads; Bool value YES by selecting +.
  2. In General Tab->Linked Frameworks and Libraries, set the status of IMIconnectNotificationServiceExtension.framework as optional.
  3. Create a Group Identifier. Refer create-an-app-group section in Quickstart Guide for more information
  4. Switch ON the AppGroups, then checkmark your group identifier in the capabilities tab. from main project target as well as from Extension Target.

For Cordova Plugin version 2.0.0 or below:

Follow the steps in the given link if you are using Cordova plugin version 2.0.0 or below.

Once done, return to this page and jump to step no. 16

For version 2.1.0 and above, simply continue below

Zero-rating Domain Configuration

Add the below key/value pair in your plist, if you want to configure your server domain to override zero-rating domain:
<string>Your server domain</string>


Import IMIconnectPlugin in AppDelegate.m file by including: #import "IMIconnectPlugin.h"

  1. Click the Build Phases tab and click the + button.
  2. Select the **New Run Script Phase" option.
  1. Copy-paste the contents of the, that is contained within plugin zip.

  2. Finally, connect the mobile (device) to your machine to see the connected device on the Scheme menu.

  3. Click the Run button from the same toolbar to the left of the Scheme to build, deploy, and execute the application on the connected device.

Now you can see your application is running on the device.

For Android App Development

  1. Configure the appId and clientKey in string.xml which is available in android/res/values/string.xml:
<string name="app_id">YOUR APPID</string>
 <string name="client_key">YOUR CLIENT KEY</string>

Zero-rating Domain Configuration

Follow the below steps to configure your server domain to override the zero-rating domain:
a. Configure the Android Manifest.
In your project, open AndroidManifest.xml and add the below meta-data:
<meta-data android:name="serverdomain" android:value="@string/server_domain"/>
b. Configure your server domain in string.xml which is available in android/res/values/string.xml, as shown below.
<string name="server_domain">YOUR SERVER DOMAIN</string>

  1. Configure Proguard Rules.

Add the following rule in the file.

If you use an obfuscation tool other than ProGuard, please refer to the tool providers documentation for configuring equivalent rules.

-dontwarn org.eclipse.jetty.**
-dontwarn javax.servlet.**
-dontwarn org.slf4j.**

# for sqlcipher
-keep class net.sqlcipher.** { *; }
-keep class net.sqlcipher.database.* { *; }

# WorkManager
-keep class * extends
-keep class * extends
-keep public class * extends {
    public <init>(...);
-keep class
  1. Create the .apk file to test the application using the following command:

$ cordova build android

Plugin Initialization


You must initialize the SDK before attempting to use any of its features. Initialize the SDK using the Application.onCreate method. If your app does not have an application class you should create it.

public class YOUR_APP_NAME extends IMIconnectApplication {
    public void onCreate() {
        super.onCreate();  // Call to super.onCreate() will initialize the IMIconnect SDK , reads the configuration from app manifest
    // Password to generate encryption key for secure preferences
    protected String getPassword()
        return "YOUR_PASSWORD";

Add your application class in AndroidManifest.xml file.

        <category android:name="android.intent.category.DEFAULT"/>
        <category android:name="android.intent.category.BROWSABLE"/>
        <action android:name="android.intent.action.MAIN"/>
        <category android:name="android.intent.category.LAUNCHER"/>


Code Integration

1. Register

To use the features provided by IMIconnect SDK, the app user must be registered with the IMIconnect platform. Register method creates a new profile of the user on our profile as part of the registration. If an existing user registers again, the profile creation step is omitted in our back-end.

To register a device with the platform, create an ICDeviceProfile instance and invoke the IMIconnect.register method.

A device profile must always have a unique device id and user-id, if you do not supply a user id then the platform will assign one for you. Typically, you will want to supply your own user-id value that corresponds to a user within your backend systems.

var deviceProfile = new ICDeviceProfile(); 


            deviceProfile.setDeviceId("PROVIDE UNIQUE DEVICE ID");      








                  deviceProfile ); 

2. Connect to IMIconnect

To use In-App Messaging you must establish a connection with the IMIconnect platform. Invoke the connect method to establish a connection and allow messages to be received.

Once the RT feature is enabled in the app asset created on IMIconnect and user registration is done, the App Developer can establish a connection between the app and IMIconnect platform by calling the connect method appropriately. This enables the messages sent from IMIconnect to be received on the app. When the application is running in the background, SDK is disconnected from IMIconnect. While in the disconnected state, incoming In-App messages are not received. However, when the application comes to the foreground again, SDK will establish a connection with IMIconnect platform and allows messages to be received.


This method throws an error when In-App Messaging is not enabled for the app or a device is not registered with the SDK.

    function(result) {
    function(error) {

3. Receive Messages

Incoming Push and In-App messages are received by registering a MessageListener implementation with IMIconnectPlugin.

Implement your message listener using the following sample code:


    function(messages) {

        var text = "";
        for (var i = 0; i < messages.length; i++) {
            text += messages[i].getMessage() + "<br>";



4. Listen for connection status events

Events are raised by the SDK whenever the connection status changes. To receive these events in your application; implement and register a connectionStatusChangedListener.

    function(result) {
    function(error) {

5. Create a Thread

All In-App Messages within IMIconnect are grouped by threads. In order to publish messages, you must first create an ICThread object.

When responding to an incoming message, you can obtain the ICThread directly from the incoming message.

var thread = new ICThread();
IMIconnectPlugin.createThread(function(thread) {
}, function(error) {
}, thread);

6. Publish a Message

Invoke publishMessage to publish a message to IMIconnect.


An ICThread object is obtained by calling the createThread method or from a received incoming message.

var message = new ICMessage();
message.setMessage("Test Message");
IMIconnectPlugin.publishMessage(function(icMessage) {
}, function(error) {
}, message);

7. Disconnect from IMIconnect (optional)

This method is used to disconnect from IMIconnect. Once disconnected, incoming In-App messages will not be received.


This method throws an exception when In-App Messaging is not enabled for the app.

    function(result) {
    function(error) {

Updated about a month ago

What's Next

Now that you have an app with basic In-App messaging and Push Notification capabilities, refer to the complete IMIconnect Cordova Plugin documentation to know about the advanced capabilities.

Cordova Plugin Documentation

Quickstart Guide for SDK Lite

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.