该 google-homegraph1 库允许访问 Google Home Graph 服务（服务 v1）的所有功能。

此文档是从 Home Graph 服务 包版本 1.0.14+20200703 生成的，其中 20200703 是由 mako 代码生成器 v1.0.14 构建的 homegraph:v1 模式的确切版本。

有关 Home Graph 服务 v1 API 的其他所有信息，请参阅官方文档网站。

功能

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

• 代理用户
• 删除
• 设备
• 查询、报告状态和通知、请求同步 和 同步

此库的结构

API 被结构化为以下主要项目

• 枢纽
  • 一个中央对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些构建器反过来又允许访问单个 调用构建器
• 资源
  • 可以应用于 活动 的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 在 活动 中永远不会直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或具体 ...

let r = hub.devices().query(...).doit()
let r = hub.devices().request_sync(...).doit()
let r = hub.devices().sync(...).doit()
let r = hub.devices().report_state_and_notification(...).doit()

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

使用方法

设置你的项目

要使用这个库，你需要将以下行放入你的 Cargo.toml 文件中

[dependencies]
google-homegraph1 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_homegraph1 as homegraph1;
use homegraph1::QueryRequest;
use homegraph1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use homegraph1::HomeGraphService;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = HomeGraphService::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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 = QueryRequest::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.devices().query(req)
             .doit();

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::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")。

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

自定义和回调

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

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

服务器请求中的可选部分

本库提供的所有结构均设计为可通过json进行编码和解码。使用可选类型来表示部分请求和响应是有效的。大多数可选类型都是被认为的部分，可以通过名称识别，这些部分将被发送到服务器，以指示请求的设置部分或响应中所需的部分。

构建器参数

通过使用方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下陈述对它适用。

• POD通过复制传递
• 字符串作为&str传递
• 请求值被移动

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

许可证

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