Amplify JS API Documentation
    Preparing search index...

    Variable getBadgeCountConst

    getBadgeCount: GetBadgeCount

    Returns the current badge count (the number next to your app's icon). This function is safe to call (but will be ignored) even when your React Native app is running on platforms where badges are not supported.

    platform: PlatformNotSupportedError - Thrown if called against an unsupported platform. Currently, only React Native is supported by this API.

    A promise that resolves to a number representing the current count displayed on the app badge.

    const badgeCount = await getBadgeCount();

    Settings

    Member Visibility