聊天室模块

• 聊天室模块(chat) 是一个服务于保利威聊天室服务的模块，包括获取和发送聊天室消息，聊天室用户登录登出，获取在线列表等功能。

• 该模块基于保利威的 聊天室SDK 实现，并通过 WebSocket 的方式来实现客户端与服务端的通信。

一、Api 方法概览

Api 方法	说明
getSocket	获取聊天室 socket 实例
getChatInfo	获取聊天室信息
getChatSetting	获取聊天室设置
getChatHistory	获取聊天历史消息
getChatHistoryBySessionId	根据场次号分页获取聊天历史消息
getChatHistoryByTime	根据时间戳获取聊天历史消息
getRealtimeLikes	获取实时的点赞数
sendLike	发送点赞数
sendEmotionalFeedback	发送情绪反馈
getEmotionImages	获取表情图片列表
sendSpeakMsg	发送文本消息
sendImageMsg	发送图片消息
sendEmotionImageMsg	发送表情图片消息
sendSystemMsg	发送系统消息
sendCustomMessage	发送自定义消息(客户端)
insertLocalRewardChatMsg	插入本地打赏消息
getFullMessage	获取超长消息的完整文本
getOnlineUserList	分页获取在线列表
startOnlineUserListPolling	开始在线用户列表轮询
stopOnlineUserListPolling	结束在线用户列表轮询
getOnlineUserListNew	获取在线用户列表新接口
getOnlineUserCount	获取聊天室的实时在线人数
parseSpeakContent	转换发言内容
getEmotionFaceDomList	获取黄脸表情节点
getEmotionFaceClickTarget	获取点击事件中的黄脸表情
getChatMsgReplayHistoryList	获取聊天消息重放历史数据
processChatMsgReplay	处理聊天消息重放
setChatMsgReplayPlaybackTarget	设置聊天消息重放对应的回放对象
initChatMsgReplay	初始化聊天消息重放
addChatMsgReplayCachePlugin	添加聊天重放本地缓存插件
removeChatMsg	根据id 移除聊天消息
replaceChatMsg	根据id，替换对应的聊天内容
getSpeakTopInfo	获取评论上墙数据
setSpeakTop	设置评论上墙数据
cancelSpeakTop	取消评论上墙

二、Event 事件概览

Event 事件	说明
ChatEvents.ChatInfoChange	聊天室信息修改
ChatEvents.ChatReconnectSuccess	聊天室重连成功事件
ChatEvents.ChatConnectFail	聊天室连接失败事件
ChatEvents.ChatMessage	聊天消息事件
ChatEvents.ReplaceChatMessage	替换聊天消息事件
ChatEvents.ChatLike	点赞事件
ChatEvents.ChatLikeCountChange	点赞数修改事件
ChatEvents.ChatEmotionalFeedback	情绪反馈事件
ChatEvents.ChatUserLogin	聊天室用户登录事件
ChatEvents.ChatUserLogout	聊天室用户登出事件
ChatEvents.CurrentUserRelogin	当前用户重复登录事件
ChatEvents.ClearMsgHistory	清空聊天室事件
ChatEvents.RemoveChatMsg	删除某条消息事件
ChatEvents.CloseChatRoom	聊天室关闭事件
ChatEvents.OpenChatRoom	聊天室开启事件
ChatEvents.OnlineUserCountChange	在线人数改变事件
ChatEvents.OnlineUserListChange	在线用户列表改变事件
ChatEvents.ChatMsgReplayReload	聊天消息重放-重新加载
ChatEvents.ChatMsgReplayStatusChange	聊天消息重放状态
ChatEvents.OverMaxOnlineCount	超出直播间最大在线人数
ChatEvents.WhiteListRemoveUser	白名单移除用户
ChatEvents.SpeakToTop	评论上墙事件
ChatEvents.SpeakCancelTop	评论取消上墙事件