Integration (TO BE REMOVED)

Step 1: Enable Push notifications

Login to CometChat dashboard and select your app.
Navigate to Notifications > Settings in the left-hand menu.
Enable the Push notifications feature.
Continue to configure Push notifications.

Step 2: Add Providers

Firebase Cloud Messaging (FCM) and Apple Push Notification Service (APNS) are the two primary supported providers for sending push notifications.

Add FCM credentials

Pre-requisite

Generate a service account key for your Firebase application by navigating to the “Service accounts” section within the “Project settings” of the Firebase Cloud Messaging Dashboard. Generate new private key and download the JSON file. This will be required in the next steps.

Add credentials

Select the ”+ Add Credentials” button.
In the dialogue that appears, provide a unique, memorable identifier for your provider.
Upload the service account JSON file you previously acquired.
Specify whether the push payload should include the “notification” key. Additional information on this configuration is available in FCM’s documentation - About FCM messages.

Similarly, you can add multiple FCM Credentials in case you have multiple FCM projects for your apps.

Add APNS credentials

Pre-requisite

To generate a .p8 key file, go to Apple Developer Account, then select “Certificates, IDs & Profiles”.
Select Keys and click on the ”+” button to add a new key.
In the new key page, type in your key name and check the Apple Push Notification service (APNs) box, then click “Continue” and click “Register”.
Then proceed to download the key file by clicking Download.
Make note of the Key ID, Team ID and your Bundle ID. These are required in the next steps.

Additional information on this configuration is available in Apple’s documentation - Create a private key to access a service

Add credentials

Select the ”+ Add Credentials” button.
Enable the toggle if your app is in the Production. For apps under development, the toggle has to be disabled.
In the dialogue that appears, provide a unique, memorable identifier for your provider.
Store the Key ID, Team ID, Bundle ID for your app.
Upload the .p8 file
Enable “Include content-available” if you want to receive background notifications. However, this is not recommended as the background notifications are throttled. Additional information is available in Apple’s documentation - Pushing background updates to your App
Enable “Include mutable-content” if you want to modify the notification before it is displayed to the user. Additional information is available in Apple’s documentation - Modifying content on newly delivered notifications

Similarly, you can add multiple APNS Credentials in case you have multiple apps with different Bundle IDs.

Custom providers

For webhook-based providers and payload samples, see Custom Providers.

Step 3: Tokens management

Push tokens, obtained from the APIs or SDKs provided by the platforms or frameworks in use, must be registered on behalf of the logged in user with the CometChat backend. For this purpose, CometChat SDKs v4+ offer the following functions: Push token registration should be completed in two scenarios:

Following the success of CometChat.login() & receiving user’s permission to receiver Push notifications.
When a refresh token becomes available.

To register a token, use the CometChatNotifications.registerPushToken() method from the SDK. This method accepts the following parameters.

Parameter	Type	Description
`pushToken`	String	The `pushToken` can contain: • Firebase (FCM) token • Device token (iOS only) • VoIP token (iOS only)
`platform`	String	The `platform` can take the following values: • PushPlatforms.FCM_ANDROID • PushPlatforms.FCM_FLUTTER_ANDROID • PushPlatforms.FCM_FLUTTER_iOS • PushPlatforms.APNS_FLUTTER_DEVICE • PushPlatforms.APNS_FLUTTER_VOIP • PushPlatforms.FCM_iOS • PushPlatforms.APNS_iOS_DEVICE • PushPlatforms.APNS_iOS_VOIP • PushPlatforms.FCM_WEB • PushPlatforms.FCM_REACT_NATIVE_ANDROID • PushPlatforms.FCM_REACT_NATIVE_iOS • PushPlatforms.APNS_REACT_NATIVE_DEVICE • PushPlatforms.APNS_REACT_NATIVE_VOIP • PushPlatforms.FCM_IONIC_CORDOVA_ANDROID • PushPlatforms.FCM_IONIC_CORDOVA_iOS • PushPlatforms.APNS_IONIC_CORDOVA_DEVICE • PushPlatforms.APNS_IONIC_CORDOVA_VOIP
`providerId`	String	The `providerId` should match with: • Any one of the FCM provider identifiers in case of an FCM token. • Any one of the APNS provider identifiers in case of Device or VoIP tokens.

JavaScript
Android
iOS
Flutter

// This is applicable for web, React native, Ionic cordova

// CometChat.init() success.
// CometChat.login() success.
// User has granted permission to display push notifications.

// For web
CometChatNotifications.registerPushToken(
  pushToken,
  CometChatNotifications.PushPlatforms.FCM_WEB,
  "fcm-provider-2"
)
  .then((payload) => {
    console.log("Token registration successful");
  })
  .catch((err) => {
    console.log("Token registration failed:", err);
  });

// For React Native Android
CometChatNotifications.registerPushToken(
  pushToken,
  CometChatNotifications.PushPlatforms.FCM_REACT_NATIVE_ANDROID,
  "fcm-provider-2"
)
  .then((payload) => {
    console.log("Token registration successful");
  })
  .catch((err) => {
    console.log("Token registration failed:", err);
  });

// For React Native iOS
CometChatNotifications.registerPushToken(
  pushToken,
  CometChatNotifications.PushPlatforms.FCM_REACT_NATIVE_iOS,
  "fcm-provider-2"
)
  .then((payload) => {
    console.log("Token registration successful");
  })
  .catch((err) => {
    console.log("Token registration failed:", err);
  });

// For Ionic cordova Android
CometChatNotifications.registerPushToken(
  pushToken,
  CometChatNotifications.PushPlatforms.FCM_IONIC_CORDOVA_ANDROID,
  "fcm-provider-2"
)
  .then((payload) => {
    console.log("Token registration successful");
  })
  .catch((err) => {
    console.log("Token registration failed:", err);
  });

// For Ionic cordova iOS
CometChatNotifications.registerPushToken(
  pushToken,
  CometChatNotifications.PushPlatforms.FCM_IONIC_CORDOVA_iOS,
  "fcm-provider-2"
)
  .then((payload) => {
    console.log("Token registration successful");
  })
  .catch((err) => {
    console.log("Token registration failed:", err);
  });

// Similary, use this method to register refresh token.

// CometChat.init() success.
// CometChat.login() success.
// User has granted permission to display push notifications.
CometChatNotifications.registerPushToken(pushToken, PushPlatforms.FCM_ANDROID, "fcm-provider-2", new CometChat.CallbackListener<String>() {
    @Override
    public void onSuccess(String s) {
        Log.e(TAG, "onSuccess:  CometChat Notification Registered : "+s );
        listener.onSuccess(s);
    }

    @Override
    public void onError(CometChatException e) {
        Log.e(TAG, "onError: Notification Registration Failed : "+e.getMessage());
        listener.onError(e);
    }
});

// Similary, use this method to register refresh token.

// CometChat.init() success.
// CometChat.login() success.
// User has granted permission to display push notifications.
CometChatNotifications.registerPushToken(pushToken: pushToken, platform: CometChatNotifications.PushPlatforms.FCM_iOS, providerId: "apns-provider-2", onSuccess: { (success) in
  print("registerPushToken: \(success)")
}) { (error) in
  print("registerPushToken: \(error.errorCode) \(error.errorDescription)")
}

// Similary, use this method to register refresh token.

// CometChat.init() success.
// CometChat.login() success.
// User has granted permission to display push notifications.

// For Android (FCM)
CometChatNotifications.registerPushToken(
  PushPlatforms.FCM_FLUTTER_ANDROID,
  providerId: "fcm-provider-1",
  fcmToken: token,
  onSuccess: (response) {
    debugPrint("registerPushToken:success ${response.toString()}");
  },
  onError: (e) {
    debugPrint("registerPushToken:error ${e.toString()}");
  },
);

// For iOS (FCM)
CometChatNotifications.registerPushToken(
  PushPlatforms.FCM_FLUTTER_iOS,
  providerId: "fcm-provider-1",
  fcmToken: token,
  onSuccess: (response) {
    debugPrint("registerPushToken:success ${response.toString()}");
  },
  onError: (e) {
    debugPrint("registerPushToken:error ${e.toString()}");
  },
);

// For ios (APNS Device token)
CometChatNotifications.registerPushToken(
  PushPlatforms.APNS_FLUTTER_DEVICE,
  providerId: "apns-provider-1",
  deviceToken: token,
  onSuccess: (response) {
    debugPrint("registerPushToken:success ${response.toString()}");
  },
  onError: (e) {
    debugPrint("registerPushToken:error ${e.toString()}");
  },
);

// For ios (APNS VoIP token)
CometChatNotifications.registerPushToken(
  PushPlatforms.APNS_FLUTTER_VOIP,
  providerId: "apns-provider-1",
  voipToken: token,
  onSuccess: (response) {
    debugPrint("registerPushToken:success ${response.toString()}");
  },
  onError: (e) {
    debugPrint("registerPushToken:error ${e.toString()}");
  },
);

// Similary, use this method to register refresh token.

Unregister push token before logout

Typically, push token unregistration should occur prior to user logout, using the CometChat.logout() method. For token unregistration, use the CometChatNotifications.unregisterPushToken() method provided by the SDKs.

JavaScript
Android
iOS
Flutter

// This is applicable for web, React native, Ionic cordova
await CometChatNotifications.unregisterPushToken();

// Followed by CometChat.logout();

CometChatNotifications.unregisterPushToken(new CometChat.CallbackListener<String>() {
    @Override
    public void onSuccess(String s) {
        // Success callback
    }

    @Override
    public void onError(CometChatException e) {
        // Error callback
    }
});

// Followed by CometChat.logout();

CometChatNotifications.unregisterPushToken { success in
    print("unregisterPushToken: \(success)")
} onError: { error in
    print("unregisterPushToken: \(error.errorCode) \(error.errorDescription)")
}

// Followed by CometChat.logout();

CometChatNotifications.unregisterPushToken(onSuccess: (response) {
  debugPrint("unregisterPushToken:success ${response.toString()}");
}, onError: (e) {
  debugPrint("unregisterPushToken:error ${e.toString()}");
});

Step 4: Handle incoming Push notifications

Push notifications should be managed primarily when the app is in the background or in a terminated state. For web and mobile applications, the Firebase Cloud Messaging (FCM) SDK offers handler functions to receive Push Notifications. For iOS applications, the FCM SDK can be used as described previously, or alternatively, PushKit can be implemented for better integration and management of chat and call (VoIP) notifications. The push payload delivered to the user’s device includes the following information, which can be customized to suit the desired notification style:

Details available in the payload

{
  // Notification details
  "title": "Andrew Joseph", // The title of the notification to be displayed
  "body": "Hello!", // The body of the notification to be displayed

  // Sender's details
  "sender": "cometchat-uid-1", // UID of the user who sent the said message.
  "senderName": "Andrew Joseph", // Name of the user who sent the said message.
  "senderAvatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-1.webp", // Avatar URL of the user.

  // Receiver's details
  "receiver": "cometchat-uid-2", // UID or GUID of the receiver.
  "receiverName": "George Alan", // Name of the user or group.
  "receiverAvatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-2.webp", // Avatar URL of the receiver.
  "receiverType": "user", // Values can be "user" or "group"

  // Message details
  "tag": "123", // The ID of the said message that can be used as the ID of the notification to be displayed.
  "conversationId": "cometchat-uid-1_user_cometchat-uid-2", // The ID of the conversation that the said message belongs to.
  "type": "chat", // Values can be "call" or "chat". If this is "call", the below details will be available.

  // Call details
  "callAction": "initiated", // Values can be "initiated" or "cancelled" or "unanswered" or "ongoing" or "rejected" or "ended" or "busy"
  "sessionId": "v1.123.aik2", // The unique sessionId of the said call that can be used as unique identifier in CallKit or ConnectionService.
  "callType": "audio", // Values can be "audio" or "video"
  "sentAt": "1741847453000",
  "message": {CometChat Message Object}, // Present if "Include message object" is enabled. The message object is present for new messages or in case a message was edited or deleted.
  "custom": {Custom JSON} // Custom JSON object is added in case it is configured in the preferences.
}

Continue to platform-specific implementation

Choose your platform to continue with the Push notifications implementation.

Android

Android UI Kit Implementation

iOS (APNS)

iOS (APNS) UI Kit Implementation

iOS (FCM)

iOS (FCM) UI Kit Implementation

Flutter (Android)

Flutter (Android) UI Kit Implementation

Flutter (iOS)

Flutter (iOS) UI Kit Implementation

React Native

React Native UI Kit Implementation

Platform Guides (UI Kit)

​Step 1: Enable Push notifications

​Step 2: Add Providers

​Add FCM credentials

​Pre-requisite

​Add credentials

​Add APNS credentials

​Pre-requisite

​Add credentials

​Custom providers

​Step 3: Tokens management

​Register push token after login

​Unregister push token before logout

​Step 4: Handle incoming Push notifications

​Continue to platform-specific implementation

Android

iOS (APNS)

iOS (FCM)

Flutter (Android)

Flutter (iOS)

React Native

Step 1: Enable Push notifications

Step 2: Add Providers

Add FCM credentials

Pre-requisite

Add credentials

Add APNS credentials

Pre-requisite

Add credentials

Custom providers

Step 3: Tokens management

Register push token after login

Unregister push token before logout

Step 4: Handle incoming Push notifications

Continue to platform-specific implementation