Welcome to ChatLib with socket.io #

This documentation provides an overview of the Chat , Networkclass and its methods.

Table of Contents #

Overview
Usage
Methods

Methods #

Default api response #

 {
       "data": "response api", // response all api
       "success": true, // status api true: success, false : have error
     }

Error definition #

header status:
- 200: success
- 400: bad request
- 401: Unauthorized
- 404: Not Found
- 500, 501: Server Error
response error:

{
  "error": {
    "code": "string", // code error
    "message": "string", // message
    "details": "string", // detail error
    "data": {
      "additionalProp1": "string", // It cannot determined
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "validationErrors": [
      {
        "message": "string",
        "members": [
          "string"
        ]
      }
    ]
  }
}

Chat

Method	Description
connect	Create connections
disconnet	Stop connections
sendMessage	send message with group
updateMessage	update message with group
receiveMessage	Listens for incoming mes
receiveDeleteMessage	Listens for incoming mes delete
setMessageSeenStatus	Sets the "message seen"

`sendMessage`

Listens for incoming chat messages and invokes a callback function when a new message is received.

chat.sendMessage(
  {
    message: "", // message sent
    attachments: [
      {
        name: "", // name file
        desciption: "",
        id: "", // id attachments (send id = null or '')
        url: "", // url file
        typeAttachment: 1, // - video = 1,  // - audio = 2// - image = 3// - file = 4 // - other = 5
        sizeByte: 0,
        durationSeconds: 0,
        revoke: 1, // 1 revoke for sender, 2 revoke for all group
      },
    ],
    forwardFromRoomId: "",
    mentionIds: [], // list userId mention
    type: 0, //type message list in here:
    // - text = 0
    // - audio = 1
    // - file = 2
    // - sticker = 3
    // - gallery = 4
    // - video = 5
    quoteMessageId: "", // message quote id
    forwardMessageId: "", // message forward id
  },
  id
);

`ListRoomChat`

Listens for incoming chat messages and invokes a callback function when a new message is received.

chat.receiveMessage(message  => {
});
// response in socket message
{
  "attachments": [], // list file
  "forwardFromMessageId": "", // id message forward
  "forwardFromRoomId": "", // id room message forward
  "mentionIds": [], // list userId mention
  "message": "Test",
  "messageId": "", // id message
  "quoteFromMessageId": "", // id message for quote
  "roomId": "", // room id
  "senderId": "", //userid sender
  "senderProfile": {
    "avatar": "", // url avatar
    "displayname": "", // name
    "id": "", // userid sender
    "username": "" // username
  },
  "timeSend": "2023-09-28T09:10:46.783Z",
  "type": 0     //type message list in here:
                // - text = 0
                // - audio = 1
                // - file = 2
                // - sticker = 3
                // - gallery = 4
                // - video = 5
}

note: Before using it, you have to initialize the data retrieval function. #

import {
  ChatUser,
  Chat,
  InitChatSocket,
  InitChatMagement,
} from "chat-app-demo-abc";
// auth config
const chatUser = InitChatUser(url, token);
or;
const chatUser = new ChatUser(url, token);
// auth message reader
const apiMessage = InitMessageReader(url, token);
or;
const apiMessage = new MessageReader(url, token);

// chat management
const apiManage = new ChatMagement("url_chat_manager", token);
or;
const apiManage = InitChatMagement("url_chat_manager", token);
// chat management
const chat = new InitChatSocket("url_chat_soket", token);
or;
const chat = ChatSocket("url_chat_socket", token);

Except for the login function, you need to pass the token for all other functions.
authUrl, messageReaderUrl, ChatManageUrl: You only need to pass one of the three. Use the cluster's URL you're using.

Auth

Method	Params	Description
Login	userName:String, passWord: string	get token using to conect chat

`Login`

const result = await ChatUser.login(param);


// param request
{
  "userName": "string", //email account login
  "passWord": "string",  // password
  "pushToken": "string"// pushtoken is device token in firebase
}

//response
{
  "access_token": "", // token access chat (you can using jwt_decode access_token to get info user)
  "refresh_token": ""
  "expires_in": 0, // expires time
  "token_type": "Bearer", // type Authorization
  "scope": "Auth offline_access"
}
// this way to get info user
import jwt_decode from "jwt-decode";
 var infoUser = jwt_decode(access_token);

note: if you need get info user ex: useId, name... you have to instal jwt-decode to decode access_token then you have it

`register`

const result = await ChatUser.register(param);


// param request
{
  "username": "string",
  "email": "string",
  "phoneNumber": "string",
  "gender": 0,
  "avatar": "string", // url avatar (optional)
  "dateOfBirth": "2023-10-06T02:43:24.154Z",
  "password": "string",
  "image": { // optional
    "fileId": "string", // file id get from api upload(optional)
    "fileName": "string", // name file (optional)
    "extension": "string", // extension file
    "fileUrl": "string", // url file
    "contentType": "string"
  },
  "isAdmin": false // status is admin default false
}

//response
{
   "userId": "string", // user id
  "access_token": "", // token access chat (you can using jwt_decode access_token to get info user)
  "refresh_token": ""
  "expires_in": 0, // expires time
  "token_type": "Bearer", // type Authorization
  "scope": "Auth offline_access"
}
// this way to get info user
import jwt_decode from "jwt-decode";
 var infoUser = jwt_decode(access_token);

`listUserContactAdd`

find list user by contact(phone)

const param = ["09xxx", "08xxx"];
const result = await chatUser.listUserContactAdd(param);

//response
[
  {
    id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", // userId
    name: "string", // name
    avatar: "string", // url avatar
    email: "string", // email user
    phoneNumber: "string", // phone user
    gender: 0, // gender 0: male, 1: female
    dateOfBirth: "2023-10-06T02:46:24.015Z",
    isFriend: true, // status is friend
    distance: 0, // distance(km)
  },
];

`searchFriends`

find friends

const result = await chatUser.searchFriends(param);

// param request
{
  "groupId": "string",
  "filters": "string", // string search
  "phoneNumber": "string",
  "sorting": "ASC",
  "skip": 0,
  "take": 10,
}

//response
{
  "items": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // userId
    "name": "string", // name
    "avatar": "string", // url avatar
    "email": "string", // email user
    "phoneNumber": "string", // phone user
    "gender": 0, // gender 0: male, 1: female
    "dateOfBirth": "2023-10-06T02:46:24.015Z",
    "isFriend": true, // status is friend
    "distance": 0 // distance(km)
    }
  ],
  "pageSize": 0,
  "totalCount": 0
}

`userDoAction`

User action(add friend, unfriend, block , unblock)

const result = await chatUser.userDoAction(param);

// param request
{
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",// userid user
  "actionType": 0 // 0: add friend, 1: unfriend, 2: block , 3 unblock
}
}

//response
{
 "success":true
}

`listFriends`

const result = await chatUser.listFriends(param);

// param request
{
  "groupId": "string",
  "filters": "string", // string search
  "phoneNumber": "string",
  "sorting": "ASC",
  "skip": 0,
  "take": 10,

}

//response
{
  "items": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // userId
    "name": "string", // name
    "avatar": "string", // url avatar
    "email": "string", // email user
    "phoneNumber": "string", // phone user
    "gender": 0, // gender 0: male, 1: female
    "dateOfBirth": "2023-10-06T02:46:24.015Z",
    "isFriend": true, // status is friend
    "distance": 0 // distance(km)
    }
  ],
  "pageSize": 0,
  "totalCount": 0
}

Message management

`ListRoomChat`

Retrieves a list of chat rooms in which a user has participated.

const param = { userId: "", skip: 0, take: 20 };
const result = await apiManage.ListRoomChat(param);

// param request
{
  "userId": "string", // userId (can be null default get by token)
  "groupName":"", // name group
  "tagFilter": null, // number 1,2,3
  "skip": 0,  // point start record
  "take": 0// The number of records retrieved
}
// response
{
  "items": [
    {
      "id": "string", //id room chat
      "createdOn": "2023-09-28T07:35:34.233Z",
      "name": "string", // name room chat
      "typeOfGroup": 0, // type group: 0: group, 1: direct, 2: support
      "topic": "string", // topic group(canbe null)
      "description": "string", // desc group (can be null)
      "image": "string", // url image room
      "ownerId": "string", // id user owner group
      "participantCount": 0, // total participant
      "lastMessage": {
        "id": "string", // id message
        "message": "string",
        "userId": "string", // userid send send
        "userName": "string", // name sender
        "fullName": "string", // full name sender
        "nickName": "string", //
        "avatar": "string",// url avata
        "time": "2023-09-28T07:35:34.233Z",
        "attachments": [
          {
            "name": "string", // name file
            "desciption": "string", //
            "id": "string", // id attachments
            "url": "string", // url file
            "urlPreView": "string",
            "typeAttachment": 1, //  // - video = 1,  // - audio = 2// - image = 3// - file = 4 // - other = 5
            "messageId": "string",
            "sizeByte": 0, // size file
            "durationSeconds": 0,
            "revoke": 1 // 1 revoke for sender, 2 revoke for all group
          }
        ],
        "type": 0,
        "isEdited": true,// status edit
        "lastEditTime": "2023-09-28T07:35:34.233Z",
        "isDeleted": true // status delete
      },
      "participantInfo": { // Only available for one-on-one chats This is information about the remaining person in the room
        "userId": "string", // userId
        "userName": "string", // username
        "fullName": "string", // fullname
        "nickName": "string", // nickname
        "avatar": "string", // url avata
        "onlineStatus": 0, //status online 0 offline, 1 online
      },
      "hasUnreadMessage": true, // status unread message
      "unreadCount": 0,// total message unread
      "isFavorite": true, // status favorite
      "tags": [
        "string"
      ], // list tags group
      "notifyStatus": true, // status get notification
      "leaveGroupHistories": [
        {
          "participant": "string", // userid leave group
          "timeLeave": "2023-09-28T07:35:34.233Z"
        }
      ]
    }
  ],
  "totalCount": 0
}