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

google-androidenterprise1

一个与 Android Enterprise (协议 v1) 交互的完整库

47 个版本 (29 个稳定版)

5.0.5+20240625 2024 年 6 月 27 日
5.0.4+20240304 2024 年 3 月 5 日
5.0.3+20230123 2023 年 8 月 23 日
5.0.2+20230123 2023 年 3 月 16 日
0.1.2+20141112 2015 年 3 月 25 日

#229 in #web-api

Download history 4/week @ 2024-05-18 2/week @ 2024-05-25 4/week @ 2024-06-01 2/week @ 2024-06-08 1/week @ 2024-06-15 77/week @ 2024-06-22 20/week @ 2024-06-29 8/week @ 2024-07-06

2,794 每月下载量
用于 google-androidenterprise1…

MIT 许可证

1.5MB
15K SLoC

google-androidenterprise1 库允许访问 Google Android Enterprise 服务(v1)的所有功能。

本文档是从 Android Enterprise 库版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 androidenterprise:v1 架构的确切修订版。

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

功能

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

库的结构

API 被组织成以下主要项目

  • 中心
  • 资源
    • 你可以将其应用于活动的几种主要类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 从未直接用于活动
  • 活动
    • 应用于资源的操作

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

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

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

或者具体来说...

let r = hub.enterprises().acknowledge_notification_set(...).doit().await
let r = hub.enterprises().complete_signup(...).doit().await
let r = hub.enterprises().create_enrollment_token(...).doit().await
let r = hub.enterprises().create_web_token(...).doit().await
let r = hub.enterprises().enroll(...).doit().await
let r = hub.enterprises().generate_signup_url(...).doit().await
let r = hub.enterprises().get(...).doit().await
let r = hub.enterprises().get_service_account(...).doit().await
let r = hub.enterprises().get_store_layout(...).doit().await
let r = hub.enterprises().list(...).doit().await
let r = hub.enterprises().pull_notification_set(...).doit().await
let r = hub.enterprises().send_test_push_notification(...).doit().await
let r = hub.enterprises().set_account(...).doit().await
let r = hub.enterprises().set_store_layout(...).doit().await
let r = hub.enterprises().unenroll(...).doit().await

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

用法

设置你的项目

要使用此库,你需要在你的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_androidenterprise1 as androidenterprise1;
use androidenterprise1::{Result, Error};
use std::default::Default;
use androidenterprise1::{AndroidEnterprise, 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 = AndroidEnterprise::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.enterprises().complete_signup()
             .enterprise_token("et")
             .completion_token("magna")
             .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() 方式,在执行最终的 doit() 调用之前。相应的函数将被调用以提供进度信息,并确定系统在失败时是否应该重试。

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

服务器请求的可选部分

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

构建器参数

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

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

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

Cargo 特性

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

许可协议

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

依赖关系

~12–23MB
~346K SLoC