@ohos.abilityAccessCtrl (程序访问控制管理)(系统接口)

程序访问控制提供程序的权限管理能力，包括鉴权、授权和取消授权等。

说明：

• 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.abilityAccessCtrl (程序访问控制管理)。

导入模块

import { abilityAccessCtrl } from '@kit.AbilityKit';

AtManager

管理访问控制模块的实例。

grantUserGrantedPermission

grantUserGrantedPermission(tokenID: number, permissionName: Permissions, permissionFlags: number): Promise<void>

授予应用user_grant权限。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GRANT_SENSITIVE_PERMISSIONS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let tokenID: number = 0; // 系统应用可以通过bundleManager.getApplicationInfo获取,普通应用可以通过bundleManager.getBundleInfoForSelf获取
let permissionFlags: number = 1;
atManager.grantUserGrantedPermission(tokenID, 'ohos.permission.READ_AUDIO', permissionFlags).then(() => {
  console.log('grantUserGrantedPermission success');
}).catch((err: BusinessError) => {
  console.error(`grantUserGrantedPermission fail, err->${JSON.stringify(err)}`);
});

grantUserGrantedPermission

grantUserGrantedPermission(tokenID: number, permissionName: Permissions, permissionFlags: number, callback: AsyncCallback<void>): void

授予应用user_grant权限。使用callback异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GRANT_SENSITIVE_PERMISSIONS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let tokenID: number = 0; // 系统应用可以通过bundleManager.getApplicationInfo获取,普通应用可以通过bundleManager.getBundleInfoForSelf获取
let permissionFlags: number = 1;
atManager.grantUserGrantedPermission(tokenID, 'ohos.permission.READ_AUDIO', permissionFlags, (err: BusinessError, data: void) => {
  if (err) {
    console.error(`grantUserGrantedPermission fail, err->${JSON.stringify(err)}`);
  } else {
    console.log('grantUserGrantedPermission success');
  }
});

revokeUserGrantedPermission

revokeUserGrantedPermission(tokenID: number, permissionName: Permissions, permissionFlags: number): Promise<void>

撤销应用user_grant权限。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.REVOKE_SENSITIVE_PERMISSIONS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let tokenID: number = 0; // 系统应用可以通过bundleManager.getApplicationInfo获取,普通应用可以通过bundleManager.getBundleInfoForSelf获取
let permissionFlags: number = 1;
atManager.revokeUserGrantedPermission(tokenID, 'ohos.permission.READ_AUDIO', permissionFlags).then(() => {
  console.log('revokeUserGrantedPermission success');
}).catch((err: BusinessError) => {
  console.error(`revokeUserGrantedPermission fail, err->${JSON.stringify(err)}`);
});

revokeUserGrantedPermission

revokeUserGrantedPermission(tokenID: number, permissionName: Permissions, permissionFlags: number, callback: AsyncCallback<void>): void

撤销应用user_grant权限。使用callback异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.REVOKE_SENSITIVE_PERMISSIONS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let tokenID: number = 0; // 系统应用可以通过bundleManager.getApplicationInfo获取,普通应用可以通过bundleManager.getBundleInfoForSelf获取
let permissionFlags: number = 1;
atManager.revokeUserGrantedPermission(tokenID, 'ohos.permission.READ_AUDIO', permissionFlags, (err: BusinessError, data: void) => {
  if (err) {
    console.error(`revokeUserGrantedPermission fail, err->${JSON.stringify(err)}`);
  } else {
    console.log('revokeUserGrantedPermission success');
  }
});

getPermissionFlags

getPermissionFlags(tokenID: number, permissionName: Permissions): Promise<number>

获取指定应用的指定权限的flag。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_SENSITIVE_PERMISSIONS or ohos.permission.GRANT_SENSITIVE_PERMISSIONS or ohos.permission.REVOKE_SENSITIVE_PERMISSIONS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let tokenID: number = 0; // 系统应用可以通过bundleManager.getApplicationInfo获取,普通应用可以通过bundleManager.getBundleInfoForSelf获取
atManager.getPermissionFlags(tokenID, 'ohos.permission.GRANT_SENSITIVE_PERMISSIONS').then((data: number) => {
  console.log(`getPermissionFlags success, data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`getPermissionFlags fail, err->${JSON.stringify(err)}`);
});

setPermissionRequestToggleStatus¹²⁺

setPermissionRequestToggleStatus(permissionName: Permissions, status: PermissionRequestToggleStatus): Promise<void>

设置当前用户指定权限的弹窗开关状态。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.DISABLE_PERMISSION_DIALOG。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl, Permissions } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager = abilityAccessCtrl.createAtManager();
let permission: Permissions = 'ohos.permission.CAMERA';

atManager.setPermissionRequestToggleStatus(permission, abilityAccessCtrl.PermissionRequestToggleStatus.CLOSED).then((err) => {
  console.info('toggle_status: Set closed successful');
}).catch((err: BusinessError) => {
  console.error(`toggle_status: Code is ${err.code}, message is ${err.message}`);
});

getPermissionRequestToggleStatus¹²⁺

getPermissionRequestToggleStatus(permissionName: Permissions): Promise<PermissionRequestToggleStatus>

获取当前用户指定权限的弹窗开关状态。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_SENSITIVE_PERMISSIONS。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl, Permissions } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager = abilityAccessCtrl.createAtManager();
let permission: Permissions = 'ohos.permission.CAMERA';

atManager.getPermissionRequestToggleStatus(permission).then((res) => {
  if (res == abilityAccessCtrl.PermissionRequestToggleStatus.CLOSED) {
    console.info('toggle_status: The toggle status is close');
  } else {
    console.info('toggle_status: The toggle status is open');
  }
}).catch((err: BusinessError) => {
console.error(`toggle_status: Code is ${err.code}, message is ${err.message}`);
});

getVersion⁹⁺

getVersion(): Promise<number>

获取当前权限管理的数据版本。使用Promise异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Security.AccessToken

返回值：

示例：

import { abilityAccessCtrl } from '@kit.AbilityKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let promise = atManager.getVersion();
promise.then((data: number) => {
    console.log(`promise: data->${JSON.stringify(data)}`);
});

getPermissionsStatus¹²⁺

getPermissionsStatus(tokenID: number, permissionList: Array<Permissions>): Promise<Array<PermissionStatus>>

获取指定应用权限状态列表。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_SENSITIVE_PERMISSIONS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let tokenID: number = 0; // 系统应用可以通过bundleManager.getApplicationInfo获取,普通应用可以通过bundleManager.getBundleInfoForSelf获取
atManager.getPermissionsStatus(tokenID, ['ohos.permission.CAMERA']).then((data: Array<abilityAccessCtrl.PermissionStatus>) => {
  console.log(`getPermissionsStatus success, data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`getPermissionsStatus fail, err->${JSON.stringify(err)}`);
});

on⁹⁺

on(type: ‘permissionStateChange’, tokenIDList: Array<number>, permissionList: Array<Permissions>, callback: Callback<PermissionStateChangeInfo>): void

订阅指定tokenId列表与权限列表的权限状态变更事件。

允许指定tokenId列表与权限列表订阅多个callback。

不允许存在交集的tokenId列表与权限列表订阅相同callback。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_SENSITIVE_PERMISSIONS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl, Permissions, bundleManager } from '@kit.AbilityKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let appInfo: bundleManager.ApplicationInfo = bundleManager.getApplicationInfoSync('com.example.myapplication', 0, 100);
let tokenIDList: Array<number> = [appInfo.accessTokenId];
let permissionList: Array<Permissions> = ['ohos.permission.DISTRIBUTED_DATASYNC'];
try {
    atManager.on('permissionStateChange', tokenIDList, permissionList, (data: abilityAccessCtrl.PermissionStateChangeInfo) => {
        console.debug('receive permission state change, data:' + JSON.stringify(data));
    });
} catch(err) {
    console.error(`catch err->${JSON.stringify(err)}`);
}

off⁹⁺

off(type: ‘permissionStateChange’, tokenIDList: Array<number>, permissionList: Array<Permissions>, callback?: Callback<PermissionStateChangeInfo>): void

取消订阅指定tokenId列表与权限列表的权限状态变更事件，使用callback回调异步返回结果。

取消订阅不传callback时，批量删除tokenIDList和permissionList下面的所有callback。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_SENSITIVE_PERMISSIONS，仅系统应用可用。

系统能力： SystemCapability.Security.AccessToken

参数：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl, Permissions, bundleManager } from '@kit.AbilityKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let appInfo: bundleManager.ApplicationInfo = bundleManager.getApplicationInfoSync('com.example.myapplication', 0, 100);
let tokenIDList: Array<number> = [appInfo.accessTokenId];
let permissionList: Array<Permissions> = ['ohos.permission.DISTRIBUTED_DATASYNC'];
try {
    atManager.off('permissionStateChange', tokenIDList, permissionList);
} catch(err) {
    console.error(`catch err->${JSON.stringify(err)}`);
}

requestPermissionOnApplicationSetting¹⁸⁺

requestPermissionOnApplicationSetting(tokenID: number): Promise<void>

拉起应用权限设置页面。使用Promise异步回调。

系统接口： 此接口为系统接口。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.Security.AccessToken

参数：

返回值：

错误码：

以下错误码的详细介绍请参见访问控制错误码。

示例：

import { abilityAccessCtrl } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let tokenID: number = 0; // 系统应用可以通过bundleManager.getApplicationInfo获取
atManager.requestPermissionOnApplicationSetting(tokenID).then(() => {
  console.log('requestPermissionOnApplicationSetting success');
}).catch((err: BusinessError) => {
  console.error(`requestPermissionOnApplicationSetting fail, err->${JSON.stringify(err)}`);
});

PermissionRequestToggleStatus¹²⁺

表示指定权限对应的弹窗开关状态的枚举。

系统能力： SystemCapability.Security.AccessToken

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Ability Kit（程序框架服务）

harmony 鸿蒙AbilityBase

harmony 鸿蒙AbilityBase_Element

harmony 鸿蒙AbilityRuntime

harmony 鸿蒙bundle

harmony 鸿蒙OH_NativeBundle_ApplicationInfo

harmony 鸿蒙OH_NativeBundle_ElementName

harmony 鸿蒙ability_base_common.h

harmony 鸿蒙ability_runtime_common.h

harmony 鸿蒙application_context.h