Flutter Local Notifications

https://pub.dev/documentation/flutter_local_notifications/latest/
Admin
A cross-platform plugin for Flutter that enables displaying, scheduling, and managing local...
Tokens:78,270
Snippets:1,169
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Migrate from DarwinInitializationSettings to IOSInitializationSettings

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

Migration example showing the existing DarwinInitializationSettings usage that continues to work and the replacement with IOSInitializationSettings to add iOS-specific options like requestCarPlayPermission. Keep DarwinInitializationSettings for macOS initialization.

```dart
// Before (still works)
final DarwinInitializationSettings initializationSettingsDarwin =
    DarwinInitializationSettings(requestAlertPermission: true);

// After (with iOS-specific features)
final IOSInitializationSettings initializationSettingsIOS =
    IOSInitializationSettings(
        requestAlertPermission: true,
        requestCarPlayPermission: true,
    );
```

--------------------------------

### WindowsInitializationSettings constructor

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/WindowsInitializationSettings-class.html

Creates a new settings object for initializing this plugin on Windows. The constructor requires appName, appUserModelId, and guid, with an optional iconPath.

```APIDOC
## WindowsInitializationSettings constructor

### Description
Creates a new settings object for initializing this plugin on Windows.

### Constructor
`WindowsInitializationSettings({required String appName, required String appUserModelId, required String guid, String? iconPath})`

### Parameters
- **appName** (String) - Required - The name of the app that should be shown in the notification toast.
- **appUserModelId** (String) - Required - The unique app user model ID that identifies the app, in the form of CompanyName.ProductName.SubProduct.VersionInformation.
- **guid** (String) - Required - The GUID that identifies the notification activation callback.
- **iconPath** (String?) - Optional - The path to the icon of the notification.

### Example
```dart
WindowsInitializationSettings(
  appName: 'My App',
  appUserModelId: 'Company.Product.SubProduct.Version',
  guid: 'your-guid-here',
  iconPath: 'path/to/icon.ico',
);
```
```

--------------------------------

### AndroidFlutterLocalNotificationsPlugin Methods

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/AndroidFlutterLocalNotificationsPlugin-class.html

Methods for starting and stopping foreground services, scheduling timezone-aware notifications, and registering the plugin.

```APIDOC
## startForegroundService

### Description
Starts an Android foreground service with the given notification.

### Method
startForegroundService

### Parameters
- **id** (int) - Required - The notification id.
- **title** (String?) - Optional - The notification title.
- **body** (String?) - Optional - The notification body.
- **notificationDetails** (AndroidNotificationDetails?) - Optional - The notification details.
- **payload** (String?) - Optional - The notification payload.
- **startType** (AndroidServiceStartType) - Optional - The service start type. Defaults to `AndroidServiceStartType.startSticky`.
- **foregroundServiceTypes** (Set<AndroidServiceForegroundType>?) - Optional - The foreground service types.

### Returns
Future<void>
```

```APIDOC
## stopForegroundService

### Description
Stops a foreground service.

### Method
stopForegroundService

### Parameters
None

### Returns
Future<void>
```

```APIDOC
## zonedSchedule

### Description
Schedules a notification to be shown at the specified date and time relative to a specific time zone.

### Method
zonedSchedule

### Parameters
- **id** (int) - Required - The notification id.
- **title** (String?) - Optional - The notification title.
- **body** (String?) - Optional - The notification body.
- **scheduledDate** (TZDateTime) - Required - The scheduled date and time.
- **payload** (String?) - Optional - The notification payload.
- **matchDateTimeComponents** (DateTimeComponents?) - Optional - The date time components to match.
- **notificationDetails** (AndroidNotificationDetails?) - Optional - The notification details.
- **scheduleMode** (AndroidScheduleMode) - Optional - The schedule mode. Defaults to `AndroidScheduleMode.exact`.

### Returns
Future<void>
```

```APIDOC
## registerWith

### Description
Registers this implementation as the plugin instance.

### Method
registerWith

### Parameters
None

### Returns
void
```

--------------------------------

### hasPackageIdentity() → bool

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/MsixUtils-class.html

Returns whether the current app was installed with an MSIX installer. This can be used to conditionally enable MSIX-specific features.

```APIDOC
## hasPackageIdentity() → bool

### Description
Returns whether the current app was installed with an MSIX installer.

### Method
Static Method

### Signature
`static bool hasPackageIdentity()`

### Parameters
None

### Returns
- **bool** - `true` if the app was installed with MSIX, otherwise `false`.

### Example
```dart
bool hasIdentity = MsixUtils.hasPackageIdentity();
```
```

--------------------------------

### Get notification app launch details

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

Gets details on whether the app was launched via a notification created by this plugin.

```dart
final NotificationAppLaunchDetails? notificationAppLaunchDetails =
    await flutterLocalNotificationsPlugin.getNotificationAppLaunchDetails();
```

--------------------------------

### Periodically show notification with interval

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

Show a notification periodically with a specified interval using periodicallyShow. Not supported on Windows. The example uses RepeatInterval.everyMinute and exactAllowWhileIdle.

```dart
  const AndroidNotificationDetails androidNotificationDetails =
      AndroidNotificationDetails(
        'repeating channel id',
        'repeating channel name',
        channelDescription: 'repeating description',
      );
  const NotificationDetails notificationDetails = NotificationDetails(
    android: androidNotificationDetails,
  );
  await flutterLocalNotificationsPlugin.periodicallyShow(
    id: id++,
    title: 'repeating title',
    body: 'repeating body',
    repeatInterval: RepeatInterval.everyMinute,
    notificationDetails: notificationDetails,
    androidScheduleMode: AndroidScheduleMode.exactAllowWhileIdle,
  );

```

--------------------------------

### Set UNUserNotificationCenter delegate in AppDelegate

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

Set the notification center delegate in the application:didFinishLaunchingWithOptions: method to enable notification handling. Required for iOS setup.

```objective-c
[UNUserNotificationCenter currentNotificationCenter].delegate = (id<UNUserNotificationCenterDelegate>) self;

```

```swift
UNUserNotificationCenter.current().delegate = self as? UNUserNotificationCenterDelegate

```

--------------------------------

### Group Android notifications with groupKey and summary

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

Shows two notifications with the same groupKey and then a summary notification using InboxStyleInformation with setAsGroupSummary: true. This is a translation of the Android developer guide for grouping notifications.

```dart
const String groupKey = 'com.android.example.WORK_EMAIL';
const String groupChannelId = 'grouped channel id';
const String groupChannelName = 'grouped channel name';
const String groupChannelDescription = 'grouped channel description';
// example based on https://developer.android.com/training/notify-user/group.html
const AndroidNotificationDetails firstNotificationAndroidSpecifics =
    AndroidNotificationDetails(
      groupChannelId,
      groupChannelName,
      channelDescription: groupChannelDescription,
      importance: Importance.max,
      priority: Priority.high,
      groupKey: groupKey,
    );
const NotificationDetails firstNotificationPlatformSpecifics =
    NotificationDetails(android: firstNotificationAndroidSpecifics);
await flutterLocalNotificationsPlugin.show(
  id: id++,
  title: 'Alex Faarborg',
  body: 'You will not believe...',
  notificationDetails: firstNotificationPlatformSpecifics,
);
const AndroidNotificationDetails secondNotificationAndroidSpecifics =
    AndroidNotificationDetails(
      groupChannelId,
      groupChannelName,
      channelDescription: groupChannelDescription,
      importance: Importance.max,
      priority: Priority.high,
      groupKey: groupKey,
    );
const NotificationDetails secondNotificationPlatformSpecifics =
    NotificationDetails(android: secondNotificationAndroidSpecifics);
await flutterLocalNotificationsPlugin.show(
  id: id++,
  title: 'Jeff Chang',
  body: 'Please join us to celebrate the...',
  notificationDetails: secondNotificationPlatformSpecifics,
);

// Create the summary notification to support older devices that pre-date
/// Android 7.0 (API level 24).
///
/// Recommended to create this regardless as the behaviour may vary as
/// mentioned in https://developer.android.com/training/notify-user/group
const List<String> lines = <String>[
  'Alex Faarborg  Check this out',
  'Jeff Chang    Launch Party',
];
const InboxStyleInformation inboxStyleInformation = InboxStyleInformation(
  lines,
  contentTitle: '2 messages',
  summaryText: 'janedoe@example.com',
);
const AndroidNotificationDetails androidNotificationDetails =
    AndroidNotificationDetails(
      groupChannelId,
      groupChannelName,
      channelDescription: groupChannelDescription,
      styleInformation: inboxStyleInformation,
      groupKey: groupKey,
      setAsGroupSummary: true,
    );
const NotificationDetails notificationDetails = NotificationDetails(
  android: androidNotificationDetails,
);
await flutterLocalNotificationsPlugin.show(
  id: id++,
  title: 'Attention',
  body: 'Two messages',
  notificationDetails: notificationDetails,
);
```

--------------------------------

### initialize({required AndroidInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse, DidReceiveBackgroundNotificationResponseCallback? onDidReceiveBackgroundNotificationResponse})

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/AndroidFlutterLocalNotificationsPlugin-class.html

Initializes the plugin with the given settings and callbacks.

```APIDOC
## initialize({required AndroidInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse, DidReceiveBackgroundNotificationResponseCallback? onDidReceiveBackgroundNotificationResponse}) → Future<bool>

### Description
Initializes the plugin.

### Method
`Future<bool> initialize({required AndroidInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse, DidReceiveBackgroundNotificationResponseCallback? onDidReceiveBackgroundNotificationResponse})`

### Parameters
- **settings** (AndroidInitializationSettings) - Required - The initialization settings.
- **onDidReceiveNotificationResponse** (DidReceiveNotificationResponseCallback?) - Optional - Callback for notification response.
- **onDidReceiveBackgroundNotificationResponse** (DidReceiveBackgroundNotificationResponseCallback?) - Optional - Callback for background notification response.
```

--------------------------------

### initialize({required InitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse, DidReceiveBackgroundNotificationResponseCallback? onDidReceiveBackgroundNotificationResponse})

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/FlutterLocalNotificationsPlugin-class.html

Initializes the plugin with the given settings and callbacks.

```APIDOC
## initialize({required InitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse, DidReceiveBackgroundNotificationResponseCallback? onDidReceiveBackgroundNotificationResponse}) → Future<bool?>

### Description
Initializes the plugin.

### Method
`initialize`

### Parameters
- **settings** (InitializationSettings) - Required - The initialization settings for the plugin.
- **onDidReceiveNotificationResponse** (DidReceiveNotificationResponseCallback?) - Optional - Callback for when a notification is tapped.
- **onDidReceiveBackgroundNotificationResponse** (DidReceiveBackgroundNotificationResponseCallback?) - Optional - Callback for when a notification is tapped in the background.

### Returns
Future<bool?> - Whether initialization was successful.

```

--------------------------------

### initialize({required LinuxInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse})

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/LinuxFlutterLocalNotificationsPlugin-class.html

Errors on attempted calling of the stub. It exists only to satisfy compile-time dependencies, and should never actually be called.

```APIDOC
## initialize({required LinuxInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse})

### Description
Errors on attempted calling of the stub. It exists only to satisfy compile-time dependencies, and should never actually be called.

### Method
Future<bool?> initialize({required LinuxInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse})

### Parameters
- **settings** (LinuxInitializationSettings) - Required - The initialization settings for the Linux platform.
- **onDidReceiveNotificationResponse** (DidReceiveNotificationResponseCallback?) - Optional - Callback for when a notification response is received.

### Return Value
Future<bool?> - but throws an error if called.
```

--------------------------------

### getAssetUri(String path) → Uri

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/MsixUtils-class.html

Gets an ms-appx:/// URI from a Flutter asset path. This is useful for accessing assets in MSIX-packaged applications.

```APIDOC
## getAssetUri(String path) → Uri

### Description
Gets an `ms-appx:///` URI from a Flutter asset path.

### Method
Static Method

### Signature
`static Uri getAssetUri(String path)`

### Parameters
- **path** (String) - Required - The Flutter asset path.

### Returns
- **Uri** - The `ms-appx:///` URI corresponding to the asset.

### Example
```dart
Uri uri = MsixUtils.getAssetUri('assets/images/logo.png');
```
```

--------------------------------

### InitializationSettings

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/InitializationSettings-class.html

Documentation for the InitializationSettings class, including its constructor, properties, methods, and operators.

```APIDOC
## InitializationSettings

### Description
Settings for initializing the plugin for each platform.

### Constructor
`InitializationSettings({AndroidInitializationSettings? android, DarwinInitializationSettings? iOS, DarwinInitializationSettings? macOS, LinuxInitializationSettings? linux, WindowsInitializationSettings? windows, WebInitializationSettings? web})`

Constructs an instance of InitializationSettings.

### Properties
- **android** (AndroidInitializationSettings?) - Settings for Android.
- **iOS** (DarwinInitializationSettings?) - Settings for iOS.
- **macOS** (DarwinInitializationSettings?) - Settings for macOS.
- **linux** (LinuxInitializationSettings?) - Settings for Linux.
- **windows** (WindowsInitializationSettings?) - Settings for Windows.
- **web** (WebInitializationSettings?) - Settings for web.

### Methods
- **noSuchMethod(Invocation invocation)** → dynamic - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** → String - A string representation of this object. (inherited)

### Operators
- **operator ==(Object other)** → bool - The equality operator. (inherited)
```

--------------------------------

### initialize({required DarwinInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse, DidReceiveBackgroundNotificationResponseCallback? onDidReceiveBackgroundNotificationResponse}) → Future<bool?>

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/IOSFlutterLocalNotificationsPlugin-class.html

Initializes the plugin for iOS with the provided settings and optional callbacks for notification responses.

```APIDOC
## initialize({required DarwinInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse, DidReceiveBackgroundNotificationResponseCallback? onDidReceiveBackgroundNotificationResponse}) → Future<bool?>

### Description
Initializes the plugin for iOS. This method must be called before using other plugin methods.

### Parameters
- **settings** (DarwinInitializationSettings) - Required - The initialization settings for iOS.
- **onDidReceiveNotificationResponse** (DidReceiveNotificationResponseCallback?) - Optional - Callback when a notification is tapped.
- **onDidReceiveBackgroundNotificationResponse** (DidReceiveBackgroundNotificationResponseCallback?) - Optional - Callback when a notification is tapped while the app is in the background.

### Returns
`Future<bool?>` - A future that resolves to a boolean indicating success or null.
```

--------------------------------

### DarwinInitializationSettings

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/DarwinInitializationSettings-class.html

Documentation for the DarwinInitializationSettings class, including its constructor, properties, methods, and operators.

```APIDOC
## DarwinInitializationSettings

### Description
Constructs an instance of DarwinInitializationSettings for configuring plugin initialization on iOS and macOS.

### Constructor
`DarwinInitializationSettings({bool requestAlertPermission = true, bool requestSoundPermission = true, bool requestBadgePermission = true, bool requestProvisionalPermission = false, bool requestCriticalPermission = false, bool requestProvidesAppNotificationSettings = false, bool defaultPresentAlert = true, bool defaultPresentSound = true, bool defaultPresentBadge = true, bool defaultPresentBanner = true, bool defaultPresentList = true, List<DarwinNotificationCategory> notificationCategories = const <DarwinNotificationCategory>[]})`

### Parameters
- `requestAlertPermission` (bool) - Optional - Request permission to display an alert.
- `requestSoundPermission` (bool) - Optional - Request permission to play a sound.
- `requestBadgePermission` (bool) - Optional - Request permission to badge app icon.
- `requestProvisionalPermission` (bool) - Optional - Request permission to send provisional notification for iOS 12+.
- `requestCriticalPermission` (bool) - Optional - Request permission to show critical notifications.
- `requestProvidesAppNotificationSettings` (bool) - Optional - Request permission to provide custom notification settings UI.
- `defaultPresentAlert` (bool) - Optional - Configures the default setting on if an alert should be displayed when a notification is triggered while app is in the foreground.
- `defaultPresentSound` (bool) - Optional - Configures the default setting on if a sound should be played when a notification is triggered while app is in the foreground.
- `defaultPresentBadge` (bool) - Optional - Configures the default setting on if a badge value should be applied when a notification is triggered while app is in the foreground.
- `defaultPresentBanner` (bool) - Optional - Configures the default setting on if the notification should be presented as a banner when a notification is triggered while app is in the foreground.
- `defaultPresentList` (bool) - Optional - Configures the default setting on if the notification should be in the notification centre when notification is triggered while app is in the foreground.
- `notificationCategories` (List<DarwinNotificationCategory>) - Optional - Configure the notification categories (DarwinNotificationCategory) available. This allows for fine-tuning of preview display.

### Properties
- `defaultPresentAlert` (bool) - final - Configures the default setting on if an alert should be displayed when a notification is triggered while app is in the foreground.
- `defaultPresentBadge` (bool) - final - Configures the default setting on if a badge value should be applied when a notification is triggered while app is in the foreground.
- `defaultPresentBanner` (bool) - final - Configures the default setting on if the notification should be presented as a banner when a notification is triggered while app is in the foreground.
- `defaultPresentList` (bool) - final - Configures the default setting on if the notification should be in the notification centre when notification is triggered while app is in the foreground.
- `defaultPresentSound` (bool) - final - Configures the default setting on if a sound should be played when a notification is triggered while app is in the foreground.
- `notificationCategories` (List<DarwinNotificationCategory>) - final - Configure the notification categories (DarwinNotificationCategory) available. This allows for fine-tuning of preview display.
- `requestAlertPermission` (bool) - final - Request permission to display an alert.
- `requestBadgePermission` (bool) - final - Request permission to badge app icon.
- `requestCriticalPermission` (bool) - final - Request permission to show critical notifications.
- `requestProvidesAppNotificationSettings` (bool) - final - Request permission to provide custom notification settings UI.
- `requestProvisionalPermission` (bool) - final - Request permission to send provisional notification for iOS 12+.
- `requestSoundPermission` (bool) - final - Request permission to play a sound.

### Methods
- `noSuchMethod(Invocation invocation)` - dynamic - Invoked when a nonexistent method or property is accessed. (inherited)
- `toString()` - String - A string representation of this object. (inherited)

### Operators
- `operator ==(Object other)` - bool - The equality operator. (inherited)
```

--------------------------------

### initialize({required DarwinInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse}) → Future<bool?>

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/MacOSFlutterLocalNotificationsPlugin-class.html

Initializes the plugin. This method is specific to this class.

```APIDOC
## initialize({required DarwinInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse}) → Future<bool?>

### Description
Initializes the plugin.

### Method
`Future<bool?> initialize({required DarwinInitializationSettings settings, DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse})`

### Parameters
- **settings** (DarwinInitializationSettings) - Required - The initialization settings for the plugin.
- **onDidReceiveNotificationResponse** (DidReceiveNotificationResponseCallback?) - Optional - Callback for when a notification response is received.

### Returns
A `Future` that resolves to a `bool` indicating success, or `null` if not available.
```

--------------------------------

### Get active notifications with getActiveNotifications

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

Retrieves the list of active notifications. On Windows, the app must be packaged as an MSIX. The API works on Android 6.0+, iOS 10.0+, and macOS 10.14+.

```dart
final List<ActiveNotification> activeNotifications =
    await flutterLocalNotificationsPlugin.getActiveNotifications();
```

--------------------------------

### LinuxServerCapabilities

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/LinuxServerCapabilities-class.html

Documentation for the LinuxServerCapabilities class, including its constructor, properties, methods, and operators.

```APIDOC
## LinuxServerCapabilities

### Description
Represents capabilities implemented by the Linux notification server. This class is immutable and provides properties for each capability, a constructor to create an instance, and a copyWith method to create modified copies.

### Constructor
`LinuxServerCapabilities({required Set<String> otherCapabilities, required bool body, required bool bodyHyperlinks, required bool bodyImages, required bool bodyMarkup, required bool iconMulti, required bool iconStatic, required bool persistence, required bool sound, required bool actions, required bool actionIcons})`

Constructs an instance of LinuxServerCapabilities. All parameters are required.

### Properties
- **otherCapabilities** (Set<String>) - Set of unknown vendor-specific capabilities. Must start with `x-vendor` and contain only alphanumeric characters and dashes.
- **body** (bool) - Supports body text.
- **bodyHyperlinks** (bool) - Supports hyperlinks in notifications.
- **bodyImages** (bool) - Supports images in notifications.
- **bodyMarkup** (bool) - Supports markup in body text.
- **iconMulti** (bool) - Supports rendering animation of all frames in an image array.
- **iconStatic** (bool) - Supports display of exactly one frame of an image array.
- **persistence** (bool) - Supports persistence of notifications.
- **sound** (bool) - Supports sounds on notifications.
- **actions** (bool) - Supports providing actions to the user.
- **actionIcons** (bool) - Supports using icons for actions.

### Methods
#### copyWith
`LinuxServerCapabilities copyWith({Set<String>? otherCapabilities, bool? body, bool? bodyHyperlinks, bool? bodyImages, bool? bodyMarkup, bool? iconMulti, bool? iconStatic, bool? persistence, bool? sound, bool? actions, bool? actionIcons})`

Creates a copy of this object with the given fields replaced with new values.

#### toString
`String toString()`

Returns a string representation of this object.

### Operators
#### operator ==
`bool operator ==(Object other)`

Determines equality with another object.
```

--------------------------------

### AndroidInitializationSettings

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/AndroidInitializationSettings-class.html

Documentation for the AndroidInitializationSettings class, including its constructor and properties.

```APIDOC
## AndroidInitializationSettings

### Description
Plugin initialization settings for Android.

### Constructor
`AndroidInitializationSettings(String defaultIcon)`

Constructs an instance of AndroidInitializationSettings.

### Properties
- `defaultIcon` (String) - Specifies the default icon for notifications.

### Methods
- `noSuchMethod(Invocation invocation)` → dynamic - Invoked when a nonexistent method or property is accessed. (inherited)
- `toString()` → String - A string representation of this object. (inherited)

### Operators
- `operator ==(Object other)` → bool - The equality operator. (inherited)
```

--------------------------------

### NotificationAppLaunchDetails class

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/NotificationAppLaunchDetails-class.html

Documentation for the NotificationAppLaunchDetails class, including its constructor, properties, methods, and operators.

```APIDOC
## NotificationAppLaunchDetails

### Description
Contains details on the notification that launched the application.

### Constructor
`NotificationAppLaunchDetails(bool didNotificationLaunchApp, {NotificationResponse? notificationResponse})`

Constructs an instance of NotificationAppLaunchDetails.

### Properties
- `didNotificationLaunchApp` (bool) - Indicates if the app was launched via notification.
- `notificationResponse` (NotificationResponse?) - Contains details of the notification that launched the app.

### Methods
- `noSuchMethod(Invocation invocation)` (dynamic) - Invoked when a nonexistent method or property is accessed. (inherited)
- `toString()` (String) - A string representation of this object. (inherited)

### Operators
- `operator ==(Object other)` (bool) - The equality operator. (inherited)
```

--------------------------------

### initialize({DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse}) → Future<bool?>

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/WebFlutterLocalNotificationsPlugin-class.html

Initializes the plugin.

```APIDOC
## initialize({DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse}) → Future<bool?>

### Description
Initializes the plugin.

### Method
`Future<bool?> initialize({DidReceiveNotificationResponseCallback? onDidReceiveNotificationResponse})`

### Parameters
- **onDidReceiveNotificationResponse** (DidReceiveNotificationResponseCallback?) - Optional - Callback invoked when a notification response is received.

### Returns
A boolean indicating whether initialization was successful, or `null` if not applicable.
```

--------------------------------

### Configure InitializationSettings with IOSInitializationSettings

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

Shows how to configure InitializationSettings with the iOS-specific IOSInitializationSettings class, which extends DarwinInitializationSettings and adds requestCarPlayPermission for CarPlay notification permissions. Requires version 17.3.0 or later.

```dart
const AndroidInitializationSettings initializationSettingsAndroid =
    AndroidInitializationSettings('app_icon');
final IOSInitializationSettings initializationSettingsIOS =
    IOSInitializationSettings(
        // Darwin settings
        requestAlertPermission: true,
        requestBadgePermission: true,
        requestSoundPermission: true,
        // iOS-specific settings
        requestCarPlayPermission: true,
    );
final DarwinInitializationSettings initializationSettingsDarwin =
    DarwinInitializationSettings();
final InitializationSettings initializationSettings = InitializationSettings(
    android: initializationSettingsAndroid,
    iOS: initializationSettingsIOS,  // Use iOS-specific settings
    macOS: initializationSettingsDarwin,  // Keep Darwin for macOS
);
```

--------------------------------

### WindowsAction

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/WindowsAction-class.html

Documentation for the WindowsAction class constructor and its properties.

```APIDOC
## WindowsAction

### Description
Constructs a Windows notification button from parameters.

### Constructor
`WindowsAction({required String content, required String arguments, WindowsActivationType activationType = WindowsActivationType.foreground, WindowsNotificationBehavior activationBehavior = WindowsNotificationBehavior.dismiss, WindowsActionPlacement? placement, Uri? imageUri, String? inputId, WindowsButtonStyle? buttonStyle, String? tooltip})`

### Parameters
- **content** (String) - Required - The body text of the button.
- **arguments** (String) - Required - An app-defined string that will be passed back if the button is pressed.
- **activationType** (WindowsActivationType) - Optional - How the application should open if the button is pressed. Defaults to `WindowsActivationType.foreground`.
- **activationBehavior** (WindowsNotificationBehavior) - Optional - How the notification should react when the button is pressed. Defaults to `WindowsNotificationBehavior.dismiss`.
- **placement** (WindowsActionPlacement?) - Optional - How the button should be placed on the notification.
- **imageUri** (Uri?) - Optional - An image to show on the button.
- **inputId** (String?) - Optional - The ID of an input box.
- **buttonStyle** (WindowsButtonStyle?) - Optional - The style of the button. Null indicates a plain button.
- **tooltip** (String?) - Optional - The tooltip, useful if content is empty.

### Properties
- **activationBehavior** (WindowsNotificationBehavior) - How the notification should react when the button is pressed.
- **activationType** (WindowsActivationType) - How the application should open if the button is pressed.
- **arguments** (String) - An app-defined string that will be passed back if the button is pressed.
- **buttonStyle** (WindowsButtonStyle?) - The style of the button. Null indicates a plain button.
- **content** (String) - The body text of the button.
- **imageUri** (Uri?) - An image to show on the button.
- **inputId** (String?) - The ID of an input box.
- **placement** (WindowsActionPlacement?) - How the button should be placed on the notification.
- **tooltip** (String?) - The tooltip, useful if content is empty.

### Methods
- **noSuchMethod(Invocation invocation)** → dynamic - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** → String - A string representation of this object. (inherited)

### Operators
- **operator ==(Object other)** → bool - The equality operator. (inherited)
```

--------------------------------

### registerWith() → void

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/IOSFlutterLocalNotificationsPlugin-class.html

Registers this implementation as the plugin instance.

```APIDOC
## registerWith() → void

### Description
Registers this implementation as the plugin instance.

### Returns
`void`
```

--------------------------------

### Initialize plugin with background response handler

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

Initialize the plugin and specify the background notification response handler. The handler runs in a separate isolate (except on Linux) and requires the @pragma('vm:entry-point') annotation.

```dart
content_copyawait flutterLocalNotificationsPlugin.initialize(
    settings: initializationSettings,
    onDidReceiveNotificationResponse: (NotificationResponse notificationResponse) async {
        // ...
    },
    onDidReceiveBackgroundNotificationResponse: notificationTapBackground,
);

```

--------------------------------

### Objective-C didFinishLaunchingWithOptions for non-UIScene apps

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

For apps not migrated to UIScene lifecycle. Extend didFinishLaunchingWithOptions to register the callback.

```objective-c
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [GeneratedPluginRegistrant registerWithRegistry:self];

    // Add this method
    [FlutterLocalNotificationsPlugin setPluginRegistrantCallback:registerPlugins];
}

```

--------------------------------

### Swift didFinishLaunchingWithOptions for non-UIScene apps

Source: https://pub.dev/documentation/flutter_local_notifications/latest/index.html

For Swift apps not migrated to UIScene lifecycle. Update didFinishLaunchingWithOptions to set the plugin registrant callback.

```swift
import UIKit
import Flutter
// This is required for calling FlutterLocalNotificationsPlugin.setPluginRegistrantCallback method.
import flutter_local_notifications

@UIApplicationMain
override func application(
  _ application: UIApplication,
  didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
  // This is required to make any communication available in the action isolate.
  FlutterLocalNotificationsPlugin.setPluginRegistrantCallback { (registry) in
    GeneratedPluginRegistrant.register(with: registry)
  }

  ...
  return super.application(application, didFinishLaunchingWithOptions: launchOptions)
}

```

--------------------------------

### getCapabilities()

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/LinuxFlutterLocalNotificationsPlugin-class.html

Errors on attempted calling of the stub. It exists only to satisfy compile-time dependencies, and should never actually be called.

```APIDOC
## getCapabilities()

### Description
Errors on attempted calling of the stub. It exists only to satisfy compile-time dependencies, and should never actually be called.

### Method
Future<LinuxServerCapabilities> getCapabilities()

### Parameters
None

### Return Value
Future<LinuxServerCapabilities> - but throws an error if called.
```

--------------------------------

### WindowsHeader constructor

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/WindowsHeader-class.html

Documentation for the WindowsHeader class constructor and its properties.

```APIDOC
## WindowsHeader({required String id, required String title, required String arguments, WindowsHeaderActivation? activation})

### Description
Creates a Windows header that groups multiple Windows notifications.

### Constructor Parameters
- **id** (String) - Required - A unique ID for this header.
- **title** (String) - Required - The title of the header.
- **arguments** (String) - Required - An application-defined payload that will be passed back when pressed.
- **activation** (WindowsHeaderActivation?) - Optional - Specifies how the application will open.

### Properties
- **activation** (WindowsHeaderActivation?) - Specifies how the application will open.
- **arguments** (String) - An application-defined payload that will be passed back when pressed.
- **id** (String) - A unique ID for this header.
- **title** (String) - The title of the header.

### Methods
- **noSuchMethod(Invocation invocation)** → dynamic - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** → String - A string representation of this object. (inherited)

### Operators
- **operator ==(Object other)** → bool - The equality operator. (inherited)
```

--------------------------------

### LinuxRawIconData Constructor

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/LinuxRawIconData-class.html

Constructs an instance of LinuxRawIconData with the required raw data, width, and height, and optional parameters for row stride, bits per sample, channels, and alpha channel presence.

```APIDOC
## LinuxRawIconData Constructor

### Description
Constructs an instance of LinuxRawIconData.

### Constructor
`LinuxRawIconData({required Uint8List data, required int width, required int height, int? rowStride, int bitsPerSample = 8, int channels = 3, bool hasAlpha = false})`

### Parameters
- **data** (Uint8List) - Required - Raw data (decoded from the image format) for the image in bytes.
- **width** (int) - Required - Width of the image in pixels.
- **height** (int) - Required - Height of the image in pixels.
- **rowStride** (int?) - Optional - The number of bytes per row in data.
- **bitsPerSample** (int) - Optional - The number of bits in each color sample. Defaults to 8.
- **channels** (int) - Optional - The number of channels in the image (e.g. 3 for RGB, 4 for RGBA). If hasAlpha is `true`, must be 4. Defaults to 3.
- **hasAlpha** (bool) - Optional - Determines if the image has an alpha channel. Defaults to false.

### Properties
- **bitsPerSample** (int) - The number of bits in each color sample. (final)
- **channels** (int) - The number of channels in the image (e.g. 3 for RGB, 4 for RGBA). If hasAlpha is `true`, must be 4. (final)
- **data** (Uint8List) - Raw data (decoded from the image format) for the image in bytes. (final)
- **hasAlpha** (bool) - Determines if the image has an alpha channel. (final)
- **height** (int) - Height of the image in pixels. (final)
- **rowStride** (int) - The number of bytes per row in data. (final)
- **width** (int) - Width of the image in pixels. (final)

### Inherited Members
- **hashCode** (int) - The hash code for this object. (no setter, inherited)
- **runtimeType** (Type) - A representation of the runtime type of the object. (no setter, inherited)
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** (String) - A string representation of this object. (inherited)
- **operator ==(Object other)** (bool) - The equality operator. (inherited)
```

--------------------------------

### WindowsImage(Uri uri, {required String altText, bool addQueryParams = false, WindowsImagePlacement? placement, WindowsImageCrop? crop})

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/WindowsImage-class.html

Constructor for creating a Windows notification image from an image URI.

```APIDOC
## WindowsImage(Uri uri, {required String altText, bool addQueryParams = false, WindowsImagePlacement? placement, WindowsImageCrop? crop})

### Description
Creates a Windows notification image from an image URI.

### Constructor
`const WindowsImage(Uri uri, {required String altText, bool addQueryParams = false, WindowsImagePlacement? placement, WindowsImageCrop? crop})`

### Parameters
- **uri** (Uri) - Required - The source of the image.
- **altText** (String) - Required - A description of the image to be used by assistive technology.
- **addQueryParams** (bool) - Optional - Whether Windows should add URL query parameters when fetching the image. Defaults to `false`.
- **placement** (WindowsImagePlacement?) - Optional - Where this image will be placed. Null indicates below the notification.
- **crop** (WindowsImageCrop?) - Optional - How the image will be cropped. Null indicates uncropped.
```

--------------------------------

### BitmapFilePathAndroidIcon

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/BitmapFilePathAndroidIcon-class.html

Documentation for the BitmapFilePathAndroidIcon class, including its constructor and properties.

```APIDOC
## BitmapFilePathAndroidIcon

### Description
Represents a file path to a bitmap that should be used as an icon on Android.

### Constructor
- **BitmapFilePathAndroidIcon(String _icon)** - Constructs an instance of BitmapFilePathAndroidIcon.

### Properties
- **data** (String) - A file path on the Android device that refers to the location of the icon.
- **source** (AndroidIconSource) - The subclass source type.

### Implemented Types
- AndroidIcon<String>
```

--------------------------------

### show({required int id, String? title, String? body, LinuxNotificationDetails? notificationDetails, String? payload})

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/LinuxFlutterLocalNotificationsPlugin-class.html

Errors on attempted calling of the stub. It exists only to satisfy compile-time dependencies, and should never actually be called.

```APIDOC
## show({required int id, String? title, String? body, LinuxNotificationDetails? notificationDetails, String? payload})

### Description
Errors on attempted calling of the stub. It exists only to satisfy compile-time dependencies, and should never actually be called.

### Method
Future<void> show({required int id, String? title, String? body, LinuxNotificationDetails? notificationDetails, String? payload})

### Parameters
- **id** (int) - Required - The notification identifier.
- **title** (String?) - Optional - The notification title.
- **body** (String?) - Optional - The notification body.
- **notificationDetails** (LinuxNotificationDetails?) - Optional - Platform-specific notification details.
- **payload** (String?) - Optional - The payload associated with the notification.

### Return Value
Future<void> - but throws an error if called.
```

--------------------------------

### openAppNotificationSettings() → Future<bool?>

Source: https://pub.dev/documentation/flutter_local_notifications/latest/flutter_local_notifications/IOSFlutterLocalNotificationsPlugin-class.html

Opens the system settings UI where the user can manage notification permissions for the app.

```APIDOC
## openAppNotificationSettings() → Future<bool?>

### Description
Opens the system settings UI where the user can manage notification permissions for the app.

### Returns
`Future<bool?>` - A future that resolves to a boolean indicating success, or null.
```
Tokens:
Raw