Skip to content

Conversation

@ajaygajra
Copy link

Description

This PR adds comprehensive documentation for the Unread Message Badge Count feature in push notifications. The badge count feature displays the total number of unread messages for a user as a badge on the app icon.

Changes include:

  1. New Badge Count page (notifications/badge-count.mdx)

    • Overview of the feature and how it works
    • Payload structure examples for FCM, APNs, and custom providers
    • Client-side implementation examples for iOS, Android, React Native, and Flutter
    • Badge clearing examples
    • Best practices and troubleshooting guide
  2. Updated existing pages with unreadMessageCount field:

    • notifications/push-integration.mdx - Added to payload example
    • notifications/custom-providers.mdx - Added to all webhook payload examples (chat, call, reaction, group action)
    • notifications/preferences.mdx - Added badge count toggle documentation
  3. Navigation update (docs.json)

    • Added badge-count page to Push tab navigation

Related Issue(s)

Linear: ENG-28864

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

  • This is a premium feature that requires users to contact CometChat team to enable
  • The documentation includes a prominent note directing users to contact CometChat for enablement
  • Client-side examples cover all major platforms (iOS, Android, React Native, Flutter)

- Added unreadMessageCount to push payload example in push-integration.mdx
- Added unreadMessageCount to all custom provider payload examples (chat, call, reaction, group action)
- Documented 'Include badge count in payload' toggle in preferences.mdx

Linear: ENG-28864
- Create new badge-count.mdx page with comprehensive documentation
- Add to navigation in docs.json under Push tab
- Include payload examples for FCM, APNs, and custom providers
- Add client-side implementation examples for iOS, Android, React Native, Flutter
- Document message type filtering settings and best practices
- Add note that users need to contact CometChat team to enable feature
- Remove message type filtering section
- Update troubleshooting to direct users to contact CometChat
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants