FlutterLocalNotificationsWindows class
The Windows implementation of package:flutter_local_notifications.
- Inheritance
-
- Object
- PlatformInterface
- FlutterLocalNotificationsPlatform
- FlutterLocalNotificationsWindows
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancel(
int id) → Future< void> -
Cancels/removes the notification with the specified id.
override
-
cancelAll(
) → Future< void> -
Cancels/removes all notifications. This applies to notifications that have been scheduled and those that have already been presented.
override
-
cancelAllPendingNotifications(
) → Future< void> -
Cancels/removes all pending notifications.
inherited
-
dispose(
) → void - Releases any resources used by this plugin.
-
getActiveNotifications(
) → Future< List< ActiveNotification> > -
Returns the list of active notifications shown by the application that
haven't been dismissed/removed.
override
-
getNotificationAppLaunchDetails(
) → Future< NotificationAppLaunchDetails?> -
Returns info on if a notification had been used to launch the application.
override
-
initialize(
WindowsInitializationSettings settings, {DidReceiveNotificationResponseCallback? onNotificationReceived}) → Future< bool> - Initializes the plugin. No other method should be called before this.
-
isValidXml(
String xml) → bool - Checks if some XML is a valid Windows notification.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pendingNotificationRequests(
) → Future< List< PendingNotificationRequest> > -
Returns a list of notifications pending to be delivered/shown
override
-
periodicallyShow(
int id, String? title, String? body, RepeatInterval repeatInterval) → Future< void> -
Periodically show a notification using the specified interval.
override
-
periodicallyShowWithDuration(
int id, String? title, String? body, Duration repeatDurationInterval) → Future< void> -
Periodically show a notification using the specified custom duration
interval.
override
-
show(
int id, String? title, String? body, {String? payload, WindowsNotificationDetails? details}) → Future< void> - Show a notification with an optional payload that will be passed back to the app when a notification is tapped on.
-
showRawXml(
{required int id, required String xml, Map< String, String> bindings = const <String, String>{}}) → Future<void> - Shows a notification using raw XML passed to the Windows APIs.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateBindings(
{required int id, required Map< String, String> bindings}) → Future<NotificationUpdateResult> - Updates any data binding in the given notification.
-
updateProgressBar(
{required int notificationId, required WindowsProgressBar progressBar}) → Future< NotificationUpdateResult> -
Updates the progress bar in the notification with the given ID.
inherited
-
zonedSchedule(
int id, String? title, String? body, TZDateTime scheduledDate, WindowsNotificationDetails? details, {String? payload}) → Future< void> - Schedules a notification to appear at the given date and time.
-
zonedScheduleRawXml(
int id, String xml, TZDateTime scheduledDate, WindowsNotificationDetails? details) → Future< void> - Schedules a notification to appear using raw XML at this date and time.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited