Struct Client

pub struct Client {
    pub config: Arc<Mutex<ClientConfig>>,
    /* private fields */
}

An asynchronous Client to interactive with DingTalk server

Using websocket fro receiving message and https for sending

Fields

config: Arc<Mutex<ClientConfig>>

config inside client can be adjusted

Implementations

impl Client

pub async fn download_url( &self, download_code: impl AsRef<str>, ) -> Result<String>

get download url instead of download it

pub async fn download( &self, download_code: impl AsRef<str>, writer: impl AsyncWrite + Unpin, ) -> Result<()>

download file from download_code

impl Client

pub async fn create_group(&self, req: CreateRequest) -> Result<(String, String)>

create group via CreateRequest, return group (open_conversation_id, chatid)

impl Client

pub async fn upload( &self, file: impl AsRef<Path>, file_type: UploadType, ) -> Result<String>

upload file and return media id for

• MessageTemplate::SampleFile
• MessageTemplate::SampleVideo
• MessageTemplate::SampleAudio

impl Client

pub fn new( client_id: impl Into<String>, client_secret: impl Into<String>, ) -> Result<Arc<Self>>

Create new client, need to specific the id and secret they provided when creating the robot

pub fn ua(self: Arc<Self>, value: impl Into<String>) -> Arc<Self>

Change the User-Agent

pub fn keep_alive(self: Arc<Self>, value: i64) -> Arc<Self>

Control client side keep alive heartbeat interval(ms), default is 8000.
When set to 0, means disable keep alive heartbeat.

pub fn reconnect(self: Arc<Self>, value: i64) -> Arc<Self>

Control client reconnect when websocket disconnected(ms), default is 1000ms.
When set to 0, means disable reconnect.

pub fn register_all_event_listener<P>( self: Arc<Self>, on_event_received: P, ) -> Arc<Self>

where P: Fn(EventData) -> EventAckData + Send + Sync + 'static,

Add listener to watch all event.
Calling this interface multiple times will replace the old listener with a new one.

pub fn register_callback_listener<P, F>( self: Arc<Self>, event_id: impl AsRef<str>, callback: P, ) -> Arc<Self>

where P: Fn(Arc<Self>, RobotRecvMessage) -> F + Send + 'static, F: Future<Output = Result<()>> + Send,

Add listener to watch specifc event id

pub async fn connect(self: Arc<Self>) -> Result<()>

Connect to api gateway, and begin the websocket stream process

pub fn exit(&self)

Trait Implementations

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.