google-chat1 库允许访问 Google Hangouts Chat 服务的所有功能。

本文档是从 Hangouts Chat crate 版本 2.0.8+20210324 生成的，其中 20210324 是由 mako 代码生成器 v2.0.8 构建的 chat:v1 架构的确切修订版本。

有关 Hangouts Chat v1 API 的其他所有信息，请参阅 官方文档网站。

功能

轻松从中心 枢纽 处理以下 资源 ...

• dms
• 对话消息、消息 和 webhooks
• media
• download
• rooms
• 对话消息、消息 和 webhooks
• spaces
• get，list，members get，members list，messages attachments get，messages create，messages delete，messages get，messages update 以及 webhooks

支持下载...

• 下载媒体

本库的结构

API 结构如下主要项目

• 中心节点
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些构建器再允许访问单个 调用构建器
• 资源
  • 主要类型，可以将 活动 应用于这些类型
  • 一系列属性和 部分
  • 部分
    • 一系列属性
    • 在 活动 中从不直接使用
• 活动
  • 应用于 资源 的操作

所有 结构 都用适用的特质标记，以进一步分类它们并简化浏览。

一般来说，你可以这样调用 活动

let r = hub.resource().activity(...).doit().await

或具体...

let r = hub.dms().conversations_messages(...).doit().await
let r = hub.dms().messages(...).doit().await
let r = hub.dms().webhooks(...).doit().await
let r = hub.rooms().conversations_messages(...).doit().await
let r = hub.rooms().messages(...).doit().await
let r = hub.rooms().webhooks(...).doit().await
let r = hub.spaces().messages_create(...).doit().await
let r = hub.spaces().messages_get(...).doit().await
let r = hub.spaces().messages_update(...).doit().await
let r = hub.spaces().webhooks(...).doit().await

代码 resource() 和 activity(...) 调用创建 构建器。第二个构建器处理 活动，支持各种配置即将进行的操作的方法（此处未显示）。它设计成所有必需的参数都必须立即指定（即 (...)），而所有可选参数可以按需要 构建。doit() 方法执行与服务器的实际通信并返回相应的结果。

使用方法

设置你的项目

要使用此库，您需要将以下行放入您的 Cargo.toml 文件中

[dependencies]
google-chat1 = "*"
hyper = "^0.14"
hyper-rustls = "^0.22"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^5.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_chat1 as chat1;
use chat1::api::Message;
use chat1::{Result, Error};
use std::default::Default;
use oauth2;
use chat1::HangoutsChat;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = yup_oauth2::InstalledFlowAuthenticator::builder(
        secret,
        yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = HangoutsChat::new(hyper::Client::builder().build(hyper_rustls::HttpsConnector::with_native_roots()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Message::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.dms().conversations_messages(req, "parent")
             .thread_key("magna")
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都作为 Result 枚举提供，作为 doit() 方法的返回值，或者作为可能的中继结果传递给 Hub Delegate 或 Authenticator Delegate。

当代理处理错误或中间值时，他们有机会指示系统重试。这使得系统可能对所有类型的错误都有抵抗力。

上传和下载

如果一种方法支持下载，您应该读取响应体（它是Result的一部分）以获取媒体。如果此类方法还支持Response Result，则默认返回该结果。您可以将其视为实际媒体元数据。要触发媒体下载，您必须通过此调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多2种不同的协议：简单和可恢复。每种协议的独特性通过自定义的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

自定义和回调

您可以通过在调用最后的doit()之前向Method Builder提供一个delegate来更改doit()方法的调用方式。相应的方法将被调用以提供进度信息，并确定系统在失败时应否重试。

delegate trait默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码和解码。可选项用于表示部分请求或响应是有效的。大多数可选项都是被认为是Parts，它们可以通过名称识别，这些部分将被发送到服务器，以指示请求中设置的部分或响应中期望的部分。

构建器参数

通过使用method builders，您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受一个参数，以下陈述是真实的。

• PODs通过复制传递
• 字符串作为&str传递
• request values被移动

参数将始终被复制或克隆到构建器中，以使它们与其原始生命周期独立。

许可

chat1库由Sebastian Thiel生成，并置于MIT许可之下。您可以在存储库的许可文件中阅读全文。