setForegroundNotificationPresentationOptions method

Future<void> setForegroundNotificationPresentationOptions({
  1. required bool alert,
  2. required bool badge,
  3. required bool sound,
})

Sets the presentation options for iOS based notifications when received in the foreground.

By default, on iOS devices notification messages are only shown when the application is in the background or terminated. Calling this method updates these settings to allow a notification to trigger feedback to the user.

Important: The requested permissions and those set by the user take priority over these settings.

  • alert Causes a notification message to display in the foreground, overlaying the current application (heads up mode).
  • badge The application badge count will be updated if the application is in the foreground.
  • sound The device will trigger a sound if the application is in the foreground.

If all arguments are false, a notification message will not be displayed in the foreground.

Implementation

Future<void> setForegroundNotificationPresentationOptions({
  required bool alert,
  required bool badge,
  required bool sound,
}) {
  throw UnimplementedError(
      'setForegroundNotificationPresentationOptions() is not implemented');
}