- 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
- 本模块接口仅可在Stage模型下使用。
权限请求结果对象,在调用requestPermissionsFromUser申请权限时返回此对象表明此次权限申请的结果。
import { PermissionRequestResult } from '@kit.AbilityKit'; 系统能力: 以下各项对应的系统能力均为SystemCapability.Security.AccessToken
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| permissions | Array<string> | 否 | 否 | 本次待申请的权限数组。 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
| authResults | Array<number> | 否 | 否 | 每个请求权限对应的授权结果。 - -1:未授权。从API version 12开始,可结合dialogShownResults进一步判断原因:若dialogShownResults为true,表示用户在本次申请中明确拒绝;若为false,表示当前状态无需再弹窗,通常需要用户前往系统设置修改。 - 0:已授权,应用可以继续访问与该权限关联的受保护资源。 - 2:请求无效,通常表示权限未声明、权限名非法,或未满足该权限的特殊申请条件。开发者应检查权限名、module.json中的权限声明以及对应权限的申请条件。 元服务API: 从API version 11开始,该接口支持在元服务中使用。 |
| dialogShownResults12+ | Array<boolean> | 否 | 是 | 表示每个权限在本次申请过程中是否真正展示过授权弹窗。 - true:系统已展示授权弹窗。 - false:系统未展示弹窗,通常是因为权限当前状态、权限类型或系统策略不允许继续走弹窗授权链路。 当authResults为-1时,结合本字段可进一步区分“本次被用户拒绝”与“当前已不再弹窗”。未返回该字段时,表示本次结果不包含授权弹窗展示状态。 元服务API: 从API version 12开始,该接口支持在元服务中使用。 |
| errorReasons18+ | Array<number> | 否 | 是 | 每个权限申请对应的原因码。主要用于解释授权失败、请求无效或无法展示弹窗的具体原因。未返回该字段时,表示本次结果不包含原因码。 - 0:本次申请合法。 - 1:权限名非法,请检查权限名格式和取值。 - 2:权限未声明,请在module.json中声明该权限。 - 3:不满足对应权限的申请条件,例如部分位置权限需要满足额外前提。当前仅位置权限涉及,包括ohos.permission.LOCATION与ohos.permission.APPROXIMATELY_LOCATION。 - 4:用户未同意隐私声明,请引导用户同意隐私声明后再申请权限。 - 5:该权限不支持通过权限弹窗进行申请,可能是申请方式受限或被系统策略管控。请改用该权限支持的授权方式。 - 6:该权限为manual_settings类型,只能通过设置页授权。从API version 21开始支持该原因码。 - 12:服务异常,请稍后重试。 元服务API: 从API version 18开始,该接口支持在元服务中使用。 |
PermissionRequestResult是权限申请的结果对象。开发者需先创建atManager实例,再调用requestPermissionsFromUser方法申请权限,该方法返回PermissionRequestResult对象,开发者可通过该对象的属性判断权限申请结果。权限申请整体流程及atManager的详细说明请参见@ohos.abilityAccessCtrl (程序访问控制管理)。
示例:
示例中context的获取方式请参见获取UIAbility的上下文信息。
import { abilityAccessCtrl, Context, common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 创建权限管理器实例
let atManager = abilityAccessCtrl.createAtManager();
try {
// 请在组件内获取context
let context: Context = this.getUIContext().getHostContext() as common.UIAbilityContext;
// 申请相机权限
atManager.requestPermissionsFromUser(context, ["ohos.permission.CAMERA"]).then((data) => {
// 打印权限申请结果
console.info("data permissions:" + data.permissions);
console.info("data authResults:" + data.authResults);
console.info("data dialogShownResults:" + data.dialogShownResults);
// errorReasons从API version 18开始支持
if (data.errorReasons) {
console.info("data errorReasons:" + data.errorReasons);
}
}).catch((err: BusinessError) => {
console.error(`code: ${err.code}, message: ${err.message}`);
});
} catch (err) {
let error = err as BusinessError;
console.error(`catch errcode: ${error.code}, message: ${error.message}`);
} 合作咨询
我们的专家服务团队将竭诚为您提供专业的合作咨询服务
解决方案
精准高效的一站式服务支持,助力开发者商业成功