The documentation is currently a work in progress whilst the product is in alpha.

openNotificationSettings

Android Only

API used to open the Android System settings for the application.



openNotificationSettings(channelId?: undefined | string): Promise<void>;

If the API version is >= 26:

  • With no channelId, the notification settings screen is displayed.
  • With a channelId, the notification settings screen for the specific channel is displayed.

If the API version is < 26, the application settings screen is displayed. The channelId is ignored.

If an invalid channelId is provided (e.g. does not exist), the settings screen will redirect back to your application.

On iOS, this is a no-op & instantly resolves.


PropertyDescriptionOptional
channelId

The ID of the channel which will be opened. Can be ignored/omitted to display the overall notification settings.


Copyright 2020 © Invertase Limited

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License and code samples are licensed under the Apache 2.0 License.

All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.