(Android + iOS) Setting to control how OneSignal notifications will be shown when one is received while your app is in focus, for apps targeting.

• DisplayType.NONE
• DisplayType.IN_APP_ALERT
• DisplayType.NOTIFICATION

(Android + iOS) You can use this property to check if the OneSignal SDK is waiting for the user to provide privacy consent.

For GDPR users, your application should call this method before initialization of the SDK. If you pass in true, your application will need to call provideConsent(true) before the OneSignal SDK gets fully initialized. Until this happens, you can continue to call methods (such as sendTags()), but nothing will happen.

Cancels a single OneSignal notification based on its Android notification integer id. Use instead of Android's NotificationManager.cancel(id); otherwise the notification will be restored when your app is restarted.

Parameters

Removes all OneSignal notifications from the Notification Shade. If you just use NotificationManager.cancelAll(); OneSignal notifications will be restored your app is restarted.

If you set the SDK to require the user's privacy consent, your application can use this method once the user does or doesn't provide privacy consent to use the OneSignal SDK.

Parameters

Deletes a single tag that was previously set on a user with sendTag or sendTags. Use deleteTags if you need to delete more than one.

Parameters

Deletes one or more tags that were previously set on a user with sendTag or sendTags.

Parameters

By default OneSignal plays the system's default notification sound when the device's notification system volume is turned on. Passing false means that the device will only vibrate unless the device is set to a total silent mode.

You can link this action to a UI button to give your user a different sound option for your notifications.

Parameters

By default OneSignal always vibrates the device when a notification is displayed unless the device is in a total silent mode. Passing false means that the device will only vibrate lightly when the device is in it's vibrate only mode.

You can link this action to a UI button to give your user a vibration option for your notifications.

Parameters

Get the current notification and permission state.

Retrieve a list of tags that have been set on the user from the OneSignal server.

Parameters

Parameters

If your app implements logout functionality, you can call logoutEmail to dissociate the email from the device

Parameters

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

See the Create notification REST API POST, https://documentation.onesignal.com/reference-link/create-notification call for a list of all possible options. Note: You can only use include_player_ids as a targeting parameter from your app. Other target options such as tags and included_segments require your OneSignal App REST API key which can only be used from your server.

Parameters

presents the settings page to control/customize push notification settings

(iOS) Prompt the user for notification permissions. Callback fires as soon as the user accepts or declines notifications.

must have set settings.autoPrompt = false; when calling OneSignal.init(settings);

IOS Recommendations: You can only prompt once so it is recommend to explain what benefits notifications will give the user.

Parameters

Prompts the user for location permissions to allow geo-tagging from the OneSignal dashboard. This lets you send notifications based on the device's location.

Note: Requires the follow entries in your .plist file.

• NSLocationUsageDescription
• NSLocationWhenInUseUsageDescription

• NSLocationAlwaysAndWhenInUseUsageDescription and NSLocationAlwaysUsageDescription along with UIBackgroundModes -> location

(Android) Notification channels are needed on Android 8+ only. You need to create one or more channels for notifications in your app and then pass the channel instance when posting the OneSignal message.

Parameters

(iOS) supported on iOS 12+

Parameters

Tag a user based on an app event of your choosing so later you can create segments on onesignal.com to target these users. Recommend using sendTags over sendTag if you need to set more than one tag on a user at a time.

Parameters

Tag a user based on an app event of your choosing so later you can create segments on onesignal.com to target these users.

Parameters

setEmail allows you to set the user's email address with the OneSignal SDK. If you have a backend server, we strongly recommend using Identity Verification with your users. Your backend can generate an email authentication token and send it to your app.

Parameters

If your system assigns unique identifiers to users, it can be annoying to have to also remember their OneSignal user ID's as well. To make things easier, OneSignal now allows you to set an external_id for your users. Simply call this method, pass in your custom user ID (as a string), and from now on when you send a push notification, you can use include_external_user_ids instead of include_player_ids.

Parameters

Allows you to enable or disable OneSignal SDK location collection. Due to Apple's App Store Guidelines, it is required in iOS applications to get the user's consent before collecting location.

Parameters

Enable logging to help debug if you run into an issue setting up OneSignal. This selector is static so you can call it before OneSignal init. The following options are available with increasingly more information;

• LogLevel.NONE
• LogLevel.FATAL
• LogLevel.ERROR
• LogLevel.WARN
• LogLevel.INFO
• LogLevel.DEBUG
• LogLevel.VERBOSE

Parameters

You can call this method with false to opt users out of receiving all notifications through OneSignal. You can pass true later to opt users back into notifications.

Parameters