Notifee Documentation

Notifee supports devices running iOS 10+ and provides an interface for the native iOS API to create interactive notifications. Key feature areas include:

• Appearance: Customizing how notifications are displayed.
• Badges: Managing the application icon badge count.
• Behaviour: Controlling notification behavior during display.
• Categories & Actions: Creating and assigning categories to enable notification actions.
• Interaction: Handling user interactions and quick actions.
• Permissions: Requesting user permission to display notifications.
• Remote Notification Support: Integrating Notifee with remote notifications.

TriggerType is an enumeration used to define how a scheduled notification should be triggered. It determines whether a notification is triggered after a specific duration (INTERVAL) or at a specific point in time (TIMESTAMP).

For detailed implementation details and usage examples, refer to the Triggers documentation.

When iOS stacks (groups) multiple unread notifications from your app, the top notification displays summary text. You can override the default iOS summary text by using a combination of:

1. Providing summaryArgument and summaryArgumentCount fields in the notification body.
2. Defining a summaryFormat within an iOS Category.

Note: This functionality requires iOS 12 or higher.

To implement advanced notification grouping and custom actions on iOS:

1. Categories: Use categoryId to link a notification to a registered IOSCategory (created via setNotificationCategories).
2. Summary Arguments: For notifications that represent a collection of items (like multiple messages in a chat), use summaryArgument (e.g., the group name) and summaryArgumentCount (the number of items) to populate the IOSCategory.summaryFormat (requires iOS >= 12).
3. Threading: Use threadId to visually group related notifications together.

The AndroidChannel interface is used to describe an Android Notification Channel. Channels are essential for Android notifications as they allow users to control notification preferences (like lights, vibration, and sound) at a category level.

Important Lifecycle Rules:

• Immutable Settings: Most properties (e.g., badge, bypassDnd, groupId, importance, lightColor, lights, sound, vibration, vibrationPattern, visibility) cannot be changed once the channel has been created. If you need to change these, you must create a new channel with a different id.
• Mutable Metadata: Only name and description can be updated after the channel is created.
• User Control: Channels override individual notification preferences, and the user has the final authority over these settings in the Android system settings.

On Android devices that do not support notification channels (API Level < 26), you can use the AndroidDefaults enumeration to override the default alert behavior. You do this by providing an array of defaults to the notification configuration.

Note: On API Levels >= 26, this enumeration has no effect because notifications follow the behavior defined by the notification channel.

Critical alerts can bypass the mute switch and Do Not Disturb settings. To use them, set critical: true within the NotificationIOS interface (requires iOS >= 12).

You can also specify the audio volume for the critical sound using criticalVolume, which accepts a float value between 0.0 and 1.0. Note that criticalVolume is only used if critical is set to true.