Notifications - CometChat Docs

AI Integration Quick Reference

// Register push token (FCM on Android)
await CometChatNotifications.registerPushToken(
  PushPlatforms.FCM_FLUTTER_ANDROID,
  fcmToken: "YOUR_FCM_TOKEN",
  onSuccess: (response) => debugPrint("Token registered: $response"),
  onError: (e) => debugPrint("Error: ${e.message}"),
);

// Fetch notification preferences
NotificationPreferences? prefs = await CometChatNotifications.fetchPreferences(
  onSuccess: (prefs) => debugPrint("Preferences: $prefs"),
  onError: (e) => debugPrint("Error: ${e.message}"),
);

// Mute a conversation
await CometChatNotifications.muteConversations(
  [MutedConversation(id: "UID", type: MutedConversationType.ONE_ON_ONE)],
  onSuccess: (response) => debugPrint("Muted: $response"),
  onError: (e) => debugPrint("Error: ${e.message}"),
);

Key classes: CometChatNotifications, NotificationPreferences, MutedConversation, PushPlatforms

The CometChatNotifications class provides methods to manage push notification preferences, register/unregister push tokens, mute/unmute conversations, and manage timezone settings.

Register Push Token

Register a push notification token with CometChat for the current user. The token type depends on your platform and push provider.

await CometChatNotifications.registerPushToken(
  PushPlatforms.FCM_FLUTTER_ANDROID,
  fcmToken: "YOUR_FCM_TOKEN",
  providerId: "YOUR_PROVIDER_ID", // optional
  onSuccess: (String response) {
    debugPrint("Token registered: $response");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.code} - ${e.message}");
  },
);

Parameter	Type	Description
`pushPlatforms`	`PushPlatforms`	The push platform to register for (required)
`fcmToken`	`String?`	FCM token (required for `FCM_FLUTTER_ANDROID` and `FCM_FLUTTER_IOS`)
`deviceToken`	`String?`	APNs device token (required for `APNS_FLUTTER_DEVICE`)
`voipToken`	`String?`	APNs VoIP token (required for `APNS_FLUTTER_VOIP`)
`providerId`	`String?`	Optional provider ID
`onSuccess`	`Function(String)?`	Called with success response
`onError`	`Function(CometChatException)?`	Called on error

PushPlatforms Enum

Value	Description
`FCM_FLUTTER_ANDROID`	Firebase Cloud Messaging on Android
`FCM_FLUTTER_IOS`	Firebase Cloud Messaging on iOS
`APNS_FLUTTER_DEVICE`	Apple Push Notification service (device)
`APNS_FLUTTER_VOIP`	Apple Push Notification service (VoIP)

Unregister Push Token

Remove the push notification token for the current user.

await CometChatNotifications.unregisterPushToken(
  onSuccess: (String response) {
    debugPrint("Token unregistered: $response");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Notification Preferences

Fetch Preferences

Retrieve the current notification preferences for the logged-in user.

NotificationPreferences? prefs = await CometChatNotifications.fetchPreferences(
  onSuccess: (NotificationPreferences prefs) {
    debugPrint("1:1 messages: ${prefs.oneOnOnePreferences?.messages}");
    debugPrint("Group messages: ${prefs.groupPreferences?.messages}");
    debugPrint("DND: ${prefs.mutePreferences?.dnd}");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Update Preferences

Update notification preferences for the logged-in user.

NotificationPreferences prefs = NotificationPreferences(
  usePrivacyTemplate: true,
  oneOnOnePreferences: OneOnOnePreferences(
    messages: MessagesOptions.SUBSCRIBE_TO_ALL,
    replies: RepliesOptions.SUBSCRIBE_TO_ALL,
    reactions: ReactionsOptions.SUBSCRIBE_TO_REACTIONS_ON_OWN_MESSAGES,
  ),
  groupPreferences: GroupPreferences(
    messages: MessagesOptions.SUBSCRIBE_TO_MENTIONS,
    replies: RepliesOptions.SUBSCRIBE_TO_MENTIONS,
    reactions: ReactionsOptions.DONT_SUBSCRIBE,
    memberJoined: MemberActionsOptions.SUBSCRIBE,
    memberLeft: MemberActionsOptions.DONT_SUBSCRIBE,
    memberKicked: MemberActionsOptions.SUBSCRIBE,
    memberBanned: MemberActionsOptions.SUBSCRIBE,
    memberUnbanned: MemberActionsOptions.DONT_SUBSCRIBE,
    memberScopeChanged: MemberActionsOptions.SUBSCRIBE,
    memberAdded: MemberActionsOptions.SUBSCRIBE,
  ),
  mutePreferences: MutePreferences(
    dnd: DNDOptions.DISABLED,
  ),
);

await CometChatNotifications.updatePreferences(prefs,
  onSuccess: (NotificationPreferences updated) {
    debugPrint("Preferences updated");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Reset Preferences

Reset notification preferences to their default values.

await CometChatNotifications.resetPreferences(
  onSuccess: (NotificationPreferences prefs) {
    debugPrint("Preferences reset to defaults");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Mute & Unmute Conversations

Get Muted Conversations

Retrieve all conversations muted by the logged-in user.

List<MutedConversation> muted = await CometChatNotifications.getMutedConversations(
  onSuccess: (List<MutedConversation> conversations) {
    for (var conv in conversations) {
      debugPrint("Muted: ${conv.id} (${conv.type}) until ${conv.until}");
    }
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Mute Conversations

Mute one or more conversations.

await CometChatNotifications.muteConversations(
  [
    MutedConversation(
      id: "user_uid",
      type: MutedConversationType.ONE_ON_ONE,
      until: 1700000000, // Unix timestamp, or null for indefinite
    ),
    MutedConversation(
      id: "group_guid",
      type: MutedConversationType.GROUP,
    ),
  ],
  onSuccess: (String response) {
    debugPrint("Conversations muted: $response");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Unmute Conversations

Unmute one or more conversations.

await CometChatNotifications.unmuteConversations(
  [
    UnmutedConversation(
      id: "user_uid",
      type: MutedConversationType.ONE_ON_ONE,
    ),
  ],
  onSuccess: (String response) {
    debugPrint("Conversations unmuted: $response");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Timezone

Update Timezone

Update the timezone preference for the logged-in user. This affects DND schedule evaluation.

await CometChatNotifications.updateTimezone("America/New_York",
  onSuccess: (String response) {
    debugPrint("Timezone updated: $response");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Get Timezone

Retrieve the current timezone preference.

String? timezone = await CometChatNotifications.getTimezone(
  onSuccess: (String tz) {
    debugPrint("Current timezone: $tz");
  },
  onError: (CometChatException e) {
    debugPrint("Error: ${e.message}");
  },
);

Models Reference

NotificationPreferences

Property	Type	Description
`usePrivacyTemplate`	`bool?`	Whether to use privacy templates for notifications
`oneOnOnePreferences`	`OneOnOnePreferences?`	Preferences for 1:1 conversations
`groupPreferences`	`GroupPreferences?`	Preferences for group conversations
`mutePreferences`	`MutePreferences?`	Do Not Disturb and schedule settings

OneOnOnePreferences

Property	Type	Description
`messages`	`MessagesOptions?`	Notification preference for messages
`replies`	`RepliesOptions?`	Notification preference for replies
`reactions`	`ReactionsOptions?`	Notification preference for reactions

GroupPreferences

Property	Type	Description
`messages`	`MessagesOptions?`	Notification preference for group messages
`replies`	`RepliesOptions?`	Notification preference for group replies
`reactions`	`ReactionsOptions?`	Notification preference for group reactions
`memberJoined`	`MemberActionsOptions?`	Notify when a member joins
`memberLeft`	`MemberActionsOptions?`	Notify when a member leaves
`memberAdded`	`MemberActionsOptions?`	Notify when a member is added
`memberKicked`	`MemberActionsOptions?`	Notify when a member is kicked
`memberBanned`	`MemberActionsOptions?`	Notify when a member is banned
`memberUnbanned`	`MemberActionsOptions?`	Notify when a member is unbanned
`memberScopeChanged`	`MemberActionsOptions?`	Notify when a member’s scope changes

MutePreferences

Property	Type	Description
`dnd`	`DNDOptions?`	Do Not Disturb mode
`schedule`	`Map<DayOfWeek, DaySchedule>?`	Per-day mute schedule

DaySchedule

Property	Type	Description
`from`	`int?`	Start hour (0–23)
`to`	`int?`	End hour (0–23)
`dnd`	`bool?`	Whether DND is active for this day

MutedConversation

Property	Type	Description
`id`	`String?`	UID (for 1:1) or GUID (for group)
`type`	`MutedConversationType?`	Conversation type
`until`	`num?`	Unix timestamp when mute expires (null = indefinite)

UnmutedConversation

Property	Type	Description
`id`	`String?`	UID (for 1:1) or GUID (for group)
`type`	`MutedConversationType?`	Conversation type

Enums Reference

MessagesOptions

Value	Int	Description
`DONT_SUBSCRIBE`	1	Don’t receive message notifications
`SUBSCRIBE_TO_ALL`	2	Receive notifications for all messages
`SUBSCRIBE_TO_MENTIONS`	3	Only receive notifications for messages that mention you

RepliesOptions

Value	Int	Description
`DONT_SUBSCRIBE`	1	Don’t receive reply notifications
`SUBSCRIBE_TO_ALL`	2	Receive notifications for all replies
`SUBSCRIBE_TO_MENTIONS`	3	Only receive notifications for replies that mention you

ReactionsOptions

Value	Int	Description
`DONT_SUBSCRIBE`	1	Don’t receive reaction notifications
`SUBSCRIBE_TO_REACTIONS_ON_OWN_MESSAGES`	2	Receive notifications for reactions on your messages
`SUBSCRIBE_TO_REACTIONS_ON_ALL_MESSAGES`	3	Receive notifications for reactions on all messages

MemberActionsOptions

Value	Int	Description
`DONT_SUBSCRIBE`	1	Don’t receive member action notifications
`SUBSCRIBE`	2	Receive member action notifications

DNDOptions

Value	Int	Description
`DISABLED`	1	Do Not Disturb is disabled
`ENABLED`	2	Do Not Disturb is enabled

MutedConversationType

Value	String	Description
`ONE_ON_ONE`	`"oneOnOne"`	1:1 conversation
`GROUP`	`"group"`	Group conversation

DayOfWeek

Value	String
`MONDAY`	`"monday"`
`TUESDAY`	`"tuesday"`
`WEDNESDAY`	`"wednesday"`
`THURSDAY`	`"thursday"`
`FRIDAY`	`"friday"`
`SATURDAY`	`"saturday"`
`SUNDAY`	`"sunday"`

Next Steps

Setup SDK

Installation and initialization guide

Connection Status

Monitor SDK connection state changes

Best Practices

Recommended patterns and practices

Error Codes

Complete SDK error code reference

​Register Push Token

​PushPlatforms Enum

​Unregister Push Token

​Notification Preferences

​Fetch Preferences

​Update Preferences

​Reset Preferences

​Mute & Unmute Conversations

​Get Muted Conversations

​Mute Conversations

​Unmute Conversations

​Timezone

​Update Timezone

​Get Timezone

​Models Reference

​NotificationPreferences

​OneOnOnePreferences

​GroupPreferences

​MutePreferences

​DaySchedule

​MutedConversation

​UnmutedConversation

​Enums Reference

​MessagesOptions

​RepliesOptions

​ReactionsOptions

​MemberActionsOptions

​DNDOptions

​MutedConversationType

​DayOfWeek

​Next Steps