Skip to content

markosole/nativescript-onesignal

 
 

Repository files navigation

NativeScript-OneSignal

A Nativescript plugin that wraps the iOS and Android OneSignal Push Notifications SDK.

Contributors

OneSignal-iOS-SDK

OneSignal-Android-SDK

Supported Platforms

  • iOS 9+ incl 14.2
  • Android

Installation

tns plugin add nativescript-onesignal

iOS

Enable background notifications and add Push Cotifications in Xcode project.

Android

Add your google-services.json file to /App_Resources/Android/

Usage

JavaScript and TypeScript

var TnsOneSignal = require('nativescript-onesignal').TnsOneSignal

iOS

TnsOneSignal is the native iOS OneSignal class.

In your app.js:

var TnsOneSignal = require('nativescript-onesignal').TnsOneSignal

if (application.ios) {
        const MyDelegate = (function (_super) {
            __extends(MyDelegate, _super);
            function MyDelegate() {
                _super.apply(this, arguments);
            }
            MyDelegate.prototype.applicationDidFinishLaunchingWithOptions = function (application, launchOptions) {

                console.log("Application data: " + application);
                try {
                    console.log('Onesignal starts here:', TnsOneSignal);
                    TnsOneSignal.initWithLaunchOptions({ kOSSettingsKeyAutoPrompt: true, kOSSettingsKeyInAppLaunchURL: true, kOSSettingsKeyInFocusDisplayOption: 2, kOSSettingsKeyProvidesAppNotificationSettings: true });
                    TnsOneSignal.setAppId("xxxxxxx-xxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxxxxxxxx");

                    // It is important to call this for any user response. Default iOS option (allow and deny) will be provided.
                    TnsOneSignal.promptForPushNotificationsWithUserResponse(funCallback());
                    function funCallback(permission) {
                        console.log("Permission selection callback:" + permission);
                    }

                } catch (error) {
                    console.log("Error: ", error)
                }
                return true;
            };
            MyDelegate.prototype.applicationDidBecomeActive = function (application) {
                console.log("Application is activated: " + application);
            };
            MyDelegate.ObjCProtocols = [UIApplicationDelegate];

            return MyDelegate;
        })(UIResponder);

        application.ios.delegate = MyDelegate;
    }

Android

TnsOneSignal is the native Android com.onesignal.OneSignal class.

In your app.js:

var TnsOneSignal = require('nativescript-onesignal').TnsOneSignal

if (application.android) {
    application.on(application.launchEvent, function (args) {
        try {

            TnsOneSignal.startInit(application.android.context).setNotificationOpenedHandler(new TnsOneSignal.NotificationOpenedHandler({

                notificationOpened: function (result) { // once notification is opened..
		// Catch payload objects sent from OneSignal dasboard
                    var obj = JSON.parse(result.notification.payload.rawPayload);
                    console.log(obj.alert);
                    var obj2 = JSON.parse(obj.custom);
                    // Onesignal example key pairs as payload
                    console.log("received example key param 1: " + obj2.a.key1);
                    console.log("received example key param 2: " + obj2.a.key2);

                }
		
            })).init();
            TnsOneSignal.setInFocusDisplaying(TnsOneSignal.OSInFocusDisplayOption.Notification);
            TnsOneSignal.startInit(application.android.context).init();
        } catch (error) {
            console.log('error', error);
        }
    })

}

API Reference

iOS API Reference

Android API Reference

Typescript Typings

iOS

Android - In the works...

Demo

npm run setup
# iOS
npm run demo.ios
# Android
npm run demo.android

About

A Nativescript plugin that wraps the iOS and Android OneSignal Push Notifications SDK.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 89.6%
  • TypeScript 9.7%
  • Ruby 0.7%