vdotok-messaging v0.18.1
VDOTOK Library for JavaScript
Demo
Looking for code to get started with? https://github.com/vdotok/JS-chat This repository includes which run in a web browser.
Usage
const Client = new MVDOTOK.Client({
projectID: "****",
secret: "********************",
});
Client.on("authenticated", (res) => {
let user = StorageService.getUserData();
Client.Register(ref_id.toString(), authorization_token.toString());
});
SDK Events
Client.on("connect", (response) => {
//after connecting successfully
});
Client.on("disconnect", (response) => { //on disconnecting });
Client.on("subscribed", (response) => { //on subscribing the channel });
Client.on("messagesent", (response) => { //on sending the message });
Client.on("online", (response) => { //when someone gets online });
Client.on("offline", (response) => { //on someone gets offline });
Client.on("message", (response) => { //on receiving a message });
Client.on("create", (response) => { //on creating a channel });
SDK Methods
CreateChannel
This method is used to create a channel. It consists of one parameter i.e, name of the channel Client.CreateChannel("abc"); SubscribeChannel
This method is used to subscribe a channel. It takes and object which contains two parameters i.e, key and channel name
Client.Subscribe( { "key": "xsesAcDs45sse", "channel": "abc/", } );
UnSubscribeChannel
This method is used to unsubscribe a channel. It takes and object which contains two parameters i.e, key and channel name
Client.UnSubscribe( { "key": "xsesAcDs45sse", "channel": "abc/", } ); SendMessage
This method is used to send message of following types:
Text // If someone sends a message Client.SendMessage({ "from": "userId", "content": "This is a text message", "id": "1611641364417", "size": 0, "key": "AACO5B_L67HeJxw7onqZz1QoYDd2KyJQ", "type": "text", "to": "4130/", "isGroupMsg": false, }); SendReceipt
This method is used to send a confirmation message of a message that is received
Client.SendReceipt({
//This id will be the same as received message id
"messageId": "1611641364415",
"from": "userId",
"key": "AACO5B_L67HeJxw7onqZz1QoYDd2KyJQ",
"to": "4130/",
"receiptType": 3,
"date": "1611639333.028"
});
Send Attachment
This method is used to send Attachments
var option = {
from:"",
topic:"",
key:"",
type:""
};
/*
<input type="file" id="fileinput" />
*/
var file = document.getElementById("fileinput").value;
Client.SendFile(file, option);
// If someone sends a raw message
var rawOptions = {
from:"",
topic:"",
key:""
}
var rawMessage = "Hi";
SendRawMessage(rawMessage, rawOption);
```
Installation
Node module
npm i vdotok-messaging
UMD bundle