flutter_local_notifications

• [Android] added support for showing subtext in the notification. Thanks to the PR from sidlatau

• [Android] added support for showing the notification timestamp as a stopwatch instead via the usesChronometer argument added to the constructor of the AndroidNotificationDetails class. Thanks to the PR from andymstone
• Updated readme to add more clarity on the compatibility with firebase_messaging plugin and iOS setup sections
• Updated changelog entry for the 2.0.0 release around support for full-screen intents to clarify that the fullScreenIntent was added to the constructor of the AndroidNotificationDetails class.

• Updated API docs for the UriAndroidNotificationSound class to further clarify that developers may need to write code that makes use of platform channels
• [Android] fix issue 881 where recurring notifications may fail to schedule the next occurrence on older Android versions as the ThreeTen Android Backport library hadn't been initialised yet
• [Android] switched implementation of createNotificationChannelGroup and deleteNotificationChannelGroup methods to use the NotificationManager APIs instead of the NotificationManagerCompat APIs. If you had issues with 3.0.1 then this should fix the issue (e.g. as reported in issue 871) as the the APIs that were previously being called would've required apps to use more recent versions of the AndroidX libraries

• [Android] additional fix for issue 871 by switching the implementation of deleteNotificationChannel to use the NotificationManager APIs instead of the NotificationManagerCompat APIs

• [Android] Fixed issue 898 around duplicate pending notifications
• Updated example app to more clearly indicate which button will demonstrate an Android notification with a different coloured icon and LED

• [Android] made changes so that the plugin will now register the receivers and permissions needed. This reduces the amount of setup needed as developers will no longer need to update their AndroidManifest.xml to do so. The section of the readme on the Android setup for scheduled notifications has been removed as a result
• [Android] fixed an issue where notifications may not appear after rebooting
• [Android] made changes so that the plugin itself specifies which classes should be kept when minified. This means developers should no longer need to add a rule for this plugin in their application's Proguard rules file. Note that rules for GSON will still be needed. The release build configuration section related to the Android setup has been updated to reflect this change
• Bump dependency on flutter_local_notifications_platform_interface
• Updated API docs

• Fixed links in table of contents in the readme. Thanks to the PR from Dihak
• Added a note in the readme to indicate changes were done in version 3.0.1+4 to reduce the setup to ensure readers have updated their application to use the latest version of the plugin
• Added a note around setting the application badge with a link to a plugin that supports this functionality

• [Android] change how the intent that associated with the notification is determined so that the plugin. This is to allow the plugin to work with applications that use activity aliases as per issue 92. Thanks the PR from crazecoder
• Fixed issue 924, where example app will now use https URLs for downloading placeholder images. These images were used when displaying some of the notifications. Thanks to the PR from Fareez

• [Android] fixed issue 935 where scheduling a notification on Android devices running Android versions older than 4.4 (API 19) could cause a crash from using an API that isn't available

• [Android] Added the createNotificationChannelGroup and deleteNotificationChannelGroup methods to the AndroidFluttterLocalNotificationsPlugin class that can be used to create and delete notification channel groups. The optional groupId parameter has been added to the AndroidNotificationChannel class that can be used to associated notification channels to a particular group. Example app has been updated to include code snippets for this.

• [iOS] Fixed issue 865 where notifications with no title weren't behaving properly
• Updated API docs and readme around handling when full-screen intent notifications occur
• Updated API docs around notification channel management

• Breaking change The scheduledNotificationRepeatFrequency parameter of the zonedSchedule method has been removed. This has been replaced by matchDateTimeComponents parameter that can be used to schedule a recurring notification. This was done to better indicate that this is used to schedule recurring daily of weekly notifications based on the specified date components. This is more inline with how the calendar trigger works for notifications for iOS and macOS. Given a date (e.g. Monday 2020-10-19 10:00 AM), specifying to match on the time component of would result in a notification occurring daily at the same time (10:00 AM). Specifying to match on the day of the week and time allows for a weekly notification to occur (Monday 10:00 AM), The deprecation warnings for the showDailyAtTime() and showWeeklyAtDayAndTime() methods have been updated to give a brief description along the same lines.

• [iOS][macOS] fixed issue 860 where notifications may fail to be scheduled to an error parsing the specified date that could occur for some users depending on their locale and if they had turned off the setting for showing 24 hour time on their device. Thanks to the PR from Eugene Alitz

• Updated example application to demonstrate how to use the schedule notifications to occur on particular weekday using zonedSchedule method
• Added a note on migrating away from the deprecated methods for scheduling daily/weekly notifications

• [Android] updated plugin and steps in the readme to ensure notifications remain scheduled after a HTC device restarts. Thanks to the PR from Le Liam

• Fixed code snippet in readme around initialisation and configuring the onDidReceiveLocalNotification callback specific to iOS. Thanks to the PR from Mike Truso

• Added macOS implementation of the plugin
• The schedule, showDailyAtTime and showWeeklyAtDayAndTime methods has been marked as a deprecated due to problems with time zones, particularly when it comes to daylight savings.
• Added the zonedSchedule method to the plugin that allows for scheduling notifications to occur on a specific date and time relative a specific time zone. This can be used to schedule daily and weekly notifications as well. The example app has been updated to demonstrate its usage. Applications will need to retrieve the device's local IANA timezone ID via native code or a plugin (e.g. flutter_native_timezone). Note that to support time zone-based scheduling, the plugin now depends on the timezone package so that an instance of the TZDateTime class is required to the specify the time the notification should occur. This should work in most cases as it is IANA-based and native platforms have time zones that are IANA-based as well. To support time zone aware dates on older versions of Android (which use older Java APIs), the plugin depends on the ThreeTen Android Backport library. Once Flutter's support for Android Studio 4.0 and Android Gradle plugin 4.0 has stabilised, the plugin will be updated to make use of desugaring instead of relying on the ThreeTen Android Backport library.
• [Android] Fixed issue [670] where getNotificationAppLaunchDetails() behaved inconsistently depending on if it was called before or after initialize()
• [Android] Added the getActiveNotifications() method to the AndroidFlutterLocalNotificationsPlugin class thanks to the PR from Vincent Kammerer. This can be used to query the active notifications and is only applicable to Android 6.0 or newer
• [Android] Fixed an issue where the error message for an invalid source resource wasn't formatted correctly to include the name of the specified resource
• [Android] Added androidAllowWhileIdle boolean argument to the periodicallyShow method. When set to true, this changes how recurring notifications are shown so that the Android AlarmManager API is used to schedule a notification with exact timing. When the notification appears, the next one is scheduled after that. This is get around the limitations where the AlarmManager APIs don't provide a way for work to be repeated with precising timing regardless of the power mode. The example app has been updated to include these changes so that it can be used as a reference as well
• [Android] Added support for full-screen notifications via the fullScreenIntent argument that has been added to the constructor of the AndroidNotificationDetails class. Thanks to the PR from Nadav Fima
• [Android] Bumped compile SDK to 30 (Android 11)
• [Android] Added ability to specify shortcut id that can be used for conversations. See https://developer.android.com/guide/topics/ui/conversations for more info. Note the plugin doesn't provide the ability to publish shortcuts so developers will likely need to look into writing their own code to do so and save the shortcut id so that it can be linked to notifications
• [iOS] Updated the details in the plugin's podspec file
• [iOS] Added ability to specify a subtitle for a notification via the subtitle property of the IOSNotificationDetails class. This property is only application to iOS versions 10 or newer
• Breaking change The InitializationSettings and NotificationDetails classes no longer have positional parameters but now have named parameters called android and iOS for passing in data specific to Android and iOS. There macOS named parameter has also been added for passing data specific to macOS
• Breaking change The toMap method that was used internally to transfer data over platform channels is no longer publicly accessible
• Breaking change All enum values have been renamed to follow lower camel case convention. This affects the following enums
  • Day
  • AndroidNotificationChannelAction
  • Importance (note: as default is a keyword, what use to be Default is now defaultImportance)
  • Priority (note: as default is a keyword, what use to be Default is now defaultPriority)
  • GroupAlertBehavior
  • NotificationVisibility
  • RepeatInterval
• Breaking change assertions have been added to the IOSInitializationSettings constructor to prevent null values being passed in
• Updated example app so that code for demonstrating functionality that is specific to a platform are only visible when running on the appropriate platform
• Bumped Android dependencies
• Updated example app's Proguard rules file to match latest configuration required by GSON
• Bumped lower bound of Dart SDK dependency to 2.6
• Updated and fixed wording in API docs
• Readme now has a table of contents. Thanks to the PR from Ascênio

This was incorrectly published in the 1.5.0 update

• Revert the breaking 1.5.0 update as that should have been published with the major version incremented

• BAD This was a breaking change that was published as a minor version update. This has been reverted by [1.5.0+1]

• Added macOS implementation of the plugin

• The schedule, showDailyAtTime and showWeeklyAtDayAndTime methods has been marked as a deprecated due to problems with time zones, particularly when it comes to daylight savings.

• Added the zonedSchedule method to the plugin that allows for scheduling notifications to occur on a specific date and time relative a specific time zone. This can be used to schedule daily and weekly notifications as well. The example app has been updated to demonstrate its usage. Note that to support time zone-based scheduling, the plugin now depends on the timezone package so that an instance of the TZDateTime class is required to the specify the time the notification should occur. This should work in most cases as it is IANA-based and native platforms have time zones that are IANA-based as well. To support time zone aware dates on older versions of Android (which use older Java APIs), the plugin depends on the ThreeTen Android Backport library. Once Flutter's support for Android Studio 4.0 and Android Gradle plugin 4.0 has stabilised, the plugin will be updated to make use of desugaring instead of relying on the ThreeTen Android Backport library.

• [Android] Fixed issue [670] where getNotificationAppLaunchDetails() behaved inconsistently depending on if it was called before or after initialize()

• [Android] Added the getActiveNotifications() method to the AndroidFlutterLocalNotificationsPlugin class thanks to the PR from Vincent Kammerer. This can be used to query the active notifications and is only applicable to Android 6.0 or newer

• [Android] Fixed an issue where the error message for an invalid source resource wasn't formatted correctly to include the name of the specified resource

• [Android] Added androidAllowWhileIdle boolean argument to the periodicallyShow method. When set to true, this changes how recurring notifications are shown so that the Android AlarmManager API is used to schedule a notification with exact timing. When the notification appears, the next one is scheduled after that. This is get around the limitations where the AlarmManager APIs don't provide a way for work to be repeated with precising timing regardless of the power mode. The example app has been updated to include these changes so that it can be used as a reference as well

• [Android] Added support for full-screen notifications via the fullScreenIntent argument that has been added to the AndroidNotificationDetails class. Thanks to the PR from Nadav Fima

• [Android] Bumped compile SDK to 30 (Android 11)

• [Android] Added ability to specify shortcut id that can be used for conversations. See https://developer.android.com/guide/topics/ui/conversations for more info. Note the plugin doesn't provide the ability to publish shortcuts so developers will likely need to look into writing their own code to do so and save the shortcut id so that it can be linked to notifications

• [iOS] Updated the details in the plugin's podspec file

• [iOS] Added ability to specify a subtitle for a notification via the subtitle property of the IOSNotificationDetails class. This property is only application to iOS versions 10 or newer

• Breaking change The InitializationSettings and NotificationDetails classes no longer have positional parameters but now have named parameters called android and iOS for passing in data specific to Android and iOS. There macOS named parameter has also been added for passing data specific to macOS

• Breaking change The toMap method that was used internally to transfer data over platform channels is no longer publicly accessible

• Breaking change All enum values have been renamed to follow lower camel case convention. This affects the following enums

  • Day
  • AndroidNotificationChannelAction
  • Importance (note: as default is a keyword, what use to be Default is now defaultImportance)
  • Priority (note: as default is a keyword, what use to be Default is now defaultPriority)
  • GroupAlertBehavior
  • NotificationVisibility
  • RepeatInterval

• Breaking change assertions have been added to the IOSInitializationSettings constructor to prevent null values being passed in

• Updated example app so that code for demonstrating functionality that is specific to a platform are only visible when running on the appropriate platform

• Bumped Android dependencies

• Updated example app's Proguard rules file to match latest configuration required by GSON

• Bumped lower bound of Dart SDK dependency to 2.6

• Updated and fixed wording in API docs

• Readme now has a table of contents. Thanks to the PR from Ascênio

• Added details that platform-specific implementations can be obtained to the Caveats and limitations section
• Added a note on restrictions imposed by the OS by Android OEMs that may be prevent scheduled notifications appearing
• Release configurations section of the readme renamed to Release build configuration

• [Android] Updated readme and plugin to fix issue 689 where plugin needs to ensure notifications stay scheduled after an application update
• Removed e2e dependency

• [Android] Fix issue 751 where the onSelectNotification callback could be called again after the user has tapped on a notification, sent the application to the background and returned to the app via the Recents screen. This issue could have previously called getNotificationAppLaunchDetails() to mistakenly report that a notification launched the app when it's called again as part of the application being resumed

• [Android] Fix issue 759 by guarding code on getting the intent from the activity in case there isn't an activity that could cause initialize() and getNotificationAppLaunchDetails() to fail when called from the background

• Updated the platform package version range constraint so that 3.x null safety releases could be used (currently used in Flutter 1.22 stable)

• [iOS] Fixes to ensure that the native completion handlers were called appropriately. If you had some issues using this plugin combined with push notifications (e.g. via firebase_messaging) when the app was in the foreground then I would recommend updating to this version. Thanks to Paweł Szot for picking up the gap in the code in handling the native willPresentNotification call
• The readme has been been touched up and had some sections rearranged. Thanks to the PR from psyanite
• Bumped lower bound of Dart SDK dependency to 2.0

• [Android] added the ability to specify additional flags for the notification. For example, this could be used to allow the audio to repeat. See the API docs and update example app for more details. Thanks to the PR from andylei
• Minor cleanup of API docs

• [Android] added the ability to specify the timestamp shown in the notification (issue 596). Thanks to the PR from Nicolas Schneider.
• Fixed API docs for showWeeklyAtDayAndTime

• [Android] added the ability to create notification channels before a notification is shown. This can be done by calling the createNotificationChannel within the AndroidFlutterLocalNotificationsPlugin class. This allows applications to create notification channels before a notification is shown. Thanks to the PR from Vladimir Gerashchenko.
• [Android] added the ability to delete notification channels. This can be done by calling deleteNotificationChannel within AndroidFlutterLocalNotificationsPlugin class.

Please note that there are a number of breaking changes in this release to improve the developer experience when using the plugin APIs. The changes should hopefully be straightforward but please through the changelog carefully just in case. The steps migrate your code has been covered below but the Git history of the example application's main.dart file can also be used as reference.

• [Android] Breaking change The style property of the AndroidNotificationDetails class has been removed as it was redundant. No changes are needed unless your application was displaying media notifications (i.e. style was set to AndroidNotificationStyle.Media). If this is the case, you can migrate your code by setting the styleInformation property of the AndroidNotificationDetails to an instance of the MediaNotificationStyleInformation class. This class is a new addition in this release

• [Android] Breaking change The AndroidNotificationSound abstract class has been introduced to represent Android notification sounds. The sound property of the AndroidNotificationDetails class has changed from being a String type to an AndroidNotificationSound type. In this release, the AndroidNotificationSound has the following subclasses

  • RawResourceAndroidNotificationSound: use this when the sound is raw resource associated with the Android application. Previously, this was the only type of sound supported so applications using the plugin prior to 1.4.0 can migrate their application by using this class. For example, if your previous code was

    var androidPlatformChannelSpecifics = AndroidNotificationDetails(
      'your other channel id',
      'your other channel name',
      'your other channel description',
      sound: 'slow_spring_board');
    

    Replace it with

    var androidPlatformChannelSpecifics = AndroidNotificationDetails(
      'your other channel id',
      'your other channel name',
      'your other channel description',
      sound: RawResourceAndroidNotificationSound('slow_spring_board');
    

  • UriAndroidNotificationSound: use this when a URI refers to the sound on the Android device. This is a new feature being supported as part of this release. Developers may need to write their code to access native Android APIs (e.g. the RingtoneManager APIs) to obtain the URIs they need.

• [Android] Breaking change The BitmapSource enum has been replaced by the newly AndroidBitmap abstract class and its subclasses. This removes the need to specify the name/path of the bitmap and the source of the bitmap as two separate properties (e.g. the largeIcon and largeIconBitmapSource properties of the AndroidNotificationDetails class). This change affects the following classes

  • AndroidNotificationDetails: the largeIcon is now an AndroidBitmap type instead of a String and the largeIconBitmapSource property has been removed
  • BigPictureStyleInformation: the largeIcon is now an AndroidBitmap type instead of a String and the largeIconBitmapSource property has been removed. The bigPicture is now a AndroidBitmap type instead of a String and the bigPictureBitmapSource property has been removed

  The following describes how each BitmapSource value maps to the AndroidBitmap subclasses

  • BitmapSource.Drawable -> DrawableResourceAndroidBitmap
  • BitmapSource.FilePath -> FilePathAndroidBitmap

  Each of these subclasses has a constructor that an argument referring to the bitmap itself. For example, if you previously had the following code

  var androidPlatformChannelSpecifics = AndroidNotificationDetails(
    'your other channel id',
    'your other channel name',
    'your other channel description',
    largeIcon: 'sample_large_icon',
    largeIconBitmapSource: BitmapSource.Drawable,
  )
  

  This would now be replaced with

  var androidPlatformChannelSpecifics = AndroidNotificationDetails(
    'your other channel id',
    'your other channel name',
    'your other channel description',
    largeIcon: DrawableResourceAndroidBitmap('sample_large_icon'),
  )
  

• [Android] Breaking change The IconSource enum has been replaced by the newly added AndroidIcon abstract class and its subclasses. This change was done for similar reasons in replacing the BitmapSource enum. This only affects the Person class, which is used when displaying each person in a messaging-style notification. Here the icon property is now an AndroidIcon type instead of a String and the iconSource property has been removed.

  The following describes how each IconSource value maps to the AndroidIcon subclasses

  • IconSource.Drawable -> DrawableResourceAndroidIcon
  • IconSource.FilePath -> BitmapFilePathAndroidIcon
  • IconSource.ContentUri -> ContentUriAndroidIcon

  Each of these subclasses has a constructor that accepts an argument referring to the icon itself. For example, if you previously had the following code

  Person(
    icon: 'me',
    iconSource: IconSource.Drawable,
  )
  

  This would now be replaced with

  Person(
    icon: DrawableResourceAndroidIcon('me'),
  )
  

  The AndroidIcon also has a BitmapAssetAndroidIcon subclass to enables the usage of bitmap icons that have been registered as a Flutter asset via the pubspec.yaml file.

• [Android] Breaking change All properties in the AndroidNotificationDetails, DefaultStyleInformation and InboxStyleInformation classes have been made final

• The DefaultStyleInformation class now implements the StyleInformation class instead of extending it

• Where possible, classes in the plugins have been updated to provide const constructors

• Updates to API docs and readme

• Bump Android dependencies

• Fixed a grammar issue 0.9.1 changelog entry

• [iOS] Breaking change Plugin will now throw a PlatformException if there was an error returned upon calling the native addNotificationRequest method. Previously the error was logged on the native side the using NSLog function.
• [iOS] Added ability to associate notifications with attachments. Only applicable to iOS 10+ where the UserNotification APIs are used. Thanks to the PR from Pavel Sipaylo
• Updated readme on using firebase_messaging together with flutter_local_notifications to let the community that firebase_messaging 6.0.13 can be used to resolve compatibility issues around callbacks when both plugins are used together

• [Android] Added ability to specify if the timestamp for when a notification occurred should be displayed. Thanks to the PR from mojtabaghiasi

• [Android] Fixed issue 512 where calling getNotificationAppLaunchDetails() within the onSelectNotification callback could indicating that the app was launched by tapping on a notification when it wasn't the case
• Update example app to indicate if a notification launched the app and include the launch notification payload

• The static values properties for the Day and Importance classes now return List<Day> and List<Importance> respectively instead of being dynamic
• Added more public API documentation
• Updated readme to move issues and contributions section to the readme within the repository
• Added screenshots to readme
• Updated how breaking changes are highlighted in changelog to all the letters aren't capitalised

• Make the static values propeerty of the Priority class return List<Priority> instead of being dynamic and added API docs for the property.

• Updated API docs for resolvePlatformSpecificImplementation() method

• Title at the top of the readme is now the same name as the plugin
• Updated readme to add subsections under the Android and iOS integration guide
• Added links in the readme under the Android release build configuration section that point to the configuration files used by the example app

• Added the resolvePlatformSpecificImplementation() method to the FlutterLocalNotificationsPlugin class. This can be used to resolve the underlying platform implementation in order to access platform-specific APIs.
• Breaking change the static instance properties in the IOSFlutterLocalNotificationsPlugin and AndroidFlutterLocalNotificationsPlugin classes have been removed due to addition of the resolvePlatformSpecificImplementation()
• Updated readme to remove use of new keyword in code snippets
• Bumped e2e dependency
• Bumped example app dependencies
• Make the pedantic dev_dependency explicit

• Minor update to readme on description around requesting notification permissions
• Add link to forked firebase_messaging plugin to readme for those that want to use it whilst the PR to fix the compatibility issues with this plugin is waiting to be reviewed

• [iOS] Added requestPermissions() method to IOSFlutterLocalNotificationsPlugin class. This can be used to request notification permissions separately from plugin initialisation. To facilitate this the IOSFlutterLocalNotificationsPlugin and AndroidFlutterLocalNotificationsPlugin now expose a static instance property that can be used obtain the platform-specific implementation of the plugin so that platform-specific methods can be used. Thanks to the PR from Dariusz Łuksza
• Updated documentation to clarify that getNotificationAppLaunchDetails() is intended to be used more on if a notification from this plugin triggered launch an application
• Updated API docs for consistency and to better follow the guidelines on effective Dart documentation

• [iOS] Added ability to set badge number. Thanks to PR from FelixYew
• Fixed a spelling mistake in the 1.1.5+1 changelog entry

• No functional changes. Fixed a reported formatting issue
• Mention removal of named constructor argument in 1.1.0 changelog entry
• Add API docs to FlutterLocalNotificationsPlugin.private() on how it could be used for testing
• Update notes on testing to mention that the FlutterLocalNotificationsPlugin.private() named constructor may be of use

• [Android] minor optimisation on scheduling related code so that Gson instance is reused instead of being rebuilt each time
• Changed plugin to require 1.12.3+hotfix.5 or greater since pub has issues resolving 1.12.3+hotfix.6
• Updated changelog entry for version 1.1.4 to mention removal of upper bound constraint on Flutter SDK requirement

• Support v2 Android embedding. Note that there is currently a known issue in the Flutter SDK that will cause onSelectNotification to fire twice on Android. The fix is in the master channel but hasn't rolled out to other channels. Subscribe to the issue for updates.
• Require Flutter SDK 1.12.3+hotfix.6 or greater. Maximum SDK restraint has also been removed

• Expose NotificationAppLaunchDetails via main plugin
• Retroactively updated changelog for 1.1.0 to indicate breaking change on moving to using platform interface
• Made plugin methods be a no-op to fix issue with version 1.1.0 where test code involving the plugin would fail when running on an environment that is neither Android or iOS

• Passing a null notification id now throws an ArgumentError. Thanks to PR from talmor_guy
• Slight tweak to message displayed with by ArgumentError when notification id is not within range of a 32-bit integer

• [Android] Added ability to specify timeout duration of notification
• [Android] Added ability to specify the notification category

• Breaking change Updated plugin to make use of flutter_local_notifications_platform_interface version 1.0.1. This allows for platform-specific implementations of the platform interface to now be accessible. Note that the plugin will check which platform the plugin is running on. Note: this may have inadvertently broke some tests for users as the plugin now checks which platform the plugin is executing code on and would throw an UnimplementedError since neither iOS or Android can be detected. Another issue is that NotificationAppLaunchDetails was no longer exposed via the main plugin. Please upgrade to 1.1.3 to have both of these issues fixed
• Breaking change Plugin callbacks are no longer publicly accessible
• Breaking change [iOS] Local notifications that launched the app should now only be processed by the plugin if they were created by the plugin.
• Breaking change MethodChannel argument has been removed from the named constructor that was visible for testing purposes