@ belonenet/ 电容- pass- to- wallet( 电容)
要添加的电容插件 .pkpass 转到苹果钱包的文件.
概览
添加数 .pkpass 使用 Capacitor app 的 Apple 钱包文件 base64 内容或本地 file URI。 。 。 .
addToWallet一次通行证addMultipleToWallet多次通行证passExists检查是否在钱包里有通行证
快开始
bun add @belongnet/capacitor-pass-to-wallet
bunx cap sync
基本用途
关于分步骤的教程,参见 添加苹果钱包口 财务报告和审定财务报表 创建苹果钱包通道。 。 。 .
从基数64添加通行证
import { CapacitorPassToWallet } from '@belongnet/capacitor-pass-to-wallet';
await CapacitorPassToWallet.addToWallet({
base64: passBase64,
});
添加本地文件的通行证
import { Filesystem, Directory } from '@capacitor/filesystem';
import { CapacitorPassToWallet } from '@belongnet/capacitor-pass-to-wallet';
const { uri } = await Filesystem.getUri({
directory: Directory.Cache,
path: 'passes/example.pkpass',
});
await CapacitorPassToWallet.addToWallet({
filePath: uri,
});
添加多张通行证
// base64 mode
await CapacitorPassToWallet.addMultipleToWallet({
base64: [base64Pass1, base64Pass2],
});
// file mode
await CapacitorPassToWallet.addMultipleToWallet({
filePaths: [uri1, uri2],
});
检查是否已经存在过关
const result = await CapacitorPassToWallet.passExists({
filePath: uri,
});
console.log(result.passExists);
[注] iOS已实施。 该寄存器中的Android执行目前是一个占位符.
兼容性
| 电容版本 | 插件版本 |
|---|---|
| 7.x 电话 | 软件包(v7) |
| 8.x 电话 | 8.x 电话 |
要求(8级)
@capacitor/core>=8.0.0- iOS 部署目标 :
15.0+ - 机器人
minSdkVersion数字 :24+ - Android 构造默认在此插件中 :
compileSdkVersion 36, (中文(简体) ),targetSdkVersion 36,爪哇语21
参考资料
- atroo/capor-pass-to-wallet(电容器) —— 7. Capacitor 7.x分叉 (中文(简体) )
@atroo/capacitor-pass-to-wallet) (中文(简体) ). - NitnelavAH/电容器接地 ——原插件(Capacitor 4–7).
API 密码
addToWallet(...)addMultipleToWallet(...)passExists(...)_experimental_passExistsById(...)_experimental_canAddPasses()_experimental_openPassInWallet(...)_experimental_removePass(...)_experimental_listPasses()- 接口
添加到钱包(...)
addToWallet(options: AddToWalletOptions) => Promise<AddToWalletResult>
打开 Apple 钱包单张 .pkpass。 。 。 .
| 参数 | 类型 |
|---|---|
options | AddToWalletOptions |
回返情况: Promise<AddToWalletResult>
添加多功能切换(...)
addMultipleToWallet(options: AddMultipleToWalletOptions) => Promise<AddToWalletResult>
打开多个苹果钱包工作表 .pkpass 文档.
| 参数 | 类型 |
|---|---|
options | AddMultipleToWalletOptions |
回返情况: Promise<AddToWalletResult>
传出(...)
passExists(options: AddToWalletOptions) => Promise<PassExistsResult>
检查 Apple 钱包中是否已经存在过关 .
| 参数 | 类型 |
|---|---|
options | AddToWalletOptions |
回返情况: Promise<PassExistsResult>
实验 passExistsById (.)
_experimental_passExistsById(options: PassIdentifierOptions) => Promise<PassExistsResult>
检查是否通过标识符和可选序列号存在.
| 参数 | 类型 |
|---|---|
options | PassIdentifierOptions |
回返情况: Promise<PassExistsResult>
实验性( C)
_experimental_canAddPasses() => Promise<CanAddPassesResult>
返回设备是否可以添加通行证 .
回返情况: Promise<CanAddPassesResult>
实验 openPassInWallet (.)
_experimental_openPassInWallet(options: PassIdentifierOptions) => Promise<OpenPassInWalletResult>
以标识符打开 Apple 钱包中已有的通道 .
| 参数 | 类型 |
|---|---|
options | PassIdentifierOptions |
回返情况: Promise<OpenPassInWalletResult>
实验 removePass (.)
_experimental_removePass(options: PassIdentifierOptions) => Promise<RemovePassResult>
通过标识符从 Apple 钱包中删除已有的密码.
| 参数 | 类型 |
|---|---|
options | PassIdentifierOptions |
回返情况: Promise<RemovePassResult>
实验 listPasses ()
_experimental_listPasses() => Promise<ListPassesResult>
列表钱包通过可见的应用程序 .
回返情况: Promise<ListPassesResult>
接口
添加到文件夹中
| Prop | 类型 | 说明 |
|---|---|---|
value | string | 行动状态。 回返 "added" 当传出时. |
添加到窗口选项
| Prop | 类型 | 说明 |
|---|---|---|
base64 | string | 基础64编码 .pkpass 文件内容。 何时可选 filePath 提供. |
filePath | string | 本地文件路径/ URI 到 a .pkpass 文件(例如来自 Filesystem.getUri) (中文(简体) ). 何时可选 base64 提供. |
添加多选项
| Prop | 类型 | 说明 |
|---|---|---|
base64 | string[] | 基准64编码列表 .pkpass 文件内容。 何时可选 filePaths 提供. |
filePaths | string[] | 本地文件路径列表/ URIs to .pkpass 文档。 何时可选 base64 提供. |
传出器
| Prop | 类型 | 说明 |
|---|---|---|
passExists | boolean | true 如果通行证已经用苹果钱包提供. |
密码识别选项
| Prop | 类型 | 说明 |
|---|---|---|
passTypeIdentifier | string | 钱包通过类型标识符(例如) pass.com.example.membership) (中文(简体) ). |
serialNumber | string | 可选的序列号以瞄准特定的通过实例. |
CanAddPasses 结果
| Prop | 类型 | 说明 |
|---|---|---|
canAddPasses | boolean | true 当设备可以显示加到wallet流时. |
OpenPass InWallet 最终结果
| Prop | 类型 | 说明 |
|---|---|---|
opened | boolean | true 当找到匹配的密码并开始打开操作时. |
删除 Pass 保留
| Prop | 类型 | 说明 |
|---|---|---|
removed | boolean | true 当匹配的通行证从钱包中移除时. |
ListPasses 结果
| Prop | 类型 | 说明 |
|---|---|---|
passes | WalletPassSummary[] | 钱包库中目前可见的通行证 . |
钱包列表
| Prop | 类型 | 说明 |
|---|---|---|
passTypeIdentifier | string | 钱包通过类型标识符(例如) pass.com.example.membership) (中文(简体) ). |
serialNumber | string | 传出序列号. |
organizationName | string | 可用时通过的有效载荷的组织名称. |
许可证 : 麻省理工学院