#slide #google-api #google #web-api #api #protocols #web

google-slides1

与 Slides(协议 v1)交互的完整库

5个稳定版本

使用旧的 Rust 2015

1.0.4+20161213 2017年2月4日
1.0.3+20161213 2017年2月1日
1.0.2+20161213 2016年12月27日
1.0.1+20161213 2016年12月24日
1.0.0+20161213 2016年12月16日

#6 in #slide


用于 google-slides1-cli

MIT 许可证

210KB
2K SLoC

google-slides1 库允许访问 Google Slides 服务的所有功能。

本文档是从 Slides 库版本 1.0.4+20161213 生成的,其中 20161213 是由 mako 代码生成器 v1.0.4 构建的 slides:v1 架构的确切修订版本。

关于 Slides v1 API 的其他所有信息可以在 官方文档网站 找到。

特性

从中央 中心 简单地处理以下 资源...

库结构

API 结构如下

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

所有 结构 都带有适用的特性,以进一步分类它们并简化浏览。

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

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

或具体...

let r = hub.presentations().create(...).doit()
let r = hub.presentations().get(...).doit()
let r = hub.presentations().batch_update(...).doit()
let r = hub.presentations().pages_get(...).doit()

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

用法

设置项目

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

[dependencies]
google-slides1 = "*"

一个完整的示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_slides1 as slides1;
use slides1::BatchUpdatePresentationRequest;
use slides1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use slides1::Slides;

// 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::new(),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Slides::new(hyper::Client::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 = BatchUpdatePresentationRequest::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.presentations().batch_update(req, "presentationId")
             .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 DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

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

支持上传的方法可以使用最多两种协议进行上传: 简单可恢复。每种协议的独特之处由定制的 doit(...) 方法表示,分别命名为 upload(...)upload_resumable(...)

定制和回调

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

代理 trait 有默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器,您可以通过多次调用它的方法来准备一个动作调用。这些方法始终只接受一个参数,以下陈述是正确的。

  • PODs通过复制传递
  • 字符串作为&str传递
  • 请求值是移动的

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

许可证

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

依赖项

~9-19MB
~309K SLoC