聊天室模块
更新时间:2024-10-10 17:27:10
聊天室模块(chat)是一个服务于保利威聊天室服务的模块,包括获取和发送聊天室消息,聊天室用户登录登出,获取在线列表等功能。- 该模块基于保利威的
聊天室SDK实现,并通过WebSocket的方式来实现客户端与服务端的通信。
一、Api 方法概览
| Api 方法 | 说明 |
|---|---|
| getChatInfo | 获取聊天室信息 |
| getChatSetting | 获取聊天室设置 |
| getChatHistory | 获取聊天历史消息 |
| getRealtimeLikes | 获取实时的点赞数 |
| sendLike | 发送点赞数 |
| getEmotionImages | 获取表情图片列表 |
| sendSpeakMsg | 发送文本消息 |
| sendImageMsg | 发送图片消息 |
| sendEmotionImageMsg | 发送表情图片消息 |
| sendSystemMsg | 发送系统消息 |
| getFullMessage | 获取超长消息的完整文本 |
| getOnlineUserCount | 获取聊天室的实时在线人数 |
| parseSpeakContent | 转换发言内容 |
| getEmotionFaceList | 获取黄脸表情列表数据 |
| splitTextAndEmotion | 切割聊天消息的文本和表情 |
二、Event 事件概览
| Event 事件 | 说明 |
|---|---|
| ChatEvents.ChatInfoChange | 聊天室信息修改 |
| ChatEvents.ChatConnectFail | 聊天室连接失败事件 |
| ChatEvents.ChatMessage | 聊天消息事件 |
| ChatEvents.ReplaceChatMessage | 替换聊天消息事件 |
| ChatEvents.ChatLike | 点赞事件 |
| ChatEvents.ChatLikeCountChange | 点赞数修改事件 |
| ChatEvents.ChatUserLogin | 聊天室用户登录事件 |
| ChatEvents.ChatUserLogout | 聊天室用户登出事件 |
| ChatEvents.CurrentUserRelogin | 当前用户重复登录事件 |
| ChatEvents.ClearMsgHistory | 清空聊天室事件 |
| ChatEvents.RemoveChatMsg | 删除某条消息事件 |
| ChatEvents.CloseChatRoom | 聊天室关闭事件 |
| ChatEvents.OpenChatRoom | 聊天室开启事件 |
| ChatEvents.OnlineUserCountChange | 在线人数改变事件 |
