IOSFlutterLocalNotificationsPlugin class
iOS implementation of the local notifications plugin.
- Inheritance
-
- Object
- PlatformInterface
- FlutterLocalNotificationsPlatform
- IOSFlutterLocalNotificationsPlugin
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> -
Cancel/remove the notification with the specified id.
inherited
-
cancelAll(
) → Future< void> -
Cancels/removes all notifications. This applies to notifications that have been scheduled and those that have already been presented.
inherited
-
getNotificationAppLaunchDetails(
) → Future< NotificationAppLaunchDetails?> -
Returns info on if a notification had been used to launch the application.
inherited
-
initialize(
IOSInitializationSettings initializationSettings, {SelectNotificationCallback? onSelectNotification}) → Future< bool?> - Initializes the plugin.
-
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
inherited
-
periodicallyShow(
int id, String? title, String? body, RepeatInterval repeatInterval, {IOSNotificationDetails? notificationDetails, String? payload}) → Future< void> -
Periodically show a notification using the specified interval.
For example, specifying a hourly interval means the first time the
notification will be an hour after the method has been called and then
every hour after that.
override
-
requestPermissions(
{bool sound = false, bool alert = false, bool badge = false}) → Future< bool?> - Requests the specified permission(s) from user and returns current permission status.
-
schedule(
int id, String? title, String? body, DateTime scheduledDate, IOSNotificationDetails? notificationDetails, {String? payload}) → Future< void> - Schedules a notification to be shown at the specified date and time with an optional payload that is passed through when a notification is tapped.
-
show(
int id, String? title, String? body, {IOSNotificationDetails? 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.
override
-
showDailyAtTime(
int id, String? title, String? body, Time notificationTime, IOSNotificationDetails? notificationDetails, {String? payload}) → Future< void> - Shows a notification on a daily interval at the specified time.
-
showWeeklyAtDayAndTime(
int id, String? title, String? body, Day day, Time notificationTime, IOSNotificationDetails? notificationDetails, {String? payload}) → Future< void> - Shows a notification on weekly interval at the specified day and time.
-
toString(
) → String -
A string representation of this object.
inherited
-
zonedSchedule(
int id, String? title, String? body, TZDateTime scheduledDate, IOSNotificationDetails? notificationDetails, {required UILocalNotificationDateInterpretation uiLocalNotificationDateInterpretation, String? payload, DateTimeComponents? matchDateTimeComponents}) → Future< void> - Schedules a notification to be shown at the specified time in the future in a specific time zone.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited