dingtalk-stream-sdk 0.2.3

DingTalk Stream SDK for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! DingTalk Stream SDK for Rust
//!
//! A Rust implementation of the DingTalk Stream SDK, based on the Node.js and Python SDKs.
//!
//! # Quick Start
//!
//! ```rust
//! use dingtalk_stream::{Credential, DingTalkStream, CallbackHandler, MessageTopic, TOPIC_ROBOT};
//! use dingtalk_stream::handlers::{Resp, Error, ErrorCode};
//! use async_trait::async_trait;
//! use dingtalk_stream::frames::{CallbackMessage, CallbackWebhookMessage};
//! use tokio::sync::mpsc::Sender;
//!
//! // Define a handler for robot messages
//! struct MyRobotHandler(MessageTopic);
//!
//! #[async_trait]
//! impl CallbackHandler for MyRobotHandler {
//!     async fn process(&self, message: &CallbackMessage, cb_webhook_msg_sender: Option<Sender<CallbackWebhookMessage>>) -> Result<Resp, Error> {
//!         // Process the message and return a response
//!         Ok(Resp::Text("Hello from DingTalk SDK!".to_string()))
//!     }
//!
//!     fn topic(&self) -> &MessageTopic {
//!         &self.0
//!     }
//! }
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     let credential = Credential::new(
//!         "your-client-id".to_string(),
//!         "your-client-secret".to_string(),
//!     );
//!
//!     let mut client = DingTalkStream::new(credential)
//!         .register_callback_handler(MyRobotHandler(
//!             MessageTopic::Callback(TOPIC_ROBOT.to_string()),
//!         ));
//!
//!     client.start().await;
//!     Ok(())
//! }
//! ```

pub mod client;
pub mod credential;
pub mod frames;
pub mod handlers;
pub mod utils;

// Re-export for convenience
pub use client::{ClientConfig, DingTalkStream};
pub use credential::Credential;

pub type Result<T, E = anyhow::Error> = anyhow::Result<T, E>;

/// The DingTalk gateway URL for opening connections
pub const GATEWAY_URL: &str = "https://api.dingtalk.com/v1.0/gateway/connections/open";

/// The DingTalk API endpoint for getting access tokens
pub const GET_TOKEN_URL: &str = "https://api.dingtalk.com/v1.0/oauth2/accessToken";

pub const MESSAGE_FILES_DOWNLOAD_URL: &str =
    "https://api.dingtalk.com/v1.0/robot/messageFiles/download";

pub const MEDIA_UPLOAD_URL: &str = "https://oapi.dingtalk.com/media/upload";

pub const ROBOT_SEND_PRIVATE_MESSAGE: &str =
    "https://api.dingtalk.com/v1.0/robot/oToMessages/batchSend";

pub const ROBOT_SEND_GROUP_MESSAGE: &str = "https://api.dingtalk.com/v1.0/robot/groupMessages/send";

/// The topic for robot message callbacks
pub const TOPIC_ROBOT: &str = "/v1.0/im/bot/messages/get";

/// The topic for robot delegate message callbacks
pub const TOPIC_ROBOT_DELEGATE: &str = "/v1.0/im/bot/messages/delegate";

/// The topic for card callback
pub const TOPIC_CARD: &str = "/v1.0/card/instances/callback";

/// SDK version
pub const VERSION: &str = env!("CARGO_PKG_VERSION");