Add app badge count

Amplify Flutter v1 is now in Maintenance Mode until April 30th, 2025. This means that we will continue to include updates to ensure compatibility with backend services and security. No new features will be introduced in v1.

Please use the latest version (v2) of Amplify Flutter to get started.

If you are currently using v1, follow these instructions to upgrade to v2.

The app badge count, when set, can be seen on your app's icon on a user's device. Amplify provides you with simple helpers to manipulate this number.

App badge count helpers are safe to call (but will be ignored) even when your app is running on platforms where badges are not supported.

Get the current badge count

Use getBadgeCount to get the current app badge count. You might need to do this to calculate the value when setting the badge count.

final count = await Amplify.Notifications.Push.getBadgeCount();

Update the badge count

Use setBadgeCount to set the current app badge count. Setting the badge count to 0 (zero) will remove the badge from your app's icon.

Amplify.Notifications.Push.setBadgeCount(42);