NotificationService class
Coordinates local notification permissions, display, and scheduling.
Create the active runtime with create or initialize, then dispose it before initializing the service with a different configuration.
- Mixed-in types
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isInitialized → bool
-
Whether this service has completed initialization and is not disposed.
no setter
-
onPermissionStatusChanged
→ Stream<
NotificationPermissionStatus> -
Stream of permission states published by permission checks and requests.
no setter
-
onRoutingEvent
→ Stream<
RoutingEvent> -
Stream of notification interactions routed by the active service.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancelAll(
) → Future< NotificationResult< void> > - Cancels all notifications managed by the enabled local features.
-
cancelAllReminders(
) → Future< NotificationResult< void> > - Cancels all active reminders.
-
cancelAllScheduled(
) → Future< NotificationResult< void> > - Cancels all scheduled notifications.
-
cancelNotification(
int id) → Future< NotificationResult< void> > -
Cancels a local or scheduled notification with identifier
id. -
cancelReminder(
int id) → Future< NotificationResult< void> > -
Cancels the reminder with identifier
id. -
cancelScheduled(
int id) → Future< NotificationResult< void> > - Cancels a scheduled notification by its identifier.
-
checkPermission(
) → Future< NotificationResult< NotificationPermissionStatus> > - Reads the current notification permission state.
-
didChangeAccessibilityFeatures(
) → void -
Called when the system changes the set of currently active accessibility
features.
inherited
-
didChangeAppLifecycleState(
AppLifecycleState state) → void -
Called when the system puts the app in the background or returns
the app to the foreground.
override
-
didChangeLocales(
List< Locale> ? locales) → void -
Called when the system tells the app that the user's locale has
changed. For example, if the user changes the system language
settings.
inherited
-
didChangeMetrics(
) → void -
Called when the application's dimensions change. For example,
when a phone is rotated.
inherited
-
didChangePlatformBrightness(
) → void -
Called when the platform brightness changes.
inherited
-
didChangeTextScaleFactor(
) → void -
Called when the platform's text scale factor changes.
inherited
-
didChangeViewFocus(
ViewFocusEvent event) → void -
Called whenever the PlatformDispatcher receives a notification that the
focus state on a view has changed.
inherited
-
didHaveMemoryPressure(
) → void -
Called when the system is running low on memory.
inherited
-
didPopRoute(
) → Future< bool> -
Called when the system tells the app to pop the current route, such as
after a system back button press or back gesture.
inherited
-
didPushRoute(
String route) → Future< bool> -
Called when the host tells the application to push a new route onto the
navigator.
inherited
-
didPushRouteInformation(
RouteInformation routeInformation) → Future< bool> -
Called when the host tells the application to push a new
RouteInformation and a restoration state onto the router.
inherited
-
didRequestAppExit(
) → Future< AppExitResponse> -
Called when a request is received from the system to exit the application.
inherited
-
dispose(
) → Future< void> - Releases this runtime and its platform resources.
-
getPendingScheduled(
) → Future< NotificationResult< List< >int> > - Returns identifiers for notifications that are currently scheduled.
-
handleCancelBackGesture(
) → void -
Called when a predictive back gesture is canceled, indicating that no
navigation should occur.
inherited
-
handleCommitBackGesture(
) → void -
Called when a predictive back gesture is finished successfully, indicating
that the current route should be popped.
inherited
-
handleStartBackGesture(
PredictiveBackEvent backEvent) → bool -
Called at the start of a predictive back gesture.
inherited
-
handleStatusBarTap(
) → void -
Called when the user taps the status bar on iOS, to scroll a scroll
view to the top.
inherited
-
handleUpdateBackGestureProgress(
PredictiveBackEvent backEvent) → void -
Called when a predictive back gesture moves.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openNotificationSettings(
) → Future< NotificationResult< void> > - Opens this app's notification settings in the operating system.
-
requestPermission(
{BuildContext? context, bool includeExactAlarm = false}) → Future< NotificationResult< NotificationPermissionStatus> > - Requests notification permission and returns the resulting state.
-
scheduleNotification(
ScheduledNotification notification) → Future< NotificationResult< void> > -
Schedules
notificationfor its configured time and recurrence. -
scheduleReminder(
ReminderNotification reminder) → Future< NotificationResult< void> > -
Schedules
reminderaccording to its time and reminder options. -
showNotification(
NotificationPayload payload) → Future< NotificationResult< void> > -
Displays
payloadimmediately. -
showReminder(
ReminderNotification reminder) → Future< NotificationResult< void> > -
Displays
reminderimmediately. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance → NotificationService
-
Active service, or an uninitialized instance whose operations return
NotInitializedFailure.
no setter
Static Methods
-
create(
NotificationConfig config) → Future< NotificationResult< NotificationService> > - Creates and initializes the single active notification runtime.
-
initialize(
NotificationConfig config) → Future< NotificationResult< NotificationService> > - Initializes the service; equivalent to create.