OneSignal

About

OneSignal is a high volume and reliable push notification service for websites and mobile applications. They support all major native and mobile platforms by providing dedicated SDKs for each platform, a RESTful server API, and an online dashboard for marketers to design and send push notifications.

OneSignal provides a simple interface to push notifications, letting content creators focus on quality user engagement instead of complex implementation.

This section describes how to setup your AIR application to use OneSignal with this extension.

This service is supported by the following variants of this extension:

• OneSignal

Setup

You should firstly setup OneSignal for your application. See the setup documentation to guide you through this process.

At the end of this process you should have your OneSignal App ID which will be required later.

Install

The simplest way to install and manage your AIR native extensions and libraries is to use the AIR Package Manager (apm). We highly recommend using apm, as it will handle downloading all required dependencies and manage your application descriptor (Android manifest additions, iOS info additions etc).

However you can choose to install it manually, as you would have done in the past.

APM

info

Note: All of the commands below should be run in a terminal / command prompt in the root directory of your application, generally the level above your source directory.

If you don't have an APM project setup, expand the guide below to setup an APM project before installing the extension.

Setup APM

Install APM

If you haven't installed apm follow the install guide on airsdk.dev.

Setup an APM project

You will need an APM project for your application.

There are many ways to do this and for more options see the APM documentation. Here we will just initialise a new empty project:

apm init

Check your github token

We use github to secure our extensions so you must have created a github personal access token and configured apm to use it.

To do this create a token using this guide from github and then set it in your apm config using:

apm config set github_token ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXX

If you don't do this correctly you may find the install will fail.

Install the extension

Install the extension by running:

apm install com.distriqt.PushNotifications-OneSignal

This will download and install the extension, required assets, and all dependencies.

Once complete apm will have created something like the following file structure:

.
|____ assets
| |____ ios 
| | |____ Frameworks
| | | |____ [dynamic frameworks]
|____ ane
| |____ com.distriqt.PushNotifications.OneSignal.ane    # PushNotifications extension
| |____ [dependencies]
|____ apm_packages                                      # cache directory - ignore
|____ project.apm                                       # apm project file

• Add the ane directory to your IDE. See the tutorials located here on adding an extension to your IDE.

• You will have an assets directory that contains required assets for the installed extensions. You must add the assets/ios folder to the root of your iOS application package. (The ios folder contains a Frameworks folder with the required iOS dynamic frameworks).

info

We suggest you use the locations directly in your builds (rather than copying the files elsewhere) so that updates with apm will be pulled automatically into your build.

• You must set a few pieces of configuration information for OneSignal. This will allow apm to automatically insert them into the correct position in your application descriptor. This includes:

  • bundleSeedId: Bundle Seed Id (or App ID Prefix) for your iOS application
  • apsEnvironment: production for release builds and development for development builds
  • getTaskAllow: false for release builds and true for development builds

You can call the following to step through the all the configuration values for this extension:

apm project config set com.distriqt.PushNotifications

Build Types

We suggest creating a build type to allow you to easily switch between the production and development configurations. To do this run the following additional commands (assuming you setup the main configuration for production):

apm -b development project config set apsEnvironment development
apm -b development project config set getTaskAllow true

This will set the values of those properties to be different for the "development" build type.

Manual

info

The following guide is used to manually install the extension, download dependencies and update the application descriptor. We highly recommend installing extensions using apm. Using apm will automate the installation and automatically handle updates and dependencies along with greatly simplifying the application descriptor generation.

First step is always to add the extension to your development environment. Download the extension from the repository and then follow the tutorial located here to add the extension to your development environment.

To use this service add the com.distriqt.PushNotifications.OneSignal.ane variant of the extension to your project in place of com.distriqt.PushNotifications.ane. You should only add one of the variants to your project. If you need to support multiple services please use the All Services variant.

All variants of the Push Notifications extension have the same extension id: com.distriqt.PushNotifications so you should add this to your extensions list in your application descriptor:

<extensions>
    ...

    <extensionID>com.distriqt.PushNotifications</extensionID>

    ...
</extensions>

Dependencies

Many of our extensions use some common libraries, for example, the Android Support libraries.

We have to separate these libraries into separate extensions in order to avoid multiple versions of the libraries being included in your application and causing packaging conflicts. This means that you need to include some additional extensions in your application along with the main extension file.

You will add these extensions as you do with any other extension, and you need to ensure it is packaged with your application.

Core

The Core extension is required by this extension. You must include this extension in your application.

This extension requires you call the init() function at some point early in your application, generally at the same time as the initialisation of this extension. If you are using other extensions that also require the Core extension, you only need to initialise it once, before initialising the other extensions.

Core.init();

The Core extension doesn't provide any functionality in itself but provides support libraries and frameworks used by our extensions. It also includes some centralised code for some common actions that can cause issues if they are implemented in each individual extension.

You can access this extension here: https://github.com/distriqt/ANE-Core.

Android Support

The Android Support libraries encompass the Android Support, Android X and common Google libraries.

These libraries are specific to Android. There are no issues including these on all platforms, they are just required for Android.

This extension requires the following extensions:

• androidx.appcompat

• androidx.browser

• androidx.cardview

• androidx.constraintlayout

• androidx.core

• androidx.emoji2

• androidx.exifinterface

• androidx.room

• androidx.vectordrawable

• androidx.work

• com.jetbrains.kotlin

• com.google.android.datatransport

• com.google.dagger

• com.google.protobuflite

• com.google.code.gson

• com.google.guava

• com.bumptech.glide

• io.reactivex

• io.grpc

You can access these extensions here: https://github.com/distriqt/ANE-AndroidSupport.

Note: if you have been using the older com.distriqt.androidsupport.* (Android Support) extensions you should remove these extensions and replace it with the androidx extensions listed above. This is the new version of the android support libraries and moving forward all our extensions will require AndroidX.

Google Play Services

This ANE requires usage of certain aspects of the Google Play Services client library. The client library is available as a series of ANEs that you add into your applications packaging options. Each separate ANE provides a component from the Play Services client library and are used by different ANEs. These client libraries aren't packaged with this ANE as they are used by multiple ANEs and separating them will avoid conflicts, allowing you to use multiple ANEs in the one application.

This ANE requires the following Google Play Services:

• com.distriqt.playservices.Base
• com.distriqt.playservices.CloudMessaging

You must include the above native extensions in your application along with this extension, and you need to ensure they are packaged with your application.

You can access the Google Play Services client library extensions here: https://github.com/distriqt/ANE-GooglePlayServices.

Firebase

To use Firebase Cloud Messaging you must include the Firebase core and messaging libraries. The core libraries are available in the following extensions alongside the Google Play Services:

• com.google.firebase.core
• com.google.firebase.messaging

You do not need to initialise or configure this.

Dynamic Frameworks

The OneSignal SDK requires several dynamic frameworks that need to be packaged and signed with your application.

To do so you must add the Frameworks folder at the root of your application package. This folder is found alongside the ane in the assets/ios/ folder.

Application Descriptor

APM

Updating your application descriptor will insert the required extensionID's and generate the manifest and info additions for your application.

You update your application descriptor by running:

apm generate app-descriptor src/MyApp-app.xml

Change the path (src/MyApp-app.xml) to point to your application descriptor.

Build Types

If you setup a development build type you can update your app descriptor with this configuration by using :

apm -b development generate app-descriptor src/MyApp-app.xml

Or you could maintain a separate "development" app descriptor by changing the output eg:

apm -b development generate app-descriptor src/MyApp-dev-app.xml

caution

This will modify your application descriptor replacing the manifest additions and info additions with the ones generated from apm.

You should backup your application descriptor before running this command to ensure you don't lose any information.

If you need to insert custom data into these sections see the guides for Android and iOS

Manual

Extension IDs

The following should be added to your extensions node in your application descriptor to identify all the required ANEs in your application:

<extensions>
    <extensionID>com.distriqt.PushNotifications</extensionID>
    <extensionID>com.distriqt.Core</extensionID>

    <extensionID>com.distriqt.playservices.Base</extensionID>
    <extensionID>com.distriqt.playservices.CloudMessaging</extensionID>
    <extensionID>com.google.firebase.core</extensionID>
    <extensionID>com.google.firebase.messaging</extensionID>
    
    <extensionID>androidx.appcompat</extensionID>
    <extensionID>androidx.browser</extensionID>
    <extensionID>androidx.cardview</extensionID>
    <extensionID>androidx.constraintlayout</extensionID>
    <extensionID>androidx.core</extensionID>
    <extensionID>androidx.emoji2</extensionID>
    <extensionID>androidx.exifinterface</extensionID>
    <extensionID>androidx.room</extensionID>
    <extensionID>androidx.vectordrawable</extensionID>
    <extensionID>androidx.work</extensionID>

    <extensionID>com.jetbrains.kotlin</extensionID>
    <extensionID>com.google.android.datatransport</extensionID>
    <extensionID>com.google.dagger</extensionID>
    <extensionID>com.google.protobuflite</extensionID>
    <extensionID>com.google.code.gson</extensionID>
    <extensionID>com.google.guava</extensionID>
    <extensionID>com.bumptech.glide</extensionID>
    <extensionID>io.reactivex</extensionID>
    <extensionID>io.grpc</extensionID>
</extensions>

iOS

Firstly make sure you have generated your iOS Push Certificates. You can follow the guide by OneSignal:

• Generate an iOS Push Certificate

Info Additions and Entitlements

Push notifications require a few additions to the Info plist and Entitlements section of your application to correctly configure your application for push notifications.

You should add the listing below to application descriptor iPhone node.

You must replace the BUNDLE_SEED_ID and BUNDLE_IDENTIFIER with the information you gathered when setting up your application. Also make sure you set the environment correctly either using production or development, both are shown in the example below with the production version commented out. More on this below.

<iPhone>
    <InfoAdditions><![CDATA[

        <key>UIBackgroundModes</key>
        <array>
            <string>remote-notification</string>
        </array>

    ]]></InfoAdditions>
    <requestedDisplayResolution>high</requestedDisplayResolution>
    <Entitlements><![CDATA[

        <!-- DEVELOPMENT -->
        <key>get-task-allow</key>
        <true/>
        <key>aps-environment</key>
        <string>development</string>

        <!-- PRODUCTION -->
        <!--
        <key>get-task-allow</key>
        <false/>
        <key>aps-environment</key>
        <string>production</string>
        -->

        <key>application-identifier</key>
        <string>BUNDLE_SEED_ID.BUNDLE_IDENTIFIER</string>
        <key>keychain-access-groups</key>
        <array>
            <string>BUNDLE_SEED_ID.*</string>
        </array>

    ]]></Entitlements>
</iPhone>

The first entitlement field is the aps-environment. This field indicates whether we are using the development or the production environment. It must be either development or production and depends on which configuration you are using. If you are running a debug build you should use development. If you are looking to publish the application to the AppStore, you should use production.

You should have noted the BUNDLE_SEED_ID (or App ID Prefix) and BUNDLE_IDENTIFIER when you were setting up your application in the iOS developer center. The seed id should be a unique ten character string and the identifier should be similar to your AIR application id.

Android

Firstly make sure you have generated your Google Service API Key. You can follow the guide by OneSignal:

• Generate a Google Server API Key
• Use an existing Firebase project

Manifest Additions

You must add all the OneSignal related manifest additions along with several additions for Cloud Messaging. This includes all the manifest additions required for Firebase core / analytics implementation.

The following shows the complete manifest additions node. You must replace APPLICATION_PACKAGE with your AIR application's Java package name, something like APPLICATION_PACKAGE. Generally this is your AIR application id prefixed by air. unless you have specified no air flair in your build options.

<manifest android:installLocation="auto" >
  <uses-sdk android:minSdkVersion="21" android:targetSdkVersion="34"/>
  <uses-permission android:name="android.permission.INTERNET"/>

  <!-- BADGE -->
  <uses-permission android:name="com.sec.android.provider.badge.permission.READ"/>
  <uses-permission android:name="com.sec.android.provider.badge.permission.WRITE"/>
  <uses-permission android:name="com.htc.launcher.permission.READ_SETTINGS"/>
  <uses-permission android:name="com.htc.launcher.permission.UPDATE_SHORTCUT"/>
  <uses-permission android:name="com.sonyericsson.home.permission.BROADCAST_BADGE"/>
  <uses-permission android:name="com.sonymobile.home.permission.PROVIDER_INSERT_BADGE"/>
  <uses-permission android:name="com.anddoes.launcher.permission.UPDATE_COUNT"/>
  <uses-permission android:name="com.majeur.launcher.permission.UPDATE_BADGE"/>
  <uses-permission android:name="com.huawei.android.launcher.permission.CHANGE_BADGE"/>
  <uses-permission android:name="com.huawei.android.launcher.permission.READ_SETTINGS"/>
  <uses-permission android:name="com.huawei.android.launcher.permission.WRITE_SETTINGS"/>
  <uses-permission android:name="android.permission.READ_APP_BADGE"/>
  <uses-permission android:name="com.oppo.launcher.permission.READ_SETTINGS"/>
  <uses-permission android:name="com.oppo.launcher.permission.WRITE_SETTINGS"/>
  <uses-permission android:name="me.everything.badger.permission.BADGE_COUNT_READ"/>
  <uses-permission android:name="me.everything.badger.permission.BADGE_COUNT_WRITE"/>

  <application android:appComponentFactory="androidx.core.app.CoreComponentFactory">

    <!-- NOTIFICATIONS -->
    <receiver android:name="com.distriqt.extension.pushnotifications.notifications.receivers.NotificationReceiver" android:exported="false">
      <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED"/>
        <action android:name="android.intent.action.QUICKBOOT_POWERON"/>
      </intent-filter>
      <intent-filter>
        <action android:name="APPLICATION_PACKAGE.NOTIFICATION_DELETED"/>
        <action android:name="APPLICATION_PACKAGE.NOTIFICATION_ACTION"/>
        <data android:scheme="dtpn"/>
      </intent-filter>
    </receiver>
    <activity android:name="com.distriqt.extension.pushnotifications.notifications.NotificationActivity" android:exported="false">
      <intent-filter>
        <action android:name="APPLICATION_PACKAGE.NOTIFICATION_SELECTED"/>
        <action android:name="APPLICATION_PACKAGE.NOTIFICATION_ACTION"/>
        <data android:scheme="dtpn"/>
      </intent-filter>
    </activity>
    <provider android:name="com.distriqt.extension.pushnotifications.content.FileProvider" android:authorities="APPLICATION_PACKAGE.pushnotificationsfileprovider" android:exported="false" android:grantUriPermissions="true">
      <meta-data android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/distriqt_pushnotifications_paths"/>
    </provider>

    <activity android:name="com.distriqt.core.auth.AuthorisationActivity" android:exported="false" android:theme="@android:style/Theme.Translucent.NoTitleBar"/>
  </application>
</manifest>

Amazon

Amazon is a specific implementation of Android and requires some additional manifest additions if you are distributing your application via the Amazon AppStore.

Firstly add the amazon namespace to your manifest tag:

<manifest android:installLocation="auto"
    xmlns:amazon="http://schemas.amazon.com/apk/res/android"
>

Add the following permissions:

<uses-permission android:name="com.amazon.device.messaging.permission.RECEIVE" />
<permission android:name="APPLICATION_PACKAGE.permission.RECEIVE_ADM_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="APPLICATION_PACKAGE.permission.RECEIVE_ADM_MESSAGE" />

In the application tag, add the following:

<amazon:enable-feature android:name="com.amazon.device.messaging" android:required="false"/>
<service android:name="com.onesignal.ADMMessageHandler" android:exported="false" />
<service android:name="com.onesignal.ADMMessageHandlerJob"
         android:permission="android.permission.BIND_JOB_SERVICE"
         android:exported="false" />
<receiver android:name="com.onesignal.ADMMessageHandler$Receiver"
          android:permission="com.amazon.device.messaging.permission.SEND" >
    <intent-filter>
        <action android:name="com.amazon.device.messaging.intent.REGISTRATION" />
        <action android:name="com.amazon.device.messaging.intent.RECEIVE" />
        <category android:name="APPLICATION_PACKAGE" />
    </intent-filter>
</receiver>

Follow the guide here to generate your Amazon API Key. You should end up with a file (api_key.txt) that you will need to add to the root of your application and ensure it is packaged into your application.

danger

Do not place the api_key.txt file in an assets folder as mentioned in the OneSignal documentation. Any assets from AIR are automatically added into this directory, so add it at the top level of your application package.

info

You will need to be using a recent version of AIR to be able to support these additional manifest namespaces and tags.