Setup
Get your Application Keys
Signup for CometChat and then:
- Create a new app
- Head over to the Credentials section and note the App ID, Auth Key & Region
Add the CometChatCalls Dependency
Install the package as NPM module:
- npm
- yarn
npm install @cometchat/calls-sdk-javascript@latest --save
yarn add @cometchat-pro/web-calls@latest
Then, import the CometChatCalls
class wherever you want to use CometChatCalls
.
- Javascript
- Typescript
import { CometChatCalls } from "@cometchat/calls-sdk-javascript";
import { CometChatCalls } from "@cometchat-pro/web-calls";
Initialize CometChatCalls
The init()
method initialises the settings required for CometChatCalls
. The init()
method takes a single paramater, that is the instance of CallAppSettings
class.
The CallAppSettingsBuilder
class allows you to configure three settings:
- appID: You CometChat App ID
- region: The region where your app was created
- host: 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 CometChatCalls
. We suggest you call the init() method on app startup, preferably in the index.js file.
- Javascript
- Typescript
let appID = "APP_ID";
let region = "REGION";
const callAppSetting = new CometChatCalls.CallAppSettingsBuilder()
.setAppId(appID)
.setRegion(region)
.build();
CometChatCalls.init(callAppSetting).then(
() => {
console.log('CometChatCalls initialization completed successfully');
},
error => {
console.log('CometChatCalls initialization failed with error:', error);
},
);
let appID = "APP_ID";
let region = "REGION";
const callAppSetting = new CometChatCalls.CallAppSettingsBuilder()
.setAppId(appID)
.setRegion(region)
.build();
CometChatCalls.init(callAppSetting).then(
() => {
console.log('CometChatCalls initialization completed successfully');
},
error => {
console.log('CometChatCalls 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.
Parameter | Description |
---|---|
callAppSettings | An object of the CallAppSettings class |