跳转至正文

权限 Capacitor 插件

使用同一个 PermissionName 枚举和规范化状态码,在 iOS、Android 和 Web 上检查并请求运行时权限

安装

bun add @capgo/capacitor-permissions bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-permissions
  • pnpm add @capgo/capacitor-permissions
  • yarn add @capgo/capacitor-permissions

指南

如何在 Capacitor 中使用 Permissions

使用 @capgo/capacitor-permissions

一个 TypeScript API,用统一的状态码在 iOS、Android 和 Web 上检查和请求运行时权限。

安装

bun add @capgo/capacitor-permissions
bunx cap sync

插件暴露的内容

  • check - 无需弹窗即可读取当前权限状态。
  • request - 向用户请求单一权限。
  • checkMultiple - 无需弹窗即可检查多项权限。
  • requestMultiple - 按顺序请求多个权限。
  • shouldShowRationale - 设置 Android 在再次请求前是否显示说明。
  • openSettings - 当访问被拦截时,跳转至应用或通知设置。
  • requestPreciseLocation - 在 iOS 上升级为精确位置,在 Android 上升级为精细位置。
  • getPluginVersion - 返回平台实现的版本标识。

用法示例

check 以及 request

import { Permissions } from '@capgo/capacitor-permissions';

export async function ensureCamera(): Promise<boolean> {
  const { status } = await Permissions.check({ permission: 'camera' });
  if (status === 'granted') return true;
  const { status: afterRequest } = await Permissions.request({ permission: 'camera' });
  return afterRequest === 'granted';
}

openSettings

import { Permissions } from '@capgo/capacitor-permissions';

document.getElementById('camera-settings')?.addEventListener('click', async () => {
  const { status } = await Permissions.check({ permission: 'camera' });
  if (status === 'blocked') {
    await Permissions.openSettings({ type: 'application' });
  }
});

完整参考

常见问题

Permissions 插件常见问题

如何在 Capacitor 应用中安装 Permissions 插件?

运行 "bun add @capgo/capacitor-permissions"(或 "npm install @capgo/capacitor-permissions"),然后运行 "bunx cap sync",让 iOS 和 Android 项目识别到原生 code。再在应用 code 中从 "@capgo/capacitor-permissions" 导入它。

@capgo/capacitor-permissions 支持 React、Vue 和 Angular 吗?

支持。Permissions 是一个 Capacitor 包,因此任何运行在 Capacitor 里的 Web 框架都能用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-permissions 支持哪个 Capacitor 版本?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-permissions 是免费开源的吗?

是的。code 的源码已在 GitHub 公开,地址是 https://github.com/Cap-go/capacitor-permissions/,该包可在 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以在不经过 App Store 审核的情况下,更新使用了 Permissions 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App Store 审核,即可快速发布权限变更

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo