Skip to content

Upgrading flutter_local_notifications 21 to 22

Breaking21.0.0 → 22.3.3Breaking2New4Changed5Fixed6Other2

Full comparisonBack to flutter_local_notifications
Fetching 11 releases from GitHub…10 / 11
BreakingUpgrade verdict

2 breaking changes.

In plain terms
  • On the web, the name of one input to the show() call has changed. Code that passes it by name must use the new name.
  • Two true/false permission checks on the web plugin are gone. Use the existing permissionStatus value to check permissions instead.
Must act 2 items need code or config changes

What you must change

Breaking2
Renames the Web show() method's details parameter to notificationDetails for consistency with other platform APIs.
show()detailsnotificationDetails
22.0.0-dev.2GitHub ReleaseSummarizedView source
Removes the hasPermission and isPermissionDenied boolean properties from WebFlutterLocalNotificationsPlugin; use permissionStatus instead.
WebFlutterLocalNotificationsPluginhasPermissionisPermissionDeniedpermissionStatus
22.0.0-dev.2GitHub ReleaseSummarizedView source

API changes

Generated by DepDelta from published Dart source. Not mixed with prose notes.

  • removed: enum DateTimeComponents
  • removed: member DateTimeComponents.dateAndTime
  • removed: member DateTimeComponents.dayOfMonthAndTime
  • removed: member DateTimeComponents.dayOfWeekAndTime
  • removed: member DateTimeComponents.time
  • changed: ctor BigPictureStyleInformation( this.bigPicture, { this.contentTitle, this.summaryText, this.htmlFormatContentTitle = …, this.htmlFormatSummaryText = …, this.largeIcon, bool htmlFormatContent = …, bool htmlFormatTitle = …, this.hideExpandedLargeIcon = …, }) → ctor BigPictureStyleInformation( this.bigPicture, { this.contentTitle, this.summaryText, this.htmlFormatContentTitle = …, this.htmlFormatSummaryText = …, this.largeIcon, bool htmlFormatContent = …, bool htmlFormatTitle = …, this.hideExpandedLargeIcon = …, this.showBigPictureWhenCollapsed = …, })
  • changed: ctor DarwinNotificationDetails({ this.presentAlert, this.presentBadge, this.presentSound, this.presentBanner, this.presentList, this.sound, this.badgeNumber, this.attachments, this.subtitle, this.threadIdentifier, this.categoryIdentifier, this.interruptionLevel, this.criticalSoundVolume, }) → ctor DarwinNotificationDetails({ this.presentAlert, this.presentBadge, this.presentSound, this.presentBanner, this.presentList, this.sound, this.badgeNumber, this.attachments, this.subtitle, this.threadIdentifier, this.categoryIdentifier, this.interruptionLevel, this.criticalSoundVolume, this.dismissIsolate, })
  • changed: ctor InitializationSettings({ this.android, this.iOS, this.macOS, this.linux, this.windows, }) → ctor InitializationSettings({ this.android, this.iOS, this.macOS, this.linux, this.windows, this.web, })
  • changed: ctor NotificationDetails({ this.android, this.iOS, this.macOS, this.linux, this.windows, }) → ctor NotificationDetails({ this.android, this.iOS, this.macOS, this.linux, this.windows, this.web, })
  • changed: method AndroidFlutterLocalNotificationsPlugin.zonedSchedule({ required int id, String? title, String? body, required TZDateTime scheduledDate, AndroidNotificationDetails? notificationDetails, required AndroidScheduleMode scheduleMode, String? payload, DateTimeComponents? matchDateTimeComponents, }): Future<void> → method AndroidFlutterLocalNotificationsPlugin.zonedSchedule({ required int id, String? title, String? body, required tz.TZDateTime scheduledDate, String? payload, DateTimeComponents? matchDateTimeComponents, AndroidNotificationDetails? notificationDetails, AndroidScheduleMode scheduleMode = …, }): Future<void>
  • changed: method IOSFlutterLocalNotificationsPlugin.zonedSchedule({ required int id, String? title, String? body, required TZDateTime scheduledDate, DarwinNotificationDetails? notificationDetails, String? payload, DateTimeComponents? matchDateTimeComponents, }): Future<void> → method IOSFlutterLocalNotificationsPlugin.zonedSchedule({ required int id, String? title, String? body, required tz.TZDateTime scheduledDate, String? payload, DateTimeComponents? matchDateTimeComponents, DarwinNotificationDetails? notificationDetails, }): Future<void>
  • changed: method MacOSFlutterLocalNotificationsPlugin.zonedSchedule({ required int id, String? title, String? body, required TZDateTime scheduledDate, DarwinNotificationDetails? notificationDetails, String? payload, DateTimeComponents? matchDateTimeComponents, }): Future<void> → method MacOSFlutterLocalNotificationsPlugin.zonedSchedule({ required int id, String? title, String? body, required tz.TZDateTime scheduledDate, String? payload, DateTimeComponents? matchDateTimeComponents, DarwinNotificationDetails? notificationDetails, }): Future<void>
  • added: enum NotificationDismissedIsolate
  • added: field AndroidNotificationDetails.dismissIsolate: final NotificationDismissedIsolate?
  • added: field BigPictureStyleInformation.showBigPictureWhenCollapsed: final bool
  • added: field DarwinNotificationDetails.dismissIsolate: final NotificationDismissedIsolate?
  • added: field InitializationSettings.web: final WebInitializationSettings?
  • added: field NotificationDetails.web: final WebNotificationDetails?
  • added: member NotificationDismissedIsolate.background
  • added: member NotificationDismissedIsolate.main
  • added: method AndroidFlutterLocalNotificationsPlugin.openAppNotificationSettings(): Future<bool?>
  • added: method FlutterLocalNotificationsPlugin.openAppNotificationSettings(): Future<bool?>
  • added: method IOSFlutterLocalNotificationsPlugin.openAppNotificationSettings(): Future<bool?>
  • added: method MacOSFlutterLocalNotificationsPlugin.openAppNotificationSettings(): Future<bool?>