Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs
切换分支/标签
查找文件 普通视图历史永久链接Permalink
js-apis-security-accessToken.md 8.1 KB
Newer Older
L
update access_token apis  
l00520400 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 
#  	访问控制管理

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

## 导入模块

```
import abilityAccessCtrl from '@ohos.abilityAccessCtrl'
```

## 系统能力
SystemCapability.Security.AccessToken

## abilityAccessCtrl.createAtManager

createAtManager(): AtManager

访问控制管理：获取访问控制模块对象。

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | [AtManager](#atManager) | 获取访问控制模块的实例。 |

- 示例：
  ```
  var AtManager = abilityAccessCtrl.createAtManager();
  ```

## AtManager

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

### verifyAccessToken

verifyAccessToken(tokenID: number, permissionName: string): Promise<GrantStatus>

校验应用是否授予权限，使用Promise方式异步返回结果。

- 参数：

  | 参数名   | 类型                 | 必填 | 说明                                       |
  | -------- | -------------------  | ---- | ------------------------------------------ |
  | tokenID   |  number   | 是   | 要校验的目标应用的身份标识。              |
  | permissionName | string | 是   | 需要校验的权限名称。 |

- 返回值：

  | 类型          | 说明                                |
  | :------------ | :---------------------------------- |
  | Promise<GrantStatus> | Promise实例，用于获取异步返回的授权状态结果。 |

- 示例：

  ```
  const AtManager = abilityAccessCtrl.createAtManager();
  let tokenID = 0;
  let promise = AtManager.verifyAccessToken(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS");
  promise.then(data => {
      console.log(`promise: data->${JSON.stringify(data)}`);
  });
  ```

### grantUserGrantedPermission

grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number): Promise<number>

授予应用user grant权限，使用Promise方式异步返回结果。

需要权限：ohos.permission.GRANT_SENSITIVE_PERMISSIONS。

- 参数：

  | 参数名    | 类型                | 必填 | 说明                                                         |
  | --------- | ------------------- | ---- | ------------------------------------------------------------ |
  | tokenID      | number              | 是   | 目标应用的身份标识。            |
  | permissionName | string              | 是   | 被授予的权限名称。 |
  | permissionFlag  | number | 是   | 授权选项，1表示下次仍需弹窗，2表示允许、禁止后不再提醒，3表示系统授权不允许更改。  |

- 返回值：

  | 类型          | 说明                                |
  | :------------ | :---------------------------------- |
  | Promise<number> | Promise实例，用于获取异步返回的授权操作结果。 |
- 示例：

  ```
  const AtManager = abilityAccessCtrl.createAtManager();
  let tokenID = 0;
  let promise = AtManager.grantUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS");
  promise.then(data => {
      console.log(`promise: data->${JSON.stringify(data)}`);
  });
  ```



### grantUserGrantedPermission

grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number, callback: AsyncCallback<number>): void

授予应用user grant权限，使用callback回调异步返回结果。

需要权限：ohos.permission.GRANT_SENSITIVE_PERMISSIONS。

- 参数：

  | 参数名    | 类型                | 必填 | 说明                          |
  | --------- | ------------------- | ---- | ------------------------------------------------------------ |
  | tokenID      | number              | 是   | 目标应用的身份标识。           |
  | permissionName | string              | 是   | 被授予的权限名称。 |
  | permissionFlag  | number | 是   | 授权选项，1表示下次仍需弹窗，2表示允许、禁止后不再提醒，3表示系统授权不允许更改。  |
  | callback | AsyncCallback<number> | 是 | 检查授予应用user grant权限的操作结果同步的回调。 |

- 示例：

  ```
  const AtManager = abilityAccessCtrl.createAtManager();
  let tokenID = 0;
  let permissionFlag = 1;
  AtManager.grantUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS",permissionFlag, data => {
      console.log(`callback: data->${JSON.stringify(data)}`);
  });
  ```

### revokeUserGrantedPermission

revokeUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number): Promise<number>

撤销应用user grant权限，使用Promise方式异步返回结果。

需要权限：ohos.permission.REVOKE_SENSITIVE_PERMISSIONS。

- 参数：

  | 参数名    | 类型                | 必填 | 说明                                                         |
  | --------- | ------------------- | ---- | ------------------------------------------------------------ |
  | tokenID      | number              | 是   | 目标应用的身份标识。            |
  | permissionName | string              | 是   | 被撤销的权限名称。 |
  | permissionFlag  | number | 是   | 授权选项，1表示下次仍需弹窗，2表示允许、禁止后不再提醒，3表示系统授权不允许更改。  |

- 返回值：

  | 类型          | 说明                                |
  | :------------ | :---------------------------------- |
  | Promise<number> | Promise实例，用于获取异步返回的授权操作结果。 |

- 示例：

  ```
  const AtManager = abilityAccessCtrl.createAtManager();
  let tokenID = 0;
  let permissionFlag = 1;
  let promise = AtManager.revokeUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS", permissionFlag);
  promise.then(data => {
      console.log(`promise: data->${JSON.stringify(data)}`);
  });
  ```

### revokeUserGrantedPermission

revokeUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number, callback: AsyncCallback<number>): void

撤销应用user grant权限，使用callback回调异步返回结果。

需要权限：ohos.permission.REVOKE_SENSITIVE_PERMISSIONS。

- 参数：

  | 参数名    | 类型                | 必填 | 说明                          |
  | --------- | ------------------- | ---- | ------------------------------------------------------------ |
  | tokenID      | number              | 是   | 目标应用的身份标识。            |
  | permissionName | string              | 是   | 被撤销的权限名称。 |
  | permissionFlag  | number | 是   | 授权选项，1表示下次仍需弹窗，2表示允许、禁止后不再提醒，3表示系统授权不允许更改。  |
  | callback | AsyncCallback<number> | 是 | 检查撤销应用user grant权限的操作结果同步的回调。 |

- 示例：

  ```
  const AtManager = abilityAccessCtrl.createAtManager();
  let tokenID = 0;
  AtManager.revokeUserGrantedPermission(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS",permissionFlag, data => {
      console.log(`callback: data->${JSON.stringify(data)}`);
  });
  ```

### getPermissionFlags

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

获取指定应用的指定权限的flag，使用Promise方式异步返回结果。

- 参数：

  | 参数名    | 类型                | 必填 | 说明                          |
  | --------- | ------------------- | ---- | ------------------------------------------------------------ |
  | tokenID      | number              | 是   | 目标应用的身份标识。            |
  | permissionName | string              | 是   | 查询的权限名称。 |

- 返回值：

  | 类型          | 说明                                |
  | :------------ | :---------------------------------- |
  | Promise<number> | Promise实例，用于获取异步返回的查询结果。 |

- 示例：

  ```
  const AtManager = abilityAccessCtrl.createAtManager();
  let tokenID = 0;
  let promise = AtManager.getPermissionFlags(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS");
  promise.then(data => {
      console.log(`promise: data->${JSON.stringify(data)}`);
  });
  ```