@ionic-native/onesignal

Improve this doc

OneSignal

$ ionic cordova plugin add onesignal-cordova-plugin
$ npm install @ionic-native/onesignal

Usage Documentation

Plugin Repo: https://github.com/OneSignal/OneSignal-Cordova-SDK

The OneSignal plugin is an client implementation for using the OneSignal Service. OneSignal is a simple implementation for delivering push notifications.

Please view the official OneSignal Ionic SDK Installation guide for more information.

Icons

If you want to use generated icons with command ionic cordova resources:

• Add a file to your hooks directory called copy_android_notification_icons.js

• Configure the hook in your config.xml

    <platform name="android">
        <hook type="after_prepare" src="hooks/copy_android_notification_icons.js" />
    </platform>

• Put the following code in it:

#!/usr/bin/env node

var fs = require('fs');
var path = require('path');

var filestocopy = [{
    "resources/android/icon/drawable-hdpi-icon.png":
        "platforms/android/app/src/main/res/drawable-hdpi/ic_stat_onesignal_default.png"
}, {
    "resources/android/icon/drawable-mdpi-icon.png":
        "platforms/android/app/src/main/res/drawable-mdpi/ic_stat_onesignal_default.png"
}, {
    "resources/android/icon/drawable-xhdpi-icon.png":
        "platforms/android/app/src/main/res/drawable-xhdpi/ic_stat_onesignal_default.png"
}, {
    "resources/android/icon/drawable-xxhdpi-icon.png":
        "platforms/android/app/src/main/res/drawable-xxhdpi/ic_stat_onesignal_default.png"
}, {
    "resources/android/icon/drawable-xxxhdpi-icon.png":
        "platforms/android/app/src/main/res/drawable-xxxhdpi/ic_stat_onesignal_default.png"
} ];

module.exports = function(context) {

    // no need to configure below
    var rootdir = context.opts.projectRoot;

    filestocopy.forEach(function(obj) {
        Object.keys(obj).forEach(function(key) {
            var val = obj[key];
            var srcfile = path.join(rootdir, key);
            var destfile = path.join(rootdir, val);
            console.log("copying "+srcfile+" to "+destfile);
            var destdir = path.dirname(destfile);
            if (fs.existsSync(srcfile) && fs.existsSync(destdir)) {
                fs.createReadStream(srcfile).pipe(
                    fs.createWriteStream(destfile));
            }
        });
    });

};

• From the root of your project make the file executable: $ chmod +x hooks/copy_android_notification_icons.js

Supported platforms

• Amazon Fire OS
  • Android
  • iOS
  • Windows

Changelog

5.36.1 (2021-10-01)

Bug Fixes

• barcode-scanner: add saveHistory option (#3713) (39ad4d1), closes /github.com/phonegap/phonegap-plugin-barcodescanner/blob/v8.1.0/src/android/com/phonegap/plugins/barcodescanner/BarcodeScanner.java#L52
• build: allow rxjs 7 closes #3691 (cd477bc)
• purchases: remove static for logIn, logOut methods (#3709) (c6b65e9)

Code Refactoring

• remove app-update plugin (#3510) (f474d5b)

Features

• adjust: update wrapper for Adjust Cordova SDK v4.29.0 (#3720) (68af9eb)
• all-in-one-sdk: add assist interface (#3717) (8ebdc6e)
• bluetooth-classic-serial: add plugin (#3729) (4c8de4d)
• facebook: plugin updates (#3721) (6f14bce)
• facebook: plugin updates (#3728) (54c197a)
• in-app-update: add plugin (#3714) (eb8d252)
• play-install-referrer: add plugin (#3718) (9a1b964)
• preview-any-file: new methods to preview or open files from url, path, assets or base64 (#3612) (24379b0)

BREAKING CHANGES

• app-update plugin is removed for violating Google Play Store policies