Skip to main content

Chat

Struct Chat 

Source
pub struct Chat { /* private fields */ }
Expand description

私聊客户端

Implementations§

Source§

impl Chat

Source

pub fn new(api_key: String) -> Self

Source

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

Source

pub async fn reconnect( &mut self, user: Option<String>, ) -> Result<(), WebSocketError>

重连

Source

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

Source

pub fn on_ws_log<F>(&mut self, hook: F)
where F: Fn(&str) + Send + Sync + 'static,

Source

pub async fn on_notice<F>(&self, listener: F)
where F: Fn(ChatNotice) + Send + Sync + 'static,

监听通知消息事件

Source

pub async fn on_data<F>(&self, listener: F)
where F: Fn(ChatData) + Send + Sync + 'static,

监听普通消息事件

Source

pub async fn on_revoke<F>(&self, listener: F)
where F: Fn(ChatRevoke) + Send + Sync + 'static,

监听消息撤回事件

Source

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

移除监听

Source

pub fn disconnect(&mut self)

断开连接

Source

pub fn send_ws(&self, content: &str) -> Result<(), Error>

通过已连接的 chat-channel 发送私聊消息

该方法要求先调用 connect(..., Some(to_user)) 建立目标会话连接。

Source

pub async fn list(&self) -> Result<Vec<ChatData>, Error>

获取有私聊用户列表第一条消息

返回 私聊消息列表

Source

pub async fn history( &self, user: String, page: u32, size: u32, autoread: bool, ) -> Result<Vec<ChatData>, Error>

获取用户私聊历史消息

  • page 页数
  • size 每页消息数量
  • autoread 是否自动标记为已读

返回 私聊消息列表

Source

pub async fn mark_as_read(&self, user: String) -> Result<bool, Error>

标记用户消息已读

  • user 用户名

返回 执行结果

Source

pub async fn unread(&self) -> Result<Vec<ChatData>, Error>

获取未读消息

返回 未读消息列表

Source

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

撤回私聊消息

  • msgId 消息 ID

返回 执行结果

Auto Trait Implementations§

§

impl Freeze for Chat

§

impl !RefUnwindSafe for Chat

§

impl Send for Chat

§

impl Sync for Chat

§

impl Unpin for Chat

§

impl UnsafeUnpin for Chat

§

impl !UnwindSafe for Chat

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more