聊天室模組
更新時間：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 | 線上人數改變事件 |
