29 个稳定版本 (4 个主要版本)
5.0.5+20240625 | 2024年6月27日 |
---|---|
5.0.4+20240226 | 2024年3月5日 |
5.0.3+20230123 | 2023年8月23日 |
5.0.2+20230123 | 2023年3月16日 |
1.0.2+20161118 | 2016年12月27日 |
#2445 in Web 编程
1,777 每月下载量
在 google-firebasedynamiclin… 中使用
190KB
2.5K SLoC
google-firebasedynamiclinks1
库允许访问 Google Firebase Dynamic Links 服务的所有功能。
本文档是从 Firebase Dynamic Links crate 版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 firebasedynamiclinks:v1 方案的精确修订。
有关 Firebase Dynamic Links v1 API 的其他信息,请参阅 官方文档站点。
特性
从中央 枢纽 轻松处理以下 资源 ...
其他活动包括 ...
本库的结构
API 结构如下主要项目
所有 结构 都带有适用的特性,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体地 ...
let r = hub.methods().install_attribution(...).doit().await
资源(resource)和活动(activity)调用创建了构建器。第二个调用处理Activities
,支持配置即将进行的操作的各种方法(此处未显示)。它设计成必须立即指定所有必需参数(即(...)
),而所有可选参数都可以根据需要构建。doit()
方法执行与服务器实际的通信,并返回相应的结果。
用法
设置你的项目
要使用此库,你将在你的Cargo.toml
文件中放入以下行
[dependencies]
google-firebasedynamiclinks1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_firebasedynamiclinks1 as firebasedynamiclinks1;
use firebasedynamiclinks1::api::GetIosPostInstallAttributionRequest;
use firebasedynamiclinks1::{Result, Error};
use std::default::Default;
use firebasedynamiclinks1::{FirebaseDynamicLinks, 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 = FirebaseDynamicLinks::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 = GetIosPostInstallAttributionRequest::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.methods().install_attribution(req)
.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")
。
支持上传的方法可以使用多达2种不同的协议进行:简单和可恢复。每个的特异性由定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
定制和回调
您可以通过向Method Builder提供代理来更改doit()
方法被调用的方式,然后在执行最终的doit()
调用之前。将调用相应的方法来提供进度信息,并确定系统是否在失败时应该重试。
默认实现了 代理特质,让您可以轻松自定义。
服务器请求中的可选部分
本库提供的所有结构都是为了通过 json 格式进行 编码 和 解码 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分被视为 部分,这些部分可以通过名称进行识别,并将发送到服务器以指示请求中设置的各部分或响应中所需的各部分。
构建器参数
通过使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对参数是正确的。
参数将始终被复制或克隆到构建器中,以使它们与其原始生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将是无效的。
许可证
firebasedynamiclinks1 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
~12–22MB
~345K SLoC