changeNotificationOptions method

  1. @override
Future<AndroidNotificationData?> changeNotificationOptions({
  1. String? channelName,
  2. String? title,
  3. String? iconName,
  4. String? subtitle,
  5. String? description,
  6. Color? color,
  7. bool? onTapBringToFront,
})
override

Change options of sticky background notification on Android.

This method only applies to Android and allows for customizing the notification, which is shown when enableBackgroundMode is set to true.

Uses title as the notification's content title and searches for a drawable resource with the given iconName. If no matching resource is found, no icon is shown. The content text will be set to subTitle, while the sub text will be set to description. The notification color can also be customized.

When onTapBringToFront is set to true, tapping the notification will bring the activity back to the front.

Both title and channelName will be set to defaults, if no values are provided. All other null arguments will be ignored.

Returns AndroidNotificationData if the notification is currently being shown. This can be used to change the notification from other parts of the app.

For Android SDK versions above 25, uses channelName for the NotificationChannel.

Implementation

@override
Future<AndroidNotificationData?> changeNotificationOptions({
  String? channelName,
  String? title,
  String? iconName,
  String? subtitle,
  String? description,
  Color? color,
  bool? onTapBringToFront,
}) async {
  // This method only applies to Android.
  // Do nothing to prevent user from handling a potential UnimplementedError.
  return null;
}