Setup

An in-depth guide on how to configure CometChat.

Get your Application Keys

Signup for CometChat and then:

  1. Create a new app on the dashboard

🚧

Important

Please follow the key concepts guide to create V3 apps.

  1. Head over to the API & Auth Keys section and note the Auth Key, App ID & Region

Add the CometChat Dependency

Web (Browser)

First, simply connect the JS file as a normal script:

<html>
<!--
 Your html code
  ... 
  ...
 -->
<script type="text/javascript" src="https://unpkg.com/@cometchat-pro/[email protected]/CometChat.js"></script>

<script type="text/javascript">
 window.onload = (function () {
  // window scoped variable called `CometChat` is created.
 })
</script>
</html>

Then a window scoped variable called CometChat is created.

Or install the package as NPM module:

npm install @cometchat-pro/[email protected] --save

And add the script to HTML file from the 'node_modules' folder (as a relative path):

<script src="~/node_modules/@cometchat-pro/chat/CometChat.js" type="text/javascript"></script>

Node.js/NPM

First, install the package as NPM module:

npm install @cometchat-pro/[email protected] --save

Then start using CometChat

import { CometChat } from "@cometchat-pro/chat";

Initialize CometChat

The init() method initialises the settings required for CometChat.

The init() method takes the below parameters:

  1. APP_ID - 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:
a. Region of the App: The Region code for the app. (For example, eu for Europe)
b. Presence Subscription.

You need to call init() before calling any other method from CometChat.

<script type="text/javascript" src="https://unpkg.com/@cometchat-pro/[email protected]/CometChat.js"></script>

<script type="text/javascript">
  window.onload = (function () {
  var appId = "APP_ID";
  let cometChatSettings = new CometChat.AppSettingsBuilder().subscribePresenceForAllUsers().setRegion('us').build();
  CometChat.init(appId, cometChatSettings)
    .then(
      () => {
        console.log("Initialization completed successfully");
        //You can now call login function.
       },
       error => {
        console.log("Initialization failed with error:", error);
        //Check the reason for error and take appropriate action.
      }
    );
 })
</script>

Parameter

Description

appID

CometChat App ID

appSetting

An object of the AppSettings class.


Did this page help you?