Privacy

• Provide user consent - If your application is set to require the user's privacy consent, you can provide this interface for the user to give consent. Until enabled, the OneSignal SDK will not fully initialize.

  • Consent - Check to acknowledge that the user has provided consent.

• Update if user provided consent - Checks if the user has already provided privacy consent. Callback trigger "On update if user provided consent" fires and toggles the condition "Is consent provided".

iOS

• Prompt for push notifications permission - Prompt the user for notifications permission. This will launch the iOS notification permission consent dialog. You can only prompt once, so make sure to specify the benefits.

Tags

• Get tags - Retrieve a list of tags that have been set on the user from the OneSignal servers.

• Send tag - Tag a user based on an app event of your choosing so you can later create segments through OneSignal's "Segments" feature to target users.

  • Key - Key of your choosing to create or update.

  • Value - Value to set for the key. [Note] Passing in a blank string deletes the key, you can also call the "Delete tag" or "Delete tags" action.

• Delete tag - Deletes a single tag that was previously set on a user with "Send tag" or "Send tags" action.

  • Key - Key to remove.

Tags - Batched

• Send tags - Tag a user based on an app event of your choosing so you can later create segments through OneSignal's "Segments" feature to target users. List is collected from previously set plans.

• Delete tags - Deletes one or more tags that were previously set on a user through the "Send Tag" or "Send Tags" action. List collected from previously set plans.

• Plan send tag - Plan a tag to add in the next "Send tags" action.

  • Key - Key of your choosing to create or update.

  • Value - Value to set for the key. [Note] Passing in a blank string deletes the key, you can also call the "Delete tag" or "Delete tags" action.

• Plan delete tag - Plan to add a tag for removal in the next "Delete tags" action.

  • Key - Key to remove.

Data

• Prompt location dialog - Prompts the user for location permissions consent. If user gives consent in the dialog prompt, geotagging will be allowed so that you can send notifications to users based on their location.

Sending notifications

• Post notification - Allows you to send notifications from user to user or schedule ones in the future to be delivered to the current device.

  • Parameter JSON - Contains the notification configuration. Reference documentation: https://documentation.onesignal.com/reference#create-notification

• Clear notifications - Clears all notifications in the "Notification Center", also known as the mobile notification shade.

In-app messaging - Trigger

• Add trigger - Add a trigger, may show an in-app message if its triggers' conditions are met.

  • Key - Key for the trigger.

  • Value - Value for the trigger.

• Remove trigger - Removes a single trigger with the given key, may show an in-app message if its triggers' conditions are met.

  • Key - Key for trigger to remove.

• Get trigger value - Gets the trigger value from a provided trigger key.

  • Key - Key for the trigger.

In-app messaging - Trigger - Batched

• Add triggers - Add a key-value object of triggers, may show an in-app message if its triggers' conditions are met. List collected from previously set plans.

• Remove triggers - Removes a list of triggers based on a collection of keys, may show an in-app message if its triggers' conditions are met. List collected from previously set plans.

• Plan add trigger - Plan a trigger to add in the next "Add triggers" action.

  • Key - Key for the trigger.

  • Value - Value for the trigger.

• Plan remove trigger - Plan to add a trigger for removal in the next "Remove triggers" action.

  • Key - Key for trigger to remove.

In-app messaging - Click

• Pause in-app messages - Allows you to temporarily pause all in-app messages. You may want to do this while the user is watching a video playing a match in your game to make sure they don't get interrupted at a bad time.

  • Toggle - Check to pause, and uncheck to resume.

Email

• Set email - This allows you to set the user's email address for the OneSignal service.

  • Email address - The email address of the user. Make sure it is verified and unique.

  • Email auth-token - Authentication token from your backend server.

• Log out email - If your app implements logout functionality, you can call this to dissociate the email from the device.

External Ids

• Set external user id - If your system assigns unique identifiers to users, it can be annoying to have to also remember their OneSignal user id as well. To make things easier, OneSignal now allows you to set an [external_id] for your users. Simply call this action, pass in your custom user id as a string. And then, from now on when you send push notifications, you can use 'include_external_user_ids' instead of 'include_player_ids'.

  • User id - User identification provided by your backend server. For example, the user's PlayFab Id.

• Remove external user id - User id provided by your backend server. For example, the user's PlayFab Id.

Notification

• Set push disabled - Enable or disable receiving of push notifications. If checked, this unsubscribes the user from the OneSignal service in receiving push notifications.

  • Toggle - Check to stop receiving push notifications, and uncheck to start/resume receiving of push notifications.

User properties

• Get device state - Get the current device's notification subscription and permission state.

Deprecated

• Enable vibrate - [Deprecated] By default OneSignal always vibrates the device when a notification is displayed unless the device is in a total silent mode. Setting unchecked means that the device will only vibrate lightly when the device is in its vibrate only mode.

  • Toggle - Set unchecked to disable vibrate, set checked to enable/re-enable vibrate.

• Enable sound - [Deprecated] By default OneSignal plays the system's default notification sound when the device's notification system volume is turned on. You may also set "custom sounds" for notifications. Setting unchecked means that the device will only vibrate unless the device is set to a total silent mode.

  • Toggle - Set unchecked to disable sound, set checked to enable/re-enable sound.

• Set subscription - [Deprecated] You can call this method and set unchecked to opt users out of receiving push notifications from OneSignal. You can set checked later to opt users back into receiving notifications. This unsubscribes the user from OneSignal, but the device will still show as subscribed to push.

  • Toggle - Check to receive push notifications, uncheck to disable receiving push notifications.

• Get permission subscription state - [Deprecated] Get the current notifications and permissions state.