Struct ChatRoom 

pub struct ChatRoom { /* private fields */ }

聊天室客户端

Implementations

impl ChatRoom

pub fn new(api_key: String) -> Self

pub async fn get_node(&self) -> Result<ChatRoomNodeResponse, WebSocketError>

pub async fn get_ws_url(&self) -> Result<String, WebSocketError>

获取 WebSocket URL

pub async fn connect(&mut self, reload: bool) -> Result<(), WebSocketError>

连接聊天室

参数

• reload - 是否重新连接

pub async fn reconnect(&mut self) -> Result<(), WebSocketError>

重连

pub fn set_reconnect_policy(&mut self, policy: RetryPolicy)

pub fn on_ws_log<F>(&mut self, hook: F)

where F: Fn(&str) + Send + Sync + 'static,

pub async fn on_online<F>(&self, listener: F)

where F: Fn(Vec<OnlineInfo>) + Send + Sync + 'static,

监听在线用户更新事件

pub async fn on_discuss<F>(&self, listener: F)

where F: Fn(String) + Send + Sync + 'static,

监听话题变更事件

pub async fn on_revoke<F>(&self, listener: F)

where F: Fn(String) + Send + Sync + 'static,

监听消息撤回事件

pub async fn on_msg<F>(&self, listener: F)

where F: Fn(ChatRoomMsg) + Send + Sync + 'static,

监听普通消息事件

pub async fn on_barrager<F>(&self, listener: F)

where F: Fn(BarragerMsg) + Send + Sync + 'static,

监听弹幕消息事件

pub async fn on_redpacket<F>(&self, listener: F)

where F: Fn(ChatRoomMsg<Value>) + Send + Sync + 'static,

监听红包消息事件

pub async fn on_redpacketstatus<F>(&self, listener: F)

where F: Fn(RedPacketStatusMsg) + Send + Sync + 'static,

监听红包状态事件

pub async fn on_music<F>(&self, listener: F)

where F: Fn(ChatRoomMsg<Value>) + Send + Sync + 'static,

监听音乐消息事件

pub async fn on_weather<F>(&self, listener: F)

where F: Fn(ChatRoomMsg<Value>) + Send + Sync + 'static,

监听天气消息事件

pub async fn on_custom<F>(&self, listener: F)

where F: Fn(CustomMsg) + Send + Sync + 'static,

监听进出场消息事件

pub async fn on_all<F>(&self, listener: F)

where F: Fn(ChatRoomEventData) + Send + Sync + 'static,

pub async fn off(&self, event: ChatRoomEventType)

移除监听

pub fn disconnect(&mut self)

断开连接

pub async fn send(&self, msg: String) -> Result<(), Error>

发送消息

参数

• msg - 消息内容

pub async fn get_discuss(&self) -> String

当前话题

pub async fn set_discuss(&self, discuss: String)

设置当前话题

参数

• discuss - 新话题

pub async fn get_online_count(&self) -> usize

当前在线人数

pub fn set_api_key(&mut self, api_key: String)

重新设置apiKey

pub fn set_client_type(&mut self, client: ClientType, version: Option<String>)

设置客户端类型

参数

• client - 客户端类型 ClientType
• version - 版本号

pub async fn history( &self, page: u32, type_: ChatContentType, ) -> Result<Vec<ChatRoomMsg>, Error>

查询聊天室历史消息

#参数 page - 页码 type_ - 内容类型 ChatContentType

pub async fn get_msg_around( &self, o_id: &str, mode: ChatRoomMessageMode, size: u32, type_: ChatContentType, ) -> Result<Vec<ChatRoomMsg>, Error>

获取指定消息附近的聊天室消息

参数

• o_id - 消息 Id
• mode - 获取模式，context 上下文模式，after 之后模式 ChatRoomMessageMode
• size - 获取消息数量，默认 25，最大 100
• type_ - 获取消息类型，默认 HTML ChatContentType
• 返回 ChatRoomMsg 消息列表

pub async fn revoke(&self, o_id: &str) -> Result<RevokeMsg, Error>

撤回消息

参数

• o_id - 消息 ID

返回 RevokeMsg

pub async fn barrager( &self, msg: String, color: Option<String>, ) -> Result<String, Error>

发送弹幕

参数

• msg - 弹幕内容
• color - 颜色（可选）

pub async fn barrage_cost(&self) -> Result<BarragerCost, Error>

获取弹幕花费

返回 BarragerCost

pub async fn mutes(&self) -> Result<Vec<MuteItem>, Error>

获取禁言中成员列表（思过崖）

返回禁言中成员列表 MuteItem

pub async fn get_raw_message(&self, o_id: &str) -> Result<String, Error>

获取消息原文（比如 Markdown）

参数

• o_id - 消息 ID