0.0.1 • Published 5 years ago

demobuild v0.0.1

Weekly downloads
11
License
SEE LICENSE IN LI...
Repository
github
Last release
5 years ago

CometChat Pro enables you to add voice, video & text chat for your website & app.

[Platform](#) [Platform](#)

Quick Start

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

Get your Application Keys

Signup for CometChat and then:

  1. Create a new app: Enter a name & hit the + button
  2. Head over to the API Keys section and click on the Create API Key button
  3. Enter a name and select the scope as Auth Only
  4. Now note the API Key and App ID

Add the CometChat Dependency

NPM

First, install via npm

Shell

npm install @cometchat-pro/chat --save

Then, import the CometChat object wherever you want to use CometChat

JavaScript

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

HTML (via CDN)

Include the CometChat Javascript library in your HTML code

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

Initialize CometChat

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

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

var appID = "APP_ID";

CometChat.init(appID).then(
  hasInitialized => {
    console.log("Initialization completed successfully", hasInitialized);
    // You can now call login function.
  },
  error => {
    console.log("Initialization failed with error:", error);
    // Check the reason for error and take apppropriate action.
  }
);

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

Login your user

Once initialization is successful, 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.

var UID = "SUPERHERO1";
var apiKey = "API_KEY";

CometChat.login(UID, apiKey).then(
  User => {
    console.log("Login Successful:", { User });
    // User loged in successfully.
  },
  error => {
    console.log("Login failed with exception:", { error });
    // User login failed, check error and take appropriate action.
  }
);

Make sure you replace the API_KEY with your CometChat API Key in the above code.

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

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

Send a message

Once your user has logged in, you can send a message using the sendMessage() method.

var receiverID = "SUPERHERO2";
var messageText = "Hello";
var messageType = CometChat.MESSAGE_TYPE.TEXT;
var receiverType = CometChat.RECEIVER_TYPE.USER;

var textMessage = new CometChat.TextMessage(receiverID, messageText, messageType, receiverType);

CometChat.sendMessage(textMessage).then(
  message => {
    console.log("Message sent successfully:", message);
    // Do something with message
  },
  error => {
    console.log("Message sending failed with error:", error);
    // Handle any error
  }
);
ParameterDescription
receiverIDThe UID or GUID of the recipient
messageTextThe message string to be sent
messageTypeThe type of the message that needs to be sent which in this case is CometChat.MESSAGE_TYPE.TEXT (text)
receiverTypeThe type of the receiver to whom the message is to be sent i.e CometChat.RECEIVER_TYPE.USER (user) or CometChat.RECEIVER_TYPE.GROUP (group)

Once the message is sent successfully, you will receive the message information as TextMessage object on Promise resolved.

Receive Messages

You can add multiple MessageListener using the addMessageListener() method, to receive incoming message wherever you need.

var listenerID = "UNIQUE_LISTENER_ID";can we get single amazon server !
CometChat.addMessageListener(listenerID, new CometChat.MessageListener({
  onTextMessageReceived: message => {
    console.log("Message received successfully:", message);
    // Handle text message
  }
}));
ParameterDescription
listenerIDAn ID that uniquely identifies that listener. We recommend using the activity or fragment name

To learn more, please refer to our javascript Developer Documentation.