18 个稳定版本 (4 个主要版本)
5.0.5+20240624 | 2024年6月27日 |
---|---|
5.0.4+20240304 | 2024年3月5日 |
5.0.3+20230123 | 2023年8月23日 |
5.0.2+20230123 | 2023年3月16日 |
1.0.8+20181011 | 2018年10月14日 |
2761 在 Web编程 中
1,126 每月下载量
用于 google-alertcenter1_beta1…
260KB
3.5K SLoC
google-alertcenter1_beta1
库允许访问 Google AlertCenter 服务(协议 v1beta1)的所有功能。
本文档是从 AlertCenter crate 版本 5.0.5+20240624 生成的,其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 alertcenter:v1beta1 模式的确切修订版。
关于 AlertCenter v1_beta1 API 的其他信息可以在 官方文档网站 上找到。
特性
轻松地从中央 中心 处理以下 资源...
其他活动包括 ...
本库的结构
API 结构如下主要项目
所有结构都标有适用的特征,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用活动
let r = hub.resource().activity(...).doit().await
或者具体...
let r = hub.alerts().feedback_create(...).doit().await
let r = hub.alerts().feedback_list(...).doit().await
let r = hub.alerts().batch_delete(...).doit().await
let r = hub.alerts().batch_undelete(...).doit().await
let r = hub.alerts().delete(...).doit().await
let r = hub.alerts().get(...).doit().await
let r = hub.alerts().get_metadata(...).doit().await
let r = hub.alerts().list(...).doit().await
let r = hub.alerts().undelete(...).doit().await
resource()
和activity(...)
调用创建构建器。第二个调用处理活动
,支持各种方法来配置即将进行的操作(此处未显示)。它被设计成所有必需的参数都必须立即指定(即(...)
),而所有可选的都可以按需构建。doit()
方法执行与服务器实际通信,并返回相应的结果。
使用方法
设置您的项目
要使用此库,您会将以下行放入您的Cargo.toml
文件中
[dependencies]
google-alertcenter1_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"
完整示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_alertcenter1_beta1 as alertcenter1_beta1;
use alertcenter1_beta1::{Result, Error};
use std::default::Default;
use alertcenter1_beta1::{AlertCenter, 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 = AlertCenter::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.alerts().list()
.page_token("et")
.page_size(-33)
.order_by("no")
.filter("ipsum")
.customer_id("voluptua.")
.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(...)
。
定制和回调
您可以通过向 方法构建器 提供一个 委托 来改变 doit()
方法的调用方式。在最终调用 doit()
之前。相应的函数将被调用来提供进度信息,以及确定系统是否在失败时应该重试。
委托特质 默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都是为了通过 json 进行 编码 和 解码 而设计的。可选部分用于表示部分请求和响应是有效的。大多数可选部分被认为是 部分,可以通过名称进行识别,这些部分将发送到服务器以指示请求的设置部分或响应中期望的部分。
构建器参数
通过使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法总是接受一个参数,以下陈述适用于该参数。
参数将始终被复制或克隆到构建器中,以使其与它们的原始生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上推导utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将无效。
许可证
alertcenter1_beta1 库是由 Sebastian Thiel 生成的,并置于 MIT 许可之下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~343K SLoC