Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“8d1045584a3c7ec27138453635d741dd63b9212c”上不存在“...release-notes/api-diff/v3.1-Release/js-apidiff-graphic.md”
未验证 提交 e8c2d83e 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!12184 [翻译完成】#I5W1U7 

Merge pull request !12184 from Annie_wang/PR10656A
上级 90804740 017ee71e
显示空白变更内容
内联 并排
Showing with 508 addition and 155 deletion
en/application-dev/reference/apis/js-apis-abilityAccessCtrl.md
浏览文件 @ e8c2d83e
...@@ -3,7 +3,6 @@ ...@@ -3,7 +3,6 @@
The **AbilityAccessCtrl** module provides APIs for application permission management, including authentication, authorization, and revocation. The **AbilityAccessCtrl** module provides APIs for application permission management, including authentication, authorization, and revocation.
> **NOTE** > **NOTE**
>
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import ## Modules to Import
...@@ -30,7 +29,7 @@ Creates an **AtManager** instance, which is used for ability access control. ...@@ -30,7 +29,7 @@ Creates an **AtManager** instance, which is used for ability access control.
**Example** **Example**
```js ```js
var AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
``` ```
## AtManager ## AtManager
...@@ -39,9 +38,9 @@ Implements ability access control. ...@@ -39,9 +38,9 @@ Implements ability access control.
### checkAccessToken<sup>9+</sup> ### checkAccessToken<sup>9+</sup>
checkAccessToken(tokenID: number, permissionName: string): Promise&lt;GrantStatus&gt; checkAccessToken(tokenID: number, permissionName: Permissions): Promise&lt;GrantStatus&gt;
Checks whether an application has been granted the specified permission. This API uses a promise to return the result. Checks whether an application has the specified permission. This API uses a promise to return the result.
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -50,7 +49,7 @@ Checks whether an application has been granted the specified permission. This AP ...@@ -50,7 +49,7 @@ Checks whether an application has been granted the specified permission. This AP
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------- | ---- | ------------------------------------------ | | -------- | ------------------- | ---- | ------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). | | tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). |
| permissionName | string | Yes | Name of the permission to verify.| | permissionName | Permissions | Yes | Permission to check.|
**Return value** **Return value**
...@@ -58,15 +57,23 @@ Checks whether an application has been granted the specified permission. This AP ...@@ -58,15 +57,23 @@ Checks whether an application has been granted the specified permission. This AP
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;GrantStatus&gt; | Promise used to return the permission grant state.| | Promise&lt;GrantStatus&gt; | Promise used to return the permission grant state.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0 |
**Example** **Example**
```js ```js
import privacyManager from '@ohos.abilityAccessCtrl'; import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
try { try {
AtManager.checkAccessToken(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS").then((data) => { atManager.checkAccessToken(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS").then((data) => {
console.log(`checkAccessToken success, data->${JSON.stringify(data)}`); console.log(`checkAccessToken success, data->${JSON.stringify(data)}`);
}).catch((err) => { }).catch((err) => {
console.log(`checkAccessToken fail, err->${JSON.stringify(err)}`); console.log(`checkAccessToken fail, err->${JSON.stringify(err)}`);
...@@ -78,9 +85,9 @@ try { ...@@ -78,9 +85,9 @@ try {
### verifyAccessTokenSync<sup>9+</sup> ### verifyAccessTokenSync<sup>9+</sup>
verifyAccessTokenSync(tokenID: number, permissionName: string): GrantStatus verifyAccessTokenSync(tokenID: number, permissionName: Permissions): GrantStatus
Checks whether an application has been granted the specified permission. This API synchronously returns the result. Verifies whether an application has the specified permission. This API returns the result synchronously.
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -89,7 +96,7 @@ Checks whether an application has been granted the specified permission. This AP ...@@ -89,7 +96,7 @@ Checks whether an application has been granted the specified permission. This AP
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------- | ---- | ------------------------------------------ | | -------- | ------------------- | ---- | ------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. | | tokenID | number | Yes | Token ID of the application. |
| permissionName | string | Yes | Name of the permission to verify.| | permissionName | Permissions | Yes | Name of the permission to verify.|
**Return value** **Return value**
...@@ -97,24 +104,32 @@ Checks whether an application has been granted the specified permission. This AP ...@@ -97,24 +104,32 @@ Checks whether an application has been granted the specified permission. This AP
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| [GrantStatus](#grantstatus) | Permission grant state.| | [GrantStatus](#grantstatus) | Permission grant state.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0 |
**Example** **Example**
```js ```js
var AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; let tokenID = 0;
let data = AtManager.verifyAccessTokenSync(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS"); let data = atManager.verifyAccessTokenSync(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS");
console.log(`data->${JSON.stringify(data)}`); console.log(`data->${JSON.stringify(data)}`);
``` ```
### grantUserGrantedPermission ### grantUserGrantedPermission
grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number): Promise&lt;void&gt; grantUserGrantedPermission(tokenID: number, permissionName: Permissions, permissionFlag: number): Promise&lt;void&gt;
Grants a user granted permission to an application. This API uses a promise to return the result. Grants a user_grant permission to an application. This API uses a promise to return the result.
This is a system API. **System API**: This is a system API.
**Required permissions**: ohos.permission.GRANT_SENSITIVE_PERMISSIONS **Required permissions**: ohos.permission.GRANT_SENSITIVE_PERMISSIONS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -123,7 +138,7 @@ This is a system API. ...@@ -123,7 +138,7 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------- | ------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------- | ---- | ------------------------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). | | tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). |
| permissionName | string | Yes | Name of the permission to grant.| | permissionName | Permissions | Yes | Name of the permission to grant.|
| permissionFlag | number | Yes | Permission flag. The value **1** means that the permission request dialog box will still be displayed after the user grants or denies the permission. The value **2** means that no dialog box will be displayed after the user grants or denies the permission. The value **3** means a system permission that cannot be changed. | | permissionFlag | number | Yes | Permission flag. The value **1** means that the permission request dialog box will still be displayed after the user grants or denies the permission. The value **2** means that no dialog box will be displayed after the user grants or denies the permission. The value **3** means a system permission that cannot be changed. |
**Return value** **Return value**
...@@ -132,16 +147,28 @@ This is a system API. ...@@ -132,16 +147,28 @@ This is a system API.
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise that returns no value.| | Promise&lt;void&gt; | Promise that returns no value.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0 |
| 12100002 | The specified tokenID does not exist. |
| 12100003 | The specified permission does not exist. |
| 12100006 | The application specified by the tokenID is not allowed to be granted with the specified permission. Either the application is a sandbox or the tokenID is from a remote device. |
| 12100007 | Service is abnormal. |
**Example** **Example**
```js ```js
import privacyManager from '@ohos.abilityAccessCtrl'; import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
let permissionFlag = 1; let permissionFlag = 1;
try { try {
AtManager.grantUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag).then(() => { atManager.grantUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag).then(() => {
console.log('grantUserGrantedPermission success'); console.log('grantUserGrantedPermission success');
}).catch((err) => { }).catch((err) => {
console.log(`grantUserGrantedPermission fail, err->${JSON.stringify(err)}`); console.log(`grantUserGrantedPermission fail, err->${JSON.stringify(err)}`);
...@@ -153,13 +180,13 @@ try { ...@@ -153,13 +180,13 @@ try {
### grantUserGrantedPermission ### grantUserGrantedPermission
grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number, callback: AsyncCallback&lt;void&gt;): void grantUserGrantedPermission(tokenID: number, permissionName: Permissions, permissionFlag: number, callback: AsyncCallback&lt;void&gt;): void
Grants a user granted permission to an application. This API uses an asynchronous callback to return the result. Grants a user_grant permission to an application. This API uses an asynchronous callback to return the result.
This is a system API. **System API**: This is a system API.
**Required permissions**: ohos.permission.GRANT_SENSITIVE_PERMISSIONS **Required permissions**: ohos.permission.GRANT_SENSITIVE_PERMISSIONS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -167,21 +194,32 @@ This is a system API. ...@@ -167,21 +194,32 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------- | ------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------- | ---- | ------------------------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). | | tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).|
| permissionName | string | Yes | Name of the permission to grant.| | permissionName | Permissions | Yes | Name of the permission to grant.|
| permissionFlag | number | Yes | Permission flag. The value **1** means that the permission request dialog box will still be displayed after the user grants or denies the permission. The value **2** means that no dialog box will be displayed after the user grants or denies the permission. The value **3** means a system permission that cannot be changed. | | permissionFlag | number | Yes | Permission flag. The value **1** means that the permission request dialog box will still be displayed after the user grants or denies the permission. The value **2** means that no dialog box will be displayed after the user grants or denies the permission. The value **3** means a system permission that cannot be changed. |
| callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.| | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result. If the permission is granted successfully, **err** is **undefine**. Otherwise, **err** is an error object.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0 |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100006 | The specified application does not support the permissions granted or ungranted as specified. |
**Example** **Example**
```js ```js
import privacyManager from '@ohos.abilityAccessCtrl'; import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
var AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
let permissionFlag = 1; let permissionFlag = 1;
try { try {
AtManager.grantUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag, (data, err) => { atManager.grantUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag, (err, data) => {
if (err) { if (err) {
console.log(`grantUserGrantedPermission fail, err->${JSON.stringify(err)}`); console.log(`grantUserGrantedPermission fail, err->${JSON.stringify(err)}`);
} else { } else {
...@@ -195,13 +233,13 @@ try { ...@@ -195,13 +233,13 @@ try {
### revokeUserGrantedPermission ### revokeUserGrantedPermission
revokeUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number): Promise&lt;void&gt; revokeUserGrantedPermission(tokenID: number, permissionName: Permissions, permissionFlag: number): Promise&lt;void&gt;
Revokes a user granted permission given to an application. This API uses a promise to return the result. Revokes a user_grant permission from an application. This API uses a promise to return the result.
This is a system API. **System API**: This is a system API.
**Required permissions**: ohos.permission.REVOKE_SENSITIVE_PERMISSIONS **Required permissions**: ohos.permission.REVOKE_SENSITIVE_PERMISSIONS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -210,7 +248,7 @@ This is a system API. ...@@ -210,7 +248,7 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------- | ------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------- | ---- | ------------------------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). | | tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). |
| permissionName | string | Yes | Name of the permission to revoke.| | permissionName | Permissions | Yes | Name of the permission to revoke.|
| permissionFlag | number | Yes | Permission flag. The value **1** means that the permission request dialog box will still be displayed after the user grants or denies the permission. The value **2** means that no dialog box will be displayed after the user grants or denies the permission. The value **3** means a system permission that cannot be changed. | | permissionFlag | number | Yes | Permission flag. The value **1** means that the permission request dialog box will still be displayed after the user grants or denies the permission. The value **2** means that no dialog box will be displayed after the user grants or denies the permission. The value **3** means a system permission that cannot be changed. |
**Return value** **Return value**
...@@ -219,16 +257,28 @@ This is a system API. ...@@ -219,16 +257,28 @@ This is a system API.
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise that returns no value.| | Promise&lt;void&gt; | Promise that returns no value.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0 |
| 12100002 | The specified tokenID does not exist. |
| 12100003 | The specified permission does not exist. |
| 12100006 | The application specified by the tokenID is not allowed to be revoked with the specified permission. Either the application is a sandbox or the tokenID is from a remote device. |
| 12100007 | Service is abnormal. |
**Example** **Example**
```js ```js
import privacyManager from '@ohos.abilityAccessCtrl'; import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
let permissionFlag = 1; let permissionFlag = 1;
try { try {
AtManager.revokeUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag).then(() => { atManager.revokeUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag).then(() => {
console.log('revokeUserGrantedPermission success'); console.log('revokeUserGrantedPermission success');
}).catch((err) => { }).catch((err) => {
console.log(`revokeUserGrantedPermission fail, err->${JSON.stringify(err)}`); console.log(`revokeUserGrantedPermission fail, err->${JSON.stringify(err)}`);
...@@ -240,13 +290,13 @@ try { ...@@ -240,13 +290,13 @@ try {
### revokeUserGrantedPermission ### revokeUserGrantedPermission
revokeUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number, callback: AsyncCallback&lt;void&gt;): void revokeUserGrantedPermission(tokenID: number, permissionName: Permissions, permissionFlag: number, callback: AsyncCallback&lt;void&gt;): void
Revokes a user granted permission given to an application. This API uses an asynchronous callback to return the result. Revokes a user_grant permission from an application. This API uses an asynchronous callback to return the result.
This is a system API. **System API**: This is a system API.
**Required permissions**: ohos.permission.REVOKE_SENSITIVE_PERMISSIONS **Required permissions**: ohos.permission.REVOKE_SENSITIVE_PERMISSIONS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -255,20 +305,31 @@ This is a system API. ...@@ -255,20 +305,31 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------- | ------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------- | ---- | ------------------------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). | | tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). |
| permissionName | string | Yes | Name of the permission to revoke.| | permissionName | Permissions | Yes | Name of the permission to revoke.|
| permissionFlag | number | Yes | Permission flag. The value **1** means that the permission request dialog box will still be displayed after the user grants or denies the permission. The value **2** means that no dialog box will be displayed after the user grants or denies the permission. The value **3** means a system permission that cannot be changed. | | permissionFlag | number | Yes | Permission flag. The value **1** means that the permission request dialog box will still be displayed after the user grants or denies the permission. The value **2** means that no dialog box will be displayed after the user grants or denies the permission. The value **3** means a system permission that cannot be changed. |
| callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.| | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result. If the permission is revoked successfully, **err** is **undefine**. Otherwise, **err** is an error object.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0 |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100006 | The specified application does not support the permissions granted or ungranted as specified. |
**Example** **Example**
```js ```js
import privacyManager from '@ohos.abilityAccessCtrl'; import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
var AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
let permissionFlag = 1; let permissionFlag = 1;
try { try {
AtManager.revokeUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag, (data, err) => { atManager.revokeUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag, (err, data) => {
if (err) { if (err) {
console.log(`revokeUserGrantedPermission fail, err->${JSON.stringify(err)}`); console.log(`revokeUserGrantedPermission fail, err->${JSON.stringify(err)}`);
} else { } else {
...@@ -282,13 +343,13 @@ try { ...@@ -282,13 +343,13 @@ try {
### getPermissionFlags ### getPermissionFlags
getPermissionFlags(tokenID: number, permissionName: string): Promise&lt;number&gt; getPermissionFlags(tokenID: number, permissionName: Permissions): Promise&lt;number&gt;
Obtains the flags of the specified permission of a given application. This API uses a promise to return the result. Obtains the flags of the specified permission of an application. This API uses a promise to return the result.
This is a system API. **System API**: This is a system API.
**Required permissions**: ohos.permission.GET_SENSITIVE_PERMISSIONS, ohos.permission.GRANT_SENSITIVE_PERMISSIONS, or ohos.permission.REVOKE_SENSITIVE_PERMISSIONS **Required permissions**: ohos.permission.GET_SENSITIVE_PERMISSIONS, ohos.permission.GRANT_SENSITIVE_PERMISSIONS, or ohos.permission.REVOKE_SENSITIVE_PERMISSIONS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -297,7 +358,7 @@ This is a system API. ...@@ -297,7 +358,7 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------- | ------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------- | ---- | ------------------------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). | | tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). |
| permissionName | string | Yes | Name of the permission to query.| | permissionName | Permissions | Yes | Name of the permission to query.|
**Return value** **Return value**
...@@ -305,18 +366,30 @@ This is a system API. ...@@ -305,18 +366,30 @@ This is a system API.
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;number&gt; | Promise used to return the result.| | Promise&lt;number&gt; | Promise used to return the result.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0 |
| 12100002 | The specified tokenID does not exist. |
| 12100003 | The specified permission does not exist. |
| 12100006 | The operation is not allowd. Either the application is a sandbox or the tokenID is from a remote device. |
| 12100007 | Service is abnormal. |
**Example** **Example**
```js ```js
import privacyManager from '@ohos.abilityAccessCtrl'; import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
let permissionFlag = 1; let permissionFlag = 1;
try { try {
AtManager.getPermissionFlags(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS").then((data) => { atManager.getPermissionFlags(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS").then((data) => {
console.log(`getPermissionFlags success, data->${JSON.stringify(data)}`); console.log(`getPermissionFlags success, data->${JSON.stringify(data)}`);
}).catch((err) = > { }).catch((err) => {
console.log(`getPermissionFlags fail, err->${JSON.stringify(err)}`); console.log(`getPermissionFlags fail, err->${JSON.stringify(err)}`);
}); });
} catch(err) { } catch(err) {
...@@ -328,9 +401,9 @@ try { ...@@ -328,9 +401,9 @@ try {
getVersion(): Promise&lt;number&gt; getVersion(): Promise&lt;number&gt;
Obtains the data version of the current permission management. This API uses a promise to return the result. Obtains the data version of the permission management. This API uses a promise to return the result.
This is a system API. **System API**: This is a system API.
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -343,8 +416,8 @@ This is a system API. ...@@ -343,8 +416,8 @@ This is a system API.
**Example** **Example**
```js ```js
var AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let promise = AtManager.getVersion(); let promise = atManager.getVersion();
promise.then(data => { promise.then(data => {
console.log(`promise: data->${JSON.stringify(data)}`); console.log(`promise: data->${JSON.stringify(data)}`);
}); });
...@@ -352,13 +425,13 @@ promise.then(data => { ...@@ -352,13 +425,13 @@ promise.then(data => {
### on<sup>9+</sup> ### on<sup>9+</sup>
on(type: 'permissionStateChange', tokenIDList: Array&lt;number&gt;, permissionNameList: Array&lt;string&gt;, callback: Callback&lt;PermissionStateChangeInfo&gt;): void; on(type: 'permissionStateChange', tokenIDList: Array&lt;number&gt;, permissionNameList: Array&lt;Permissions&gt;, callback: Callback&lt;PermissionStateChangeInfo&gt;): void;
Subscribes to permission grant state change events of a specified token ID list and permission list. This API uses an asynchronous callback to return the result. Subscribes to permission grant state changes of the specified applications and permissions.
This is a system API. **System API**: This is a system API.
**Required permissions**: ohos.permission.GET_SENSITIVE_PERMISSIONS **Required permissions**: ohos.permission.GET_SENSITIVE_PERMISSIONS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -367,10 +440,22 @@ This is a system API. ...@@ -367,10 +440,22 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------------ | --------------------- | ---- | ------------------------------------------------------------ | | ------------------ | --------------------- | ---- | ------------------------------------------------------------ |
| type | string | Yes | Event type. The value is fixed at **'permissionStateChange'**, indicating the permission grant state change event. | | type | string | Yes | Event type. The value is fixed at **'permissionStateChange'**, indicating the permission grant state change event. |
| tokenIDList | Array&lt;number&gt; | No | List of token IDs. If this parameter is left empty, the permission grant state changes of all applications are subscribed to. | | tokenIDList | Array&lt;number&gt; | Yes | List of token IDs. If this parameter is left empty, the permission grant state changes of all applications are subscribed to. |
| permissionNameList | Array&lt;string&gt; | No | List of permission names. If this parameter is left empty, the permission grant state changes of all permissions are subscribed to. | | permissionNameList | Array&lt;Permissions&gt; | Yes | List of permission names. If this parameter is left empty, the permission grant state changes of all permissions are subscribed to. |
| callback | Callback&lt;[PermissionStateChangeInfo](#permissionstatechangeinfo9)&gt; | Yes| Callback used to return the permission grant state change information.| | callback | Callback&lt;[PermissionStateChangeInfo](#permissionstatechangeinfo9)&gt; | Yes| Callback used to return the permission grant state change information.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID is 0 |
| 12100004 | The interface is called repeatedly with the same input. |
| 12100005 | The registration time has exceeded the limitation. |
| 12100007 | Service is abnormal. |
| 12100008 | Out of memory. |
**Example** **Example**
```js ```js
...@@ -378,7 +463,7 @@ import abilityAccessCtrl from '@ohos.abilityAccessCtrl'; ...@@ -378,7 +463,7 @@ import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let atManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenIDList: Array<number> = []; let tokenIDList: Array<number> = [];
let permissionNameList: Array<string> = []; let permissionNameList = [];
try { try {
atManager.on('permissionStateChange', tokenIDList, permissionNameList, (data) => { atManager.on('permissionStateChange', tokenIDList, permissionNameList, (data) => {
console.debug("receive permission state change, data:" + JSON.stringify(data)); console.debug("receive permission state change, data:" + JSON.stringify(data));
...@@ -390,13 +475,13 @@ try { ...@@ -390,13 +475,13 @@ try {
### off<sup>9+</sup> ### off<sup>9+</sup>
off(type: 'permissionStateChange', tokenIDList: Array&lt;number&gt;, permissionNameList: Array&lt;string&gt;, callback?: Callback&lt;PermissionStateChangeInfo&gt;): void; off(type: 'permissionStateChange', tokenIDList: Array&lt;number&gt;, permissionNameList: Array&lt;Permissions&gt;, callback?: Callback&lt;PermissionStateChangeInfo&gt;): void;
Unsubscribes from permission grant state change events of a specified token ID list and permission list. This API uses an asynchronous callback to return the result. Unsubscribes from permission grant state changes of the specified applications and permissions. This API uses an asynchronous callback to return the result.
This is a system API. **System API**: This is a system API.
**Required permissions**: ohos.permission.GET_SENSITIVE_PERMISSIONS **Required permissions**: ohos.permission.GET_SENSITIVE_PERMISSIONS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -405,10 +490,21 @@ This is a system API. ...@@ -405,10 +490,21 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------------ | --------------------- | ---- | ------------------------------------------------------------ | | ------------------ | --------------------- | ---- | ------------------------------------------------------------ |
| type | string | Yes | Event type. The value is fixed at **'permissionStateChange'**, indicating the permission grant state change event. | | type | string | Yes | Event type. The value is fixed at **'permissionStateChange'**, indicating the permission grant state change event. |
| tokenIDList | Array&lt;number&gt; | No | List of token IDs. If this parameter is left empty, the permission grant state changes of all applications are unsubscribed from. The value must be the same as that passed in **on()**.| | tokenIDList | Array&lt;number&gt; | Yes | List of token IDs. If this parameter is left empty, the permission grant state changes of all applications are unsubscribed from. The value must be the same as that passed in **on()**.|
| permissionNameList | Array&lt;string&gt; | No | List of permission names. If this parameter is left empty, the permission grant state changes of all permissions are unsubscribed from. The value must be the same as that passed in **on()**.| | permissionNameList | Array&lt;Permissions&gt; | Yes | List of permission names. If this parameter is left empty, the permission grant state changes of all permissions are unsubscribed from. The value must be the same as that passed in **on()**.|
| callback | Callback&lt;[PermissionStateChangeInfo](#permissionstatechangeinfo9)&gt; | No| Callback used to return the permission grant state change information.| | callback | Callback&lt;[PermissionStateChangeInfo](#permissionstatechangeinfo9)&gt; | No| Callback used to return the permission grant state change information.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | The parameter is invalid. The tokenID in list is all invalid |
| 12100004 | The interface is not used with |
| 12100007 | Service is abnormal. |
| 12100008 | Out of memory. |
**Example** **Example**
```js ```js
...@@ -416,7 +512,7 @@ import abilityAccessCtrl from '@ohos.abilityAccessCtrl'; ...@@ -416,7 +512,7 @@ import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let atManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenIDList: Array<number> = []; let tokenIDList: Array<number> = [];
let permissionNameList: Array<string> = []; let permissionNameList = [];
try { try {
atManager.off('permissionStateChange', tokenIDList, permissionNameList); atManager.off('permissionStateChange', tokenIDList, permissionNameList);
} catch(err) { } catch(err) {
...@@ -424,15 +520,49 @@ try { ...@@ -424,15 +520,49 @@ try {
} }
``` ```
### verifyAccessToken<sup>9+</sup>
verifyAccessToken(tokenID: number, permissionName: Permissions): Promise&lt;GrantStatus&gt;
Verifies whether an application has the specified permission. This API uses a promise to return the result.
> **NOTE**<br>You are advised to use [checkAccessToken](#checkaccesstoken9).
**System capability**: SystemCapability.Security.AccessToken
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------------------- | ---- | ------------------------------------------ |
| tokenID | number | Yes | Token ID of the application. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). |
| permissionName | Permissions | Yes | Name of the permission to verify. Only valid permission names are supported.|
**Return value**
| Type | Description |
| :------------ | :---------------------------------- |
| Promise&lt;GrantStatus&gt; | Promise used to return the permission grant state.|
**Example**
```js
import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
let promise = atManager.verifyAccessToken(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS");
promise.then(data => {
console.log(`promise: data->${JSON.stringify(data)}`);
});
```
### verifyAccessToken<sup>(deprecated)</sup> ### verifyAccessToken<sup>(deprecated)</sup>
verifyAccessToken(tokenID: number, permissionName: string): Promise&lt;GrantStatus&gt; verifyAccessToken(tokenID: number, permissionName: string): Promise&lt;GrantStatus&gt;
Checks whether an application has been granted the specified permission. This API uses a promise to return the result. Verifies whether an application has the specified permission. This API uses a promise to return the result.
> **NOTE** > NOTE<br>This API is deprecated since API version 9. You are advised to use [checkAccessToken](#checkaccesstoken9).
>
> This API is deprecated since API version 9. You are advised to use [checkAccessToken](#checkaccesstoken9) instead.
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -452,11 +582,11 @@ Checks whether an application has been granted the specified permission. This AP ...@@ -452,11 +582,11 @@ Checks whether an application has been granted the specified permission. This AP
**Example** **Example**
```js ```js
import privacyManager from '@ohos.abilityAccessCtrl'; import abilityAccessCtrl from '@ohos.abilityAccessCtrl';
var AtManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
let promise = AtManager.verifyAccessToken(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS"); let promise = atManager.verifyAccessToken(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS");
promise.then(data => { promise.then(data => {
console.log(`promise: data->${JSON.stringify(data)}`); console.log(`promise: data->${JSON.stringify(data)}`);
}); });
...@@ -468,7 +598,7 @@ Enumerates the permission grant states. ...@@ -468,7 +598,7 @@ Enumerates the permission grant states.
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
| Name | Default Value| Description | | Name | Value| Description |
| ------------------ | ----- | ----------- | | ------------------ | ----- | ----------- |
| PERMISSION_DENIED | -1 | Permission denied.| | PERMISSION_DENIED | -1 | Permission denied.|
| PERMISSION_GRANTED | 0 | Permission granted.| | PERMISSION_GRANTED | 0 | Permission granted.|
...@@ -481,7 +611,7 @@ Enumerates the operations that trigger permission grant state changes. ...@@ -481,7 +611,7 @@ Enumerates the operations that trigger permission grant state changes.
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
| Name | Default Value| Description | | Name | Value| Description |
| ----------------------- | ------ | ----------------- | | ----------------------- | ------ | ----------------- |
| PERMISSION_REVOKED_OPER | 0 | Operation to revoke the permission.| | PERMISSION_REVOKED_OPER | 0 | Operation to revoke the permission.|
| PERMISSION_GRANTED_OPER | 1 | Operation to grant the permission.| | PERMISSION_GRANTED_OPER | 1 | Operation to grant the permission.|
...@@ -492,10 +622,10 @@ Defines the detailed permission grant state change information. ...@@ -492,10 +622,10 @@ Defines the detailed permission grant state change information.
**System API**: This is a system API. **System API**: This is a system API.
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| -------------- | ------------------------- | ---- | ---- | ------------------ | | -------------- | ------------------------- | ---- | ---- | ------------------ |
| change | [PermissionStateChangeType](#permissionstatechangetype9) | Yes | No | Operation that triggers the permission grant state change. | | change | [PermissionStateChangeType](#permissionstatechangetype9) | Yes | No | Operation that triggers the permission grant state change. |
| tokenID | number | Yes | No | Token ID of the application whose permission grant state changes are subscribed.| | tokenID | number | Yes | No | Token ID of the application whose permission grant state changes are subscribed.|
| permissionName | string | Yes | No | Name of the permission whose grant state is changed.| | permissionName | Permissions | Yes | No | Name of the permission whose grant state is changed.|
en/application-dev/reference/apis/js-apis-privacyManager.md
浏览文件 @ e8c2d83e
# Privacy Management # Privacy Management
The **PrivacyManager** module provides APIs for privacy management, such as management of permission usage records. The **privacyManager** module provides APIs for privacy management, such as management of permission usage records.
> **NOTE** > **NOTE**
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
> The APIs of this module are system APIs and cannot be called by third-party applications. > The APIs provided by this module are system APIs.
## Modules to Import ## Modules to Import
...@@ -15,10 +15,10 @@ import privacyManager from '@ohos.privacyManager'; ...@@ -15,10 +15,10 @@ import privacyManager from '@ohos.privacyManager';
## privacyManager.addPermissionUsedRecord ## privacyManager.addPermissionUsedRecord
addPermissionUsedRecord(tokenID: number, permissionName: string, successCount: number, failCount: number): Promise&lt;void&gt; addPermissionUsedRecord(tokenID: number, permissionName: Permissions, successCount: number, failCount: number): Promise&lt;void&gt;
Adds a permission usage record when an application protected by the permission is called by another service or application. This API uses a promise to return the result. Adds a permission usage record when an application protected by the permission is called by another service or application. This API uses a promise to return the result.
The permission usage record includes the application identity of the invoker, name of the permission used, and number of successful and failed accesses to the application. The permission usage record includes the application identity (token ID) of the invoker, name of the permission used, and number of successful and failed accesses to the target application.
**Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications) **Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications)
...@@ -28,8 +28,8 @@ The permission usage record includes the application identity of the invoker, na ...@@ -28,8 +28,8 @@ The permission usage record includes the application identity of the invoker, na
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------- | ---- | ------------------------------------------ | | -------- | ------------------- | ---- | ------------------------------------------ |
| tokenID | number | Yes | Application token ID of the invoker. You can obtain it from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). | | tokenID | number | Yes | Application token ID of the invoker. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). |
| permissionName | string | Yes | Name of the permission.| | permissionName | Permissions | Yes | Name of the permission.|
| successCount | number | Yes | Number of successful accesses.| | successCount | number | Yes | Number of successful accesses.|
| failCount | number | Yes | Number of failed accesses.| | failCount | number | Yes | Number of failed accesses.|
...@@ -39,6 +39,15 @@ The permission usage record includes the application identity of the invoker, na ...@@ -39,6 +39,15 @@ The permission usage record includes the application identity of the invoker, na
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise that returns no value.| | Promise&lt;void&gt; | Promise that returns no value.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
**Example** **Example**
```js ```js
...@@ -58,10 +67,10 @@ try { ...@@ -58,10 +67,10 @@ try {
## privacyManager.addPermissionUsedRecord ## privacyManager.addPermissionUsedRecord
addPermissionUsedRecord(tokenID: number, permissionName: string, successCount: number, failCount: number, callback: AsyncCallback&lt;void&gt;): void addPermissionUsedRecord(tokenID: number, permissionName: Permissions, successCount: number, failCount: number, callback: AsyncCallback&lt;void&gt;): void
Adds a permission usage record when an application protected by the permission is called by another service or application. This API uses an asynchronous callback to return the result. Adds a permission usage record when an application protected by the permission is called by another service or application. This API uses an asynchronous callback to return the result.
The permission usage record includes the application identity of the invoker, name of the permission used, and number of successful and failed accesses to the application. The permission usage record includes the application identity (token ID) of the invoker, name of the permission used, and number of successful and failed accesses to the target application.
**Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications) **Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications)
...@@ -71,11 +80,20 @@ The permission usage record includes the application identity of the invoker, na ...@@ -71,11 +80,20 @@ The permission usage record includes the application identity of the invoker, na
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------- | ---- | ------------------------------------------ | | -------- | ------------------- | ---- | ------------------------------------------ |
| tokenID | number | Yes | Application token ID of the invoker. You can obtain it from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). | | tokenID | number | Yes | Application token ID of the invoker. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md). |
| permissionName | string | Yes | Name of the permission.| | permissionName | Permissions | Yes | Name of the permission.|
| successCount | number | Yes | Number of successful accesses.| | successCount | number | Yes | Number of successful accesses.|
| failCount | number | Yes | Number of failed accesses.| | failCount | number | Yes | Number of failed accesses.|
| callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result.| | callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result. If a usage record is added successfully, **err** is **undefine**. Otherwise, **err** is an error object.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
**Example** **Example**
...@@ -84,7 +102,7 @@ import privacyManager from '@ohos.privacyManager'; ...@@ -84,7 +102,7 @@ import privacyManager from '@ohos.privacyManager';
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
try { try {
privacyManager.addPermissionUsedRecord(tokenID, "ohos.permission.PERMISSION_USED_STATS", 1, 0, (data, err) => { privacyManager.addPermissionUsedRecord(tokenID, "ohos.permission.PERMISSION_USED_STATS", 1, 0, (err, data) => {
if (err) { if (err) {
console.log(`addPermissionUsedRecord fail, err->${JSON.stringify(err)}`); console.log(`addPermissionUsedRecord fail, err->${JSON.stringify(err)}`);
} else { } else {
...@@ -116,7 +134,16 @@ Obtains historical permission usage records. This API uses a promise to return t ...@@ -116,7 +134,16 @@ Obtains historical permission usage records. This API uses a promise to return t
| Type | Description | | Type | Description |
| :------------ | :---------------------------------- | | :------------ | :---------------------------------- |
| Promise<[PermissionUsedResponse](#permissionusedresponse)> | Promise used to return the permission usage records obtained.| | Promise<[PermissionUsedResponse](#permissionusedresponse)> | Promise used to return the permission usage records.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
**Example** **Example**
...@@ -159,7 +186,16 @@ Obtains historical permission usage records. This API uses an asynchronous callb ...@@ -159,7 +186,16 @@ Obtains historical permission usage records. This API uses an asynchronous callb
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------- | ---- | ------------------------------------------ | | -------- | ------------------- | ---- | ------------------------------------------ |
| request | [PermissionUsedRequest](#permissionusedrequest) | Yes| Request for querying permission usage records.| | request | [PermissionUsedRequest](#permissionusedrequest) | Yes| Request for querying permission usage records.|
| callback | AsyncCallback<[PermissionUsedResponse](#permissionusedresponse)> | Yes| Callback invoked to return the permission usage records obtained.| | callback | AsyncCallback<[PermissionUsedResponse](#permissionusedresponse)> | Yes| Callback invoked to return the result. If the query is successful, **err** is **undefine** and **data** is the permission usage record. Otherwise, **err** is an error object.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
**Example** **Example**
...@@ -191,9 +227,9 @@ try { ...@@ -191,9 +227,9 @@ try {
## privacyManager.startUsingPermission ## privacyManager.startUsingPermission
startUsingPermission(tokenID: number, permissionName: string): Promise&lt;void&gt; startUsingPermission(tokenID: number, permissionName: Permissions): Promise&lt;void&gt;
Starts to record a permission usage event. This API is called by a system service and uses a promise to return the result. The permissions used by an app in the foreground and background can be observed, and the permission usage records can be saved. Starts to use a permission and flushes the permission usage record. This API is called by a system application, either running in the foreground or background, and uses a promise to return the result. This API uses a promise to return the result.
**Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications) **Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications)
...@@ -203,8 +239,8 @@ Starts to record a permission usage event. This API is called by a system servic ...@@ -203,8 +239,8 @@ Starts to record a permission usage event. This API is called by a system servic
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------------- | ------ | ---- | ------------------------------------ | | -------------- | ------ | ---- | ------------------------------------ |
| tokenID | number | Yes | Application token ID of the invoker. You can obtain it from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).| | tokenID | number | Yes | Application token ID of the invoker. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).|
| permissionName | string | Yes | Permission to use. | | permissionName | Permissions | Yes | Permission to use. |
**Return value** **Return value**
...@@ -212,6 +248,16 @@ Starts to record a permission usage event. This API is called by a system servic ...@@ -212,6 +248,16 @@ Starts to record a permission usage event. This API is called by a system servic
| ------------- | --------------------------------------- | | ------------- | --------------------------------------- |
| Promise&lt;void&gt; | Promise that returns no value.| | Promise&lt;void&gt; | Promise that returns no value.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100004 | The interface is not used together. |
**Example** **Example**
```js ```js
...@@ -231,9 +277,9 @@ try { ...@@ -231,9 +277,9 @@ try {
## privacyManager.startUsingPermission ## privacyManager.startUsingPermission
startUsingPermission(tokenID: number, permissionName: string, callback: AsyncCallback&lt;void&gt;): void startUsingPermission(tokenID: number, permissionName: Permissions, callback: AsyncCallback&lt;void&gt;): void
Starts to record a permission usage event. This API is called by a system service and uses an asynchronous callback to return the result. The permissions used by an app in the foreground and background can be observed and saved. Starts to use a permission and flushes the permission usage record. This API is called by a system application, either running in the foreground or background, and uses a promise to return the result. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications) **Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications)
...@@ -243,9 +289,19 @@ Starts to record a permission usage event. This API is called by a system servic ...@@ -243,9 +289,19 @@ Starts to record a permission usage event. This API is called by a system servic
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------------- | --------------------- | ---- | ------------------------------------ | | -------------- | --------------------- | ---- | ------------------------------------ |
| tokenID | number | Yes | Application token ID of the invoker. You can obtain it from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).| | tokenID | number | Yes | Application token ID of the invoker. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).|
| permissionName | string | Yes | Permission to use. | | permissionName | Permissions | Yes | Permission to use. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result.| | callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result. If the permission is successfully used, **err** is **undefine**. Otherwise, **err** is an error object.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100004 | The interface is not used together. |
**Example** **Example**
...@@ -254,7 +310,7 @@ import privacyManager from '@ohos.privacyManager'; ...@@ -254,7 +310,7 @@ import privacyManager from '@ohos.privacyManager';
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
try { try {
privacyManager.startUsingPermission(tokenID, "ohos.permission.PERMISSION_USED_STATS", (data, err) => { privacyManager.startUsingPermission(tokenID, "ohos.permission.PERMISSION_USED_STATS", (err, data) => {
if (err) { if (err) {
console.log(`startUsingPermission fail, err->${JSON.stringify(err)}`); console.log(`startUsingPermission fail, err->${JSON.stringify(err)}`);
} else { } else {
...@@ -270,7 +326,7 @@ try { ...@@ -270,7 +326,7 @@ try {
stopUsingPermission(tokenID: number, permissionName: string): Promise&lt;void&gt; stopUsingPermission(tokenID: number, permissionName: string): Promise&lt;void&gt;
Stops recording the permission usage event. This API is called by a system service and uses a promise to return the result. **startUsingPermission** and **stopUsingPermission** are used in pairs. Stops using a permission. This API is called by a system application and uses a promise to return the result. **startUsingPermission** and **stopUsingPermission** are used in pairs. This API uses a promise to return the result.
**Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications) **Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications)
...@@ -280,8 +336,8 @@ Stops recording the permission usage event. This API is called by a system servi ...@@ -280,8 +336,8 @@ Stops recording the permission usage event. This API is called by a system servi
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------------- | ------ | ---- | ------------------------------------ | | -------------- | ------ | ---- | ------------------------------------ |
| tokenID | number | Yes | Application token ID of the invoker. You can obtain it from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).| | tokenID | number | Yes | Application token ID of the invoker. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).|
| permissionName | string | Yes | Permission to use. | | permissionName | Permissions | Yes | Permission to use. |
**Return value** **Return value**
...@@ -289,6 +345,16 @@ Stops recording the permission usage event. This API is called by a system servi ...@@ -289,6 +345,16 @@ Stops recording the permission usage event. This API is called by a system servi
| ------------- | --------------------------------------- | | ------------- | --------------------------------------- |
| Promise&lt;void&gt; | Promise that returns no value.| | Promise&lt;void&gt; | Promise that returns no value.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100004 | The interface is not used together. |
**Example** **Example**
```js ```js
...@@ -308,9 +374,9 @@ try { ...@@ -308,9 +374,9 @@ try {
## privacyManager.stopUsingPermission ## privacyManager.stopUsingPermission
stopUsingPermission(tokenID: number, permissionName: string, callback: AsyncCallback&lt;void&gt;): void stopUsingPermission(tokenID: number, permissionName: Permissions, callback: AsyncCallback&lt;void&gt;): void
Stops recording the permission usage event. This API is called by the system service and uses an asynchronous callback to return the result. **startUsingPermission** and **stopUsingPermission** are used in pairs. Stops using a permission. This API is called by a system application and uses a promise to return the result. **startUsingPermission** and **stopUsingPermission** are used in pairs. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications) **Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications)
...@@ -320,9 +386,19 @@ Stops recording the permission usage event. This API is called by the system ser ...@@ -320,9 +386,19 @@ Stops recording the permission usage event. This API is called by the system ser
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------------- | --------------------- | ---- | ------------------------------------ | | -------------- | --------------------- | ---- | ------------------------------------ |
| tokenID | number | Yes | Application token ID of the invoker. You can obtain it from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).| | tokenID | number | Yes | Application token ID of the invoker. The value can be obtained from [ApplicationInfo](js-apis-bundle-ApplicationInfo.md).|
| permissionName | string | Yes | Permission to use. | | permissionName | Permissions | Yes | Permission to use. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result.| | callback | AsyncCallback&lt;void&gt; | Yes | Callback invoked to return the result. If the operation is successful, **err** is **undefine**. Otherwise, **err** is an error object.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100002 | TokenId does not exist. |
| 12100003 | Permission does not exist. |
| 12100004 | The interface is not used together. |
**Example** **Example**
...@@ -331,7 +407,7 @@ import privacyManager from '@ohos.privacyManager'; ...@@ -331,7 +407,7 @@ import privacyManager from '@ohos.privacyManager';
let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID. let tokenID = 0; // You can use getApplicationInfo to obtain the access token ID.
try { try {
privacyManager.stopUsingPermission(tokenID, "ohos.permission.PERMISSION_USED_STATS", (data, err) => { privacyManager.stopUsingPermission(tokenID, "ohos.permission.PERMISSION_USED_STATS", (err, data) => {
if (err) { if (err) {
console.log(`stopUsingPermission fail, err->${JSON.stringify(err)}`); console.log(`stopUsingPermission fail, err->${JSON.stringify(err)}`);
} else { } else {
...@@ -345,13 +421,11 @@ try { ...@@ -345,13 +421,11 @@ try {
## privacyManager.on ## privacyManager.on
on(type: 'activeStateChange', permissionNameList: Array&lt;string&gt;, callback: Callback&lt;ActiveChangeResponse&gt;): void on(type: 'activeStateChange', permissionNameList: Array&lt;Permissions&gt;, callback: Callback&lt;ActiveChangeResponse&gt;): void
Subscribes to the changes in the usage of the specified permission list. This API uses a callback to return the result.
This is a system API. Subscribes to the permission usage status changes of the specified permissions.
**Required permissions**: ohos.permission.PERMISSION_USED_STATS **Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -359,16 +433,25 @@ This is a system API. ...@@ -359,16 +433,25 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------------ | --------------------- | ---- | ------------------------------------------------------------ | | ------------------ | --------------------- | ---- | ------------------------------------------------------------ |
| type | string | Yes | Event type to subscribe to. The value is **activeStateChange**, which indicates permission usage change event. | | type | string | Yes | Event type to subscribe to. The value is **'activeStateChange'**, which indicates the permission usage change event. |
| permissionNameList | Array&lt;string&gt; | No | List of permissions to be observed. If this parameter is left empty, the usage changes of all permissions are observed. | | permissionNameList | Array&lt;Permissions&gt; | No | List of permissions to be observed. If this parameter is left empty, the usage changes of all permissions are observed. |
| callback | Callback&lt;[ActiveChangeResponse](#activechangeresponse)&gt; | Yes| Callback invoked to return a change in permission usage.| | callback | Callback&lt;[ActiveChangeResponse](#activechangeresponse)&gt; | Yes| Callback invoked to return a change in the permission usage.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100004 | The interface is not used together. |
| 12100005 | The number of listeners exceeds the limit. |
**Example** **Example**
```js ```js
import privacyManager from '@ohos.privacyManager'; import privacyManager from '@ohos.privacyManager';
let permissionNameList: Array<string> = []; let permissionNameList: Array<Permissions> = [];
try { try {
atManager.on('activeStateChange', permissionNameList, (data) => { atManager.on('activeStateChange', permissionNameList, (data) => {
console.debug("receive permission state change, data:" + JSON.stringify(data)); console.debug("receive permission state change, data:" + JSON.stringify(data));
...@@ -380,13 +463,11 @@ try { ...@@ -380,13 +463,11 @@ try {
## privacyManager.off ## privacyManager.off
off(type: 'activeStateChange', permissionNameList: Array&lt;string&gt;, callback?: Callback&lt;ActiveChangeResponse&gt;): void; off(type: 'activeStateChange', permissionNameList: Array&lt;Permissions&gt;, callback?: Callback&lt;ActiveChangeResponse&gt;): void;
Unsubscribes from the changes in the usage of the specified permission list. This API uses a callback to return the result.
This is a system API. Unsubscribes from the permission usage status changes of the specified permissions.
**Required permissions**: ohos.permission.PERMISSION_USED_STATS **Required permissions**: ohos.permission.PERMISSION_USED_STATS (available only to system applications)
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
...@@ -394,16 +475,24 @@ This is a system API. ...@@ -394,16 +475,24 @@ This is a system API.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------------ | --------------------- | ---- | ------------------------------------------------------------ | | ------------------ | --------------------- | ---- | ------------------------------------------------------------ |
| type | string | Yes | Event type to subscribe to. The value is **activeStateChange**, which indicates permission usage change event. | | type | string | Yes | Event type to subscribe to. The value is **'activeStateChange'**, which indicates the permission usage change event. |
| permissionNameList | Array&lt;string&gt; | No | List of permissions to be observed. If this parameter is left blank, the usage changes of all permissions are unsubscribed from. The value must be the same as that specified in **on()**.| | permissionNameList | Array&lt;Permissions&gt; | No | List of permissions to be observed. If this parameter is left blank, the usage changes of all permissions are unsubscribed from. The value must be the same as that specified in **on()**.|
| callback | Callback&lt;[ActiveChangeResponse](#activechangeresponse)&gt; | No| Callback for the permission usage change event.| | callback | Callback&lt;[ActiveChangeResponse](#activechangeresponse)&gt; | No| Callback for the permission usage change event.|
**Error codes**
For details about the error codes, see [Ability Access Control Error Codes](../errorcodes/errorcode-access-token.md).
| ID| Error Message|
| -------- | -------- |
| 12100001 | Parameter invalid. |
| 12100004 | The interface is not used together. |
**Example** **Example**
```js ```js
import privacyManager from '@ohos.privacyManager'; import privacyManager from '@ohos.privacyManager';
let permissionNameList: Array<string> = []; let permissionNameList: Array<Permissions> = [];
try { try {
privacyManager.off('activeStateChange', permissionNameList); privacyManager.off('activeStateChange', permissionNameList);
}catch(err) { }catch(err) {
...@@ -430,11 +519,11 @@ Represents the request for querying permission usage records. ...@@ -430,11 +519,11 @@ Represents the request for querying permission usage records.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | -------------- | ---- | ---------------------------------------- | | -------- | -------------- | ---- | ---------------------------------------- |
| tokenId | number | No | Token ID of the application. | | tokenId | number | No | Token ID of the application (invoker). |
| isRemote | boolean | No | Whether the token ID belongs to a remote device. The default value is **false**.| | isRemote | boolean | No | Whether the token ID belongs to the application on a remote device. The default value is **false**.|
| deviceId | string | No | ID of the device hosting the target application. | | deviceId | string | No | ID of the device hosting the target application. |
| bundleName | string | No | Bundle name of the target application.| | bundleName | string | No | Bundle name of the target application.|
| permissionNames | Array&lt;string&gt; | No | Permissions to query. | | permissionNames | Array&lt;Permissions&gt; | No | Permissions to query. |
| beginTime | number | No | Start time of the query, in ms. The default value is **0**, indicating that no start time is set.| | beginTime | number | No | Start time of the query, in ms. The default value is **0**, indicating that no start time is set.|
| endTime | number | No | End time of the query, in ms. The default value is **0**, indicating that no end time is set.| | endTime | number | No | End time of the query, in ms. The default value is **0**, indicating that no end time is set.|
| flag | [PermissionUsageFlag](#permissionusageflag) | Yes | Query mode. The default value is **FLAG_PERMISSION_USAGE_SUMMARY**.| | flag | [PermissionUsageFlag](#permissionusageflag) | Yes | Query mode. The default value is **FLAG_PERMISSION_USAGE_SUMMARY**.|
...@@ -449,7 +538,7 @@ Represents the permission usage records of all applications. ...@@ -449,7 +538,7 @@ Represents the permission usage records of all applications.
| -------- | -------------- | ---- | ---------------------------------------- | | -------- | -------------- | ---- | ---------------------------------------- |
| beginTime | number | No | Start time of the query, in ms.| | beginTime | number | No | Start time of the query, in ms.|
| endTime | number | No | End time of the query, in ms.| | endTime | number | No | End time of the query, in ms.|
| bundleRecords | Array&lt;[BundleUsedRecord](#bundleusedrecord)&gt; | No | Permission usage records obtained. | | bundleRecords | Array&lt;[BundleUsedRecord](#bundleusedrecord)&gt; | No | Permission usage records. |
## BundleUsedRecord ## BundleUsedRecord
...@@ -459,8 +548,8 @@ Represents the permission access records of an application. ...@@ -459,8 +548,8 @@ Represents the permission access records of an application.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | -------------- | ---- | ---------------------------------------- | | -------- | -------------- | ---- | ---------------------------------------- |
| tokenId | number | No | Token ID of the application. | | tokenId | number | No | Token ID of the application (invoker). |
| isRemote | boolean | No | Whether the token ID belongs to a remote device. The default value is **false**.| | isRemote | boolean | No | Whether the token ID belongs to the application on a remote device. The default value is **false**.|
| deviceId | string | No | ID of the device hosting the target application. | | deviceId | string | No | ID of the device hosting the target application. |
| bundleName | string | No | Bundle name of the target application.| | bundleName | string | No | Bundle name of the target application.|
| permissionRecords | Array&lt;[PermissionUsedRecord](#permissionusedrecord)&gt; | No | Permission usage records of the target application. | | permissionRecords | Array&lt;[PermissionUsedRecord](#permissionusedrecord)&gt; | No | Permission usage records of the target application. |
...@@ -473,14 +562,14 @@ Represents the usage records of a permission. ...@@ -473,14 +562,14 @@ Represents the usage records of a permission.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | -------------- | ---- | ---------------------------------------- | | -------- | -------------- | ---- | ---------------------------------------- |
| permissionName | string | No | Name of the permission. | | permissionName | Permissions | No | Name of the permission. |
| accessCount | number | No | Total number of times that the permission is accessed.| | accessCount | number | No | Total number of times that the permission is accessed.|
| rejectCount | number | No | Total number of times that the access to the permission is rejected.| | rejectCount | number | No | Total number of times that the access to the permission is rejected.|
| lastAccessTime | number | No | Last time when the permission was accessed, accurate to ms.| | lastAccessTime | number | No | Last time when the permission was accessed, accurate to ms.|
| lastRejectTime | number | No | Last time when the access to the permission was rejected, accurate to ms.| | lastRejectTime | number | No | Last time when the access to the permission was rejected, accurate to ms.|
| lastAccessDuration | number | No | Last access duration, in ms.| | lastAccessDuration | number | No | Last access duration, in ms.|
| accessRecords | Array&lt;[UsedRecordDetail](#usedrecorddetail)&gt; | No | Access records. This parameter is valid only when **flag** is **FLAG_PERMISSION_USAGE_SUMMARY**. By default, 10 records are provided. | | accessRecords | Array&lt;[UsedRecordDetail](#usedrecorddetail)&gt; | No | Successful access records. This parameter is valid only when **flag** is **FLAG_PERMISSION_USAGE_SUMMARY**. By default, 10 records are provided. |
| rejectRecords | Array&lt;[UsedRecordDetail](#usedrecorddetail)&gt; | No | Rejected records. This parameter is valid only when **flag** is **FLAG_PERMISSION_USAGE_SUMMARY**. By default, 10 records are provided. | | rejectRecords | Array&lt;[UsedRecordDetail](#usedrecorddetail)&gt; | No | Rejected access records. This parameter is valid only when **flag** is **FLAG_PERMISSION_USAGE_SUMMARY**. By default, 10 records are provided. |
## UsedRecordDetail ## UsedRecordDetail
...@@ -496,15 +585,15 @@ Represents the details of a single access record. ...@@ -496,15 +585,15 @@ Represents the details of a single access record.
## PermissionActiveStatus ## PermissionActiveStatus
Enumerates of permission usage statuses. Enumerates the permission usage statuses.
**System capability**: SystemCapability.Security.AccessToken **System capability**: SystemCapability.Security.AccessToken
| Name | Default Value| Description | | Name | Default Value| Description |
| ------------------------- | ------ | ---------------- | | ------------------------- | ------ | ---------------- |
| PERM_INACTIVE | 0 | The permission is not used. | | PERM_INACTIVE | 0 | The permission is not used. |
| PERM_ACTIVE_IN_FOREGROUND | 1 | The permission is being used in the foreground.| | PERM_ACTIVE_IN_FOREGROUND | 1 | The permission is being used by an application running in the foreground.|
| PERM_ACTIVE_IN_BACKGROUND | 2 | The permission is being used in the background.| | PERM_ACTIVE_IN_BACKGROUND | 2 | The permission is being used by an application running in the background.|
## ActiveChangeResponse ## ActiveChangeResponse
...@@ -514,7 +603,7 @@ Defines the detailed permission usage information. ...@@ -514,7 +603,7 @@ Defines the detailed permission usage information.
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| -------------- | ---------------------- | ---- | ---- | --------------------- | | -------------- | ---------------------- | ---- | ---- | --------------------- |
| tokenId | number | Yes | No | Token ID of the application that applies for the permission. | | tokenId | number | Yes | No | Token ID of the application. |
| permissionName | string | Yes | No | Name of the permission.| | permissionName | Permissions | Yes | No | Name of the permission.|
| deviceId | string | Yes | No | Device number. | | deviceId | string | Yes | No | Device ID. |
| activeStatus | [PermissionActiveStatus](#permissionactivestatus) | Yes | No | Permission usage status. | | activeStatus | [PermissionActiveStatus](#permissionactivestatus) | Yes | No | Permission usage status. |
en/application-dev/reference/errorcodes/errorcode-Access-token.md → en/application-dev/reference/errorcodes/errorcode-access-token.md
浏览文件 @ e8c2d83e
# Access Token Error Codes # Ability Access Control Error Codes
## 401 Parameter Error ## 12100001 Invalid Parameters
### Error Message **Error Message**
Parameter error.${messageInfo}.
### Possible Causes Parameter invalid, message is ${messageInfo}.
This error code is reported if an error occurs during JS parameter parsing. The possible causes are as follows:
1. The number of input parameters is insufficient.
2. The parameter type is incorrect.
### Solution **Possible Causes**
1. Add input parameters.
2. Correct parameter types.
This error code is reported if an error occurs during parameter verification. The possible causes are as follows:
- The value of **tokenId** is **0**.
- The permission name is empty or exceeds 256 characters.
- The **flag** value in the permission authorization or revocation request is invalid.
- The input parameters specified for registering a listener are incorrect.
## 201 Permission denied. **Solution**
### Error Message Correct the invalid parameter values.
Permission denied.${messageInfo}.
### Possible Causes
This error code is reported if the application process that calls an API is not granted the required permission. The possible causes are as follows:
1. The application process is not granted the required permission.
2. The permission requires user authorization to take effect, but the application process does not obtain the user authorization.
### Solution ## 12100002 TokenId Does Not Exist
1. Check whether the application process is granted the required permission.
2. Check whether the application process has obtained the user authorization if the permission requires user authorization to take effect.
**Error Message**
## 12100001 Invalid Parameters TokenId does not exist.
### Error Message **Possible Causes**
Parameter invalid, message is ${messageInfo}.
### Possible Causes - The specified **tokenId** does not exist.
This error code is reported if an error occurs during parameter verification. The possible causes are as follows: - The process of the specified **tokenId** is not an application process.
1. The value of **tokenId** is **0**.
2. The specified permission name is empty or contains more than 256 characters.
3. The **flag** value in the permission authorization or revocation request is invalid.
4. The input parameters specified for registering a listener are incorrect.
### Solution **Solution**
1. Correct the invalid parameter values.
Set **tokenId** correctly.
## 12100002 TokenId does not exist.
### Error Message ## 12100003 Permission Does Not Exist
TokenId does not exist.
### Possible Causes
1. The specified **tokenId** does not exist.
2. The process corresponding to the specified **tokenId** is not an application process.
### Solution **Error Message**
Set a correct **tokenId**, and make sure that the process corresponding to the specified **tokenId** is an application process.
Permission does not exist.
## 12100003 Permission Not Exist **Possible Causes**
### Error Message - The specified **permissionName** does not exist.
Permission does not exist. - The specified **permissionName** does not match the **tokenId** in the permission authorization or revocation scenario.
- The specified **permissionName** is not a sensitive permission that requires user authorization.
### Possible Causes **Solution**
1. The specified **permissionName** does not exist.
2. The specified **permissionName** does not match the specified **tokenId** in the permission authorization or revocation scenario.
3. The specified **permissionName** is not a sensitive permission that requires user authorization.
### Solution
Set the **permissionName** parameter correctly. For details, see [permission-list](../../security/permission-list.md). Set the **permissionName** parameter correctly. For details, see [permission-list](../../security/permission-list.md).
## 12100004 Listener APIs Not Used in Pairs ## 12100004 Listener APIs Not Used in Pairs
### Error Message **Error Message**
The listener interface is not used together.
The interface is not used together.
**Possible Causes**
### Possible Causes
This error code is reported if listener APIs are not used in pairs. The possible causes are as follows: This error code is reported if listener APIs are not used in pairs. The possible causes are as follows:
1. The listener APIs that need to be used in pairs are repeatedly called. 1. The listener APIs that need to be used in pairs are repeatedly called.
2. The listener APIs that need to be used in pairs are independently called. 2. The listener APIs that need to be used in pairs are independently called.
### Solution **Solution**
1. Check whether the API needs to be used in pairs. That is, if an API is called to enable listening, an API with the same input parameters cannot be called unless an API is called to stop listening first. 1. Check whether the API needs to be used in pairs. That is, if an API is called to enable listening, an API with the same input parameters cannot be called unless an API is called to stop listening first.
2. Check whether the API needs to be used in pairs. That is, an API for disabling listening or unregistering a listener can only be called after the API for enabling listening or registering a listener is called. 2. Check whether the API needs to be used in pairs. That is, an API for disabling listening or unregistering a listener can only be called after the API for enabling listening or registering a listener is called.
## 12100005 Listener Overflow ## 12100005 Listener Overflow
### Error Message **Error Message**
The number of listeners exceeds the limit. The number of listeners exceeds the limit.
### Possible Causes **Possible Causes**
The number of listeners exceeds 200 (the upper limit). The number of listeners exceeds 200 (the upper limit).
### Solution **Solution**
Abandon unused listeners in a timely manner.
Release unused listeners in a timely manner.
## 12100006 Permission Granting or Revocation Not Supported for the Specified Application ## 12100006 Permission Granting or Revocation Not Supported for the Specified Application
### Error Message **Error Message**
The specified application does not support the permissions granted or ungranted as specified. The specified application does not support the permissions granted or ungranted as specified.
### Possible Causes **Possible Causes**
1. The specified **tokenId** is the identity of the remote device. Distributed granting and revocation are not yet supported.
1. The specified **tokenId** is the identity of the remote device. Distributed permission granting and revocation are not yet supported.
2. The specified **tokenId** belongs to a sandbox application, which is not allowed to apply for the specified permission. 2. The specified **tokenId** belongs to a sandbox application, which is not allowed to apply for the specified permission.
### Solution **Solution**
1. Check whether the method of obtaining **tokenId** is correct. 1. Check whether the method of obtaining **tokenId** is correct.
2. Check whether the sandbox application works in restrictive mode. Most permissions cannot be granted to a sandbox application in restrictive mode. 2. Check whether the sandbox application works in restrictive mode. Most permissions cannot be granted to a sandbox application in restrictive mode.
## 12100007 System Services Not Working Properly ## 12100007 System Services Not Working Properly
### Error Message **Error Message**
Service is abnormal. Service is abnormal.
### Possible Causes **Possible Causes**
This error code is reported if system services are not working properly. The possible causes are as follows: This error code is reported if system services are not working properly. The possible causes are as follows:
1. The permission management service cannot be started properly. - The permission management service cannot start properly.
2. An error occurs while reading or writing IPC data. - The read or write of IPC data fails.
**Solution**
### Solution
System services do not work properly. Try again later or restart the device. System services do not work properly. Try again later or restart the device.
## 12100008 Out of Memory ## 12100008 Out of Memory
### Error Message **Error Message**
Out of memory. Out of memory.
### Possible Causes **Possible Causes**
The system memory is insufficient. The system memory is insufficient.
### Solution **Solution**
Try again later or restart the device. Try again later or restart the device.
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或