GotAllTags

Raised after GetAllTags finishes. Returns all user tags as a dictionary.
tagDictionary : dictionary

NotificationSent

Raised when a notification is sent successfully

NotificationSendFailed

Raised when sending a notification fails. Returns the error message.
errorMsg : text

PermissionStateChanged

Raised after requesting notification permission. Returns true if permission was granted.
isGranted : boolean

NotificationOpened

Raised when the user opens a notification. Returns the notification ID, title, body, and the notification data as JSON text.
id : number
title : text
body : text
data : text

NotificationReceived

Raised when a notification is received while the app is open. Returns the notification ID, title, body, and the notification data as JSON text.
id : number
title : text
body : text
data : text

ActionButtonClicked

Raised when the user taps a notification action button. Returns the notification ID, action ID, title, body, and the notification data as JSON text.
id : number
actionId : text
title : text
body : text
data : text

SubscriptionChanged

Raised when the push subscription state changes. Returns whether push is enabled, the subscription ID, and the push token.
isSubscribed : boolean
subscriptionId : text
pushToken : text

AddUserEmail

Adds an email address to the current user in OneSignal
email : text

RemoveUserEmail

Removes an email address from the current user in OneSignal
email : text

AddUserPhone

Adds a phone number for SMS messages
phone : text

RemoveUserPhone

Removes the phone number used for SMS messages
phone : text

Initialize

Initializes OneSignal with your App ID. It is recommended to call this only once.
appId : text

ClearNotification

Clears a specific notification using its Android notification ID
id : number

ClearAllNotifications

Clears all notifications posted by this app

AskPermission

Requests notification permission on Android 13 and above. Use the PermissionStateChanged event to know the result.

IsPermissionGranted

Returns true if notification permission is granted. Always returns true on Android 12 and below.

IsInitialized

Returns true if OneSignal is already initialized

Login

Logs in with the given external user ID so you can identify the user across devices and send targeted notifications
userId : text

GetUserId

Returns the current external user ID set with Login

GetSubscriptionId

Returns the current push subscription ID. It is used when sending notifications to specific users.

GetPushToken

Returns the current device push token

AddTag

Adds or updates a user tag with the specified key and value
tag : text
value : text

RemoveTag

Removes a user tag
tag : text

GetAllTags

Gets all tags for the current user. The result is returned in GotAllTags event.

EnablePush

Enables push notifications for the current user in OneSignal

DisablePush

Disables push notifications for the current user in OneSignal

IsSubscribed

Returns true if push notifications are enabled for the current user

LogOut

Logs out the current user from OneSignal

RetrieveBackgroundNotifs

Returns notifications that were received while the app was closed. Each value contains the notification data, title, and body as JSON text.

ClearBackgroundNotifs

Clears all saved background notifications

SendToAllSubscribers

Sends a notification to all subscribed users
apiKey : text
appId : text
title : text
body : text
largeIcon : text
data : dictionary

SendToSubsIDs

Sends a notification to the specified subscription IDs. Use GetSubscriptionId to collect these IDs first. The IDs should be provided as a list of strings.
apiKey : text
appId : text
ids : list
title : text
body : text
largeIcon : text
data : text

SendCustomNotif

Sends a custom OneSignal notification request using raw JSON. Use this when you need options not covered by the built-in send blocks. Notification sound can be set in the JSON using the "sound" key. Example: "sound": "notification" for notification.mp3 in assets or "sound": "default". The JSON should include the app_id and at least one targeting parameter (e.g. included_segments or include_subscription_ids). Refer to OneSignal's API documentation for details: https://documentation.onesignal.com/reference/create-notification
apiKey : text
jsonString : text

SdkVersion

Returns the OneSignal SDK version used by this extension
Accepts: text

Language

Sets the user's language in OneSignal. Example: "en" or "hi"
Accepts: text

SmallIcon

Sets the custom small notification icon from app assets, to be used while showing notifications
Accepts: text

UseBigPicture

If true, notifications sent by this extension will use the image URL as a big picture instead of a large icon
Accepts: boolean