Cordova integration

Quick Guide to Cordova SDK Integration.

Index

• What do you need for integration?
• Integration
  • Import the plugin
  • Configuration for Android
    • Adding the SDK dependencies
    • Adding indigitall Services
    • Adding Firebase Services
    • Adding HMS Services
    • Setting the notifications icon
  • Configuration for iOS
    • Notification Service Extension
  • SDK initialization
• Validate the integration
  • Verify files
  • Modifications with Ionic
  • Validation

What do you need for integration?

• An account with which to access the Indigitall panel, if you have not yet created it you can create an account here .
• The next thing is to have a project associated with the application web (web browsers) and / or mobile (android, ios), if you have not yet created and configured it you can create a project in your indigitall account.

It is important since the project contains the configuration data of your application, that is, the domain where your website is hosted, the safari or iOS certificates or the firebase key that android uses. It all depends on the platforms (web or app) that the project uses.

• You will need the App Key of the project, which is the key that our system uses to identify it, so it is unique for each project. You can find it in the administration console within the Configuration section in the Projects tab. You can see it in the following image, and to copy it, it is easy to click on the icon next to the key (App Key)
  
  
  
  
  • For android
• A Firebase Server Key
• A HMS Push Kit Server Key
• Android Studio
• An Android device or emulator with Google Play services installed to run the app
  • For iOS
• A valid push certificate for iOS. Learn how get push certificate from APNS
• Xcode
• An iOS device to run the app

Integration

This article shows the minimum development that must be done to start registering devices and being able to carry out the first push campaigns.

The Indigitall SDK is compatible with Google messaging services, through the Firebase platform and with the services of HMS or Huawei Mobile Services of Huawei .

You can see it in this tutorial video or read the instructions below:

Our SDK is available via npm .

npm (Node Package Manager) it is a package management system. It consists of a command line client and an online database of public and private packages.

Import the plugin

To import the SDK into your project, follow these steps:

1. Open the console and position yourself at the root of the project.

$ cd /PATH/TO/YOUR/PROJECT

2. Run this line in the console to import the plugin :

$ cordova plugin add indigitall-cordova-plugin

Configuration for Android

If you don't want to compile your Cordova project for Android devices, you can skip this point.

Otherwise, follow these steps:

Adding the SDK dependencies

If you are with a version of Kotlin less than 1.5.21, you will have to add the following implementation of coroutines in the gradle dependencies:

dependencies {
    implementation 'androidx.appcompat:appcompat:1.1.0'
    ...

    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.1'
}

• SDK compatibility with Android is as of Android 5.0

Adding the indigitall services

These services are necessary so that our SDK can synchronize device data with indigitall's servers.

<manifest ...>
    <!-- ... -->

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.VIBRATE" />
    <uses-permission android:name="android.permission.WAKE_LOCK" />
    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

    <!-- To obtain the location of the device -->
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION"/>
    <application ...>
        <!-- ... -->

        <!-- MANDATORY -->

        <!-- So that when the user presses a push, the metric is saved -->
        <service android:name="com.indigitall.android.services.StatisticService"/>

        <!-- Daily sync of device data -->
        <service android:name="com.indigitall.android.services.NightService"/>

        <!-- To start services when you restart the device -->
        <receiver android:name="com.indigitall.android.receivers.BootReceiver">
            <intent-filter>
                <action android:name="android.intent.action.BOOT_COMPLETED" />
            </intent-filter>
        </receiver>

        <!-- OPTIONAL -->

        <!-- So that when the user clicks an InApp message, the metric is saved.
        It is only necessary if you use the InApp message functionality -->
        <service android:name="com.indigitall.android.inapp.services.StatisticInAppService" />

        <!-- To obtain the location of the device.
        It is only necessary if you are going to ask for location permission
        to segment pushes by device location -->
        <receiver android:name="com.indigitall.android.receivers.LocationReceiver">
            <intent-filter>
                <action android:name="LocationReceiver.Action.LOCATION_UPDATE" />
            </intent-filter>
        </receiver>

    </application>
</manifest>

Adding Firebase Services

1. To start you need a file called google-services.json . This file can be exported from the Firebase console .

2. Move it to the root folder of your project . You should have something like this:

3. Add the following code in the config.xml file inside the android section.

<platform name="android">
    <resource-file src="google-services.json" target="/google-services.json" />
    ...
</platform>

4. Once the android project is created, it must be added in the manifest of the application, which can be found in the following path:

5. Add the following lines:

<service android:name="com.indigitall.android.services.FirebaseMessagingService" >
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>

6. You also have to edit the build.gradle of the application, which can be found in the following path:

7. Add the following lines:

• Huawei libraries only have to be added if HMS services is implemented

buildscript {
    repositories {
        ...
        // maven {url 'https://developer.huawei.com/repo/'} 
    }
    dependencies {
        ...
        classpath 'com.google.gms:google-services:4.0.+'
    }
}

allprojects {
    repositories {
        ...
        // maven {url 'https://developer.huawei.com/repo/'} 
    }
}

apply plugin: 'com.google.gms.google-services'

...
dependencies {
    implementation fileTree(dir: 'libs', include: '*.jar')
    // SUB-PROJECT DEPENDENCIES START
    ...
    implementation "com.google.firebase:firebase-core:17.2.2"
    implementation "com.google.firebase:firebase-messaging:20.1.0"

    // implementation "com.huawei.hms:location:5.0.0.301" // GET LOCATION
    // SUB-PROJECT DEPENDENCIES END
}

Adding HMS Services