48 个版本 (30 个稳定版)
5.0.5+20200628 | 2024年6月27日 |
---|---|
5.0.4+20200628 | 2024年3月5日 |
5.0.3+20200628 | 2023年8月23日 |
5.0.2+20200628 | 2023年3月16日 |
0.1.2+20140828 | 2015年3月25日 |
#2992 in 网页编程
在 google-appsactivity1-cli 中使用
115KB
1.5K SLoC
该 google-appsactivity1
库允许访问 Google appsactivity 服务的所有功能。
本文档是根据版本 5.0.5+20200628 的 appsactivity crate 生成的,其中 20200628 是由 mako 代码生成器 v5.0.5 构建的 appsactivity:v1 模式的确切版本。
有关 appsactivity v1 API 的其他所有信息,请参阅官方文档网站。
特性
轻松从中央 中心 处理以下 资源...
本库结构
API 结构如下主要项目
所有 结构 都用适用特徵标记,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体来说...
let r = hub.activities().list(...).doit().await
资源(resource)和活动(activity)调用创建构建器。其中第二个处理活动(Activities),支持配置即将进行的操作(此处未显示)的各种方法。它被设计成所有必需的参数必须立即指定(即(...)
),而所有可选的则可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置项目
要使用这个库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-appsactivity1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_appsactivity1 as appsactivity1;
use appsactivity1::{Result, Error};
use std::default::Default;
use appsactivity1::{Appsactivity, oauth2, hyper, hyper_rustls, chrono, FieldMask};
// 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 = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = Appsactivity::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.activities().list()
.user_id("et")
.source("magna")
.page_token("no")
.page_size(-55)
.grouping_strategy("voluptua.")
.drive_file_id("At")
.drive_ancestor_id("sanctus")
.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")
。
支持上传的方法可以使用最多两种不同的协议:简单和可恢复。每种的独特性由定制的doit
方法表示,分别命名为upload
和upload_resumable
。
定制和回调
您可以通过向Method Builder
提供代理来更改doit
方法被调用的方式,在执行最终的doit
调用之前。将调用相应的方法来提供进度信息,并确定系统在失败时是否应该重试。
代理特质具有默认实现,允许您以最小的努力进行定制。
服务器请求中的可选部分
本库提供的所有结构都是为了能够通过json进行编码和解码而设计的。使用可选参数来表示部分请求或响应是有效的。大多数可选参数被认为是部分,可以通过名称识别,这些部分将被发送到服务器,以指示请求或响应中所需的特定部分。
构建器参数
通过使用方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受一个参数,以下是一些关于这个参数的说明。
参数将被复制或克隆到构建器中,以确保它们与其原始的生命周期独立。
Cargo功能
utoipa
- 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema
。您必须导入并在#[openapi(schemas(...))]
中注册所需类型,否则生成的openapi
规范将是无效的。
许可证
appsactivity1库由Sebastian Thiel生成,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。
依赖关系
~12–23MB
~344K SLoC