Skip to main content
Version: v4

Overview

This guide demonstrates how to add chat to a React Native application using CometChat. Before you begin, we strongly recommend you read the Key Concepts guide.

I want to explore a sample app (includes UI)

Open the app folder in your favourite code editor and follow the steps mentioned in the README.md file.

React Native Sample App

Get your Application Keys

Signup for CometChat and then:

  1. Create a new app
  2. Head over to the API & Auth Keys section and note the Auth Key, App ID & Region

Add the CometChat Dependency

Install the package as NPM module:

npm install @cometchat/chat-sdk-react-native@latest --save

In order to integrate the CometChat Pro React Native SDK, you need to install one more dependencies.

  1. Async-Storage:
npm install @react-native-async-storage/async-storage --save
info

v2.4+ onwards, Voice & Video Calling functionality has been moved to a separate library. In case you plan to use the calling feature, please install the Calling dependency (@cometchat/calls-sdk-react-native).

npm install @cometchat/calls-sdk-react-native@2.3.0 --save

The calling component requires some configuration. Please follow the steps mentioned here.

Calling Component Configuration

For @cometchat/calls-sdk-react-natives, please make sure you add the following additional dependencies & permissions.

{
"@cometchat/chat-sdk-react-native": "^4.0.5",
"@react-native-async-storage/async-storage": "^1.17.5",
"@react-native-community/netinfo": "7.1.7", // for react-native 0.63 & above.
"@react-native-community/netinfo": "6.1.0", // for react-native below 0.63
"react-native-background-timer": "2.4.1",
"react-native-callstats": "3.73.7",
"react-native-webrtc": "1.100.0"
}

Permissions:

Android:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

iOS:

<key>NSCameraUsageDescription</key>
<string>This is for Camera permission</string>
<key>NSMicrophoneUsageDescription</key>
<string>This is for Mic permission</string>

Android:

Goto ./android folder and open project level build.gradle file and add all repository URLs in the repositories block under the allprojects section. Also in the same file in buildscript section in ext block make sure you have set minSdkVersion to 24.

allprojects {
repositories {
maven {
url "https://dl.cloudsmith.io/public/cometchat/cometchat-pro-android/maven/"
}
}
}

Also in the same file in buildscript section in ext block make sure you have set minSdkVersion to 24.

buildscript {
ext {
buildToolsVersion = "29.0.2"
minSdkVersion = 24
compileSdkVersion = 29
targetSdkVersion = 29
}
}

iOS:

Please update the minimum target version in the Podfile. Goto ./ios folder and open the Podfile. In the Podfile update the platform version to 11.0

platform :ios, '11.0'   

Open the ios/App folder and run pod install this will create an App.xcworkspace open this and run the app.

Initialize CometChat

The init() method initialises the settings required for CometChat. The init() method takes the below parameters:

  1. appID - You CometChat App ID
  2. appSettings - An object of the AppSettings class can be created using the AppSettingsBuilder class. The region field is mandatory and can be set using the setRegion() method.

The AppSettings class allows you to configure two settings:

  • Region: The region where your app was created.
  • Presence Subscription: Represents the subscription type for user presence (real-time online/offline status)
  • autoEstablishSocketConnection(boolean value): This property takes a boolean value which when set to true informs the SDK to manage the web-socket connection internally. If set to false, it informs the SDK that the web-socket connection will be managed manually. The default value for this parameter is true. For more information on this, please check the Managing connections manually section. The default value for this property is true.
  • overrideAdminHost(adminHost: string): This method takes the admin URL as input and uses this admin URL instead of the default admin URL. This can be used in case of dedicated deployment of CometChat.
  • overrideClientHost(clientHost: string): This method takes the client URL as input and uses this client URL instead of the default client URL. This can be used in case of dedicated deployment of CometChat.

You need to call init() before calling any other method from CometChat. We suggest you call the init() method on app startup, preferably in the index.js file.

let appID = "APP_ID";
let region = "REGION";
let appSetting = new CometChat.AppSettingsBuilder()
.subscribePresenceForAllUsers()
.setRegion(region)
.autoEstablishSocketConnection(true)
.build();
CometChat.init(appID, appSetting).then(
() => {
console.log("Initialization completed successfully");
}, error => {
console.log("Initialization failed with error:", error);
}
);

Make sure you replace the APP_ID with your CometChat App ID and REGION with your App Region in the above code.

Register and Login your user

Once initialization is successful, you will need to create a user. To create users on the fly, you can use the createUser() method. This method takes a User object and the Auth Key as input parameters and returns the created User object if the request is successful.

let authKey = "AUTH_KEY";
let uid = "user1";
let name = "Kevin";

let user = new CometChat.User(uid);

user.setName(name);

CometChat.createUser(user, authKey).then(
user => {
console.log("user created", user);
}, error => {
console.log("error", error);
}
)

Make sure that UID and name are specified as these are mandatory fields to create a user.

Once you have created the user successfully, you will need to log the user into CometChat using the login() method.

We recommend you call the CometChat login() method once your user logs into your app. The login() method needs to be called only once.

let UID = "SUPERHERO1";
let authKey = "AUTH_KEY";

CometChat.getLoggedinUser().then(
(user) => {
if(!user){
CometChat.login(UID, authKey).then(
user => {
console.log("Login Successful:", { user });
}, error => {
console.log("Login failed with exception:", { error });
}
);
}
}, error => {
console.log("Some Error Occured", { error });
}
);

Make sure you replace the AUTH_KEY with your CometChat Auth Key in the above code.

info

We have set-up 5 users for testing having UIDs: SUPERHERO1, SUPERHERO2, SUPERHERO3, SUPERHERO4 and SUPERHERO5.

The login() method returns the User object containing all the information of the logged-in user.

Warning

UID can be alphanumeric with underscore and hyphen. Spaces, punctuation and other special characters are not allowed.

Integrate our UI Kits

Please refer to the React Native UI Kit section to integrate React Native UI Kit inside your app.