8 个版本 (稳定版)

5.0.5+20240625 2024年6月27日
5.0.4+20240304 2024年3月5日
5.0.3+20230124 2023年8月24日
5.0.2+20230124 2023年3月17日
3.0.0+20220305 2022年3月8日

#2664 in 网页编程


用于 google-mybusinessnotifica…

MIT 许可证

115KB
1.5K SLoC

google-mybusinessnotifications1 库允许访问 Google My Business 通知设置服务(协议 v1)的所有功能。

本文档是根据 My Business 通知设置 crate 版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 mybusinessnotifications:v1 架构的确切修订版本。

有关 My Business 通知设置 v1 API 的其他所有信息,请参阅 官方文档网站

特性

从中心 枢纽 简单易用地处理以下 资源...

库结构

API 结构如下主要项目

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

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

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

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

或具体地说...

let r = hub.accounts().get_notification_setting(...).doit().await
let r = hub.accounts().update_notification_setting(...).doit().await

资源(resource)和活动(activity)的调用创建了构建器。第二个调用处理Activities,支持配置即将进行的操作的各种方法(此处未展示)。它被设计成所有必需的参数必须立即指定(即(...)),而所有可选参数可以按需构建。

使用方法

设置你的项目

要使用此库,请将以下行放入你的Cargo.toml文件中

[dependencies]
google-mybusinessnotifications1 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_mybusinessnotifications1 as mybusinessnotifications1;
use mybusinessnotifications1::api::NotificationSetting;
use mybusinessnotifications1::{Result, Error};
use std::default::Default;
use mybusinessnotifications1::{MyBusinessNotificationSettings, 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 = MyBusinessNotificationSettings::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), 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 = NotificationSetting::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.accounts().update_notification_setting(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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枚举,或者作为可能的中途结果传递给Hub DelegateAuthenticator Delegate

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

上传和下载

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

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器,您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下语句是真实的。

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

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

Cargo特性

  • utoipa - 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema。您必须在#[openapi(schemas(...))]中导入并注册所需类型,否则生成的openapi规范将无效。

许可证

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

依赖关系

~12–23MB
~343K SLoC