OneSignal Push Notification

You'll need to import the javascript file in your website before starting from this link.

getPlayerId: It returns playerId from OneSignal - that can be used to send custom notification from OneSignalApis.

Plain Javascript

const { getPlayerId } = WTN.OneSignal;

getPlayerId().then(function(playerId){
  if(playerId){
    // handle for playerId
    console.log(playerId)
  }
});

ES5+

setExternalUserId: To set unique user Id to OneSignal.

Plain Javascript

const { setExternalUserId } = WTN.OneSignal;

setExternalUserId("#$%jfnkjf");

ES5+

removeExternalUserId: To remove externalUserId

Plain Javascript

const { removeExternalUserId } = WTN.OneSignal;

removeExternalUserId();

ES5+

setTags: To add custom data attributes to your OneSignal Users

Plain Javascript

const { setTags } = WTN.OneSignal;

setTags({
  tags:{
    type:'PREMIUM'
  }
});

ES5+

Triggers: https://documentation.onesignal.com/docs/iam-triggers

addTrigger

Plain Javascript

const { addTrigger } = WTN.OneSignal;

addTrigger({
    key: "Trigger Key",
    value: "Trigger Value"
});

ES5+

addTriggers

Plain Javascript

const { addTriggers } = WTN.OneSignal;

addTriggers({
    triggers: [
        {
            key: "Trigger Key 1",
            value: "Trigger Value 1"
        },
        {
            key: "Trigger Key 2",
            value: "Trigger Value 2"
        }
    ]
});

ES5+

removeTrigger

Plain Javascript

const { removeTrigger } = WTN.OneSignal;

removeTrigger({
    key: "Trigger Key"
});

ES5+

removeTriggers

Plain Javascript

const { removeTriggers } = WTN.OneSignal;

removeTriggers({
    keys: [ "Trigger Key 1" , "Trigger Key 2" ]
});

ES5+

getTriggerValue - depricated

Plain Javascript

const { getTriggerValue } = WTN.OneSignal;

getTriggerValue({
    key: "Trigger Key",
    callback: function(data){
        if(data.isSuccess){
            //data.value contains trigger value for corresponding key
        }
    }
});

ES5+

getTriggers - depricated

Plain Javascript

const { getTriggers } = WTN.OneSignal;

getTriggers({
    callback:function(data){
        if(data.isSuccess){
            //data.triggers contains list of active trigger
            /*
                e.g.     
                {
                    key: "Trigger Key 1",
                    value: "Trigger Value 1"
                },
                {
                    key: "Trigger Key 2",
                    value: "Trigger Value 2"
                }
            /*
        }
    }
});

ES5+

Setting Email and SMS Numbers

Feature released on 12/06/2023

Available only on Android

Setting and Logging Out Email

Plain Javascript

const { setEmail, logoutEmail } = WTN.OneSignal;

setEmail({
    emailId:"[email protected]"
});

logoutEmail({
    emailId:"[email protected]"
});

ES5+

Setting and Logging Out SMS Number

Plain Javascript

const { setEmail, logoutEmail } = WTN.OneSignal;

setSMSNumber({
    smsNumber:"[phone]"
});
//Pass Mobile Number with ISD Code

logoutSMSNumber({
    smsNumber:"[phone]"
}); 

ES5+

• Changes done on 26th June, 2024 for Android targetSdk 34. Now for logout the email and number is mandatory for the required functions.

OptIn and OptOut Functions

Feature added on 06/12/2024

This can be used to manually optin and optout users from OnrSignal.

Plain Javascript

const { optInUser, optOutUser } = WTN.OneSignal;

optInUser();

optOutUser();

ES5+