未验证 提交 37a82c3e 编写于 作者: O openharmony_ci 提交者: Gitee

!10656 【程序访问控制】API参考内容优化

Merge pull request !10656 from chennian/master
......@@ -40,7 +40,7 @@ var AtManager = abilityAccessCtrl.createAtManager();
checkAccessToken(tokenID: number, permissionName: string): Promise<GrantStatus>
校验应用是否授予权限,使用Promise方式异步返回结果
校验应用是否授予权限。使用Promise异步回调
**系统能力:** SystemCapability.Security.AccessToken
......@@ -57,10 +57,17 @@ checkAccessToken(tokenID: number, permissionName: string): Promise<GrantStatu
| :------------ | :---------------------------------- |
| Promise<GrantStatus> | Promise对象。返回授权状态结果。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
**示例:**
```js
import privacyManager from '@ohos.abilityAccessCtrl';
import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let AtManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
......@@ -96,6 +103,13 @@ verifyAccessTokenSync(tokenID: number, permissionName: string): GrantStatus
| :------------ | :---------------------------------- |
| [GrantStatus](#grantstatus) | 枚举实例,返回授权状态。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
**示例:**
```js
......@@ -109,11 +123,11 @@ console.log(`data->${JSON.stringify(data)}`);
grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number): Promise<void>
授予应用user grant权限,使用Promise方式异步返回结果
授予应用user grant权限。使用Promise异步回调
此接口为系统接口。
**系统接口:** 此接口为系统接口。
**需要权限:** ohos.permission.GRANT_SENSITIVE_PERMISSIONS
**需要权限:** ohos.permission.GRANT_SENSITIVE_PERMISSIONS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -131,10 +145,20 @@ grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFl
| :------------ | :---------------------------------- |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100006 | The specified application does not support the permissions granted or ungranted as specified. |
**示例:**
```js
import privacyManager from '@ohos.abilityAccessCtrl';
import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let AtManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
......@@ -154,11 +178,11 @@ try {
grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number, callback: AsyncCallback<void>): void
授予应用user grant权限,使用callback回调异步返回结果
授予应用user grant权限。使用callback异步回调
此接口为系统接口。
**系统接口:** 此接口为系统接口。
**需要权限:** ohos.permission.GRANT_SENSITIVE_PERMISSIONS
**需要权限:** ohos.permission.GRANT_SENSITIVE_PERMISSIONS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -169,12 +193,22 @@ grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFl
| tokenID | number | 是 | 目标应用的身份标识。可通过应用的[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)获得 |
| permissionName | string | 是 | 被授予的权限名称。 |
| permissionFlag | number | 是 | 授权选项,1表示下次仍需弹窗,2表示允许、禁止后不再提醒,3表示系统授权不允许更改。 |
| callback | AsyncCallback<void> | 是 | 检查授予应用user grant权限的操作结果同步的回调。 |
| callback | AsyncCallback<void> | 是 | 授予应用user grant权限。当授予权限成功时,err为undefine;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100006 | The specified application does not support the permissions granted or ungranted as specified. |
**示例:**
```js
import privacyManager from '@ohos.abilityAccessCtrl';
import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
var AtManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
......@@ -196,11 +230,11 @@ try {
revokeUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number): Promise<void>
撤销应用user grant权限,使用Promise方式异步返回结果
撤销应用user grant权限。使用Promise异步回调
此接口为系统接口。
**系统接口:** 此接口为系统接口。
**需要权限:** ohos.permission.REVOKE_SENSITIVE_PERMISSIONS
**需要权限:** ohos.permission.REVOKE_SENSITIVE_PERMISSIONS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -218,10 +252,20 @@ revokeUserGrantedPermission(tokenID: number, permissionName: string, permissionF
| :------------ | :---------------------------------- |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100006 | The specified application does not support the permissions granted or ungranted as specified. |
**示例:**
```js
import privacyManager from '@ohos.abilityAccessCtrl';
import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let AtManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
......@@ -241,11 +285,11 @@ try {
revokeUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number, callback: AsyncCallback<void>): void
撤销应用user grant权限,使用callback回调异步返回结果
撤销应用user grant权限。使用callback异步回调
此接口为系统接口。
**系统接口:** 此接口为系统接口。
**需要权限:** ohos.permission.REVOKE_SENSITIVE_PERMISSIONS
**需要权限:** ohos.permission.REVOKE_SENSITIVE_PERMISSIONS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -256,12 +300,22 @@ revokeUserGrantedPermission(tokenID: number, permissionName: string, permissionF
| tokenID | number | 是 | 目标应用的身份标识。可通过应用的[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)获得 |
| permissionName | string | 是 | 被撤销的权限名称。 |
| permissionFlag | number | 是 | 授权选项,1表示下次仍需弹窗,2表示允许、禁止后不再提醒,3表示系统授权不允许更改。 |
| callback | AsyncCallback<void> | 是 | 检查撤销应用user grant权限的操作结果同步的回调。 |
| callback | AsyncCallback<void> | 是 | 撤销应用user grant权限。当撤销权限成功时,err为undefine;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100006 | The specified application does not support the permissions granted or ungranted as specified. |
**示例:**
```js
import privacyManager from '@ohos.abilityAccessCtrl';
import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
var AtManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
......@@ -283,11 +337,11 @@ try {
getPermissionFlags(tokenID: number, permissionName: string): Promise<number>
获取指定应用的指定权限的flag,使用Promise方式异步返回结果
获取指定应用的指定权限的flag。使用Promise异步回调
此接口为系统接口。
**系统接口:** 此接口为系统接口。
**需要权限:** ohos.permission.GET_SENSITIVE_PERMISSIONS or ohos.permission.GRANT_SENSITIVE_PERMISSIONS or ohos.permission.REVOKE_SENSITIVE_PERMISSIONS
**需要权限:** ohos.permission.GET_SENSITIVE_PERMISSIONS or ohos.permission.GRANT_SENSITIVE_PERMISSIONS or ohos.permission.REVOKE_SENSITIVE_PERMISSIONS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -304,10 +358,20 @@ getPermissionFlags(tokenID: number, permissionName: string): Promise<number&g
| :------------ | :---------------------------------- |
| Promise<number> | Promise对象。返回查询结果。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100006 | The specified application does not support the permissions granted or ungranted as specified. |
**示例:**
```js
import privacyManager from '@ohos.abilityAccessCtrl';
import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let AtManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
......@@ -327,9 +391,9 @@ try {
getVersion(): Promise<number>
获取当前权限管理的数据版本,使用Promise方式异步返回结果
获取当前权限管理的数据版本。使用Promise异步回调
此接口为系统接口。
**系统接口:** 此接口为系统接口。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -353,11 +417,11 @@ promise.then(data => {
on(type: 'permissionStateChange', tokenIDList: Array<number>, permissionNameList: Array<string>, callback: Callback<PermissionStateChangeInfo>): void;
订阅指定tokenId列表与权限列表的权限状态变更事件,使用callback回调异步返回结果
订阅指定tokenId列表与权限列表的权限状态变更事件。
此接口为系统接口。
**系统接口:** 此接口为系统接口。
**需要权限:** ohos.permission.GET_SENSITIVE_PERMISSIONS
**需要权限:** ohos.permission.GET_SENSITIVE_PERMISSIONS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -370,6 +434,15 @@ on(type: 'permissionStateChange', tokenIDList: Array<number>, permissionNa
| permissionNameList | Array<string> | 否 | 订阅的权限名列表,为空时表示订阅所有的权限状态变化。 |
| callback | Callback<[PermissionStateChangeInfo](#permissionstatechangeinfo9)> | 是 | 订阅指定tokenId与指定权限名状态变更事件的回调。|
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100004 | The listener interface is not used together. |
| 12100005 | The number of listeners exceeds the limit. |
**示例:**
```js
......@@ -393,9 +466,9 @@ off(type: 'permissionStateChange', tokenIDList: Array<number>, permissionN
取消订阅指定tokenId列表与权限列表的权限状态变更事件,使用callback回调异步返回结果。
此接口为系统接口。
**系统接口:** 此接口为系统接口。
**需要权限:** ohos.permission.GET_SENSITIVE_PERMISSIONS
**需要权限:** ohos.permission.GET_SENSITIVE_PERMISSIONS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -408,6 +481,14 @@ off(type: 'permissionStateChange', tokenIDList: Array<number>, permissionN
| permissionNameList | Array<string> | 否 | 订阅的权限名列表,为空时表示订阅所有的权限状态变化,必须与on的输入一致。 |
| callback | Callback<[PermissionStateChangeInfo](#permissionstatechangeinfo9)> | 否 | 取消订阅指定tokenId与指定权限名状态变更事件的回调。|
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100004 | The listener interface is not used together. |
**示例:**
```js
......@@ -427,7 +508,7 @@ try {
verifyAccessToken(tokenID: number, permissionName: string): Promise<GrantStatus>
校验应用是否授予权限,使用Promise方式异步返回结果
校验应用是否授予权限。使用Promise异步回调
> **说明:** 从API version 9开始不再维护,建议使用[checkAccessToken](#checkaccesstoken9)替代。
......@@ -437,7 +518,7 @@ verifyAccessToken(tokenID: number, permissionName: string): Promise<GrantStat
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ------------------------------------------ |
| tokenID | number | 是 | 要校验的目标应用的身份标识。可通过应用的[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)获得 |
| tokenID | number | 是 | 要校验的目标应用的身份标识。可通过应用的[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)获得 |
| permissionName | string | 是 | 需要校验的权限名称。 |
**返回值:**
......@@ -449,7 +530,7 @@ verifyAccessToken(tokenID: number, permissionName: string): Promise<GrantStat
**示例:**
```js
import privacyManager from '@ohos.abilityAccessCtrl';
import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
var AtManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // 可以通过getApplicationInfo获取accessTokenId
......@@ -489,7 +570,7 @@ promise.then(data => {
**系统接口:** 此接口为系统接口。
**系统能力:** SystemCapability.Security.AccessToken
**系统能力:** SystemCapability.Security.AccessToken
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | ------------------------- | ---- | ---- | ------------------ |
......
# 隐私管理
模块主要提供权限使用记录等隐私管理接口。
模块主要提供权限使用记录等隐私管理接口。
> **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口为系统接口,三方应用不支持调用
> 本模块接口为系统接口。
## 导入模块
......@@ -39,6 +39,15 @@ addPermissionUsedRecord(tokenID: number, permissionName: string, successCount: n
| :------------ | :---------------------------------- |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
**示例:**
```js
......@@ -75,7 +84,16 @@ addPermissionUsedRecord(tokenID: number, permissionName: string, successCount: n
| permissionName | string | 是 | 应用权限名称。 |
| successCount | number | 是 | 访问成功的次数。 |
| failCount | number | 是 | 访问失败的次数。 |
| callback | AsyncCallback<void> | 是 | 回调函数。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当添加使用记录成功时,err为undefine;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
**示例:**
......@@ -100,7 +118,7 @@ try {
getPermissionUsedRecords(request: PermissionUsedRequest): Promise<PermissionUsedResponse>
获取历史权限使用记录。
获取历史权限使用记录。使用Promise异步回调。
**需要权限:** ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。
......@@ -116,7 +134,16 @@ getPermissionUsedRecords(request: PermissionUsedRequest): Promise<PermissionU
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise<[PermissionUsedResponse](#permissionusedresponse)> | Promise对象。返回权限使用记录。|
| Promise<[PermissionUsedResponse](#permissionusedresponse)> | Promise对象。返回查询的权限使用记录。|
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
**示例:**
......@@ -148,7 +175,7 @@ try {
getPermissionUsedRecords(request: PermissionUsedRequest, callback: AsyncCallback&lt;PermissionUsedResponse&gt;): void
获取历史权限使用记录。
获取历史权限使用记录。使用callback异步回调。
**需要权限:** ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。
......@@ -159,7 +186,16 @@ getPermissionUsedRecords(request: PermissionUsedRequest, callback: AsyncCallback
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ------------------------------------------ |
| request | [PermissionUsedRequest](#permissionusedrequest) | 是 | 查询权限使用记录的请求。 |
| callback | AsyncCallback<[PermissionUsedResponse](#permissionusedresponse)> | 是 | 回调函数。返回权限使用记录。 |
| callback | AsyncCallback<[PermissionUsedResponse](#permissionusedresponse)> | 是 | 回调函数。当查询记录成功时,err为undefine,data为查询到的权限使用记录;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
**示例:**
......@@ -193,7 +229,7 @@ try {
startUsingPermission(tokenID: number, permissionName: string): Promise&lt;void&gt;
应用开始使用某项权限,可监听应用在前后台使用权限,并将使用权限的记录落盘,由系统服务调用。
应用开始使用某项权限,可监听应用在前后台使用权限,并将使用权限的记录落盘,由系统服务调用。使用Promise异步回调。
**需要权限:** ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。
......@@ -212,6 +248,16 @@ startUsingPermission(tokenID: number, permissionName: string): Promise&lt;void&g
| ------------- | --------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。|
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100004 | The interface is not used together. |
**示例:**
```js
......@@ -233,7 +279,7 @@ try {
startUsingPermission(tokenID: number, permissionName: string, callback: AsyncCallback&lt;void&gt;): void
应用开始使用某项权限,可监听应用在前后台使用权限,并将使用权限的记录落盘,由系统服务调用。
应用开始使用某项权限,可监听应用在前后台使用权限,并将使用权限的记录落盘,由系统服务调用。使用callback异步回调。
**需要权限:** ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。
......@@ -245,7 +291,17 @@ startUsingPermission(tokenID: number, permissionName: string, callback: AsyncCal
| -------------- | --------------------- | ---- | ------------------------------------ |
| tokenID | number | 是 | 调用方的应用身份标识。可通过应用的[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)获得。 |
| permissionName | string | 是 | 需要使用的权限名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调,返回开始使用权限的结果。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当开始使用权限成功时,err为undefine;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100004 | The interface is not used together. |
**示例:**
......@@ -270,7 +326,7 @@ try {
stopUsingPermission(tokenID: number, permissionName: string): Promise&lt;void&gt;
应用停止使用某项权限,与Start对应,由系统服务调用。
应用停止使用某项权限,与Start对应,由系统服务调用。使用Promise异步回调。
**需要权限:** ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。
......@@ -289,6 +345,16 @@ stopUsingPermission(tokenID: number, permissionName: string): Promise&lt;void&gt
| ------------- | --------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。|
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100004 | The interface is not used together. |
**示例:**
```js
......@@ -310,7 +376,7 @@ try {
stopUsingPermission(tokenID: number, permissionName: string, callback: AsyncCallback&lt;void&gt;): void
应用停止使用某项权限,与Start对应,由系统服务调用。
应用停止使用某项权限,与Start对应,由系统服务调用。使用callback异步回调。
**需要权限:** ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。
......@@ -322,7 +388,17 @@ stopUsingPermission(tokenID: number, permissionName: string, callback: AsyncCall
| -------------- | --------------------- | ---- | ------------------------------------ |
| tokenID | number | 是 | 调用方的应用身份标识。可通过应用的[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)获得。 |
| permissionName | string | 是 | 需要使用的权限名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调,返回停止使用权限的结果。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当停止使用权限成功时,err为undefine;否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100004 | The interface is not used together. |
**示例:**
......@@ -347,11 +423,9 @@ try {
on(type: 'activeStateChange', permissionNameList: Array&lt;string&gt;, callback: Callback&lt;ActiveChangeResponse&gt;): void
订阅指定权限列表的权限使用状态变更事件,使用callback回调异步返回结果。
此接口为系统接口。
订阅指定权限列表的权限使用状态变更事件。
**需要权限:** ohos.permission.PERMISSION_USED_STATS
**需要权限:** ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -363,6 +437,15 @@ on(type: 'activeStateChange', permissionNameList: Array&lt;string&gt;, callback:
| permissionNameList | Array&lt;string&gt; | 否 | 订阅的权限名列表,为空时表示订阅所有的权限使用状态变化。 |
| callback | Callback&lt;[ActiveChangeResponse](#activechangeresponse)&gt; | 是 | 订阅指定权限使用状态变更事件的回调。 |
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100004 | The interface is not used together. |
| 12100005 | The number of listeners exceeds the limit. |
**示例:**
```js
......@@ -382,11 +465,9 @@ try {
off(type: 'activeStateChange', permissionNameList: Array&lt;string&gt;, callback?: Callback&lt;ActiveChangeResponse&gt;): void;
取消订阅指定权限列表的权限使用状态变更事件,使用callback回调异步返回结果。
此接口为系统接口。
取消订阅指定权限列表的权限使用状态变更事件。
**需要权限:** ohos.permission.PERMISSION_USED_STATS
**需要权限:** ohos.permission.PERMISSION_USED_STATS,仅系统应用可用。
**系统能力:** SystemCapability.Security.AccessToken
......@@ -398,6 +479,14 @@ off(type: 'activeStateChange', permissionNameList: Array&lt;string&gt;, callback
| permissionNameList | Array&lt;string&gt; | 否 | 订阅的权限名列表,为空时表示订阅所有的权限状态变化,必须与on的输入一致。 |
| callback | Callback&lt;[ActiveChangeResponse](#activechangeresponse)&gt; | 否 | 取消订阅指定tokenId与指定权限名状态变更事件的回调。|
**错误码:**
以下错误码的详细介绍请参见[程序访问控制错误码](../errorcodes/errorcode-access-token.md)
| 错误码ID | 错误信息 |
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100004 | The interface is not used together. |
**示例:**
```js
......@@ -426,7 +515,7 @@ try {
表示使用记录的查询请求。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Security.AccessToken
**系统能力:** SystemCapability.Security.AccessToken
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------------- |
......@@ -443,7 +532,7 @@ try {
表示所有应用的访问记录。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Security.AccessToken
**系统能力:** SystemCapability.Security.AccessToken
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------------- |
......@@ -455,7 +544,7 @@ try {
某个应用的访问记录。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Security.AccessToken
**系统能力:** SystemCapability.Security.AccessToken
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------------- |
......@@ -469,7 +558,7 @@ try {
某个权限的访问记录。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Security.AccessToken
**系统能力:** SystemCapability.Security.AccessToken
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------------- |
......@@ -486,7 +575,7 @@ try {
单次访问记录详情。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Security.AccessToken
**系统能力:** SystemCapability.Security.AccessToken
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------------- |
......@@ -498,7 +587,7 @@ try {
表示权限使用状态变化类型的枚举。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Security.AccessToken
**系统能力:** SystemCapability.Security.AccessToken
| 名称 | 默认值 | 描述 |
| ------------------------- | ------ | ---------------- |
......@@ -510,7 +599,7 @@ try {
表示某次权限使用状态变化的详情。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Security.AccessToken
**系统能力:** SystemCapability.Security.AccessToken
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | ---------------------- | ---- | ---- | --------------------- |
......
......@@ -56,7 +56,7 @@ Permission does not exist.
**错误信息**
The listener interface is not used together.
The interface is not used together.
**可能原因**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册