AndroidFlutterLocalNotificationsPlugin class

Android implementation of the local notifications plugin.

  • Object
  • PlatformInterface
  • FlutterLocalNotificationsPlatform
  • AndroidFlutterLocalNotificationsPlugin


hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


areNotificationsEnabled() Future<bool?>
Returns whether the app can post notifications.
cancel(int id, {String? tag}) Future<void>
Cancel/remove the notification with the specified id.
cancelAll() Future<void>
Cancels/removes all notifications. This applies to notifications that have been scheduled and those that have already been presented.
canScheduleExactNotifications() Future<bool?>
Returns whether the app can schedule exact notifications.
createNotificationChannel(AndroidNotificationChannel notificationChannel) Future<void>
Creates a notification channel.
createNotificationChannelGroup(AndroidNotificationChannelGroup notificationChannelGroup) Future<void>
Creates a notification channel group.
deleteNotificationChannel(String channelId) Future<void>
Deletes the notification channel with the specified channelId.
deleteNotificationChannelGroup(String groupId) Future<void>
Deletes the notification channel group with the specified groupId as well as all of the channels belonging to the group.
getActiveNotificationMessagingStyle(int id, {String? tag}) Future<MessagingStyleInformation?>
Returns the messaging style information of an active notification shown by the application that hasn't been dismissed/removed.
getActiveNotifications() Future<List<ActiveNotification>>
Returns the list of active notifications shown by the application that haven't been dismissed/removed.
getNotificationAppLaunchDetails() Future<NotificationAppLaunchDetails?>
Returns info on if a notification had been used to launch the application.
getNotificationChannels() Future<List<AndroidNotificationChannel>?>
Returns the list of all notification channels.
initialize(AndroidInitializationSettings initializationSettings, {DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse, DidReceiveBackgroundNotificationResponseCallback? onDidReceiveBackgroundNotificationResponse}) Future<bool>
Initializes the plugin.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
pendingNotificationRequests() Future<List<PendingNotificationRequest>>
Returns a list of notifications pending to be delivered/shown
periodicallyShow(int id, String? title, String? body, RepeatInterval repeatInterval, {AndroidNotificationDetails? notificationDetails, String? payload, AndroidScheduleMode scheduleMode = AndroidScheduleMode.exact}) Future<void>
Periodically show a notification using the specified interval.
requestExactAlarmsPermission() Future<bool?>
Requests the permission to schedule exact alarms.
requestNotificationsPermission() Future<bool?>
Requests the permission for sending notifications. Returns whether the permission was granted.
show(int id, String? title, String? body, {AndroidNotificationDetails? notificationDetails, String? payload}) Future<void>
Show a notification with an optional payload that will be passed back to the app when a notification is tapped on.
startForegroundService(int id, String? title, String? body, {AndroidNotificationDetails? notificationDetails, String? payload, AndroidServiceStartType startType = AndroidServiceStartType.startSticky, Set<AndroidServiceForegroundType>? foregroundServiceTypes}) Future<void>
Starts an Android foreground service with the given notification.
stopForegroundService() Future<void>
Stops a foreground service.
toString() String
A string representation of this object.
zonedSchedule(int id, String? title, String? body, TZDateTime scheduledDate, AndroidNotificationDetails? notificationDetails, {required AndroidScheduleMode scheduleMode, String? payload, DateTimeComponents? matchDateTimeComponents}) Future<void>
Schedules a notification to be shown at the specified date and time relative to a specific time zone.


operator ==(Object other) bool
The equality operator.