js-apis-osAccount.md 226.1 KB
Newer Older
1
# @ohos.account.osAccount (系统帐号管理)
Z
zhangalong 已提交
2

J
jidong 已提交
3
本模块提供管理系统帐号的基础能力,包括系统帐号的添加、删除、查询、设置、订阅、启动等功能。
L
lichenchen 已提交
4

5 6
> **说明:**
>
Z
zhangalong 已提交
7 8 9 10 11
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

Z
zhangalong 已提交
12
```js
Z
zhangalong 已提交
13 14 15 16 17 18 19
import account_osAccount from '@ohos.account.osAccount';
```

## account_osAccount.getAccountManager

getAccountManager(): AccountManager

J
jidong 已提交
20
获取系统帐号管理对象。
Z
zhangalong 已提交
21

Z
zengyawen 已提交
22
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
23

Z
zengyawen 已提交
24
**返回值:**
25

J
jidong 已提交
26 27 28
| 类型                              | 说明              |
| --------------------------------- | ---------------- |
| [AccountManager](#accountmanager) | 系统帐号管理对象。 |
Z
zengyawen 已提交
29

30
**示例:**
Z
zhangalong 已提交
31
  ```js
F
fanchenxuan 已提交
32
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
33 34 35
  ```

## OsAccountType
Z
zengyawen 已提交
36

J
jidong 已提交
37
表示系统帐号类型的枚举。
Z
zengyawen 已提交
38

J
jidong 已提交
39
**系统能力:** SystemCapability.Account.OsAccount。
Z
zengyawen 已提交
40

41
| 名称   | 值 | 说明         |
J
jidong 已提交
42
| ------ | ------ | ----------- |
Z
zengyawen 已提交
43 44 45
| ADMIN  | 0      | 管理员帐号。 |
| NORMAL | 1      | 普通帐号。   |
| GUEST  | 2      | 访客帐号。   |
Z
zhangalong 已提交
46 47 48

## AccountManager

J
jidong 已提交
49
系统帐号管理类。
Z
zhangalong 已提交
50 51 52 53 54

### activateOsAccount

activateOsAccount(localId: number, callback: AsyncCallback<void>): void

J
jidong 已提交
55
激活指定系统帐号。使用callback异步回调。
Z
zhangalong 已提交
56

J
jidong 已提交
57
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
58

Z
zhangalong 已提交
59 60
**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

Z
zengyawen 已提交
61
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
62

Z
zengyawen 已提交
63
**参数:**
Z
zhangalong 已提交
64

J
jidong 已提交
65 66 67 68 69 70 71 72 73
| 参数名   | 类型                       | 必填 | 说明                                                |
| -------- | ------------------------- | ---- | -------------------------------------------------- |
| localId  | number                    | 是   | 系统帐号ID。                  |
| callback | AsyncCallback<void> | 是   | 回调函数。当帐号激活成功时,err为null,否则为错误对象。 |

**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
74
| 12300001 | System service exception. |
J
jidong 已提交
75
| 12300002 | Invalid localId.    |
J
jidong 已提交
76 77 78
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
| 12300009 | Account has been activated. |
Z
zengyawen 已提交
79

80
**示例:** 激活ID为100的系统帐号
Z
zhangalong 已提交
81
  ```js
F
fanchenxuan 已提交
82 83
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
84 85
  try {
    accountManager.activateOsAccount(localId, (err)=>{
J
jidong 已提交
86
      if (err) {
87
        console.error(`activateOsAccount failed, code is ${err.code}, message is ${err.message}`);
J
jidong 已提交
88 89 90
      } else {
        console.log("activateOsAccount successfully");
      }
91
    });
J
jidong 已提交
92
  } catch (err) {
93
    console.error(`activateOsAccount failed, code is ${err.code}, message is ${err.message}`);
94
  }
Z
zhangalong 已提交
95 96 97 98 99 100
  ```

### activateOsAccount

activateOsAccount(localId: number): Promise<void>

J
jidong 已提交
101
激活指定系统帐号。使用Promise异步回调。
Z
zhangalong 已提交
102

J
jidong 已提交
103
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
104

Z
zhangalong 已提交
105 106
**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

Z
zengyawen 已提交
107
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
108

Z
zengyawen 已提交
109
**参数:**
Z
zhangalong 已提交
110

Z
zengyawen 已提交
111 112
| 参数名  | 类型   | 必填 | 说明                 |
| ------- | ------ | ---- | -------------------- |
J
jidong 已提交
113
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
114

Z
zengyawen 已提交
115
**返回值:**
Z
zhangalong 已提交
116

J
jidong 已提交
117
| 类型                | 说明                                  |
J
jidong 已提交
118
| ------------------- | ------------------------------------ |
A
Annie_wang 已提交
119
| Promise<void> | Promise对象,无返回结果的Promise对象。 |
J
jidong 已提交
120 121 122 123 124

**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
125
| 12300001 | System service exception. |
J
jidong 已提交
126
| 12300002 | Invalid localId.    |
J
jidong 已提交
127 128 129
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
| 12300009 | Account has been activated. |
Z
zengyawen 已提交
130

131
**示例:** 激活ID为100的系统帐号
Z
zhangalong 已提交
132
  ```js
F
fanchenxuan 已提交
133 134
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
135 136
  try {
    accountManager.activateOsAccount(localId).then(() => {
J
jidong 已提交
137
      console.log('activateOsAccount successfully');
138
    }).catch((err) => {
J
jidong 已提交
139
      console.log('activateOsAccount failed, err:' + JSON.stringify(err));
140 141 142 143 144 145
    });
  } catch (e) {
    console.log('activateOsAccount exception:' + JSON.stringify(e));
  }
  ```

J
jidong 已提交
146
### checkMultiOsAccountEnabled<sup>9+</sup>
147

J
jidong 已提交
148
checkMultiOsAccountEnabled(callback: AsyncCallback&lt;boolean&gt;): void
149

J
jidong 已提交
150
判断是否支持多系统帐号。使用callback异步回调。
151 152 153 154 155

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
156 157 158
| 参数名   | 类型                         | 必填 | 说明                                                     |
| -------- | ---------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示支持多系统帐号;返回false表示不支持。 |
159

J
jidong 已提交
160 161 162 163 164 165
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

166 167 168 169 170
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
171
    accountManager.checkMultiOsAccountEnabled((err, isEnabled) => {
J
jidong 已提交
172
      if (err) {
173
        console.error(`checkMultiOsAccountEnabled failed, code is ${err.code}, message is ${err.message}`);
J
jidong 已提交
174 175 176
      } else {
      console.log("checkMultiOsAccountEnabled successfully, isEnabled: " + isEnabled);
      }
177
    });
J
jidong 已提交
178
  } catch (err) {
179
    console.error(`checkMultiOsAccountEnabled failed, code is ${err.code}, message is ${err.message}`);
180
  }
Z
zhangalong 已提交
181 182
  ```

J
jidong 已提交
183
### checkMultiOsAccountEnabled<sup>9+</sup>
184

J
jidong 已提交
185
checkMultiOsAccountEnabled(): Promise&lt;boolean&gt;
186

J
jidong 已提交
187
判断是否支持多系统帐号。使用Promise异步回调。
188 189 190 191 192

**系统能力:** SystemCapability.Account.OsAccount

**返回值:**

J
jidong 已提交
193 194 195
| 类型                   | 说明                                                        |
| :--------------------- | :--------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示支持多系统帐号;返回false表示不支持。 |
196

J
jidong 已提交
197 198 199 200 201 202
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

203 204 205 206 207
**示例:**

  ```js
  try {
    let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
208 209
    accountManager.checkMultiOsAccountEnabled().then((isEnabled) => {
      console.log('checkMultiOsAccountEnabled successfully, isEnabled: ' + isEnabled);
210
    }).catch((err) => {
211
      console.error(`checkMultiOsAccountEnabled failed, code is ${err.code}, message is ${err.message}`);
212
    });
J
jidong 已提交
213
  } catch (err) {
214
    console.error(`checkMultiOsAccountEnabled failed, code is ${err.code}, message is ${err.message}`);
215 216 217
  }
  ```

J
jidong 已提交
218
### checkOsAccountActivated<sup>9+</sup>
Z
zhangalong 已提交
219

J
jidong 已提交
220
checkOsAccountActivated(localId: number, callback: AsyncCallback&lt;boolean&gt;): void
Z
zhangalong 已提交
221

J
jidong 已提交
222
判断指定系统帐号是否处于激活状态。使用callback异步回调。
Z
zhangalong 已提交
223

J
jidong 已提交
224
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
225

Z
zengyawen 已提交
226 227 228
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
229

J
jidong 已提交
230 231 232 233
| 参数名   | 类型                         | 必填 | 说明                                                     |
| -------- | ---------------------------- | ---- | ------------------------------------------------------ |
| localId  | number                       | 是   | 系统帐号ID。                                             |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示帐号已激活;返回false表示帐号未激活。 |
Z
zhangalong 已提交
234

J
jidong 已提交
235 236 237 238
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
239
| 12300001 | System service exception. |
J
jidong 已提交
240
| 12300002 | Invalid localId.    |
J
jidong 已提交
241
| 12300003 | Account not found. |
J
jidong 已提交
242 243

**示例:** 判断ID为100的系统帐号是否处于激活状态
Z
zhangalong 已提交
244

Z
zhangalong 已提交
245
  ```js
F
fanchenxuan 已提交
246
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
247
  let localId = 100;
J
jidong 已提交
248
  try {
J
jidong 已提交
249
    accountManager.checkOsAccountActivated(localId, (err, isActivated) => {
J
jidong 已提交
250 251 252 253 254 255 256 257 258
      if (err) {
        console.log('checkOsAccountActivated failed, error:' + JSON.stringify(err));
      } else {
        console.log('checkOsAccountActivated successfully, isActivated:' + isActivated);
      }
    });
  } catch (err) {
    console.log('checkOsAccountActivated exception:' + JSON.stringify(err));
  }
Z
zhangalong 已提交
259 260
  ```

J
jidong 已提交
261
### checkOsAccountActivated<sup>9+</sup>
Z
zhangalong 已提交
262

J
jidong 已提交
263
checkOsAccountActivated(localId: number): Promise&lt;boolean&gt;
Z
zhangalong 已提交
264

J
jidong 已提交
265
判断指定系统帐号是否处于激活状态。使用Promise异步回调。
Z
zhangalong 已提交
266

J
jidong 已提交
267
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
268

Z
zengyawen 已提交
269
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
270

J
jidong 已提交
271 272 273 274 275 276
**参数:**

| 参数名  | 类型   | 必填 | 说明                               |
| ------- | ------ | ---- | --------------------------------- |
| localId | number | 是   | 系统帐号ID。 |

Z
zengyawen 已提交
277
**返回值:**
Z
zhangalong 已提交
278

J
jidong 已提交
279 280 281
| 类型                   | 说明                                                       |
| ---------------------- | ---------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示帐号已激活;返回false表示帐号未激活。 |
Z
zengyawen 已提交
282

J
jidong 已提交
283 284 285 286
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
287
| 12300001 | System service exception. |
J
jidong 已提交
288
| 12300002 | Invalid localId.    |
J
jidong 已提交
289
| 12300003 | Account not found. |
J
jidong 已提交
290 291

**示例:** 判断ID为100的系统帐号是否处于激活状态
Z
zhangalong 已提交
292

Z
zhangalong 已提交
293
  ```js
F
fanchenxuan 已提交
294
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
295 296 297 298 299 300 301 302 303 304
  let localId = 100;
  try {
    accountManager.checkOsAccountActivated(localId).then((isActivated) => {
      console.log('checkOsAccountActivated successfully, isActivated: ' + isActivated);
    }).catch((err) => {
      console.log('checkOsAccountActivated failed, error: '  + JSON.stringify(err));
    });
  } catch (err) {
    console.log('checkOsAccountActivated exception:' + JSON.stringify(err));
  }
Z
zhangalong 已提交
305 306
  ```

C
cclicn 已提交
307
### checkOsAccountConstraintEnabled<sup>9+</sup>
308

C
cclicn 已提交
309
checkOsAccountConstraintEnabled(localId: number, constraint: string, callback: AsyncCallback&lt;boolean&gt;): void
310

J
jidong 已提交
311
判断指定系统帐号是否具有指定约束。使用callback异步回调。
312

C
cclicn 已提交
313
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
314 315 316 317 318

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
319 320 321 322 323
| 参数名     | 类型                         | 必填 | 说明                                                               |
| ---------- | ---------------------------- | ---- | ----------------------------------------------------------------- |
| localId    | number                       | 是   | 系统帐号ID。                                 |
| constraint | string                       | 是   | 指定的[约束](#系统帐号约束列表)名称。                                |
| callback   | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示已使能指定的约束;返回false表示未使能指定的约束。 |
324

J
jidong 已提交
325 326 327 328
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
329 330 331
| 12300001 | System service exception. |
| 12300002 | Invalid localId or constraint.    |
| 12300003 | Account not found. |
J
jidong 已提交
332 333

**示例:** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
334 335 336

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
337 338
  let localId = 100;
  let constraint = "constraint.wifi";
339
  try {
C
cclicn 已提交
340
    accountManager.checkOsAccountConstraintEnabled(localId, constraint, (err, isEnabled)=>{
J
jidong 已提交
341
      if (err) {
C
cclicn 已提交
342
        console.log("checkOsAccountConstraintEnabled failed, error: " + JSON.stringify(err));
J
jidong 已提交
343
      } else {
C
cclicn 已提交
344
        console.log("checkOsAccountConstraintEnabled successfully, isEnabled: " + isEnabled);
J
jidong 已提交
345
      }
346
    });
J
jidong 已提交
347
  } catch (err) {
C
cclicn 已提交
348
    console.log("checkOsAccountConstraintEnabled exception: " + JSON.stringify(err));
349 350 351
  }
  ```

C
cclicn 已提交
352
### checkOsAccountConstraintEnabled<sup>9+</sup>
353

C
cclicn 已提交
354
checkOsAccountConstraintEnabled(localId: number, constraint: string): Promise&lt;boolean&gt;
355

J
jidong 已提交
356
判断指定系统帐号是否具有指定约束。使用Promise异步回调。
357

C
cclicn 已提交
358
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
359 360 361 362 363

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
364 365 366 367
| 参数名     | 类型   | 必填 | 说明                                |
| ---------- | ------ | ---- | ---------------------------------- |
| localId    | number | 是   | 系统帐号ID。  |
| constraint | string | 是   | 指定的[约束](#系统帐号约束列表)名称。 |
368 369 370

**返回值:**

J
jidong 已提交
371 372 373
| 类型                   | 说明                                                                  |
| --------------------- | --------------------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示已使能指定的约束;返回false表示未使能指定的约束。 |
374

J
jidong 已提交
375 376 377 378
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
379 380 381
| 12300001 | System service exception. |
| 12300002 | Invalid localId or constraint.    |
| 12300003 | Account not found. |
J
jidong 已提交
382 383

**示例:** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
384 385 386

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
387 388
  let localId = 100;
  let constraint = "constraint.wifi";
389
  try {
C
cclicn 已提交
390 391
    accountManager.checkOsAccountConstraintEnabled(localId, constraint).then((isEnabled) => {
      console.log("checkOsAccountConstraintEnabled successfully, isEnabled: " + isEnabled);
392
    }).catch((err) => {
C
cclicn 已提交
393
      console.log("checkOsAccountConstraintEnabled failed, error: "  + JSON.stringify(err));
394
    });
J
jidong 已提交
395
  } catch (err) {
C
cclicn 已提交
396
    console.log("checkOsAccountConstraintEnabled exception: " + JSON.stringify(err));
397 398 399
  }
  ```

J
jidong 已提交
400
### checkOsAccountTestable<sup>9+</sup>
Z
zhangalong 已提交
401

J
jidong 已提交
402
checkOsAccountTestable(callback: AsyncCallback&lt;boolean&gt;): void
403

J
jidong 已提交
404
检查当前系统帐号是否为测试帐号。使用callback异步回调。
Z
zengyawen 已提交
405 406

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
407

Z
zengyawen 已提交
408
**参数:**
Z
zhangalong 已提交
409

J
jidong 已提交
410 411 412
| 参数名   | 类型                         | 必填 | 说明                                                                   |
| -------- | ---------------------------- | ---- | --------------------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示当前帐号为测试帐号;返回false表示当前帐号非测试帐号。 |
Z
zengyawen 已提交
413

J
jidong 已提交
414 415 416 417
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
418
| 12300001 | System service exception. |
J
jidong 已提交
419 420

**示例:**
Z
zhangalong 已提交
421

Z
zhangalong 已提交
422
  ```js
F
fanchenxuan 已提交
423
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
424 425 426 427 428 429 430 431 432 433 434
  try {
    accountManager.checkOsAccountTestable((err, isTestable) => {
      if (err) {
        console.log("checkOsAccountTestable failed, error: " + JSON.stringify(err));
      } else {
        console.log("checkOsAccountTestable successfully, isTestable: " + isTestable);
      }
    });
  } catch (err) {
    console.log("checkOsAccountTestable error: " + JSON.stringify(err));
  }
Z
zhangalong 已提交
435 436
  ```

J
jidong 已提交
437
### checkOsAccountTestable<sup>9+</sup>
Z
zhangalong 已提交
438

J
jidong 已提交
439
checkOsAccountTestable(): Promise&lt;boolean&gt;
Z
zhangalong 已提交
440

J
jidong 已提交
441
检查当前系统帐号是否为测试帐号。使用Promise异步回调。
Z
zhangalong 已提交
442

J
jidong 已提交
443 444 445 446 447 448 449 450 451 452 453 454
**系统能力:** SystemCapability.Account.OsAccount

**返回值:**

| 类型                   | 说明                                                                      |
| ---------------------- | ------------------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise对象。返回true表示当前帐号为测试帐号;返回false表示当前帐号非测试帐号。 |

**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
455
| 12300001 | System service exception. |
J
jidong 已提交
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
    accountManager.checkOsAccountTestable().then((isTestable) => {
      console.log("checkOsAccountTestable successfully, isTestable: " + isTestable);
    }).catch((err) => {
      console.log("checkOsAccountTestable failed, error: "  + JSON.stringify(err));
    });
  } catch (err) {
    console.log('checkOsAccountTestable exception: ' + JSON.stringify(err));
  }
  ```

### checkOsAccountVerified<sup>9+</sup>

checkOsAccountVerified(callback: AsyncCallback&lt;boolean&gt;): void

检查当前系统帐号是否已验证。使用callback异步回调。
477

Z
zengyawen 已提交
478 479 480
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
481

J
jidong 已提交
482 483 484
| 参数名   | 类型                         | 必填 | 说明                                                            |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示当前帐号已验证;返回false表示当前帐号未验证。 |
Z
zhangalong 已提交
485

J
jidong 已提交
486
**错误码:**
Z
zhangalong 已提交
487

J
jidong 已提交
488 489
| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
490
| 12300001 | System service exception. |
Z
zhangalong 已提交
491

J
jidong 已提交
492
**示例:**
Z
zhangalong 已提交
493

Z
zhangalong 已提交
494
  ```js
F
fanchenxuan 已提交
495
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
496 497 498 499 500 501 502 503 504 505 506
  try {
    accountManager.checkOsAccountVerified((err, isVerified) => {
      if (err) {
        console.log("checkOsAccountVerified failed, error: " + JSON.stringify(err));
      } else {
        console.log("checkOsAccountVerified successfully, isVerified: " + isVerified);
      }
    });
  } catch (err) {
    console.log("checkOsAccountVerified exception: " + JSON.stringify(err));
  }
Z
zhangalong 已提交
507 508
  ```

J
jidong 已提交
509
### checkOsAccountVerified<sup>9+</sup>
510

J
jidong 已提交
511
checkOsAccountVerified(localId: number, callback: AsyncCallback&lt;boolean&gt;): void
512

J
jidong 已提交
513
检查指定系统帐号是否已验证。使用callback异步回调。
514

J
jidong 已提交
515
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
516 517 518 519 520

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
521 522
| 参数名   | 类型                         | 必填 | 说明                                                            |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------- |
523
| localId  | number                       | 是   | 系统帐号ID。                              |
J
jidong 已提交
524
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示指定帐号已验证;返回false表示指定帐号未验证。 |
525

J
jidong 已提交
526 527 528 529
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
530 531 532
| 12300001 | System service exception. |
| 12300002 | Invalid localId.    |
| 12300003 | Account not found. |
J
jidong 已提交
533 534

**示例:**
535 536 537 538 539

  ```js
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  try {
J
jidong 已提交
540
    accountManager.checkOsAccountVerified(localId, (err, isVerified) => {
J
jidong 已提交
541 542 543 544 545
      if (err) {
        console.log("checkOsAccountVerified failed, error: " + JSON.stringify(err));
      } else {
        console.log("checkOsAccountVerified successfully, isVerified: " + isVerified);
      }
546
    });
J
jidong 已提交
547 548
  } catch (err) {
    console.log("checkOsAccountVerified exception: " + err);
549 550 551
  }
  ```

J
jidong 已提交
552
### checkOsAccountVerified<sup>9+</sup>
553

Z
zhouyan 已提交
554
checkOsAccountVerified(localId: number): Promise&lt;boolean&gt;
555

J
jidong 已提交
556
检查指定系统帐号是否已验证。使用Promise异步回调。
557

J
jidong 已提交
558
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
559 560 561 562 563

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
564 565
| 参数名  | 类型   | 必填 | 说明                                                              |
| ------- | ------ | ---- | --------------------------------------------------------------- |
Z
zhouyan 已提交
566
| localId | number | 是   | 系统帐号ID。不填则检查当前系统帐号是否已验证。 |
567 568 569

**返回值:**

J
jidong 已提交
570 571 572
| 类型                   | 说明                                                               |
| ---------------------- | ----------------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示指定帐号已验证;返回false表示指定帐号未验证。 |
573

J
jidong 已提交
574 575 576 577
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
578 579 580
| 12300001 | System service exception. |
| 12300002 | Invalid localId.    |
| 12300003 | Account not found. |
J
jidong 已提交
581 582

**示例:**
583 584 585 586 587

  ```js
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  try {
J
jidong 已提交
588 589
    accountManager.checkOsAccountVerified(localId).then((isVerified) => {
      console.log("checkOsAccountVerified successfully, isVerified: " + isVerified);
590
    }).catch((err) => {
J
jidong 已提交
591
      console.log("checkOsAccountVerified failed, error: " + JSON.stringify(err));
592
    });
J
jidong 已提交
593
  } catch (err) {
J
jidong 已提交
594
    console.log('checkOsAccountVerified exception: ' + JSON.stringify(err));
595 596 597
  }
  ```

J
jidong 已提交
598
### removeOsAccount
Z
zhangalong 已提交
599

J
jidong 已提交
600
removeOsAccount(localId: number, callback: AsyncCallback&lt;void&gt;): void
Z
zhangalong 已提交
601

J
jidong 已提交
602
删除指定系统帐号。使用callback异步回调。
Z
zhangalong 已提交
603

J
jidong 已提交
604
**系统接口:** 此接口为系统接口。
605

Z
zengyawen 已提交
606
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zhangalong 已提交
607

Z
zengyawen 已提交
608
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
609

Z
zengyawen 已提交
610 611
**参数:**

J
jidong 已提交
612 613 614 615
| 参数名   | 类型                      | 必填 | 说明                                                 |
| -------- | ------------------------- | ---- | -------------------------------------------------- |
| localId  | number                    | 是   | 系统帐号ID。                  |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。如果删除帐号成功,err为null,否则为错误对象。 |
Z
zengyawen 已提交
616

J
jidong 已提交
617 618 619 620
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
621
| 12300001 | System service exception. |
J
jidong 已提交
622
| 12300002 | Invalid localId.    |
J
jidong 已提交
623 624
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
625 626

**示例:**
Z
zhangalong 已提交
627

Z
zhangalong 已提交
628
  ```js
F
fanchenxuan 已提交
629
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
630 631 632 633 634 635 636 637 638 639 640 641 642 643
  let accountName = "testAccountName";
  try {
    accountManager.createOsAccount(accountName, account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo) => {
      accountManager.removeOsAccount(osAccountInfo.localId, (err)=>{
        if (err) {
          console.log("removeOsAccount failed, error: " + JSON.stringify(err));
        } else {
          console.log("removeOsAccount successfully");
        }
      });
    });
  } catch (err) {
    console.log('removeOsAccount exception:' + JSON.stringify(err));
  }
Z
zhangalong 已提交
644 645
  ```

J
jidong 已提交
646
### removeOsAccount
Z
zhangalong 已提交
647

J
jidong 已提交
648
removeOsAccount(localId: number): Promise&lt;void&gt;
Z
zhangalong 已提交
649

J
jidong 已提交
650
删除指定系统帐号。使用Promise异步回调。
Z
zengyawen 已提交
651

J
jidong 已提交
652
**系统接口:** 此接口为系统接口。
653

Z
zengyawen 已提交
654 655 656
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
657

Z
zengyawen 已提交
658
**参数:**
Z
zhangalong 已提交
659

J
jidong 已提交
660 661 662
| 参数名  | 类型   | 必填 | 说明                               |
| ------- | ------ | ---- | --------------------------------- |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
663

Z
zengyawen 已提交
664
**返回值:**
Z
zhangalong 已提交
665

J
jidong 已提交
666 667
| 类型                | 说明                                  |
| ------------------- | ------------------------------------ |
A
Annie_wang 已提交
668
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
Z
zhangalong 已提交
669

J
jidong 已提交
670 671 672 673
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
674
| 12300001 | System service exception. |
J
jidong 已提交
675
| 12300002 | Invalid localId.    |
J
jidong 已提交
676 677
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
678 679

**示例:**
Z
zhangalong 已提交
680

Z
zhangalong 已提交
681
  ```js
F
fanchenxuan 已提交
682
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
683 684 685 686 687 688 689 690 691 692 693 694
  let accountName = "testAccountName";
  try {
    accountManager.createOsAccount(accountName, account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{
      accountManager.removeOsAccount(osAccountInfo.localId).then(() => {
        console.log("removeOsAccount successfully");
      }).catch((err) => {
          console.log("removeOsAccount failed, error: " + JSON.stringify(err));
      });
    });
  } catch (err) {
    console.log("removeOsAccount exception: " + JSON.stringify(err));
  }
Z
zhangalong 已提交
695 696
  ```

J
jidong 已提交
697 698 699 700 701
### setOsAccountConstraints

setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enable: boolean,callback: AsyncCallback&lt;void&gt;): void

为指定系统帐号设置/删除约束。使用callback异步回调。
702

J
jidong 已提交
703
**系统接口:** 此接口为系统接口。
704

J
jidong 已提交
705
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
706 707 708 709 710

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
711 712 713 714 715 716
| 参数名      | 类型                      | 必填 | 说明                                             |
| ----------- | ------------------------- | ---- | ----------------------------------------------- |
| localId     | number                    | 是   | 系统帐号ID。               |
| constraints | Array&lt;string&gt;       | 是   | 待设置/删除的[约束](#系统帐号约束列表)列表。        |
| enable      | boolean                   | 是   | 设置(true)/删除(false)                           |
| callback    | AsyncCallback&lt;void&gt; | 是   | 回调函数。如果设置成功,err为null,否则为错误对象。 |
717

J
jidong 已提交
718 719 720 721
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
722
| 12300001 | System service exception. |
C
chennian 已提交
723
| 12300002 | Invalid localId or constraints.    |
J
jidong 已提交
724 725
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
726 727

**示例:** 给ID为100的系统帐号设置禁止使用Wi-Fi的约束
728 729 730

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
731 732
  let localId = 100;
  let constraint = "constraint.wifi";
733
  try {
J
jidong 已提交
734 735 736 737 738 739
    accountManager.setOsAccountConstraints(localId, [constraint], true, (err) => {
      if (err) {
        console.log("setOsAccountConstraints failed, error:" + JSON.stringify(err));
      } else {
        console.log("setOsAccountConstraints successfully");
      }
740
    });
J
jidong 已提交
741 742
  } catch (err) {
    console.log("setOsAccountConstraints exception: " + JSON.stringify(err));
743 744 745
  }
  ```

J
jidong 已提交
746 747 748 749 750
### setOsAccountConstraints

setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enable: boolean): Promise&lt;void&gt;

为指定系统帐号设置/删除约束。使用Promise异步回调。
751

J
jidong 已提交
752
**系统接口:** 此接口为系统接口。
753

J
jidong 已提交
754
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
755 756 757

**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
758 759 760 761 762 763 764 765
**参数:**

| 参数名      | 类型                | 必填 | 说明                                         |
| ----------- | ------------------- | ---- | -------------------------------------------- |
| localId     | number              | 是   | 系统帐号ID。           |
| constraints | Array&lt;string&gt; | 是   | 待设置/删除的[约束](#系统帐号约束列表)列表。    |
| enable      | boolean             | 是   | 设置(true)/删除(false)。                     |

766 767
**返回值:**

J
jidong 已提交
768 769
| 类型                | 说明                                 |
| :------------------ | :----------------------------------- |
A
Annie_wang 已提交
770
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
771

J
jidong 已提交
772 773 774 775
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
776
| 12300001 | System service exception. |
C
chennian 已提交
777
| 12300002 | Invalid localId or constraints.    |
J
jidong 已提交
778 779
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
780 781

**示例:** 删除ID为100的系统帐号的禁止使用Wi-Fi的约束
782 783 784

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
785
  let localId = 100;
786
  try {
J
jidong 已提交
787 788
    accountManager.setOsAccountConstraints(localId, ['constraint.location.set'], false).then(() => {
      console.log('setOsAccountConstraints succsuccessfully');
789
    }).catch((err) => {
J
jidong 已提交
790
      console.log('setOsAccountConstraints failed, error: '  + JSON.stringify(err));
791
    });
J
jidong 已提交
792 793
  } catch (err) {
    console.log('setOsAccountConstraints exception:' + JSON.stringify(err));
794 795 796
  }
  ```

J
jidong 已提交
797
### setOsAccountName
Z
zhangalong 已提交
798

J
jidong 已提交
799
setOsAccountName(localId: number, localName: string, callback: AsyncCallback&lt;void&gt;): void
Z
zhangalong 已提交
800

J
jidong 已提交
801
设置指定系统帐号的帐号名。使用callback异步回调。
Z
zhangalong 已提交
802

J
jidong 已提交
803 804 805
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
806

Z
zengyawen 已提交
807
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
808

Z
zengyawen 已提交
809
**参数:**
Z
zhangalong 已提交
810

J
jidong 已提交
811 812 813
| 参数名    | 类型                      | 必填 | 说明                                             |
| :-------- | ------------------------- | ---- | ----------------------------------------------- |
| localId   | number                    | 是   | 系统帐号ID。               |
J
jidong 已提交
814
| localName | string                    | 是   | 帐号名,最大长度为1024个字符。                          |
J
jidong 已提交
815
| callback  | AsyncCallback&lt;void&gt; | 是   | 回调函数。如果设置成功,err为null,否则为错误对象。 |
Z
zengyawen 已提交
816

J
jidong 已提交
817 818 819 820
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
821 822 823 824
| 12300001 | System service exception. |
| 12300002 | Invalid localId or localName. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
825 826

**示例:** 将ID为100的系统帐号的帐号名设置成demoName
Z
zhangalong 已提交
827

Z
zhangalong 已提交
828
  ```js
F
fanchenxuan 已提交
829
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
830 831 832 833 834 835 836 837 838 839 840 841 842
  let localId = 100;
  let name = "demoName";
  try {
    accountManager.setOsAccountName(localId, name, (err) => {
      if (err) {
        console.log("setOsAccountName failed, error: " + JSON.stringify(err));
      } else {
        console.log("setOsAccountName successfully");
      }
    });
  } catch (err) {
    console.log('setOsAccountName exception:' + JSON.stringify(err));
  }
Z
zhangalong 已提交
843 844
  ```

J
jidong 已提交
845
### setOsAccountName
Z
zhangalong 已提交
846

J
jidong 已提交
847
setOsAccountName(localId: number, localName: string): Promise&lt;void&gt;
Z
zhangalong 已提交
848

J
jidong 已提交
849
设置指定系统帐号的帐号名。使用Promise异步调用。 
Z
zhangalong 已提交
850

J
jidong 已提交
851 852 853
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
854

Z
zengyawen 已提交
855 856
**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
857 858 859 860 861 862 863
**参数:**

| 参数名    | 类型   | 必填 | 说明                                |
| --------- | ------ | ---- | --------------------------------- |
| localId   | number | 是   | 系统帐号ID。 |
| localName | string | 是   | 帐号名,最大长度为1024。            |

Z
zengyawen 已提交
864
**返回值:**
Z
zhangalong 已提交
865

J
jidong 已提交
866
| 类型                | 说明                                  |
J
jidong 已提交
867
| ------------------- | ------------------------------------ |
A
Annie_wang 已提交
868
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
Z
zhangalong 已提交
869

J
jidong 已提交
870 871 872 873
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
874 875 876 877
| 12300001 | System service exception. |
| 12300002 | Invalid localId or localName.    |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
878 879

**示例:** 将ID为100的系统帐号的帐号名设置成demoName
Z
zhangalong 已提交
880

Z
zhangalong 已提交
881
  ```js
F
fanchenxuan 已提交
882
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
883 884 885 886 887 888 889 890 891 892 893
  let localId = 100;
  let name = 'testName';
  try {
    accountManager.setOsAccountName(localId, name).then(() => {
      console.log('setOsAccountName successfully');
    }).catch((err) => {
      console.log('setOsAccountName failed, error: '  + JSON.stringify(err));
    });
  } catch (err) {
    console.log('setOsAccountName exception:' + JSON.stringify(err));
  }
Z
zhangalong 已提交
894 895
  ```

J
jidong 已提交
896
### getOsAccountCount<sup>9+</sup>
897

J
jidong 已提交
898
getOsAccountCount(callback: AsyncCallback&lt;number&gt;): void
899

J
jidong 已提交
900
获取已创建的系统帐号数量。使用callback异步回调。
901

J
jidong 已提交
902
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
903 904 905 906 907

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
908 909 910
| 参数名   | 类型                        | 必填 | 说明                                                                         |
| -------- | --------------------------- | ---- | -------------------------------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。当获取成功时,err为null,data为已创建的系统帐号的数量;否则为错误对象。 |
911

J
jidong 已提交
912 913 914 915 916 917
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

918 919 920 921 922
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
923 924 925 926 927 928
    accountManager.getOsAccountCount((err, count) => {
      if (err) {
        console.log("getOsAccountCount failed, error: " + JSON.stringify(err));
      } else {
        console.log("getOsAccountCount successfully, count: " + count);
      }
929
    });
J
jidong 已提交
930 931
  } catch (err) {
    console.log("getOsAccountCount exception: " + JSON.stringify(err));
932 933 934
  }
  ```

J
jidong 已提交
935
### getOsAccountCount<sup>9+</sup>
936

J
jidong 已提交
937
getOsAccountCount(): Promise&lt;number&gt;
938

J
jidong 已提交
939
获取已创建的系统帐号数量。使用Promise异步回调。
940

J
jidong 已提交
941
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
942 943 944

**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
945
**返回值:**
946

J
jidong 已提交
947 948 949
| 类型                  | 说明                                    |
| --------------------- | -------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回已创建的系统帐号的数量。 |
950

J
jidong 已提交
951 952 953 954 955 956
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

957 958 959 960 961
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
962 963 964 965
    accountManager.getOsAccountCount().then((count) => {
      console.log("getOsAccountCount successfully, count: " + count);
    }).catch((err) => {
      console.log("getOsAccountCount failed, error: " + JSON.stringify(err));
966
    });
J
jidong 已提交
967 968
  } catch(err) {
    console.log('getOsAccountCount exception:' + JSON.stringify(err));
969 970 971
  }
  ```

C
cclicn 已提交
972
### getOsAccountLocalId<sup>9+</sup>
973

C
cclicn 已提交
974
getOsAccountLocalId(callback: AsyncCallback&lt;number&gt;): void
975

J
jidong 已提交
976
获取当前进程所属的系统帐号ID,使用callback异步回调。
977 978 979 980 981

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
982 983 984
| 参数名   | 类型                        | 必填 | 说明                                                                           |
| -------- | --------------------------- | ---- | ---------------------------------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。当获取成功时,err为null,data为当前进程所属的系统帐号ID;否则为错误对象。 |
985

J
jidong 已提交
986 987 988 989
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
990
| 12300001 | System service exception. |
J
jidong 已提交
991

992 993 994 995 996
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
C
cclicn 已提交
997
    accountManager.getOsAccountLocalId((err, localId) => {
J
jidong 已提交
998
      if (err) {
C
cclicn 已提交
999
        console.log("getOsAccountLocalId failed, error: " + JSON.stringify(err));
J
jidong 已提交
1000
      } else {
C
cclicn 已提交
1001
        console.log("getOsAccountLocalId successfully, localId: " + localId);
J
jidong 已提交
1002
      }
1003
    });
J
jidong 已提交
1004
  } catch (err) {
C
cclicn 已提交
1005
    console.log("getOsAccountLocalId exception: " + JSON.stringify(err));
1006 1007 1008
  }
  ```

C
cclicn 已提交
1009
### getOsAccountLocalId<sup>9+</sup>
Z
zhangalong 已提交
1010

C
cclicn 已提交
1011
getOsAccountLocalId(): Promise&lt;number&gt;
Z
zhangalong 已提交
1012

J
jidong 已提交
1013
获取当前进程所属的系统帐号ID,使用Promise异步回调。
1014

Z
zengyawen 已提交
1015
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
1016

J
jidong 已提交
1017
**返回值:**
Z
zhangalong 已提交
1018

J
jidong 已提交
1019
| 类型                  | 说明                                      |
J
jidong 已提交
1020
| --------------------- | ---------------------------------------- |
J
jidong 已提交
1021
| Promise&lt;number&gt; | Promise对象,返回当前进程所属的系统帐号ID。 |
Z
zengyawen 已提交
1022

J
jidong 已提交
1023 1024 1025 1026
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
1027
| 12300001 | System service exception. |
J
jidong 已提交
1028

1029
**示例:**
Z
zhangalong 已提交
1030

Z
zhangalong 已提交
1031
  ```js
F
fanchenxuan 已提交
1032
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1033
  try {
C
cclicn 已提交
1034 1035
    accountManager.getOsAccountLocalId().then((localId) => {
      console.log("getOsAccountLocalId successfully, localId: " + localId);
J
jidong 已提交
1036
    }).catch((err) => {
C
cclicn 已提交
1037
      console.log("getOsAccountLocalId failed, error: "  + JSON.stringify(err));
J
jidong 已提交
1038 1039
    });
  } catch (err) {
C
cclicn 已提交
1040
    console.log('getOsAccountLocalId exception: ' + JSON.stringify(err));
J
jidong 已提交
1041
  }
Z
zhangalong 已提交
1042 1043
  ```

C
cclicn 已提交
1044
### getOsAccountLocalIdForUid<sup>9+</sup>
Z
zhangalong 已提交
1045

C
cclicn 已提交
1046
getOsAccountLocalIdForUid(uid: number, callback: AsyncCallback&lt;number&gt;): void
1047

J
jidong 已提交
1048
根据uid查询对应的系统帐号ID,使用callback异步回调。
Z
zhangalong 已提交
1049

Z
zengyawen 已提交
1050 1051 1052
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
1053

J
jidong 已提交
1054 1055 1056 1057
| 参数名   | 类型                        | 必填 | 说明                                                                    |
| -------- | --------------------------- | ---- | --------------------------------------------------------------------- |
| uid      | number                      | 是   | 进程uid。                                                              |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。如果查询成功,err为null,data为对应的系统帐号ID;否则为错误对象。 |
Z
zhangalong 已提交
1058

J
jidong 已提交
1059 1060 1061
**错误码:**

| 错误码ID | 错误信息         |
J
jidong 已提交
1062
| -------- | --------------- |
C
chennian 已提交
1063 1064
| 12300001 | System service exception. |
| 12300002 | Invalid uid.    |
J
jidong 已提交
1065 1066

**示例:** 查询值为12345678的uid所属的系统帐号的帐号ID
Z
zhangalong 已提交
1067

Z
zhangalong 已提交
1068
  ```js
F
fanchenxuan 已提交
1069
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1070 1071
  let uid = 12345678;
  try {
C
cclicn 已提交
1072
    accountManager.getOsAccountLocalIdForUid(uid, (err, localId) => {
J
jidong 已提交
1073
      if (err) {
C
cclicn 已提交
1074
        console.log("getOsAccountLocalIdForUid failed, error: " + JSON.stringify(err));
J
jidong 已提交
1075
      }
C
cclicn 已提交
1076
      console.log("getOsAccountLocalIdForUid successfully, localId: " + localId);
J
jidong 已提交
1077 1078
    });
  } catch (err) {
C
cclicn 已提交
1079
    console.log("getOsAccountLocalIdForUid exception: " + JSON.stringify(err));
J
jidong 已提交
1080
  }
Z
zhangalong 已提交
1081 1082
  ```

C
cclicn 已提交
1083
### getOsAccountLocalIdForUid<sup>9+</sup>
Z
zhangalong 已提交
1084

C
cclicn 已提交
1085
getOsAccountLocalIdForUid(uid: number): Promise&lt;number&gt;
1086

J
jidong 已提交
1087
根据uid查询对应的系统帐号ID,使用Promise异步回调。
Z
zhangalong 已提交
1088

Z
zengyawen 已提交
1089
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
1090

Z
zengyawen 已提交
1091
**参数:**
Z
zhangalong 已提交
1092

J
jidong 已提交
1093 1094 1095
| 参数名 | 类型   | 必填 | 说明      |
| ------ | ------ | ---- | --------- |
| uid    | number | 是   | 进程uid。 |
Z
zhangalong 已提交
1096

Z
zengyawen 已提交
1097
**返回值:**
Z
zhangalong 已提交
1098

J
jidong 已提交
1099 1100 1101
| 类型                  | 说明                                     |
| --------------------- | --------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回指定uid对应的系统帐号ID。 |
Z
zengyawen 已提交
1102

J
jidong 已提交
1103 1104 1105
**错误码:**

| 错误码ID | 错误信息       |
J
jidong 已提交
1106
| -------- | ------------- |
C
chennian 已提交
1107 1108
| 12300001 | System service exception. |
| 12300002 | Invalid uid. |
J
jidong 已提交
1109 1110

**示例:** 查询值为12345678的uid所属的系统帐号ID
Z
zhangalong 已提交
1111

Z
zhangalong 已提交
1112
  ```js
F
fanchenxuan 已提交
1113
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1114 1115
  let uid = 12345678;
  try {
C
cclicn 已提交
1116 1117
    accountManager.getOsAccountLocalIdForUid(uid).then((localId) => {
      console.log("getOsAccountLocalIdForUid successfully, localId: " + localId);
J
jidong 已提交
1118
    }).catch((err) => {
C
cclicn 已提交
1119
      console.log("getOsAccountLocalIdForUid failed, error: " + JSON.stringify(err));
J
jidong 已提交
1120 1121
    });
  } catch (err) {
C
cclicn 已提交
1122
    console.log('getOsAccountLocalIdForUid exception: ' + JSON.stringify(err));
J
jidong 已提交
1123
  }
Z
zhangalong 已提交
1124 1125
  ```

C
cclicn 已提交
1126
### getOsAccountLocalIdForDomain<sup>9+</sup>
Z
zhangalong 已提交
1127

C
cclicn 已提交
1128
getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
1129

J
jidong 已提交
1130
根据域帐号信息,获取与其关联的系统帐号ID。使用callback异步回调。
Z
zengyawen 已提交
1131 1132 1133 1134 1135 1136

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
1137

J
jidong 已提交
1138 1139 1140 1141
| 参数名     | 类型                                    | 必填 | 说明                                                                         |
| ---------- | --------------------------------------- | ---- | -------------------------------------------------------------------------- |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。                                                                |
| callback   | AsyncCallback&lt;number&gt;             | 是   | 回调函数。如果查询成功,err为null,data为域帐号关联的系统帐号ID;否则为错误对象。 |
Z
zhangalong 已提交
1142

J
jidong 已提交
1143 1144 1145 1146
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
C
chennian 已提交
1147 1148
| 12300001 | System service exception. |
| 12300002 | Invalid domainInfo. |
J
jidong 已提交
1149

1150
**示例:**
Z
zhangalong 已提交
1151

Z
zhangalong 已提交
1152
  ```js
J
jidong 已提交
1153
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
F
fanchenxuan 已提交
1154
  let accountManager = account_osAccount.getAccountManager();
1155
  try {
C
cclicn 已提交
1156
    accountManager.getOsAccountLocalIdForDomain(domainInfo, (err, localId) => {
J
jidong 已提交
1157
      if (err) {
C
cclicn 已提交
1158
        console.log("getOsAccountLocalIdForDomain failed, error: " + JSON.stringify(err));
J
jidong 已提交
1159
      } else {
C
cclicn 已提交
1160
        console.log("getOsAccountLocalIdForDomain successfully, localId: " + localId);
J
jidong 已提交
1161
      }
J
jidong 已提交
1162
    });
J
jidong 已提交
1163
  } catch (err) {
C
cclicn 已提交
1164
    console.log('getOsAccountLocalIdForDomain exception: ' + JSON.stringify(err));
1165
  }
Z
zhangalong 已提交
1166 1167
  ```

C
cclicn 已提交
1168
### getOsAccountLocalIdForDomain<sup>9+</sup>
Z
zhangalong 已提交
1169

C
cclicn 已提交
1170
getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo): Promise&lt;number&gt;
Z
zhangalong 已提交
1171

J
jidong 已提交
1172
根据域帐号信息,获取与其关联的系统帐号的帐号ID。使用Promise异步回调。
Z
zengyawen 已提交
1173 1174 1175 1176 1177 1178

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
1179

J
jidong 已提交
1180 1181 1182
| 参数名     | 类型                                    | 必填 | 说明         |
| ---------- | --------------------------------------- | ---- | ------------ |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。 |
Z
zhangalong 已提交
1183

Z
zengyawen 已提交
1184
**返回值:**
Z
zhangalong 已提交
1185

J
jidong 已提交
1186 1187 1188
| 类型                  | 说明                                    |
| :-------------------- | :------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回域帐号关联的系统帐号ID。 |
Z
zhangalong 已提交
1189

J
jidong 已提交
1190 1191 1192 1193
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
C
chennian 已提交
1194 1195
| 12300001 | System service exception. |
| 12300002 | Invalid domainInfo. |
J
jidong 已提交
1196

1197
**示例:**
Z
zhangalong 已提交
1198

Z
zhangalong 已提交
1199
  ```js
F
fanchenxuan 已提交
1200
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1201
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
1202
  try {
C
cclicn 已提交
1203 1204
    accountManager.getOsAccountLocalIdForDomain(domainInfo).then((localId) => {
      console.log("getOsAccountLocalIdForDomain successfully, localId: " + localId);
J
jidong 已提交
1205
    }).catch((err) => {
C
cclicn 已提交
1206
      console.log("getOsAccountLocalIdForDomain failed, error: "  + JSON.stringify(err));
J
jidong 已提交
1207
    });
J
jidong 已提交
1208
  } catch (err) {
C
cclicn 已提交
1209
    console.log("getOsAccountLocalIdForDomain exception: " + JSON.stringify(err));
1210
  }
Z
zhangalong 已提交
1211 1212
  ```

J
jidong 已提交
1213
### queryMaxOsAccountNumber
Z
zhangalong 已提交
1214

J
jidong 已提交
1215
queryMaxOsAccountNumber(callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
1216

J
jidong 已提交
1217
查询允许创建的系统帐号的最大数量。使用callback异步回调。
Z
zhangalong 已提交
1218

J
jidong 已提交
1219
**系统接口:** 此接口为系统接口。
Z
zhangalong 已提交
1220

Z
zengyawen 已提交
1221 1222 1223 1224
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
1225 1226 1227
| 参数名   | 类型                        | 必填 | 说明                                                                              |
| -------- | --------------------------- | ---- | -------------------------------------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,如果查询成功,err为null,data为允许创建的系统帐号的最大数量;否则为错误对象。 |
Z
zengyawen 已提交
1228

J
jidong 已提交
1229 1230 1231 1232 1233 1234
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |

J
jidong 已提交
1235
**示例:**
Z
zhangalong 已提交
1236

Z
zhangalong 已提交
1237
  ```js
F
fanchenxuan 已提交
1238
  let accountManager = account_osAccount.getAccountManager();
1239
  try {
J
jidong 已提交
1240 1241 1242 1243 1244 1245
    accountManager.queryMaxOsAccountNumber((err, maxCnt) => {
      if (err) {
        console.log('queryMaxOsAccountNumber failed, error:' + JSON.stringify(err));
      } else {
        console.log('queryMaxOsAccountNumber successfully, maxCnt:' + maxCnt);
      }
1246
    });
J
jidong 已提交
1247 1248
  } catch (err) {
    console.log('queryMaxOsAccountNumber exception:' + JSON.stringify(err));
1249
  }
Z
zhangalong 已提交
1250 1251
  ```

J
jidong 已提交
1252
### queryMaxOsAccountNumber
Z
zhangalong 已提交
1253

J
jidong 已提交
1254
queryMaxOsAccountNumber(): Promise&lt;number&gt;
Z
zengyawen 已提交
1255

J
jidong 已提交
1256
查询允许创建的系统帐号的最大数量。使用Promise异步回调。
Z
zhangalong 已提交
1257

J
jidong 已提交
1258
**系统接口:** 此接口为系统接口。
Z
zhangalong 已提交
1259

Z
zengyawen 已提交
1260
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
1261

Z
zengyawen 已提交
1262 1263
**返回值:**

J
jidong 已提交
1264 1265 1266
| 类型                  | 说明                                         |
| --------------------- | ------------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回允许创建的系统帐号的最大数量。 |
Z
zengyawen 已提交
1267

J
jidong 已提交
1268 1269 1270 1271 1272 1273
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |

J
jidong 已提交
1274
**示例:**
Z
zhangalong 已提交
1275

Z
zhangalong 已提交
1276
  ```js
F
fanchenxuan 已提交
1277
  let accountManager = account_osAccount.getAccountManager();
1278
  try {
J
jidong 已提交
1279 1280
    accountManager.queryMaxOsAccountNumber().then((maxCnt) => {
      console.log('queryMaxOsAccountNumber successfully, maxCnt: ' + maxCnt);
1281
    }).catch((err) => {
J
jidong 已提交
1282
      console.log('queryMaxOsAccountNumber failed, error: '  + JSON.stringify(err));
1283
    });
J
jidong 已提交
1284 1285
  } catch (err) {
    console.log('queryMaxOsAccountNumber exception:' + JSON.stringify(err));
1286
  }
Z
zhangalong 已提交
1287 1288
  ```

J
jidong 已提交
1289
### getOsAccountConstraints<sup>9+</sup>
Z
zhangalong 已提交
1290

J
jidong 已提交
1291
getOsAccountConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
Z
zhangalong 已提交
1292

J
jidong 已提交
1293
获取指定系统帐号的全部约束。使用callback异步回调。
Z
zengyawen 已提交
1294

Z
zhangalong 已提交
1295 1296
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

Z
zengyawen 已提交
1297 1298 1299
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
1300

J
jidong 已提交
1301 1302 1303 1304
| 参数名   | 类型                                     | 必填 | 说明                                                                                           |
| -------- | ---------------------------------------- | ---- | -------------------------------------------------------------------------------------------- |
| localId  | number                                   | 是   | 系统帐号ID。                                                                                  |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是   | 回调函数,如果获取成功,err为null,data为该系统帐号的全部[约束](#系统帐号约束列表);否则为错误对象。 |
Z
zhangalong 已提交
1305

J
jidong 已提交
1306 1307 1308 1309
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
1310
| 12300001 | System service exception. |
J
jidong 已提交
1311
| 12300002 | Invalid localId.    |
J
jidong 已提交
1312
| 12300003 | Account not found. |
J
jidong 已提交
1313 1314

**示例:** 获取ID为100的系统帐号的全部约束
Z
zhangalong 已提交
1315

Z
zhangalong 已提交
1316
  ```js
F
fanchenxuan 已提交
1317 1318
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
1319
  try {
J
jidong 已提交
1320 1321 1322 1323 1324 1325
    accountManager.getOsAccountConstraints(localId, (err, constraints) => {
      if (err) {
        console.log("getOsAccountConstraints failed, err: " + JSON.stringify(err));
      } else {
        console.log("getOsAccountConstraints successfully, constraints: " + JSON.stringify(constraints));
      }
1326
    });
J
jidong 已提交
1327 1328
  } catch (err) {
    console.log('getOsAccountConstraints exception:' + JSON.stringify(err));
1329
  }
Z
zhangalong 已提交
1330 1331
  ```

J
jidong 已提交
1332
### getOsAccountConstraints<sup>9+</sup>
Z
zhangalong 已提交
1333

J
jidong 已提交
1334
getOsAccountConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt;
Z
zhangalong 已提交
1335

J
jidong 已提交
1336
获取指定系统帐号的全部约束。使用Promise异步回调。
Z
zhangalong 已提交
1337

Z
zhangalong 已提交
1338 1339
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

Z
zengyawen 已提交
1340
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
1341

Z
zengyawen 已提交
1342
**参数:**
Z
zhangalong 已提交
1343

J
jidong 已提交
1344 1345 1346
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
1347

Z
zengyawen 已提交
1348 1349
**返回值:**

J
jidong 已提交
1350 1351 1352
| 类型                               | 说明                                                       |
| ---------------------------------- | ---------------------------------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象,返回指定系统帐号的全部[约束](#系统帐号约束列表)。 |
Z
zengyawen 已提交
1353

J
jidong 已提交
1354 1355 1356 1357
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
1358
| 12300001 | System service exception. |
J
jidong 已提交
1359
| 12300002 | Invalid localId.    |
J
jidong 已提交
1360
| 12300003 | Account not found. |
J
jidong 已提交
1361 1362

**示例:** 获取ID为100的系统帐号的全部约束
Z
zhangalong 已提交
1363

Z
zhangalong 已提交
1364
  ```js
F
fanchenxuan 已提交
1365 1366
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
1367
  try {
J
jidong 已提交
1368 1369
    accountManager.getOsAccountConstraints(localId).then((constraints) => {
      console.log('getOsAccountConstraints, constraints: ' + constraints);
1370
    }).catch((err) => {
J
jidong 已提交
1371
      console.log('getOsAccountConstraints err: '  + JSON.stringify(err));
1372 1373
    });
  } catch (e) {
J
jidong 已提交
1374
    console.log('getOsAccountConstraints exception:' + JSON.stringify(e));
1375
  }
Z
zhangalong 已提交
1376 1377
  ```

J
jidong 已提交
1378
### queryAllCreatedOsAccounts
1379

J
jidong 已提交
1380
queryAllCreatedOsAccounts(callback: AsyncCallback&lt;Array&lt;OsAccountInfo&gt;&gt;): void
1381

J
jidong 已提交
1382
查询已创建的所有系统帐号的信息列表。使用callback异步回调。
1383

J
jidong 已提交
1384
**系统接口:** 此接口为系统接口。
1385 1386 1387

**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
1388 1389
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

1390 1391
**参数:**

J
jidong 已提交
1392 1393 1394
| 参数名   | 类型                                                         | 必填 | 说明                                               |
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | 是   | 回调函数。如果查询成功,err为null,data为已创建的所有系统帐号的信息列表;否则为错误对象。 |
1395

J
jidong 已提交
1396 1397 1398 1399 1400 1401
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |

1402 1403 1404 1405 1406
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
1407 1408 1409
    accountManager.queryAllCreatedOsAccounts((err, accountArr)=>{
      console.log('queryAllCreatedOsAccounts err:' + JSON.stringify(err));
      console.log('queryAllCreatedOsAccounts accountArr:' + JSON.stringify(accountArr));
1410 1411
    });
  } catch (e) {
J
jidong 已提交
1412
    console.log('queryAllCreatedOsAccounts exception:' + JSON.stringify(e));
1413 1414 1415
  }
  ```

J
jidong 已提交
1416
### queryAllCreatedOsAccounts
1417

J
jidong 已提交
1418
queryAllCreatedOsAccounts(): Promise&lt;Array&lt;OsAccountInfo&gt;&gt;
1419

J
jidong 已提交
1420
查询已创建的所有系统帐号的信息列表。使用Promise异步回调。
1421

J
jidong 已提交
1422
**系统接口:** 此接口为系统接口。
1423 1424 1425

**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
1426 1427
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

1428 1429
**返回值:**

J
jidong 已提交
1430 1431 1432
| 类型                                                        | 说明                                           |
| ----------------------------------------------------------- | --------------------------------------------- |
| Promise&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | Promise对象,返回已创建的所有系统帐号的信息列表。 |
1433

J
jidong 已提交
1434 1435 1436 1437 1438 1439
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |

1440 1441 1442 1443 1444
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
1445 1446
    accountManager.queryAllCreatedOsAccounts().then((accountArr) => {
      console.log('queryAllCreatedOsAccounts, accountArr: ' + JSON.stringify(accountArr));
1447
    }).catch((err) => {
J
jidong 已提交
1448
      console.log('queryAllCreatedOsAccounts err: '  + JSON.stringify(err));
1449
    });
J
jidong 已提交
1450 1451
  } catch (e) {
    console.log('queryAllCreatedOsAccounts exception:' + JSON.stringify(e));
1452 1453 1454
  }
  ```

C
cclicn 已提交
1455
### getActivatedOsAccountLocalIds<sup>9+</sup>
Z
zhangalong 已提交
1456

C
cclicn 已提交
1457
getActivatedOsAccountLocalIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
1458

J
jidong 已提交
1459
查询当前处于激活状态的系统帐号的ID列表。使用callback异步回调。
Z
zengyawen 已提交
1460 1461 1462 1463

**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
1464

J
jidong 已提交
1465 1466 1467
| 参数名   | 类型                                     | 必填 | 说明                                                   |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是   | 回调函数。如果查询成功,err为null,data为当前处于激活状态的系统帐号的ID列表;否则为错误对象。 |
Z
zhangalong 已提交
1468

J
jidong 已提交
1469 1470 1471 1472
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
C
chennian 已提交
1473
| 12300001 | System service exception. |
J
jidong 已提交
1474

1475
**示例:**
Z
zhangalong 已提交
1476

Z
zhangalong 已提交
1477
  ```js
F
fanchenxuan 已提交
1478
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1479
  try {
C
cclicn 已提交
1480 1481 1482
    accountManager.getActivatedOsAccountLocalIds((err, idArray)=>{
      console.log('getActivatedOsAccountLocalIds err:' + JSON.stringify(err));
      console.log('getActivatedOsAccountLocalIds idArray length:' + idArray.length);
J
jidong 已提交
1483 1484 1485 1486 1487
      for(let i=0;i<idArray.length;i++) {
        console.info('activated os account id: ' + idArray[i]);
      }
    });
  } catch (e) {
C
cclicn 已提交
1488
    console.log('getActivatedOsAccountLocalIds exception:' + JSON.stringify(e));
J
jidong 已提交
1489
  }
Z
zhangalong 已提交
1490 1491
  ```

C
cclicn 已提交
1492
### getActivatedOsAccountLocalIds<sup>9+</sup>
Z
zhangalong 已提交
1493

C
cclicn 已提交
1494
getActivatedOsAccountLocalIds(): Promise&lt;Array&lt;number&gt;&gt;
1495

J
jidong 已提交
1496
查询当前处于激活状态的系统帐号的ID列表。使用Promise异步回调。
Z
zhangalong 已提交
1497

Z
zengyawen 已提交
1498
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
1499

Z
zengyawen 已提交
1500 1501
**返回值:**

J
jidong 已提交
1502 1503 1504
| 类型                               | 说明                                               |
| :--------------------------------- | :------------------------------------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | Promise对象,返回当前处于激活状态的系统帐号的ID列表。 |
Z
zengyawen 已提交
1505

J
jidong 已提交
1506 1507 1508 1509
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
C
chennian 已提交
1510
| 12300001 | System service exception. |
J
jidong 已提交
1511

1512
**示例:**
Z
zhangalong 已提交
1513

Z
zhangalong 已提交
1514
  ```js
F
fanchenxuan 已提交
1515
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1516
  try {
C
cclicn 已提交
1517 1518
    accountManager.getActivatedOsAccountLocalIds().then((idArray) => {
      console.log('getActivatedOsAccountLocalIds, idArray: ' + idArray);
J
jidong 已提交
1519
    }).catch((err) => {
C
cclicn 已提交
1520
      console.log('getActivatedOsAccountLocalIds err: '  + JSON.stringify(err));
J
jidong 已提交
1521 1522
    });
  } catch (e) {
C
cclicn 已提交
1523
    console.log('getActivatedOsAccountLocalIds exception:' + JSON.stringify(e));
J
jidong 已提交
1524
  }
Z
zhangalong 已提交
1525 1526
  ```

J
jidong 已提交
1527
### createOsAccount
1528

J
jidong 已提交
1529
createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback&lt;OsAccountInfo&gt;): void
1530

J
jidong 已提交
1531 1532 1533 1534 1535
创建一个系统帐号。使用callback异步回调。

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1536 1537 1538 1539 1540

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
1541 1542 1543 1544 1545 1546 1547
| 参数名    | 类型                                                 | 必填 | 说明                                                                         |
| :-------- | ---------------------------------------------------- | ---- | --------------------------------------------------------------------------- |
| localName | string                                               | 是   | 创建的系统帐号的名称。                                                        |
| type      | [OsAccountType](#osaccounttype)                      | 是   | 创建的系统帐号的类型。                                                        |
| callback  | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调函数。如果创建成功,err为null,data为新创建的系统帐号的信息;否则为错误对象。 |

**错误码:**
J
jidong 已提交
1548 1549 1550 1551

| 错误码ID  | 错误信息                   |
| -------- | ------------------------- |
| 12300001 | System service exception. |
J
jidong 已提交
1552
| 12300002 | Invalid localName or type. |
J
jidong 已提交
1553 1554 1555
| 12300005 | Multi-user not supported. |
| 12300006 | Unsupported account type. |
| 12300007 | The number of account reaches the upper limit. |
1556 1557 1558 1559 1560 1561

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
1562 1563 1564
    accountManager.createOsAccount('testName', account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{
      console.log('createOsAccount err:' + JSON.stringify(err));
      console.log('createOsAccount osAccountInfo:' + JSON.stringify(osAccountInfo));
1565 1566
    });
  } catch (e) {
J
jidong 已提交
1567
    console.log('createOsAccount exception:' + JSON.stringify(e));
1568 1569 1570
  }
  ```

J
jidong 已提交
1571
### createOsAccount
1572

J
jidong 已提交
1573
createOsAccount(localName: string, type: OsAccountType): Promise&lt;OsAccountInfo&gt;
1574

J
jidong 已提交
1575 1576 1577 1578 1579
创建一个系统帐号。使用Promise异步回调。 

**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1580 1581 1582

**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
1583 1584 1585 1586 1587 1588 1589
**参数:**

| 参数名    | 类型                            | 必填 | 说明                   |
| --------- | ------------------------------- | ---- | ---------------------- |
| localName | string                          | 是   | 创建的系统帐号的名称。 |
| type      | [OsAccountType](#osaccounttype) | 是   | 创建的系统帐号的类型。 |

1590 1591
**返回值:**

J
jidong 已提交
1592 1593
| 类型                                           | 说明                                  |
| ---------------------------------------------- | ------------------------------------- |
A
Annie_wang 已提交
1594
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise对象,返回新创建的系统帐号的信息。 |
J
jidong 已提交
1595 1596

**错误码:**
J
jidong 已提交
1597 1598 1599 1600

| 错误码ID  | 错误信息                   |
| -------- | ------------------------- |
| 12300001 | System service exception. |
J
jidong 已提交
1601
| 12300002 | Invalid localName or type. |
J
jidong 已提交
1602 1603 1604
| 12300005 | Multi-user not supported. |
| 12300006 | Unsupported account type. |
| 12300007 | The number of account reaches the upper limit. |
1605 1606 1607 1608 1609 1610

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
1611 1612
    accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL).then((accountInfo) => {
      console.log('createOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
1613
    }).catch((err) => {
J
jidong 已提交
1614
      console.log('createOsAccount err: '  + JSON.stringify(err));
1615 1616
    });
  } catch (e) {
J
jidong 已提交
1617
    console.log('createOsAccount exception:' + JSON.stringify(e));
1618 1619 1620
  }
  ```

J
jidong 已提交
1621
### createOsAccountForDomain<sup>8+</sup>
Z
zhangalong 已提交
1622

J
jidong 已提交
1623
createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;OsAccountInfo&gt;): void
Z
zhangalong 已提交
1624

J
jidong 已提交
1625
根据域帐号信息,创建一个系统帐号并将其与域帐号关联。使用callback异步回调。
Z
zhangalong 已提交
1626

J
jidong 已提交
1627 1628 1629
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1630

Z
zengyawen 已提交
1631 1632 1633
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
1634

J
jidong 已提交
1635
| 参数名     | 类型                                                 | 必填 | 说明                                                                         |
J
jidong 已提交
1636
| ---------- | ---------------------------------------------------- | ---- | -------------------------------------------------------------------------- |
J
jidong 已提交
1637 1638 1639 1640 1641
| type       | [OsAccountType](#osaccounttype)                      | 是   | 创建的系统帐号的类型。                                                       |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8)              | 是   | 域帐号信息。                                                               |
| callback   | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调函数。如果创建成功,err为null,data为新创建的系统帐号的信息;否则为错误对象。 |

**错误码:**
J
jidong 已提交
1642

J
jidong 已提交
1643
| 错误码ID | 错误信息                     |
J
jidong 已提交
1644 1645
| -------- | ------------------- |
| 12300001 | System service exception. |
J
jidong 已提交
1646
| 12300002 | Invalid type or domainInfo. |
J
jidong 已提交
1647 1648 1649
| 12300005 | Multi-user not supported. |
| 12300006 | Unsupported account type. |
| 12300007 | The number of account reaches the upper limit. |
Z
zhangalong 已提交
1650

1651
**示例:**
Z
zhangalong 已提交
1652

Z
zhangalong 已提交
1653
  ```js
F
fanchenxuan 已提交
1654
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1655 1656 1657 1658 1659 1660 1661 1662 1663
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
  try {
    accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo, (err, osAccountInfo)=>{
      console.log('createOsAccountForDomain err:' + JSON.stringify(err));
      console.log('createOsAccountForDomain osAccountInfo:' + JSON.stringify(osAccountInfo));
    });
  } catch (e) {
    console.log('createOsAccountForDomain exception:' + JSON.stringify(e));
  }
Z
zhangalong 已提交
1664 1665
  ```

J
jidong 已提交
1666
### createOsAccountForDomain<sup>8+</sup>
Z
zhangalong 已提交
1667

J
jidong 已提交
1668
createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo): Promise&lt;OsAccountInfo&gt;
Z
zhangalong 已提交
1669

J
jidong 已提交
1670
根据传入的域帐号信息,创建与其关联的系统帐号。使用Promise异步回调。 
Z
zhangalong 已提交
1671

J
jidong 已提交
1672 1673 1674
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1675

Z
zengyawen 已提交
1676
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
1677

J
jidong 已提交
1678 1679 1680 1681 1682 1683 1684
**参数:**

| 参数名     | 类型                                      | 必填 | 说明                 |
| ---------- | ---------------------------------------- | ---- | -------------------- |
| type       | [OsAccountType](#osaccounttype)          | 是   | 创建的系统帐号的类型。 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。          |

Z
zengyawen 已提交
1685
**返回值:**
Z
zhangalong 已提交
1686

J
jidong 已提交
1687 1688 1689 1690 1691
| 类型                                           | 说明                                    |
| ---------------------------------------------- | -------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise对象,返回新创建的系统帐号的信息。 |

**错误码:**
J
jidong 已提交
1692

J
jidong 已提交
1693
| 错误码ID | 错误信息                     |
J
jidong 已提交
1694 1695
| -------- | ------------------- |
| 12300001 | System service exception. |
J
jidong 已提交
1696
| 12300002 | Invalid type or domainInfo. |
J
jidong 已提交
1697 1698 1699
| 12300005 | Multi-user not supported. |
| 12300006 | Unsupported account type. |
| 12300007 | The number of account reaches the upper limit. |
Z
zengyawen 已提交
1700

1701
**示例:**
Z
zhangalong 已提交
1702

Z
zhangalong 已提交
1703
  ```js
F
fanchenxuan 已提交
1704
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
  try {
    accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo).then((accountInfo) => {
      console.log('createOsAccountForDomain, account info: ' + JSON.stringify(accountInfo));
    }).catch((err) => {
      console.log('createOsAccountForDomain err: '  + JSON.stringify(err));
    });
  } catch (e) {
    console.log('createOsAccountForDomain exception:' + JSON.stringify(e));
  }
Z
zhangalong 已提交
1715 1716
  ```

J
jidong 已提交
1717
### getCurrentOsAccount<sup>9+</sup>
1718

J
jidong 已提交
1719
getCurrentOsAccount(callback: AsyncCallback&lt;OsAccountInfo&gt;): void
1720

J
jidong 已提交
1721 1722 1723
查询当前进程所属的系统帐号的信息。使用callback异步回调。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1724 1725 1726 1727 1728

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
1729 1730 1731
| 参数名   | 类型                                                 | 必填 | 说明                                           |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调函数。如果查询成功,err为null,data为当前进程所属的系统帐号信息;否则为错误对象。 |
1732

J
jidong 已提交
1733 1734 1735 1736 1737 1738
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

J
jidong 已提交
1739
**示例:**
1740 1741 1742 1743

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
1744 1745 1746
    accountManager.getCurrentOsAccount((err, curAccountInfo)=>{
      console.log('getCurrentOsAccount err:' + JSON.stringify(err));
      console.log('getCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
1747 1748
    });
  } catch (e) {
J
jidong 已提交
1749
    console.log('getCurrentOsAccount exception:' + JSON.stringify(e));
1750 1751 1752
  }
  ```

J
jidong 已提交
1753
### getCurrentOsAccount<sup>9+</sup>
1754

J
jidong 已提交
1755
getCurrentOsAccount(): Promise&lt;OsAccountInfo&gt;
1756

J
jidong 已提交
1757
查询当前进程所属的系统帐号的信息。使用Promise异步回调。
1758

J
jidong 已提交
1759
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1760

J
jidong 已提交
1761
**系统能力:** SystemCapability.Account.OsAccount
1762 1763 1764

**返回值:**

J
jidong 已提交
1765 1766 1767
| 类型                                           | 说明                                       |
| ---------------------------------------------- | ----------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise对象,返回当前进程所属的系统帐号信息。 |
1768

J
jidong 已提交
1769 1770 1771 1772 1773 1774
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

J
jidong 已提交
1775
**示例:**
1776 1777 1778 1779

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
1780 1781
    accountManager.getCurrentOsAccount().then((accountInfo) => {
      console.log('getCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
1782
    }).catch((err) => {
J
jidong 已提交
1783
      console.log('getCurrentOsAccount err: '  + JSON.stringify(err));
1784 1785
    });
  } catch (e) {
J
jidong 已提交
1786
    console.log('getCurrentOsAccount exception:' + JSON.stringify(e));
1787 1788 1789
  }
  ```

J
jidong 已提交
1790
### queryOsAccountById
Z
zhangalong 已提交
1791

J
jidong 已提交
1792
queryOsAccountById(localId: number, callback: AsyncCallback&lt;OsAccountInfo&gt;): void
Z
zhangalong 已提交
1793

J
jidong 已提交
1794
查询指定系统帐号的信息。使用callback异步回调。
Z
zhangalong 已提交
1795

J
jidong 已提交
1796 1797 1798
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
1799

Z
zengyawen 已提交
1800 1801 1802
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
1803

J
jidong 已提交
1804 1805 1806 1807
| 参数名   | 类型                                                 | 必填 | 说明                                                                       |
| -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------------------ |
| localId  | number                                               | 是   | 要查询的系统帐号的ID。                                                      |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调函数。如果查询成功,err为null,data为查到的系统帐号的信息;否则为错误对象。 |
Z
zhangalong 已提交
1808

J
jidong 已提交
1809
**错误码:**
J
jidong 已提交
1810

J
jidong 已提交
1811 1812
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
1813
| 12300001 | System service exception. |
J
jidong 已提交
1814
| 12300002 | Invalid localId.    |
J
jidong 已提交
1815
| 12300003 | Account not found. |
J
jidong 已提交
1816 1817

**示例:** 查询ID为100的系统帐号信息
Z
zhangalong 已提交
1818

Z
zhangalong 已提交
1819
  ```js
F
fanchenxuan 已提交
1820
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1821 1822 1823 1824 1825 1826 1827 1828 1829
  let localId = 100;
  try {
    accountManager.queryOsAccountById(localId, (err, accountInfo)=>{
      console.log('queryOsAccountById err:' + JSON.stringify(err));
      console.log('queryOsAccountById accountInfo:' + JSON.stringify(accountInfo));
    });
  } catch (e) {
    console.log('queryOsAccountById exception:' + JSON.stringify(e));
  }
Z
zhangalong 已提交
1830 1831
  ```

J
jidong 已提交
1832
### queryOsAccountById
Z
zhangalong 已提交
1833

J
jidong 已提交
1834
queryOsAccountById(localId: number): Promise&lt;OsAccountInfo&gt;
Z
zhangalong 已提交
1835

J
jidong 已提交
1836
查询指定系统帐号的信息。使用Promise异步回调。
Z
zhangalong 已提交
1837

J
jidong 已提交
1838 1839 1840
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
1841

Z
zengyawen 已提交
1842
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
1843

Z
zengyawen 已提交
1844
**参数:**
Z
zhangalong 已提交
1845

J
jidong 已提交
1846 1847 1848
| 参数名  | 类型   | 必填 | 说明                 |
| ------- | ------ | ---- | -------------------- |
| localId | number | 是   | 要查询的系统帐号的ID |
Z
zhangalong 已提交
1849

Z
zengyawen 已提交
1850
**返回值:**
Z
zhangalong 已提交
1851

J
jidong 已提交
1852 1853 1854
| 类型                                           | 说明                                 |
| ---------------------------------------------- | ------------------------------------ |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise对象,返回查到的系统帐号的信息。 |
Z
zengyawen 已提交
1855

J
jidong 已提交
1856
**错误码:**
J
jidong 已提交
1857

J
jidong 已提交
1858 1859
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
1860
| 12300001 | System service exception. |
C
chennian 已提交
1861
| 12300002 | Invalid localId. |
J
jidong 已提交
1862
| 12300003 | Account not found. |
J
jidong 已提交
1863 1864

**示例:** 查询ID为100的系统帐号信息
Z
zhangalong 已提交
1865

Z
zhangalong 已提交
1866
  ```js
F
fanchenxuan 已提交
1867
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
  let localId = 100;
  try {
    accountManager.queryOsAccountById(localId).then((accountInfo) => {
      console.log('queryOsAccountById, accountInfo: ' + JSON.stringify(accountInfo));
    }).catch((err) => {
      console.log('queryOsAccountById err: '  + JSON.stringify(err));
    });
  } catch (e) {
    console.log('queryOsAccountById exception:' + JSON.stringify(e));
  }
Z
zhangalong 已提交
1878 1879
  ```

J
jidong 已提交
1880
### getOsAccountType<sup>9+</sup>
1881

J
jidong 已提交
1882
getOsAccountType(callback: AsyncCallback&lt;OsAccountType&gt;): void
1883

J
jidong 已提交
1884
查询当前进程所属的系统帐号的帐号类型。使用callback异步回调。
1885 1886 1887 1888 1889

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
1890 1891 1892
| 参数名   | 类型                                                 | 必填 | 说明                                                 |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountType](#osaccounttype)&gt; | 是   | 回调函数。如果查询成功,err为null,data为当前进程所属的系统帐号的帐号类型;否则为错误对象。 |
1893

J
jidong 已提交
1894 1895 1896 1897 1898 1899
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

1900 1901 1902 1903 1904
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
1905 1906 1907
    accountManager.getOsAccountType((err, accountType) => {
      console.log('getOsAccountType err: ' + JSON.stringify(err));
      console.log('getOsAccountType accountType: ' + accountType);
1908 1909
    });
  } catch (e) {
J
jidong 已提交
1910
    console.log('getOsAccountType exception: ' + JSON.stringify(e));
1911 1912 1913
  }
  ```

J
jidong 已提交
1914
### getOsAccountType<sup>9+</sup>
1915

J
jidong 已提交
1916
getOsAccountType(): Promise&lt;OsAccountType&gt;
1917

J
jidong 已提交
1918
查询当前进程所属的系统帐号的帐号类型。使用Promise异步回调。
1919 1920 1921 1922 1923

**系统能力:** SystemCapability.Account.OsAccount

**返回值:**

J
jidong 已提交
1924 1925 1926
| 类型                                           | 说明                                             |
| ---------------------------------------------- | ----------------------------------------------- |
| Promise&lt;[OsAccountType](#osaccounttype)&gt; | Promise对象,返回当前进程所属的系统帐号的帐号类型。 |
1927

J
jidong 已提交
1928 1929 1930 1931 1932 1933
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

1934 1935 1936 1937 1938
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
  try {
J
jidong 已提交
1939 1940
    accountManager.getOsAccountType().then((accountType) => {
      console.log('getOsAccountType, accountType: ' + accountType);
1941
    }).catch((err) => {
J
jidong 已提交
1942
      console.log('getOsAccountType err: '  + JSON.stringify(err));
1943 1944
    });
  } catch (e) {
J
jidong 已提交
1945
    console.log('getOsAccountType exception: ' + JSON.stringify(e));
1946 1947 1948
  }
  ```

J
jidong 已提交
1949
### queryDistributedVirtualDeviceId<sup>9+</sup>
Z
zhangalong 已提交
1950

J
jidong 已提交
1951
queryDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void
Z
zhangalong 已提交
1952

J
jidong 已提交
1953
获取分布式虚拟设备ID。使用callback异步回调。
1954

J
jidong 已提交
1955
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
1956 1957

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
1958

Z
zengyawen 已提交
1959
**参数:**
Z
zhangalong 已提交
1960

J
jidong 已提交
1961 1962 1963
| 参数名   | 类型                        | 必填 | 说明                                                                   |
| -------- | --------------------------- | ---- | --------------------------------------------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。如果获取成功,err为null,data为分布式虚拟设备ID;否则为错误对象。 |
Z
zengyawen 已提交
1964

J
jidong 已提交
1965 1966 1967 1968 1969 1970
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

1971
**示例:**
Z
zhangalong 已提交
1972

Z
zhangalong 已提交
1973
  ```js
F
fanchenxuan 已提交
1974
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1975 1976 1977 1978 1979 1980 1981 1982
  try {
    accountManager.queryDistributedVirtualDeviceId((err, virtualID) => {
      console.log('queryDistributedVirtualDeviceId err: ' + JSON.stringify(err));
      console.log('queryDistributedVirtualDeviceId virtualID: ' + virtualID);
    });
  } catch (e) {
    console.log('queryDistributedVirtualDeviceId exception: ' + JSON.stringify(e));
  }
Z
zhangalong 已提交
1983 1984
  ```

J
jidong 已提交
1985
### queryDistributedVirtualDeviceId<sup>9+</sup>
Z
zhangalong 已提交
1986

J
jidong 已提交
1987
queryDistributedVirtualDeviceId(): Promise&lt;string&gt;
Z
zhangalong 已提交
1988

J
jidong 已提交
1989
获取分布式虚拟设备ID。使用Promise异步回调。
1990

J
jidong 已提交
1991
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
1992 1993 1994 1995

**系统能力:** SystemCapability.Account.OsAccount

**返回值:**
Z
zhangalong 已提交
1996

J
jidong 已提交
1997 1998 1999
| 类型                  | 说明                              |
| --------------------- | --------------------------------- |
| Promise&lt;string&gt; | Promise对象,返回分布式虚拟设备ID。 |
Z
zhangalong 已提交
2000

J
jidong 已提交
2001 2002 2003 2004 2005 2006
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |

2007
**示例:**
Z
zhangalong 已提交
2008

Z
zhangalong 已提交
2009
  ```js
F
fanchenxuan 已提交
2010
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2011 2012 2013 2014 2015 2016 2017 2018 2019
  try {
    accountManager.queryDistributedVirtualDeviceId().then((virtualID) => {
      console.log('queryDistributedVirtualDeviceId, virtualID: ' + virtualID);
    }).catch((err) => {
      console.log('queryDistributedVirtualDeviceId err: '  + JSON.stringify(err));
    });
  } catch (e) {
    console.log('queryDistributedVirtualDeviceId exception: ' + JSON.stringify(e));
  }
Z
zhangalong 已提交
2020 2021
  ```

J
jidong 已提交
2022
### getOsAccountProfilePhoto
Z
zhangalong 已提交
2023

J
jidong 已提交
2024
getOsAccountProfilePhoto(localId: number, callback: AsyncCallback&lt;string&gt;): void
Z
zhangalong 已提交
2025

J
jidong 已提交
2026
获取指定系统帐号的头像信息。使用callback异步回调。
Z
zhangalong 已提交
2027

J
jidong 已提交
2028 2029 2030
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zhangalong 已提交
2031

Z
zengyawen 已提交
2032
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2033

Z
zengyawen 已提交
2034 2035
**参数:**

J
jidong 已提交
2036 2037 2038 2039
| 参数名   | 类型                        | 必填 | 说明                                                                         |
| -------- | --------------------------- | ---- | -------------------------------------------------------------------------- |
| localId  | number                      | 是   | 系统帐号ID。                                                                |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。如果获取成功,err为null,data为指定系统帐号的头像信息;否则为错误对象。 |
Z
zengyawen 已提交
2040

J
jidong 已提交
2041
**错误码:**
J
jidong 已提交
2042

J
jidong 已提交
2043 2044
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
2045
| 12300001 | System service exception. |
J
jidong 已提交
2046
| 12300002 | Invalid localId.    |
J
jidong 已提交
2047
| 12300003 | Account not found. |
J
jidong 已提交
2048 2049

**示例:** 获取ID为100的系统帐号的头像
Z
zhangalong 已提交
2050

Z
zhangalong 已提交
2051
  ```js
F
fanchenxuan 已提交
2052
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2053
  let localId = 100;
2054
  try {
J
jidong 已提交
2055 2056 2057
    accountManager.getOsAccountProfilePhoto(localId, (err, photo)=>{
      console.log('getOsAccountProfilePhoto err:' + JSON.stringify(err));
      console.log('get photo:' + photo + ' by localId: ' + localId);
2058 2059
    });
  } catch (e) {
J
jidong 已提交
2060
    console.log('getOsAccountProfilePhoto exception:' + JSON.stringify(e));
2061
  }
Z
zhangalong 已提交
2062 2063
  ```

J
jidong 已提交
2064
### getOsAccountProfilePhoto
Z
zhangalong 已提交
2065

J
jidong 已提交
2066
getOsAccountProfilePhoto(localId: number): Promise&lt;string&gt;
Z
zhangalong 已提交
2067

J
jidong 已提交
2068
获取指定系统帐号的头像信息。使用Promise异步回调。
Z
zhangalong 已提交
2069

J
jidong 已提交
2070 2071 2072
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
2073 2074 2075

**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
2076 2077 2078 2079 2080 2081
**参数:**

| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |

Z
zengyawen 已提交
2082
**返回值:**
Z
zhangalong 已提交
2083

J
jidong 已提交
2084 2085 2086
| 类型                  | 说明                                    |
| --------------------- | -------------------------------------- |
| Promise&lt;string&gt; | Promise对象,返回指定系统帐号的头像信息。 |
Z
zhangalong 已提交
2087

J
jidong 已提交
2088
**错误码:**
J
jidong 已提交
2089

J
jidong 已提交
2090 2091
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
2092
| 12300001 | System service exception. |
J
jidong 已提交
2093
| 12300002 | Invalid localId.    |
J
jidong 已提交
2094
| 12300003 | Account not found. |
J
jidong 已提交
2095 2096

**示例:** 获取ID为100的系统帐号的头像
Z
zhangalong 已提交
2097

Z
zhangalong 已提交
2098
  ```js
F
fanchenxuan 已提交
2099
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2100
  let localId = 100;
2101
  try {
J
jidong 已提交
2102 2103
    accountManager.getOsAccountProfilePhoto(localId).then((photo) => {
      console.log('getOsAccountProfilePhoto: ' + photo);
2104
    }).catch((err) => {
J
jidong 已提交
2105
      console.log('getOsAccountProfilePhoto err: '  + JSON.stringify(err));
2106 2107
    });
  } catch (e) {
J
jidong 已提交
2108
    console.log('getOsAccountProfilePhoto exception:' + JSON.stringify(e));
2109 2110 2111
  }
  ```

J
jidong 已提交
2112
### setOsAccountProfilePhoto
2113

J
jidong 已提交
2114 2115 2116
setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback&lt;void&gt;): void

为指定系统帐号设置头像信息。使用callback异步回调。
2117

J
jidong 已提交
2118
**系统接口:** 此接口为系统接口。
2119

J
jidong 已提交
2120
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
2121 2122 2123 2124 2125

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
2126 2127 2128 2129
| 参数名   | 类型                      | 必填 | 说明         |
| -------- | ------------------------- | ---- | ------------ |
| localId  | number                    | 是   | 系统帐号ID。 |
| photo    | string                    | 是   | 头像信息。   |
2130
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。如果设置成功,err为null,否则为错误对象。  |
J
jidong 已提交
2131 2132

**错误码:**
J
jidong 已提交
2133

J
jidong 已提交
2134 2135
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
2136 2137 2138 2139
| 12300001 | System service exception. |
| 12300002 | Invalid localId or photo.    |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
2140

J
jidong 已提交
2141
**示例:** 给ID为100的系统帐号设置头像
2142 2143 2144 2145

  ```js
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
J
jidong 已提交
2146 2147 2148 2149
  let photo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
  'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
  'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
  '+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
2150
  try {
J
jidong 已提交
2151 2152
    accountManager.setOsAccountProfilePhoto(localId, photo, (err)=>{
      console.log('setOsAccountProfilePhoto err:' + JSON.stringify(err));
2153 2154
    });
  } catch (e) {
J
jidong 已提交
2155
    console.log('setOsAccountProfilePhoto exception:' + JSON.stringify(e));
2156 2157 2158
  }
  ```

J
jidong 已提交
2159
### setOsAccountProfilePhoto
2160

J
jidong 已提交
2161 2162 2163
setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt;

为指定系统帐号设置头像信息。使用Promise异步回调。
2164

J
jidong 已提交
2165
**系统接口:** 此接口为系统接口。
2166

J
jidong 已提交
2167
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
2168 2169 2170 2171 2172 2173 2174 2175

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
J
jidong 已提交
2176
| photo   | string | 是   | 头像信息。   |
2177 2178 2179

**返回值:**

J
jidong 已提交
2180
| 类型                | 说明                                 |
J
jidong 已提交
2181
| ------------------- | ------------------------------------ |
A
Annie_wang 已提交
2182
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
2183

J
jidong 已提交
2184
**错误码:**
J
jidong 已提交
2185

J
jidong 已提交
2186 2187
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
2188 2189 2190 2191
| 12300001 | System service exception. |
| 12300002 | Invalid localId or photo.    |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
2192 2193

**示例:** 给ID为100的系统帐号设置头像
2194 2195 2196 2197

  ```js
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
J
jidong 已提交
2198 2199 2200 2201
  let photo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
  'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
  'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
  '+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
2202
  try {
J
jidong 已提交
2203 2204
    accountManager.setOsAccountProfilePhoto(localId, photo).then(() => {
      console.log('setOsAccountProfilePhoto success');
2205
    }).catch((err) => {
J
jidong 已提交
2206
      console.log('setOsAccountProfilePhoto err: '  + JSON.stringify(err));
2207 2208
    });
  } catch (e) {
J
jidong 已提交
2209
    console.log('setOsAccountProfilePhoto exception:' + JSON.stringify(e));
2210
  }
Z
zhangalong 已提交
2211 2212
  ```

C
cclicn 已提交
2213
### getOsAccountLocalIdForSerialNumber<sup>9+</sup>
Z
zhangalong 已提交
2214

C
cclicn 已提交
2215
getOsAccountLocalIdForSerialNumber(serialNumber: number, callback: AsyncCallback&lt;number&gt;): void
2216

J
jidong 已提交
2217
通过SN码查询与其关联的系统帐号的帐号ID。使用callback异步回调。
Z
zhangalong 已提交
2218

Z
zengyawen 已提交
2219
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2220

Z
zengyawen 已提交
2221 2222
**参数:**

J
jidong 已提交
2223 2224 2225 2226
| 参数名       | 类型                        | 必填 | 说明                                                                           |
| ------------ | --------------------------- | ---- | ---------------------------------------------------------------------------- |
| serialNumber | number                      | 是   | 帐号SN码。                                                                    |
| callback     | AsyncCallback&lt;number&gt; | 是   | 回调函数。如果成功,err为null,data为与SN码关联的系统帐号的帐号ID;否则为错误对象。 |
Z
zengyawen 已提交
2227

J
jidong 已提交
2228
**错误码:**
J
jidong 已提交
2229

J
jidong 已提交
2230
| 错误码ID | 错误信息               |
J
jidong 已提交
2231
| -------- | ------------------- |
C
chennian 已提交
2232 2233 2234
| 12300001 | System service exception. |
| 12300002 | Invalid serialNumber. |
| 12300003 | The account indicated by serialNumber dose not exist. |
J
jidong 已提交
2235 2236

**示例:** 查询与SN码12345关联的系统帐号的ID
Z
zhangalong 已提交
2237

Z
zhangalong 已提交
2238
  ```js
F
fanchenxuan 已提交
2239
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2240 2241
  let serialNumber = 12345;
  try {
C
cclicn 已提交
2242
    accountManager.getOsAccountLocalIdForSerialNumber(serialNumber, (err, localId)=>{
J
jidong 已提交
2243 2244 2245 2246 2247 2248
      console.log('ger localId err:' + JSON.stringify(err));
      console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
    });
  } catch (e) {
    console.log('ger localId exception:' + JSON.stringify(e));
  }
Z
zhangalong 已提交
2249 2250
  ```

C
cclicn 已提交
2251
### getOsAccountLocalIdForSerialNumber<sup>9+</sup>
2252

C
cclicn 已提交
2253
getOsAccountLocalIdForSerialNumber(serialNumber: number): Promise&lt;number&gt;
Z
zengyawen 已提交
2254

J
jidong 已提交
2255
通过SN码查询与其关联的系统帐号的帐号ID。使用Promise异步回调。
Z
zhangalong 已提交
2256

Z
zengyawen 已提交
2257
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2258

Z
zengyawen 已提交
2259
**参数:**
Z
zhangalong 已提交
2260

J
jidong 已提交
2261 2262 2263
| 参数名       | 类型   | 必填 | 说明       |
| ------------ | ------ | ---- | ---------- |
| serialNumber | number | 是   | 帐号SN码。 |
Z
zhangalong 已提交
2264

Z
zengyawen 已提交
2265
**返回值:**
Z
zhangalong 已提交
2266

J
jidong 已提交
2267
| 类型                  | 说明                                         |
J
jidong 已提交
2268
| --------------------- | -------------------------------------------- |
J
jidong 已提交
2269
| Promise&lt;number&gt; | Promise对象,返回与SN码关联的系统帐号的帐号ID。 |
Z
zengyawen 已提交
2270

J
jidong 已提交
2271
**错误码:**
J
jidong 已提交
2272

J
jidong 已提交
2273
| 错误码ID | 错误信息               |
J
jidong 已提交
2274
| -------- | ------------------- |
C
chennian 已提交
2275 2276 2277
| 12300001 | System service exception. |
| 12300002 | Invalid serialNumber. |
| 12300003 | The account indicated by serialNumber dose not exist. |
J
jidong 已提交
2278 2279

**示例:** 查询与SN码12345关联的系统帐号的ID
Z
zhangalong 已提交
2280

Z
zhangalong 已提交
2281
  ```js
F
fanchenxuan 已提交
2282
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2283 2284
  let serialNumber = 12345;
  try {
C
cclicn 已提交
2285 2286
    accountManager.getOsAccountLocalIdForSerialNumber(serialNumber).then((localId) => {
      console.log('getOsAccountLocalIdForSerialNumber localId: ' + localId);
J
jidong 已提交
2287
    }).catch((err) => {
C
cclicn 已提交
2288
      console.log('getOsAccountLocalIdForSerialNumber err: '  + JSON.stringify(err));
J
jidong 已提交
2289 2290
    });
  } catch (e) {
C
cclicn 已提交
2291
    console.log('getOsAccountLocalIdForSerialNumber exception: '  + JSON.stringify(e));
J
jidong 已提交
2292
  }
Z
zhangalong 已提交
2293 2294
  ```

C
cclicn 已提交
2295
### getSerialNumberForOsAccountLocalId<sup>9+</sup>
Z
zhangalong 已提交
2296

C
cclicn 已提交
2297
getSerialNumberForOsAccountLocalId(localId: number, callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
2298

J
jidong 已提交
2299
通过系统帐号ID获取与该系统帐号关联的SN码。使用callback异步回调。
Z
zengyawen 已提交
2300 2301

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2302

Z
zengyawen 已提交
2303
**参数:**
Z
zhangalong 已提交
2304

J
jidong 已提交
2305 2306 2307 2308
| 参数名   | 类型                        | 必填 | 说明                                                                         |
| -------- | --------------------------- | ---- | -------------------------------------------------------------------------- |
| localId  | number                      | 是   | 系统帐号ID。                                                                 |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。如果获取成功,err为null,data为与该系统帐号关联的SN码;否则为错误对象。 |
Z
zengyawen 已提交
2309

J
jidong 已提交
2310 2311 2312 2313
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
2314 2315 2316
| 12300001 | System service exception. |
| 12300002 | Invalid localId.    |
| 12300003 | Account not found. |
J
jidong 已提交
2317 2318

**示例:** 获取ID为100的系统帐号关联的SN码
Z
zhangalong 已提交
2319

Z
zhangalong 已提交
2320
  ```js
F
fanchenxuan 已提交
2321
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2322
  let localId = 100;
2323
  try {
C
cclicn 已提交
2324
    accountManager.getSerialNumberForOsAccountLocalId(localId, (err, serialNumber)=>{
J
jidong 已提交
2325 2326
      console.log('ger serialNumber err:' + JSON.stringify(err));
      console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
2327 2328
    });
  } catch (e) {
J
jidong 已提交
2329
    console.log('ger serialNumber exception:' + JSON.stringify(e));
2330
  }
Z
zhangalong 已提交
2331 2332
  ```

C
cclicn 已提交
2333
### getSerialNumberForOsAccountLocalId<sup>9+</sup>
Z
zhangalong 已提交
2334

C
cclicn 已提交
2335
getSerialNumberForOsAccountLocalId(localId: number): Promise&lt;number&gt;
Z
zhangalong 已提交
2336

J
jidong 已提交
2337
通过系统帐号ID获取与该系统帐号关联的SN码。使用Promise异步回调。
Z
zengyawen 已提交
2338 2339

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2340

J
jidong 已提交
2341 2342 2343 2344 2345
**参数:**

| 参数名  | 类型   | 必填 | 说明          |
| ------- | ------ | ---- | ----------- |
| localId | number | 是   | 系统帐号ID。 |
L
lichenchen 已提交
2346

Z
zengyawen 已提交
2347
**返回值:**
Z
zhangalong 已提交
2348

J
jidong 已提交
2349 2350 2351
| 类型                  | 说明                                    |
| :-------------------- | :------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回与该系统帐号关联的SN码。 |
Z
zengyawen 已提交
2352

J
jidong 已提交
2353 2354 2355 2356
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
C
chennian 已提交
2357 2358 2359
| 12300001 | System service exception. |
| 12300002 | Invalid localId.    |
| 12300003 | Account not found. |
J
jidong 已提交
2360 2361

**示例:** 获取ID为100的系统帐号关联的SN码
Z
zhangalong 已提交
2362

Z
zhangalong 已提交
2363
  ```js
F
fanchenxuan 已提交
2364
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2365
  let localId = 100;
2366
  try {
C
cclicn 已提交
2367 2368
    accountManager.getSerialNumberForOsAccountLocalId(localId).then((serialNumber) => {
      console.log('getSerialNumberForOsAccountLocalId serialNumber: ' + serialNumber);
2369
    }).catch((err) => {
C
cclicn 已提交
2370
      console.log('getSerialNumberForOsAccountLocalId err: '  + JSON.stringify(err));
2371 2372
    });
  } catch (e) {
C
cclicn 已提交
2373
    console.log('getSerialNumberForOsAccountLocalId exception:' + JSON.stringify(e));
2374 2375 2376
  }
  ```

J
jidong 已提交
2377
### on
2378

J
jidong 已提交
2379 2380
on(type: 'activate' | 'activating', name: string, callback: Callback&lt;number&gt;): void

2381
订阅系统帐号的激活完成与激活中的事件。使用callback异步回调。
2382

J
jidong 已提交
2383 2384 2385
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
2386 2387 2388 2389 2390

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
2391 2392 2393 2394
| 参数名   | 类型                       | 必填 | 说明                                                         |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| type     | 'activate' \| 'activating' | 是   | 订阅类型,activate表示订阅的是帐号已激活完成的事件,activating表示订阅的是帐号正在激活的事件。 |
| name     | string                     | 是   | 订阅名称,可自定义,要求非空且长度不超过1024字节。           |
2395
| callback | Callback&lt;number&gt;     | 是   | 订阅系统帐号激活完成与激活中的事件回调,表示激活完成后或正在激活中的系统帐号ID。    |
2396

J
jidong 已提交
2397 2398 2399 2400 2401 2402 2403
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or name. |

2404 2405 2406 2407
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2408 2409 2410
  function onCallback(receiveLocalId){
    console.log('receive localId:' + receiveLocalId);
  }
2411
  try {
J
jidong 已提交
2412
    accountManager.on('activating', 'osAccountOnOffNameA', onCallback);
2413
  } catch (e) {
J
jidong 已提交
2414
    console.log('receive localId exception:' + JSON.stringify(e));
2415 2416 2417
  }
  ```

J
jidong 已提交
2418
### off
2419

J
jidong 已提交
2420 2421
off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number&gt;): void

2422
取消订阅系统帐号的激活完成与激活中的事件。使用callback异步回调。
2423

J
jidong 已提交
2424 2425 2426
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
2427 2428 2429

**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
2430
**参数:**
2431

J
jidong 已提交
2432 2433 2434
| 参数名   | 类型                       | 必填 | 说明                                                         |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| type     | 'activate' \| 'activating' | 是   | 取消订阅类型,activate表示取消订阅帐号已激活完成的事件,activating取消订阅帐号正在激活的事件。 |
C
cclicn 已提交
2435
| name     | string                     | 是   | 订阅名称,可自定义,要求非空且长度不超过1024字节,需要与订阅接口传入的值保持一致。 |
2436
| callback | Callback&lt;number&gt;     | 否   | 取消订阅系统帐号激活完成与激活中的事件回调,默认返回0。                      |
2437

J
jidong 已提交
2438 2439 2440 2441 2442 2443 2444
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or name. |

2445 2446 2447 2448
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2449 2450 2451
  function offCallback(){
    console.log('off enter')
  }
2452
  try {
J
jidong 已提交
2453
    accountManager.off('activating', 'osAccountOnOffNameA', offCallback);
2454
  } catch (e) {
J
jidong 已提交
2455
    console.log('off exception:' + JSON.stringify(e));
2456
  }
Z
zhangalong 已提交
2457 2458
  ```

C
cclicn 已提交
2459
### getBundleIdForUid<sup>9+</sup>
Z
zhangalong 已提交
2460

C
cclicn 已提交
2461
getBundleIdForUid(uid: number, callback: AsyncCallback&lt;number&gt;): void;
Z
zhangalong 已提交
2462

J
jidong 已提交
2463
通过uid查询对应的bundleId,使用callback异步回调。
Z
zhangalong 已提交
2464

J
jidong 已提交
2465
**系统接口:** 此接口为系统接口。
2466

Z
zengyawen 已提交
2467 2468 2469
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
2470

J
jidong 已提交
2471 2472 2473 2474
| 参数名   | 类型                       | 必填 | 说明                                                                        |
| -------- | --------------------------- | ---- | ------------------------------------------------------------------------ |
| uid      | number                      | 是   | 进程uid。                                                                 |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。如果查询成功,err为null,data为与uid对应的bundleId;否则为错误对象。 |
Z
zhangalong 已提交
2475

J
jidong 已提交
2476 2477 2478 2479
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
C
chennian 已提交
2480 2481
| 12300001 | System service exception. |
| 12300002 | Invalid uid. |
J
jidong 已提交
2482

2483
**示例:**
Z
zhangalong 已提交
2484

Z
zhangalong 已提交
2485
  ```js
F
fanchenxuan 已提交
2486
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2487 2488
  let testUid = 1000000;
  try {
C
cclicn 已提交
2489 2490 2491
    accountManager.getBundleIdForUid(testUid, (err, bundleId) => {
      console.info('getBundleIdForUid errInfo:' + JSON.stringify(err));
      console.info('getBundleIdForUid bundleId:' + JSON.stringify(bundleId));
J
jidong 已提交
2492 2493
    });
  } catch (e) {
C
cclicn 已提交
2494
    console.info('getBundleIdForUid exception:' + JSON.stringify(e));
J
jidong 已提交
2495
  }
Z
zhangalong 已提交
2496
  ```
C
cclicn 已提交
2497
### getBundleIdForUid<sup>9+</sup>
Z
zhangalong 已提交
2498

C
cclicn 已提交
2499
getBundleIdForUid(uid: number): Promise&lt;number&gt;;
Z
zhangalong 已提交
2500

A
Annie_wang 已提交
2501
通过uid查询对应的bundleId,使用Promise异步回调。
2502

J
jidong 已提交
2503
**系统接口:** 此接口为系统接口。
Z
zhangalong 已提交
2504

Z
zengyawen 已提交
2505
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2506

J
jidong 已提交
2507 2508 2509 2510 2511 2512
**参数:**

| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| uid     | number | 是   |  进程uid。 |

Z
zengyawen 已提交
2513
**返回值:**
Z
zhangalong 已提交
2514

J
jidong 已提交
2515 2516 2517
| 类型                  | 说明                                  |
| --------------------- | ------------------------------------ |
| Promise&lt;number&gt; | Promise对象,返回与uid对应的bundleId。 |
Z
zengyawen 已提交
2518

J
jidong 已提交
2519 2520 2521 2522
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
C
chennian 已提交
2523 2524
| 12300001 | System service exception. |
| 12300002 | Invalid uid. |
J
jidong 已提交
2525

2526
**示例:**
Z
zhangalong 已提交
2527

Z
zhangalong 已提交
2528
  ```js
F
fanchenxuan 已提交
2529
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2530 2531
  let testUid = 1000000;
  try {
C
cclicn 已提交
2532 2533
    accountManager.getBundleIdForUid(testUid).then((result) => {
      console.info('getBundleIdForUid bundleId:' + JSON.stringify(result));
J
jidong 已提交
2534
    }).catch((err)=>{
C
cclicn 已提交
2535
      console.info('getBundleIdForUid errInfo:' + JSON.stringify(err));
J
jidong 已提交
2536 2537
    });
  } catch (e) {
C
cclicn 已提交
2538
    console.info('getBundleIdForUid exception:' + JSON.stringify(e));
J
jidong 已提交
2539 2540
  }
  ```
Z
zhangalong 已提交
2541

J
jidong 已提交
2542 2543 2544
### isMainOsAccount<sup>9+</sup>

isMainOsAccount(callback: AsyncCallback&lt;boolean&gt;): void;
Z
zhangalong 已提交
2545

J
jidong 已提交
2546
查询当前进程是否处于主用户,使用callback异步回调。
Z
zhangalong 已提交
2547

J
jidong 已提交
2548
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
2549 2550

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zhangalong 已提交
2551

Z
zengyawen 已提交
2552
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2553

Z
zengyawen 已提交
2554 2555
**参数:**

J
jidong 已提交
2556 2557 2558
| 参数名   | 类型                          | 必填 | 说明                                                               |
| -------- | ---------------------------- | ---- | ----------------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数,返回true表示当前帐号为主帐号,返回false表示当前帐号非主帐号。 |
Z
zengyawen 已提交
2559

J
jidong 已提交
2560 2561 2562 2563 2564 2565
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |

2566
**示例:**
Z
zhangalong 已提交
2567

Z
zhangalong 已提交
2568
  ```js
F
fanchenxuan 已提交
2569
  let accountManager = account_osAccount.getAccountManager();
2570
  try {
J
jidong 已提交
2571 2572 2573
    accountManager.isMainOsAccount((err,result)=>{
      console.info('isMainOsAccount errInfo:' + JSON.stringify(err));
      console.info('isMainOsAccount result:' + JSON.stringify(result));
2574 2575
    });
  } catch (e) {
J
jidong 已提交
2576
    console.info('isMainOsAccount exception:' + JSON.stringify(e));
2577
  }
Z
zhangalong 已提交
2578
  ```
J
jidong 已提交
2579
### isMainOsAccount<sup>9+</sup>
Z
zhangalong 已提交
2580

J
jidong 已提交
2581
isMainOsAccount(): Promise&lt;boolean&gt;;
Z
zhangalong 已提交
2582

J
jidong 已提交
2583
查询当前进程是否处于主用户,使用Promise异步回调。
Z
zhangalong 已提交
2584

J
jidong 已提交
2585
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
2586 2587 2588 2589

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2590

Z
zengyawen 已提交
2591
**返回值:**
Z
zhangalong 已提交
2592

J
jidong 已提交
2593 2594 2595
| 类型                   | 说明                                                                  |
| ---------------------- | --------------------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象,返回true表示当前帐号为主帐号,返回false表示当前帐号非主帐号。 |
Z
zengyawen 已提交
2596

J
jidong 已提交
2597 2598 2599 2600 2601 2602
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |

2603
**示例:**
Z
zhangalong 已提交
2604

Z
zhangalong 已提交
2605
  ```js
F
fanchenxuan 已提交
2606
  let accountManager = account_osAccount.getAccountManager();
2607
  try {
J
jidong 已提交
2608 2609 2610 2611
    accountManager.isMainOsAccount().then((result) => {
      console.info('isMainOsAccount result:' + JSON.stringify(result));
    }).catch((err)=>{
      console.info('isMainOsAccount errInfo:' + JSON.stringify(err));
2612 2613
    });
  } catch (e) {
J
jidong 已提交
2614
    console.info('isMainOsAccount exception:' + JSON.stringify(e));
2615
  }
Z
zhangalong 已提交
2616
  ```
C
cclicn 已提交
2617
### getOsAccountConstraintSourceTypes<sup>9+</sup>
Z
zhangalong 已提交
2618

C
cclicn 已提交
2619
getOsAccountConstraintSourceTypes(localId: number, constraint: string, callback: AsyncCallback&lt;Array&lt;ConstraintSourceTypeInfo&gt;&gt;): void;
Z
zhangalong 已提交
2620

J
jidong 已提交
2621
查询指定系统帐号的指定约束来源信息,使用callback异步回调。
Z
zhangalong 已提交
2622

J
jidong 已提交
2623
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
2624 2625 2626 2627

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2628

Z
zengyawen 已提交
2629
**参数:**
Z
zhangalong 已提交
2630

J
jidong 已提交
2631 2632 2633 2634 2635
| 参数名   | 类型                       | 必填 | 说明                                                         |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| localId     | number | 是   |  要查询的系统帐号ID |
| constraint     | string | 是   |  要查询的[约束](#系统帐号约束列表)名称 |
| callback | AsyncCallback&lt;Array&lt;[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)&gt;&gt;     | 是   | 回调函数。如果成功,err为null,data为指定系统帐号的指定[约束](#系统帐号约束列表)来源信息;否则为错误对象。                      |
Z
zengyawen 已提交
2636

J
jidong 已提交
2637 2638 2639 2640
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
C
chennian 已提交
2641 2642 2643
| 12300001 | System service exception. |
| 12300002 | Invalid name or constraint. |
| 12300003 | Account not found. |
J
jidong 已提交
2644

2645
**示例:**
Z
zhangalong 已提交
2646

Z
zhangalong 已提交
2647
  ```js
F
fanchenxuan 已提交
2648
  let accountManager = account_osAccount.getAccountManager();
2649
  try {
C
cclicn 已提交
2650 2651 2652
    accountManager.getOsAccountConstraintSourceTypes(100, 'constraint.wifi',(err,sourceTypeInfos)=>{
      console.info('getOsAccountConstraintSourceTypes errInfo:' + JSON.stringify(err));
      console.info('getOsAccountConstraintSourceTypes sourceTypeInfos:' + JSON.stringify(sourceTypeInfos));
2653 2654
    });
  } catch (e) {
C
cclicn 已提交
2655
    console.info('getOsAccountConstraintSourceTypes exception:' + JSON.stringify(e));
2656
  }
Z
zhangalong 已提交
2657 2658
  ```

C
cclicn 已提交
2659
### getOsAccountConstraintSourceTypes<sup>9+</sup>
Z
zhangalong 已提交
2660

C
cclicn 已提交
2661
getOsAccountConstraintSourceTypes(localId: number, constraint: string): Promise&lt;Array&lt;ConstraintSourceTypeInfo&gt;&gt;;
Z
zhangalong 已提交
2662

J
jidong 已提交
2663
查询指定系统帐号的指定约束来源信息,使用Promise异步回调。
Z
zhangalong 已提交
2664

J
jidong 已提交
2665
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
2666 2667 2668 2669 2670 2671

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
2672

J
jidong 已提交
2673 2674 2675 2676
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId     | number | 是   |  要查询的系统帐号ID |
| constraint     | string | 是   |  要查询的[约束](#系统帐号约束列表)名称 |
Z
zhangalong 已提交
2677

Z
zengyawen 已提交
2678
**返回值:**
Z
zhangalong 已提交
2679

J
jidong 已提交
2680
| 类型                  | 说明                                                         |
J
jidong 已提交
2681
| --------------------- | ------------------------------------------------------------ |
J
jidong 已提交
2682
| Promise&lt;Array&lt;[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)&gt;&gt; | Promise对象,返回指定系统帐号的指定[约束](#系统帐号约束列表)来源信息。 |
Z
zhangalong 已提交
2683

J
jidong 已提交
2684 2685 2686 2687
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
C
chennian 已提交
2688 2689 2690
| 12300001 | System service exception. |
| 12300002 | Invalid name or constraint. |
| 12300003 | Account not found. |
J
jidong 已提交
2691

2692
**示例:**
Z
zhangalong 已提交
2693

Z
zhangalong 已提交
2694
  ```js
F
fanchenxuan 已提交
2695
  let accountManager = account_osAccount.getAccountManager();
2696
  try {
C
cclicn 已提交
2697 2698
    accountManager.getOsAccountConstraintSourceTypes(100, 'constraint.wifi').then((result) => {
      console.info('getOsAccountConstraintSourceTypes sourceTypeInfos:' + JSON.stringify(result));
J
jidong 已提交
2699
    }).catch((err)=>{
C
cclicn 已提交
2700
      console.info('getOsAccountConstraintSourceTypes errInfo:' + JSON.stringify(err));
2701 2702
    });
  } catch (e) {
C
cclicn 已提交
2703
    console.info('getOsAccountConstraintSourceTypes exception:' + JSON.stringify(e));
2704 2705 2706
  }
  ```

J
jidong 已提交
2707
### isMultiOsAccountEnable<sup>(deprecated)</sup>
2708

J
jidong 已提交
2709
isMultiOsAccountEnable(callback: AsyncCallback&lt;boolean&gt;): void
2710

J
jidong 已提交
2711
判断是否支持多系统帐号。使用callback异步回调。
2712

A
Annie_wang 已提交
2713
> **说明:** 
J
jidong 已提交
2714
>
A
Annie_wang 已提交
2715
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkMultiOsAccountEnabled](#checkmultiosaccountenabled9)。
2716 2717 2718 2719 2720

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
2721 2722 2723
| 参数名   | 类型                         | 必填 | 说明                                                     |
| -------- | ---------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示支持多系统帐号;返回false表示不支持。 |
2724 2725 2726 2727 2728

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2729
  accountManager.isMultiOsAccountEnable((err, isEnabled) => {
J
jidong 已提交
2730 2731 2732 2733 2734 2735
    if (err) {
      console.log("isMultiOsAccountEnable failed, error: " + JSON.stringify(err));
    } else {
    console.log("isMultiOsAccountEnable successfully, isEnabled: " + isEnabled);
    }
  });
2736 2737
  ```

J
jidong 已提交
2738
### isMultiOsAccountEnable<sup>(deprecated)</sup>
2739

J
jidong 已提交
2740
isMultiOsAccountEnable(): Promise&lt;boolean&gt;
2741

J
jidong 已提交
2742
判断是否支持多系统帐号。使用Promise异步回调。
2743

A
Annie_wang 已提交
2744
> **说明:** 
J
jidong 已提交
2745
>
A
Annie_wang 已提交
2746
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkMultiOsAccountEnabled](#checkmultiosaccountenabled9-1)。
2747 2748 2749 2750 2751

**系统能力:** SystemCapability.Account.OsAccount

**返回值:**

J
jidong 已提交
2752 2753 2754
| 类型                   | 说明                                                       |
| :--------------------- | :--------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示支持多系统帐号;返回false表示不支持。 |
2755 2756 2757 2758 2759

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2760 2761 2762 2763 2764
  accountManager.isMultiOsAccountEnable().then((isEnabled) => {
    console.log('isMultiOsAccountEnable successfully, isEnabled: ' + isEnabled);
  }).catch((err) => {
    console.log('isMultiOsAccountEnable failed, error: '  + JSON.stringify(err));
  });
Z
zhangalong 已提交
2765 2766 2767
  ```


J
jidong 已提交
2768
### isOsAccountActived<sup>(deprecated)</sup>
Z
zhangalong 已提交
2769

J
jidong 已提交
2770
isOsAccountActived(localId: number, callback: AsyncCallback&lt;boolean&gt;): void
Z
zhangalong 已提交
2771

J
jidong 已提交
2772 2773
判断指定系统帐号是否处于激活状态。使用callback异步回调。

A
Annie_wang 已提交
2774
> **说明:** 
2775
>
A
Annie_wang 已提交
2776
> 从 API version 7开始支持从API version 9开始废弃, 建议使用[checkOsAccountActivated](#checkosaccountactivated9)。
2777

J
jidong 已提交
2778
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
Z
zhangalong 已提交
2779

Z
zengyawen 已提交
2780
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2781

Z
zengyawen 已提交
2782 2783
**参数:**

J
jidong 已提交
2784 2785 2786 2787
| 参数名   | 类型                         | 必填 | 说明                                                     |
| -------- | ---------------------------- | ---- | ------------------------------------------------------ |
| localId  | number                       | 是   | 系统帐号ID。                                            |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示帐号已激活;返回false表示帐号未激活。 |
Z
zengyawen 已提交
2788

J
jidong 已提交
2789
**示例:** 判断ID为100的系统帐号是否处于激活状态
Z
zhangalong 已提交
2790

Z
zhangalong 已提交
2791
  ```js
F
fanchenxuan 已提交
2792
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2793 2794 2795 2796 2797 2798 2799
  let localId = 100;
  accountManager.isOsAccountActived(localId, (err, isActived) => {
    if (err) {
      console.log('isOsAccountActived failed, err:' + JSON.stringify(err));
    } else {
      console.log('isOsAccountActived successfully, isActived:' + isActived);
    }
Z
zhangalong 已提交
2800 2801 2802
  });
  ```

J
jidong 已提交
2803
### isOsAccountActived<sup>(deprecated)</sup>
Z
zhangalong 已提交
2804

J
jidong 已提交
2805
isOsAccountActived(localId: number): Promise&lt;boolean&gt;
Z
zhangalong 已提交
2806

J
jidong 已提交
2807
判断指定系统帐号是否处于激活状态。使用Promise异步回调。
Z
zhangalong 已提交
2808

A
Annie_wang 已提交
2809
> **说明:** 
2810
>
A
Annie_wang 已提交
2811
> 从 API version 7开始支持从API version 9开始废弃, 建议使用[checkOsAccountActivated](#checkosaccountactivated9-1)。
2812

J
jidong 已提交
2813
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
Z
zengyawen 已提交
2814 2815 2816

**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
2817 2818 2819 2820 2821 2822
**参数:**

| 参数名  | 类型   | 必填 | 说明                               |
| ------- | ------ | ---- | --------------------------------- |
| localId | number | 是   | 系统帐号ID。 |

Z
zengyawen 已提交
2823
**返回值:**
Z
zhangalong 已提交
2824

J
jidong 已提交
2825 2826 2827
| 类型                   | 说明                                                        |
| --------------------- | ----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示帐号已激活;返回false表示帐号未激活。 |
Z
zhangalong 已提交
2828

J
jidong 已提交
2829
**示例:** 判断ID为100的系统帐号是否处于激活状态
Z
zhangalong 已提交
2830

Z
zhangalong 已提交
2831
  ```js
F
fanchenxuan 已提交
2832
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2833 2834 2835
  let localId = 100;
  accountManager.isOsAccountActived(localId).then((isActived) => {
    console.log('isOsAccountActived successfully, isActived: ' + isActived);
Z
zhangalong 已提交
2836
  }).catch((err) => {
J
jidong 已提交
2837
    console.log('isOsAccountActived failed, error: '  + JSON.stringify(err));
Z
zhangalong 已提交
2838 2839 2840
  });
  ```

J
jidong 已提交
2841
### isOsAccountConstraintEnable<sup>(deprecated)</sup>
Z
zhangalong 已提交
2842

J
jidong 已提交
2843
isOsAccountConstraintEnable(localId: number, constraint: string, callback: AsyncCallback&lt;boolean&gt;): void
Z
zhangalong 已提交
2844

J
jidong 已提交
2845
判断指定系统帐号是否具有指定约束。使用callback异步回调。
Z
zhangalong 已提交
2846

A
Annie_wang 已提交
2847
> **说明:** 
J
jidong 已提交
2848
>
C
cclicn 已提交
2849
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountConstraintEnabled](#checkosaccountconstraintenabled9)。
Z
zhangalong 已提交
2850

J
jidong 已提交
2851
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zhangalong 已提交
2852

Z
zengyawen 已提交
2853 2854 2855 2856
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
2857 2858 2859 2860 2861
| 参数名     | 类型                         | 必填 | 说明                                                                |
| ---------- | ---------------------------- | ---- | ----------------------------------------------------------------- |
| localId    | number                       | 是   | 系统帐号ID。                                 |
| constraint | string                       | 是   | 指定的[约束](#系统帐号约束列表)名称。                                |
| callback   | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示已使能指定的约束;返回false表示未使能指定的约束。 |
Z
zengyawen 已提交
2862

J
jidong 已提交
2863
**示例:** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
Z
zhangalong 已提交
2864

Z
zhangalong 已提交
2865
  ```js
F
fanchenxuan 已提交
2866 2867
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
J
jidong 已提交
2868 2869 2870 2871 2872 2873 2874 2875
  let constraint = "constraint.wifi";
  accountManager.isOsAccountConstraintEnable(localId, constraint, (err, isEnabled) => {
    if (err) {
      console.log("isOsAccountConstraintEnable failed, error:" + JSON.stringify(err));
    } else {
      console.log("isOsAccountConstraintEnable successfully, isEnabled:" + isEnabled);
    }
  });
Z
zhangalong 已提交
2876 2877
  ```

J
jidong 已提交
2878
### isOsAccountConstraintEnable<sup>(deprecated)</sup>
Z
zhangalong 已提交
2879

J
jidong 已提交
2880
isOsAccountConstraintEnable(localId: number, constraint: string): Promise&lt;boolean&gt;
Z
zhangalong 已提交
2881

J
jidong 已提交
2882
判断指定系统帐号是否具有指定约束。使用Promise异步回调。
Z
zhangalong 已提交
2883

A
Annie_wang 已提交
2884
> **说明:** 
J
jidong 已提交
2885
>
C
cclicn 已提交
2886
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountConstraintEnabled](#checkosaccountconstraintenabled9-1)。
Z
zengyawen 已提交
2887

J
jidong 已提交
2888
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zhangalong 已提交
2889

Z
zengyawen 已提交
2890
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
2891

Z
zengyawen 已提交
2892
**参数:**
Z
zhangalong 已提交
2893

J
jidong 已提交
2894 2895 2896 2897
| 参数名     | 类型   | 必填 | 说明                                 |
| ---------- | ------ | ---- | ---------------------------------- |
| localId    | number | 是   | 系统帐号ID。  |
| constraint | string | 是   | 指定的[约束](#系统帐号约束列表)名称。 |
Z
zhangalong 已提交
2898

Z
zengyawen 已提交
2899 2900
**返回值:**

J
jidong 已提交
2901 2902 2903
| 类型                   | 说明                                                                   |
| ---------------------- | --------------------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示已使能指定的约束;返回false表示未使能指定的约束。 |
Z
zengyawen 已提交
2904

J
jidong 已提交
2905
**示例:** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
2906 2907 2908 2909

  ```js
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
J
jidong 已提交
2910 2911 2912 2913 2914 2915
  let constraint = "constraint.wifi";
  accountManager.isOsAccountConstraintEnable(localId, constraint).then((isEnabled) => {
    console.log("isOsAccountConstraintEnable successfully, isEnabled: " + isEnabled);
  }).catch((err) => {
    console.log("isOsAccountConstraintEnable err: "  + JSON.stringify(err));
  });
2916 2917
  ```

J
jidong 已提交
2918
### isTestOsAccount<sup>(deprecated)</sup>
2919

J
jidong 已提交
2920
isTestOsAccount(callback: AsyncCallback&lt;boolean&gt;): void
2921

J
jidong 已提交
2922 2923
检查当前系统帐号是否为测试帐号。使用callback异步回调。

A
Annie_wang 已提交
2924
> **说明:** 
J
jidong 已提交
2925
>
A
Annie_wang 已提交
2926
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountTestable](#checkosaccounttestable9)。
2927 2928 2929 2930 2931

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
2932 2933 2934
| 参数名   | 类型                         | 必填 | 说明                                                                   |
| -------- | ---------------------------- | ---- | --------------------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示当前帐号为测试帐号;返回false表示当前帐号非测试帐号。 |
2935 2936 2937 2938 2939

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2940 2941 2942 2943 2944 2945 2946
  accountManager.isTestOsAccount((err, isTestable) => {
    if (err) {
      console.log("isTestOsAccount failed, error: " + JSON.stringify(err));
    } else {
      console.log("isTestOsAccount successfully, isTestable: " + isTestable);
    }
  });
2947 2948
  ```

J
jidong 已提交
2949
### isTestOsAccount<sup>(deprecated)</sup>
2950

J
jidong 已提交
2951 2952 2953
isTestOsAccount(): Promise&lt;boolean&gt;

检查当前系统帐号是否为测试帐号。使用Promise异步回调。
2954

A
Annie_wang 已提交
2955
> **说明:** 
J
jidong 已提交
2956
>
A
Annie_wang 已提交
2957
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountTestable](#checkosaccounttestable9-1)。
2958 2959 2960 2961 2962

**系统能力:** SystemCapability.Account.OsAccount

**返回值:**

J
jidong 已提交
2963 2964 2965
| 类型                   | 说明                                                                      |
| ---------------------- | ------------------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise对象。返回true表示当前帐号为测试帐号;返回false表示当前帐号非测试帐号。 |
2966 2967 2968 2969 2970

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2971 2972 2973 2974 2975
  accountManager.isTestOsAccount().then((isTestable) => {
      console.log("isTestOsAccount successfully, isTestable: " + isTestable);
  }).catch((err) => {
      console.log("isTestOsAccount failed, error: " + JSON.stringify(err));
  });
2976 2977
  ```

J
jidong 已提交
2978
### isOsAccountVerified<sup>(deprecated)</sup>
2979

J
jidong 已提交
2980
isOsAccountVerified(callback: AsyncCallback&lt;boolean&gt;): void
2981

J
jidong 已提交
2982
检查当前系统帐号是否已验证。使用callback异步回调。
2983

A
Annie_wang 已提交
2984
> **说明:** 
2985
>
A
Annie_wang 已提交
2986
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountVerified](#checkosaccountverified9)。
2987

J
jidong 已提交
2988 2989
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

2990 2991 2992 2993
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
2994 2995 2996
| 参数名   | 类型                         | 必填 | 说明                                                            |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示指定帐号已验证;返回false表示指定帐号未验证。 |
2997 2998 2999 3000 3001

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3002 3003 3004 3005 3006 3007
  accountManager.isOsAccountVerified((err, isVerified) => {
    if (err) {
      console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
    } else {
      console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
    }
3008 3009 3010
  });
  ```

J
jidong 已提交
3011
### isOsAccountVerified<sup>(deprecated)</sup>
3012

J
jidong 已提交
3013
isOsAccountVerified(localId: number, callback: AsyncCallback&lt;boolean&gt;): void
3014

J
jidong 已提交
3015
检查指定系统帐号是否已验证。使用callback异步回调。
3016

A
Annie_wang 已提交
3017
> **说明:** 
3018
>
A
Annie_wang 已提交
3019
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountVerified](#checkosaccountverified9-1)。
3020

J
jidong 已提交
3021 3022
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

3023 3024
**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
3025
**参数:**
3026

J
jidong 已提交
3027 3028
| 参数名   | 类型                         | 必填 | 说明                                                            |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------- |
3029
| localId  | number                       | 是   | 系统帐号ID。                             |
J
jidong 已提交
3030
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示指定帐号已验证;返回false表示指定帐号未验证。 |
3031 3032

**示例:**
Z
zhangalong 已提交
3033

Z
zhangalong 已提交
3034
  ```js
F
fanchenxuan 已提交
3035
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3036 3037 3038 3039 3040 3041 3042
  let localId = 100;
  accountManager.isOsAccountVerified(localId, (err, isVerified) => {
    if (err) {
      console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
    } else {
      console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
    }
Z
zhangalong 已提交
3043 3044 3045
  });
  ```

J
jidong 已提交
3046
### isOsAccountVerified<sup>(deprecated)</sup>
Z
zhangalong 已提交
3047

J
jidong 已提交
3048
isOsAccountVerified(localId?: number): Promise&lt;boolean&gt;
Z
zhangalong 已提交
3049

J
jidong 已提交
3050
检查指定系统帐号是否已验证。使用Promise异步回调。
3051

A
Annie_wang 已提交
3052
> **说明:** 
J
jidong 已提交
3053
>
A
Annie_wang 已提交
3054
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountVerified](#checkosaccountverified9-2)。
J
jidong 已提交
3055 3056

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
Z
zhangalong 已提交
3057

Z
zengyawen 已提交
3058 3059 3060
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
3061

J
jidong 已提交
3062 3063 3064
| 参数名  | 类型   | 必填 | 说明                                                              |
| ------- | ------ | ---- | ---------------------------------------------------------------- |
| localId | number | 否   | 系统帐号ID。不填则检查当前系统帐号是否已验证。 |
Z
zhangalong 已提交
3065

Z
zengyawen 已提交
3066
**返回值:**
Z
zhangalong 已提交
3067

J
jidong 已提交
3068 3069 3070
| 类型                   | 说明                                                               |
| ---------------------- | ----------------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示指定帐号已验证;返回false表示指定帐号未验证。 |
Z
zengyawen 已提交
3071

3072
**示例:**
Z
zhangalong 已提交
3073

Z
zhangalong 已提交
3074
  ```js
F
fanchenxuan 已提交
3075
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3076 3077 3078 3079 3080
  accountManager.isOsAccountVerified(localId).then((isVerified) => {
    console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
  }).catch((err) => {
    console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
  });
Z
zhangalong 已提交
3081 3082
  ```

J
jidong 已提交
3083
### getCreatedOsAccountsCount<sup>(deprecated)</sup>
Z
zhangalong 已提交
3084

J
jidong 已提交
3085
getCreatedOsAccountsCount(callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
3086

J
jidong 已提交
3087
获取已创建的系统帐号数量。使用callback异步回调。
Z
zhangalong 已提交
3088

A
Annie_wang 已提交
3089
> **说明:** 
3090
>
A
Annie_wang 已提交
3091
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountCount](#getosaccountcount9)。
3092

J
jidong 已提交
3093
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
3094 3095

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3096

Z
zengyawen 已提交
3097
**参数:**
Z
zhangalong 已提交
3098

J
jidong 已提交
3099 3100 3101
| 参数名   | 类型                        | 必填 | 说明                                                                         |
| -------- | --------------------------- | ---- | -------------------------------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。当获取成功时,err为null,data为已创建的系统帐号的数量;否则为错误对象。 |
Z
zengyawen 已提交
3102

3103
**示例:**
Z
zhangalong 已提交
3104

Z
zhangalong 已提交
3105
  ```js
F
fanchenxuan 已提交
3106
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3107 3108 3109 3110 3111 3112
  accountManager.getCreatedOsAccountsCount((err, count)=>{
    if (err) {
      console.log("getCreatedOsAccountsCount failed, error: " + JSON.stringify(err));
    } else {
      console.log("getCreatedOsAccountsCount successfully, count: " + count);
    }
Z
zhangalong 已提交
3113 3114 3115
  });
  ```

J
jidong 已提交
3116
### getCreatedOsAccountsCount<sup>(deprecated)</sup>
Z
zhangalong 已提交
3117

J
jidong 已提交
3118
getCreatedOsAccountsCount(): Promise&lt;number&gt;
Z
zhangalong 已提交
3119

J
jidong 已提交
3120
获取已创建的系统帐号数量,使用Promise异步回调。
Z
zhangalong 已提交
3121

A
Annie_wang 已提交
3122
> **说明:** 
3123
>
A
Annie_wang 已提交
3124
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountCount](#getosaccountcount9-1)。
3125

J
jidong 已提交
3126
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
3127 3128

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3129

Z
zengyawen 已提交
3130
**返回值:**
Z
zhangalong 已提交
3131

J
jidong 已提交
3132 3133 3134
| 类型                  | 说明                                    |
| --------------------- | -------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回已创建的系统帐号的数量。 |
Z
zengyawen 已提交
3135

3136
**示例:**
Z
zhangalong 已提交
3137

Z
zhangalong 已提交
3138
  ```js
F
fanchenxuan 已提交
3139
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3140 3141
  accountManager.getCreatedOsAccountsCount().then((count) => {
    console.log("getCreatedOsAccountsCount successfully, count: " + count);
Z
zhangalong 已提交
3142
  }).catch((err) => {
J
jidong 已提交
3143
    console.log("getCreatedOsAccountsCount failed, error: "  + JSON.stringify(err));
Z
zhangalong 已提交
3144 3145 3146
  });
  ```

J
jidong 已提交
3147
### getOsAccountLocalIdFromProcess<sup>(deprecated)</sup>
Z
zhangalong 已提交
3148

J
jidong 已提交
3149
getOsAccountLocalIdFromProcess(callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
3150

J
jidong 已提交
3151
获取当前进程所属的系统帐号ID,使用callback异步回调。
Z
zengyawen 已提交
3152

A
Annie_wang 已提交
3153
> **说明:** 
J
jidong 已提交
3154
>
C
cclicn 已提交
3155
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalId](#getosaccountlocalid9)。
Z
zengyawen 已提交
3156 3157 3158 3159

**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
3160

J
jidong 已提交
3161 3162 3163
| 参数名   | 类型                        | 必填 | 说明                                                                           |
| -------- | --------------------------- | ---- | ---------------------------------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。当获取成功时,err为null,data为当前进程所属的系统帐号ID;否则为错误对象。 |
Z
zhangalong 已提交
3164

J
jidong 已提交
3165
**示例:**
Z
zhangalong 已提交
3166

Z
zhangalong 已提交
3167
  ```js
F
fanchenxuan 已提交
3168
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3169 3170 3171 3172 3173 3174 3175
  accountManager.getOsAccountLocalIdFromProcess((err, localId) => {
    if (err) {
      console.log("getOsAccountLocalIdFromProcess failed, error: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountLocalIdFromProcess successfully, localId: " + localId);
    }
  });
Z
zhangalong 已提交
3176 3177
  ```

J
jidong 已提交
3178
### getOsAccountLocalIdFromProcess<sup>(deprecated)</sup>
Z
zhangalong 已提交
3179

J
jidong 已提交
3180
getOsAccountLocalIdFromProcess(): Promise&lt;number&gt;
Z
zhangalong 已提交
3181

J
jidong 已提交
3182
获取当前进程所属的系统帐号ID,使用Promise异步回调。
Z
zhangalong 已提交
3183

A
Annie_wang 已提交
3184
> **说明:**
J
jidong 已提交
3185
>
C
cclicn 已提交
3186
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalId](#getosaccountlocalid9-1)。
Z
zhangalong 已提交
3187

Z
zengyawen 已提交
3188
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3189

Z
zengyawen 已提交
3190 3191
**返回值:**

J
jidong 已提交
3192 3193 3194
| 类型                  | 说明                                      |
| :-------------------- | :--------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回当前进程所属的系统帐号ID。 |
Z
zengyawen 已提交
3195

J
jidong 已提交
3196
**示例:**
Z
zhangalong 已提交
3197

Z
zhangalong 已提交
3198
  ```js
F
fanchenxuan 已提交
3199
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3200 3201 3202 3203 3204
  accountManager.getOsAccountLocalIdFromProcess().then((localId) => {
    console.log('getOsAccountLocalIdFromProcess successfully, localId: ' + localId);
  }).catch((err) => {
    console.log('getOsAccountLocalIdFromProcess failed, error: '  + JSON.stringify(err));
  });
Z
zhangalong 已提交
3205 3206
  ```

J
jidong 已提交
3207
### getOsAccountLocalIdFromUid<sup>(deprecated)</sup>
Z
zhangalong 已提交
3208

J
jidong 已提交
3209
getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
3210

J
jidong 已提交
3211
根据uid查询对应的系统帐号ID。使用callback异步回调。
Z
zengyawen 已提交
3212

A
Annie_wang 已提交
3213
> **说明:** 
J
jidong 已提交
3214
>
C
cclicn 已提交
3215
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForUid](#getosaccountlocalidforuid9)。
Z
zhangalong 已提交
3216

Z
zengyawen 已提交
3217
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3218

Z
zengyawen 已提交
3219 3220
**参数:**

J
jidong 已提交
3221 3222 3223 3224
| 参数名   | 类型                        | 必填 | 说明                                                                    |
| -------- | --------------------------- | ---- | --------------------------------------------------------------------- |
| uid      | number                      | 是   | 进程uid。                                                              |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。如果查询成功,err为null,data为对应的系统帐号ID;否则为错误对象。 |
Z
zengyawen 已提交
3225

J
jidong 已提交
3226
**示例:** 查询值为12345678的uid所属的系统帐号ID
Z
zhangalong 已提交
3227

Z
zhangalong 已提交
3228
  ```js
F
fanchenxuan 已提交
3229
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3230 3231 3232 3233 3234 3235 3236 3237
  let uid = 12345678;
  accountManager.getOsAccountLocalIdFromUid(uid, (err, localId) => {
    if (err) {
      console.log("getOsAccountLocalIdFromUid failed, error: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountLocalIdFromUid successfully, localId: " + localId);
    }
  });
Z
zhangalong 已提交
3238 3239
  ```

J
jidong 已提交
3240
### getOsAccountLocalIdFromUid<sup>(deprecated)</sup>
Z
zhangalong 已提交
3241

J
jidong 已提交
3242
getOsAccountLocalIdFromUid(uid: number): Promise&lt;number&gt;
Z
zhangalong 已提交
3243

J
jidong 已提交
3244
根据uid查询对应的系统帐号ID,使用Promise异步回调。
Z
zengyawen 已提交
3245

A
Annie_wang 已提交
3246
> **说明:** 
J
jidong 已提交
3247
>
C
cclicn 已提交
3248
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForUid](#getosaccountlocalidforuid9-1)。
Z
zhangalong 已提交
3249

Z
zengyawen 已提交
3250
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3251

Z
zengyawen 已提交
3252
**参数:**
Z
zhangalong 已提交
3253

J
jidong 已提交
3254 3255 3256
| 参数名 | 类型   | 必填 | 说明      |
| ------ | ------ | ---- | --------- |
| uid    | number | 是   | 进程uid。 |
Z
zhangalong 已提交
3257

Z
zengyawen 已提交
3258 3259
**返回值:**

J
jidong 已提交
3260 3261 3262
| 类型                  | 说明                                  |
| :-------------------- | :----------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回uid对应的系统帐号ID。 |
Z
zengyawen 已提交
3263

J
jidong 已提交
3264
**示例:** 查询值为12345678的uid所属的系统帐号ID
Z
zhangalong 已提交
3265

Z
zhangalong 已提交
3266
  ```js
F
fanchenxuan 已提交
3267
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3268 3269 3270 3271 3272 3273
  let uid = 12345678;
  accountManager.getOsAccountLocalIdFromUid(uid).then((localId) => {
    console.log("getOsAccountLocalIdFromUid successfully, localId: " + localId);
  }).catch((err) => {
    console.log("getOsAccountLocalIdFromUid failed, error: "  + JSON.stringify(err));
  });
3274 3275
  ```

J
jidong 已提交
3276
### getOsAccountLocalIdFromDomain<sup>(deprecated)</sup>
3277

J
jidong 已提交
3278 3279 3280 3281
getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;number&gt;): void

根据域帐号信息,获取与其关联的系统帐号的帐号ID。使用callback异步回调。

A
Annie_wang 已提交
3282
> **说明:** 
J
jidong 已提交
3283
>
C
cclicn 已提交
3284
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForDomain](#getosaccountlocalidfordomain9)。
3285

J
jidong 已提交
3286
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
3287 3288 3289 3290 3291

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3292 3293 3294 3295
| 参数名     | 类型                                    | 必填 | 说明                                                                         |
| ---------- | --------------------------------------- | ---- | --------------------------------------------------------------------------- |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。                                                                |
| callback   | AsyncCallback&lt;number&gt;             | 是   | 回调函数,如果获取成功,err为null,data为域帐号关联的系统帐号ID;否则为错误对象。 |
3296

J
jidong 已提交
3297
**示例:**
3298 3299

  ```js
J
jidong 已提交
3300
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
3301
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3302 3303 3304 3305 3306 3307 3308
  accountManager.getOsAccountLocalIdFromDomain(domainInfo, (err, localId) => {
    if (err) {
      console.log("getOsAccountLocalIdFromDomain failed, error: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountLocalIdFromDomain successfully, localId: " + localId);
    }
  });
3309 3310
  ```

J
jidong 已提交
3311
### getOsAccountLocalIdFromDomain<sup>(deprecated)</sup>
3312

J
jidong 已提交
3313 3314 3315 3316
getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise&lt;number&gt;

根据域帐号信息,获取与其关联的系统帐号的帐号ID。使用Promise异步回调。

A
Annie_wang 已提交
3317
> **说明:** 
J
jidong 已提交
3318
>
C
cclicn 已提交
3319
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForDomain](#getosaccountlocalidfordomain9-1)。
3320

J
jidong 已提交
3321
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
3322 3323 3324 3325 3326

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3327 3328 3329
| 参数名     | 类型                                    | 必填 | 说明         |
| ---------- | --------------------------------------- | ---- | ------------ |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。 |
3330 3331 3332

**返回值:**

J
jidong 已提交
3333 3334 3335
| 类型                  | 说明                                    |
| :-------------------- | :------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回域帐号关联的系统帐号ID。 |
3336

J
jidong 已提交
3337
**示例:**
3338 3339 3340

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3341 3342 3343 3344 3345 3346
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
  accountManager.getOsAccountLocalIdFromDomain(domainInfo).then((localId) => {
    console.log('getOsAccountLocalIdFromDomain successfully, localId: ' + localId);
  }).catch((err) => {
    console.log('getOsAccountLocalIdFromDomain failed, error: '  + JSON.stringify(err));
  });
Z
zhangalong 已提交
3347 3348
  ```

J
jidong 已提交
3349
### getOsAccountAllConstraints<sup>(deprecated)</sup>
Z
zhangalong 已提交
3350

J
jidong 已提交
3351
getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
Z
zhangalong 已提交
3352

J
jidong 已提交
3353
获取指定系统帐号的全部约束。使用callback异步回调。
Z
zhangalong 已提交
3354

A
Annie_wang 已提交
3355
> **说明:** 
3356
>
A
Annie_wang 已提交
3357
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountConstraints](#getosaccountconstraints9)。
J
jidong 已提交
3358 3359

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
3360

Z
zengyawen 已提交
3361
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3362

Z
zengyawen 已提交
3363
**参数:**
Z
zhangalong 已提交
3364

J
jidong 已提交
3365 3366 3367 3368
| 参数名   | 类型                                     | 必填 | 说明                                                                                             |
| -------- | ---------------------------------------- | ---- | ---------------------------------------------------------------------------------------------- |
| localId  | number                                   | 是   | 系统帐号ID。                                                                                    |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是   | 回调函数。如果获取成功,err为null,data为指定系统帐号的全部[约束](#系统帐号约束列表);否则为错误对象。 |
Z
zengyawen 已提交
3369

J
jidong 已提交
3370
**示例:** 获取ID为100的系统帐号的全部约束
Z
zhangalong 已提交
3371

Z
zhangalong 已提交
3372
  ```js
F
fanchenxuan 已提交
3373
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3374 3375 3376 3377
  let localId = 100;
  accountManager.getOsAccountAllConstraints(localId, (err, constraints)=>{
    console.log('getOsAccountAllConstraints err:' + JSON.stringify(err));
    console.log('getOsAccountAllConstraints:' + JSON.stringify(constraints));
Z
zhangalong 已提交
3378 3379 3380
  });
  ```

J
jidong 已提交
3381
### getOsAccountAllConstraints<sup>(deprecated)</sup>
Z
zhangalong 已提交
3382

J
jidong 已提交
3383
getOsAccountAllConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt;
Z
zhangalong 已提交
3384

A
Annie_wang 已提交
3385
> **说明:** 
3386
>
A
Annie_wang 已提交
3387
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountConstraints](#getosaccountconstraints9-1)。
J
jidong 已提交
3388 3389 3390 3391

获取指定系统帐号的全部约束。使用Promise异步回调。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
3392

Z
zengyawen 已提交
3393 3394 3395
**系统能力:** SystemCapability.Account.OsAccount

**参数:**
Z
zhangalong 已提交
3396

J
jidong 已提交
3397 3398 3399
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
3400

Z
zengyawen 已提交
3401
**返回值:**
Z
zhangalong 已提交
3402

J
jidong 已提交
3403 3404 3405
| 类型                               | 说明                                                         |
| :--------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象,返回指定系统帐号的全部[约束](#系统帐号约束列表)。 |
Z
zhangalong 已提交
3406

J
jidong 已提交
3407
**示例:** 获取ID为100的系统帐号的全部约束
Z
zhangalong 已提交
3408

Z
zhangalong 已提交
3409
  ```js
F
fanchenxuan 已提交
3410
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3411 3412 3413
  let localId = 100;
  accountManager.getOsAccountAllConstraints(localId).then((constraints) => {
    console.log('getOsAccountAllConstraints, constraints: ' + constraints);
Z
zhangalong 已提交
3414
  }).catch((err) => {
J
jidong 已提交
3415
    console.log('getOsAccountAllConstraints err: '  + JSON.stringify(err));
Z
zhangalong 已提交
3416 3417 3418
  });
  ```

J
jidong 已提交
3419
### queryActivatedOsAccountIds<sup>(deprecated)</sup>
3420

J
jidong 已提交
3421 3422 3423
queryActivatedOsAccountIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void

查询当前处于激活状态的系统帐号的ID列表。使用callback异步回调。
3424

A
Annie_wang 已提交
3425
> **说明:** 
J
jidong 已提交
3426
>
C
cclicn 已提交
3427
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getActivatedOsAccountLocalIds](#getactivatedosaccountlocalids9)。
3428 3429 3430 3431 3432

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3433 3434 3435
| 参数名   | 类型                                     | 必填 | 说明                                                   |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是   | 回调函数。如果查询成功,err为null,data为当前处于激活状态的系统帐号的ID列表;否则为错误对象。 |
3436

J
jidong 已提交
3437
**示例:**
3438 3439 3440

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3441 3442 3443 3444 3445 3446 3447
  accountManager.queryActivatedOsAccountIds((err, idArray)=>{
    console.log('queryActivatedOsAccountIds err:' + JSON.stringify(err));
    console.log('queryActivatedOsAccountIds idArray length:' + idArray.length);
    for(let i=0;i<idArray.length;i++) {
      console.info('activated os account id: ' + idArray[i]);
    }
  });
3448 3449
  ```

J
jidong 已提交
3450
### queryActivatedOsAccountIds<sup>(deprecated)</sup>
3451

J
jidong 已提交
3452
queryActivatedOsAccountIds(): Promise&lt;Array&lt;number&gt;&gt;
3453

A
Annie_wang 已提交
3454
> **说明:** 
J
jidong 已提交
3455
>
C
cclicn 已提交
3456
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getActivatedOsAccountLocalIds](#getactivatedosaccountlocalids9-1)。
3457

J
jidong 已提交
3458
查询当前处于激活状态的系统帐号的ID列表。使用Promise异步回调。
3459

J
jidong 已提交
3460
**系统能力:** SystemCapability.Account.OsAccount
3461 3462 3463

**返回值:**

J
jidong 已提交
3464 3465 3466
| 类型                               | 说明                                               |
| ---------------------------------- | ------------------------------------------------- |
| Promise&lt;Array&lt;number&gt;&gt; | Promise对象,返回当前处于激活状态的系统帐号的ID列表。 |
3467

J
jidong 已提交
3468
**示例:**
3469 3470 3471

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3472 3473 3474 3475 3476
  accountManager.queryActivatedOsAccountIds().then((idArray) => {
    console.log('queryActivatedOsAccountIds, idArray: ' + idArray);
  }).catch((err) => {
    console.log('queryActivatedOsAccountIds err: '  + JSON.stringify(err));
  });
3477 3478
  ```

J
jidong 已提交
3479
### queryCurrentOsAccount<sup>(deprecated)</sup>
Z
zhangalong 已提交
3480

J
jidong 已提交
3481
queryCurrentOsAccount(callback: AsyncCallback&lt;OsAccountInfo&gt;): void
Z
zhangalong 已提交
3482

J
jidong 已提交
3483
查询当前进程所属的系统帐号的信息。使用callback异步回调。
Z
zhangalong 已提交
3484

A
Annie_wang 已提交
3485
> **说明:** 
3486
>
A
Annie_wang 已提交
3487
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCurrentOsAccount](#getcurrentosaccount9)。
J
jidong 已提交
3488 3489

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
3490

Z
zengyawen 已提交
3491
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3492

Z
zengyawen 已提交
3493
**参数:**
Z
zhangalong 已提交
3494

J
jidong 已提交
3495 3496 3497
| 参数名   | 类型                                                 | 必填 | 说明                                           |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调函数。如果查询成功,err为null,data为当前进程所属的系统帐号信息;否则为错误对象。 |
Z
zengyawen 已提交
3498

J
jidong 已提交
3499
**示例:**
Z
zhangalong 已提交
3500

Z
zhangalong 已提交
3501
  ```js
F
fanchenxuan 已提交
3502
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3503 3504 3505
  accountManager.queryCurrentOsAccount((err, curAccountInfo)=>{
    console.log('queryCurrentOsAccount err:' + JSON.stringify(err));
    console.log('queryCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
Z
zhangalong 已提交
3506 3507 3508
  });
  ```

J
jidong 已提交
3509
### queryCurrentOsAccount<sup>(deprecated)</sup>
Z
zhangalong 已提交
3510

J
jidong 已提交
3511
queryCurrentOsAccount(): Promise&lt;OsAccountInfo&gt;
Z
zhangalong 已提交
3512

J
jidong 已提交
3513
查询当前进程所属的系统帐号的信息。使用Promise异步回调。
Z
zhangalong 已提交
3514

A
Annie_wang 已提交
3515
> **说明:** 
3516
>
A
Annie_wang 已提交
3517
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCurrentOsAccount](#getcurrentosaccount9-1)。
Z
zengyawen 已提交
3518

J
jidong 已提交
3519
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zhangalong 已提交
3520

J
jidong 已提交
3521
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3522

Z
zengyawen 已提交
3523
**返回值:**
Z
zhangalong 已提交
3524

J
jidong 已提交
3525 3526 3527
| 类型                                           | 说明                                       |
| ---------------------------------------------- | ------------------------------------------ |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise对象,返回当前进程所属的系统帐号信息。 |
Z
zhangalong 已提交
3528

J
jidong 已提交
3529
**示例:**
Z
zhangalong 已提交
3530

Z
zhangalong 已提交
3531
  ```js
F
fanchenxuan 已提交
3532
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3533 3534
  accountManager.queryCurrentOsAccount().then((accountInfo) => {
    console.log('queryCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
Z
zhangalong 已提交
3535
  }).catch((err) => {
J
jidong 已提交
3536
    console.log('queryCurrentOsAccount err: '  + JSON.stringify(err));
Z
zhangalong 已提交
3537 3538 3539
  });
  ```

J
jidong 已提交
3540
### getOsAccountTypeFromProcess<sup>(deprecated)</sup>
Z
zhangalong 已提交
3541

J
jidong 已提交
3542
getOsAccountTypeFromProcess(callback: AsyncCallback&lt;OsAccountType&gt;): void
Z
zhangalong 已提交
3543

J
jidong 已提交
3544
查询当前进程所属的系统帐号的帐号类型。使用callback异步回调。
Z
zengyawen 已提交
3545

A
Annie_wang 已提交
3546
> **说明:** 
J
jidong 已提交
3547
>
A
Annie_wang 已提交
3548
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountType](#getosaccounttype9)。
Z
zhangalong 已提交
3549

Z
zengyawen 已提交
3550
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3551

Z
zengyawen 已提交
3552 3553
**参数:**

J
jidong 已提交
3554 3555 3556
| 参数名   | 类型                                                 | 必填 | 说明                                                 |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountType](#osaccounttype)&gt; | 是   | 回调函数。如果查询成功,err为null,data为当前进程所属的系统帐号的帐号类型;否则为错误对象。 |
Z
zengyawen 已提交
3557

3558
**示例:**
Z
zhangalong 已提交
3559

Z
zhangalong 已提交
3560
  ```js
F
fanchenxuan 已提交
3561
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3562 3563 3564 3565
  accountManager.getOsAccountTypeFromProcess((err, accountType) => {
    console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err));
    console.log('getOsAccountTypeFromProcess accountType: ' + accountType);
  });
Z
zhangalong 已提交
3566 3567
  ```

J
jidong 已提交
3568
### getOsAccountTypeFromProcess<sup>(deprecated)</sup>
Z
zhangalong 已提交
3569

J
jidong 已提交
3570
getOsAccountTypeFromProcess(): Promise&lt;OsAccountType&gt;
Z
zhangalong 已提交
3571

J
jidong 已提交
3572
查询当前进程所属的系统帐号的帐号类型。使用Promise异步回调。
Z
zengyawen 已提交
3573

A
Annie_wang 已提交
3574
> **说明:**
J
jidong 已提交
3575
>
A
Annie_wang 已提交
3576
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountType](#getosaccounttype9-1)。
Z
zengyawen 已提交
3577 3578

**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3579

J
jidong 已提交
3580
**返回值:**
Z
zhangalong 已提交
3581

J
jidong 已提交
3582 3583 3584
| 类型                                           | 说明                                            |
| ---------------------------------------------- | ----------------------------------------------- |
| Promise&lt;[OsAccountType](#osaccounttype)&gt; | Promise对象,返回当前进程所属的系统帐号的帐号类型。 |
Z
zengyawen 已提交
3585

3586
**示例:**
Z
zhangalong 已提交
3587

Z
zhangalong 已提交
3588
  ```js
F
fanchenxuan 已提交
3589
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3590 3591 3592 3593 3594
  accountManager.getOsAccountTypeFromProcess().then((accountType) => {
    console.log('getOsAccountTypeFromProcess, accountType: ' + accountType);
  }).catch((err) => {
    console.log('getOsAccountTypeFromProcess err: '  + JSON.stringify(err));
  });
Z
zhangalong 已提交
3595 3596
  ```

J
jidong 已提交
3597
### getDistributedVirtualDeviceId<sup>(deprecated)</sup>
3598

J
jidong 已提交
3599
getDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void
3600

J
jidong 已提交
3601 3602
获取分布式虚拟设备ID。使用callback异步回调。

A
Annie_wang 已提交
3603
> **说明:** 
J
jidong 已提交
3604
>
A
Annie_wang 已提交
3605
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[queryDistributedVirtualDeviceId](#querydistributedvirtualdeviceid9)。
3606

J
jidong 已提交
3607
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS
3608 3609 3610 3611 3612

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3613 3614 3615
| 参数名   | 类型                        | 必填 | 说明                                                                    |
| -------- | --------------------------- | ---- | --------------------------------------------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。如果获取成功,err为null,data为分布式虚拟设备ID;否则为错误对象。 |
3616

3617
**示例:**
3618 3619

  ```js
F
fanchenxuan 已提交
3620
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3621 3622 3623 3624
  accountManager.getDistributedVirtualDeviceId((err, virtualID) => {
    console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err));
    console.log('getDistributedVirtualDeviceId virtualID: ' + virtualID);
  });
3625 3626
  ```

J
jidong 已提交
3627
### getDistributedVirtualDeviceId<sup>(deprecated)</sup>
3628

J
jidong 已提交
3629
getDistributedVirtualDeviceId(): Promise&lt;string&gt;
3630

J
jidong 已提交
3631
获取分布式虚拟设备ID。使用Promise异步回调。
3632

A
Annie_wang 已提交
3633
> **说明:** 
J
jidong 已提交
3634
>
A
Annie_wang 已提交
3635
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[queryDistributedVirtualDeviceId](#querydistributedvirtualdeviceid9-1)。
3636

J
jidong 已提交
3637
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS
3638

J
jidong 已提交
3639
**系统能力:** SystemCapability.Account.OsAccount
3640 3641 3642

**返回值:**

J
jidong 已提交
3643 3644 3645
| 类型                  | 说明                              |
| --------------------- | --------------------------------- |
| Promise&lt;string&gt; | Promise对象,返回分布式虚拟设备ID。 |
3646

3647
**示例:**
3648 3649

  ```js
F
fanchenxuan 已提交
3650
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3651 3652 3653 3654 3655
  accountManager.getDistributedVirtualDeviceId().then((virtualID) => {
    console.log('getDistributedVirtualDeviceId, virtualID: ' + virtualID);
  }).catch((err) => {
    console.log('getDistributedVirtualDeviceId err: '  + JSON.stringify(err));
  });
3656 3657
  ```

J
jidong 已提交
3658
### getOsAccountLocalIdBySerialNumber<sup>(deprecated)</sup>
3659

J
jidong 已提交
3660
getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback&lt;number&gt;): void
3661

J
jidong 已提交
3662
通过SN码查询与其关联的系统帐号的帐号ID。使用callback异步回调。
3663

A
Annie_wang 已提交
3664
> **说明:** 
J
jidong 已提交
3665
>
C
cclicn 已提交
3666
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForSerialNumber](#getosaccountlocalidforserialnumber9)。
3667

3668 3669 3670 3671
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3672 3673 3674 3675
| 参数名       | 类型                        | 必填 | 说明                                                                               |
| ------------ | --------------------------- | ---- | -------------------------------------------------------------------------------- |
| serialNumber | number                      | 是   | 帐号SN码。                                                                        |
| callback     | AsyncCallback&lt;number&gt; | 是   | 回调函数。如果查询成功,err为null,data为与SN码关联的系统帐号的帐号ID;否则为错误对象。 |
3676

J
jidong 已提交
3677
**示例:** 查询与SN码12345关联的系统帐号的ID
3678 3679

  ```js
F
fanchenxuan 已提交
3680
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3681 3682 3683 3684 3685
  let serialNumber = 12345;
  accountManager.getOsAccountLocalIdBySerialNumber(serialNumber, (err, localId)=>{
    console.log('ger localId err:' + JSON.stringify(err));
    console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
  });
3686 3687
  ```

J
jidong 已提交
3688
### getOsAccountLocalIdBySerialNumber<sup>(deprecated)</sup>
3689

J
jidong 已提交
3690
getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt;
3691

J
jidong 已提交
3692
通过SN码查询与其关联的系统帐号的帐号ID。使用Promise异步回调。
3693

A
Annie_wang 已提交
3694
> **说明:** 
J
jidong 已提交
3695
>
C
cclicn 已提交
3696
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForSerialNumber](#getosaccountlocalidforserialnumber9-1)。
3697

3698 3699
**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
3700 3701 3702 3703 3704 3705
**参数:**

| 参数名       | 类型   | 必填 | 说明       |
| ------------ | ------ | ---- | ---------- |
| serialNumber | number | 是   | 帐号SN码。 |

3706 3707 3708
**返回值:**

| 类型                  | 说明                                                         |
J
jidong 已提交
3709 3710
| --------------------- | -------------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回与SN码关联的系统帐号的帐号ID。 |
3711

J
jidong 已提交
3712
**示例:** 查询与SN码12345关联的系统帐号的ID
3713 3714

  ```js
F
fanchenxuan 已提交
3715
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3716 3717 3718 3719 3720 3721
  let serialNumber = 12345;
  accountManager.getOsAccountLocalIdBySerialNumber(serialNumber).then((localId) => {
    console.log('getOsAccountLocalIdBySerialNumber localId: ' + localId);
  }).catch((err) => {
    console.log('getOsAccountLocalIdBySerialNumber err: '  + JSON.stringify(err));
  });
3722 3723
  ```

J
jidong 已提交
3724
### getSerialNumberByOsAccountLocalId<sup>(deprecated)</sup>
3725

J
jidong 已提交
3726
getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;number&gt;): void
3727

J
jidong 已提交
3728
通过系统帐号ID获取与该系统帐号关联的SN码。使用callback异步回调。
3729

A
Annie_wang 已提交
3730
> **说明:** 
J
jidong 已提交
3731
>
C
cclicn 已提交
3732
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getSerialNumberForOsAccountLocalId](#getserialnumberforosaccountlocalid9)。
3733 3734 3735 3736 3737

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3738 3739 3740 3741
| 参数名   | 类型                        | 必填 | 说明                                                                         |
| -------- | --------------------------- | ---- | --------------------------------------------------------------------------- |
| localId  | number                      | 是   | 系统帐号ID。                                                                 |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数。如果获取成功,err为null,data为与该系统帐号关联的SN码;否则为错误对象。 |
3742

J
jidong 已提交
3743
**示例:** 获取ID为100的系统帐号关联的SN码
3744 3745

  ```js
F
fanchenxuan 已提交
3746
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3747 3748 3749 3750 3751
  let localId = 100;
  accountManager.getSerialNumberByOsAccountLocalId(localId, (err, serialNumber)=>{
    console.log('ger serialNumber err:' + JSON.stringify(err));
    console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
  });
3752 3753
  ```

J
jidong 已提交
3754
### getSerialNumberByOsAccountLocalId<sup>(deprecated)</sup>
3755

J
jidong 已提交
3756
getSerialNumberByOsAccountLocalId(localId: number): Promise&lt;number&gt;
3757

J
jidong 已提交
3758
通过系统帐号ID获取与该系统帐号关联的SN码。使用Promise异步回调。
3759

A
Annie_wang 已提交
3760
> **说明:** 
J
jidong 已提交
3761
>
C
cclicn 已提交
3762
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getSerialNumberForOsAccountLocalId](#getserialnumberforosaccountlocalid9-1)。
3763 3764 3765 3766 3767

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3768 3769 3770
| 参数名  | 类型   | 必填 | 说明          |
| ------- | ------ | ---- | ----------- |
| localId | number | 是   | 系统帐号ID。 |
3771 3772 3773

**返回值:**

J
jidong 已提交
3774 3775 3776
| 类型                  | 说明                                    |
| --------------------- | -------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回与该系统帐号关联的SN码。 |
3777

J
jidong 已提交
3778
**示例:** 获取ID为100的系统帐号关联的SN码
3779 3780

  ```js
F
fanchenxuan 已提交
3781
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3782 3783 3784 3785 3786 3787
  let localId = 100;
  accountManager.getSerialNumberByOsAccountLocalId(localId).then((serialNumber) => {
    console.log('getSerialNumberByOsAccountLocalId serialNumber: ' + serialNumber);
  }).catch((err) => {
    console.log('getSerialNumberByOsAccountLocalId err: '  + JSON.stringify(err));
  });
3788 3789
  ```

3790 3791 3792 3793
## UserAuth<sup>8+</sup>

用户认证类。

J
jidong 已提交
3794
**系统接口:** 此接口为系统接口。
3795

3796 3797 3798 3799 3800 3801
### constructor<sup>8+</sup>

constructor()

创建用户认证的实例。

J
jidong 已提交
3802
**系统接口:** 此接口为系统接口。
3803

3804 3805
**系统能力**:SystemCapability.Account.OsAccount

3806
**示例:**  
3807
  ```js
J
jidong 已提交
3808
  let userAuth = new account_osAccount.UserAuth();
3809 3810 3811 3812 3813 3814 3815 3816
  ```

### getVersion<sup>8+</sup>

getVersion(): number;

返回版本信息。

J
jidong 已提交
3817
**系统接口:** 此接口为系统接口。
3818 3819 3820 3821 3822 3823 3824 3825 3826

**系统能力:** SystemCapability.Account.OsAccount

**返回值:**

| 类型   | 说明         |
| :----- | :----------- |
| number | 返回版本信息。|

3827
**示例:**  
3828
  ```js
J
jidong 已提交
3829 3830
  let userAuth = new account_osAccount.UserAuth();
  let version = userAuth.getVersion();
F
fanchenxuan 已提交
3831
  console.log('getVersion version = ' + version);
3832 3833 3834 3835 3836 3837
  ```

### getAvailableStatus<sup>8+</sup>

getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;

J
jidong 已提交
3838
获取指定认证类型和认证可信等级的认证能力的可用状态。
3839

J
jidong 已提交
3840
**系统接口:** 此接口为系统接口。
3841 3842 3843 3844 3845 3846 3847

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

J
jidong 已提交
3848 3849 3850 3851
| 参数名           | 类型                               | 必填 | 说明                       |
| --------------- | -----------------------------------| ---- | ------------------------- |
| authType        | [AuthType](#authtype8)             | 是   | 认证类型。     |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8) | 是   | 认证的可信等级。 |
3852 3853 3854

**返回值:**

J
jidong 已提交
3855 3856 3857 3858 3859 3860 3861 3862 3863 3864
| 类型   | 说明                           |
| ------ | ----------------------------- |
| number | 返回认证能力的可用状态。 |

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType or authTrustLevel. |
3865

3866
**示例:**  
3867
  ```js
J
jidong 已提交
3868 3869 3870
  let userAuth = new account_osAccount.UserAuth();
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
3871 3872 3873 3874 3875 3876
  try {
    let status = userAuth.getAvailableStatus(authType, authTrustLevel);
    console.log('getAvailableStatus status = ' + status);
  } catch (e) {
    console.log('getAvailableStatus exception = ' + JSON.stringify(e));
  }
3877 3878 3879 3880 3881 3882
  ```

### getProperty<sup>8+</sup>

getProperty(request: GetPropertyRequest, callback: AsyncCallback&lt;ExecutorProperty&gt;): void;

J
jidong 已提交
3883
基于指定的请求信息获取属性。使用callback异步回调。
3884

J
jidong 已提交
3885
**系统接口:** 此接口为系统接口。
3886 3887 3888 3889 3890 3891 3892 3893

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

| 参数名    | 类型                                                                    | 必填 | 说明                                |
J
jidong 已提交
3894
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------ |
3895
| request  | [GetPropertyRequest](#getpropertyrequest8)                  | 是   | 请求信息,包括认证类型和属性类型列表。 |
J
jidong 已提交
3896 3897 3898 3899 3900 3901 3902 3903
| callback | AsyncCallback&lt;[ExecutorProperty](#executorproperty8)&gt; | 是   | 回调函数。如果获取成功,err为null,data为执行器属性信息;否则为错误对象。|

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |
3904

3905
**示例:**
3906
  ```js
J
jidong 已提交
3907 3908 3909 3910 3911 3912 3913 3914 3915 3916
  let userAuth = new account_osAccount.UserAuth();
  let keys = [
    account_osAccount.GetPropertyType.AUTH_SUB_TYPE, 
    account_osAccount.GetPropertyType.REMAIN_TIMES,
    account_osAccount.GetPropertyType.FREEZING_TIME
  ];
  let request = {
    authType: account_osAccount.AuthType.PIN,
    keys: keys
  };
3917 3918 3919 3920 3921 3922 3923 3924
  try {
    userAuth.getProperty(request, (err, result) => {
      console.log('getProperty err = ' + JSON.stringify(err));
      console.log('getProperty result = ' + JSON.stringify(result));
    });
  } catch (e) {
    console.log('getProperty exception = ' + JSON.stringify(e));
  }
3925 3926 3927 3928
  ```

### getProperty<sup>8+</sup>

3929
getProperty(request: GetPropertyRequest): Promise&lt;ExecutorProperty&gt;;
3930

J
jidong 已提交
3931
基于指定的请求信息获取属性。使用Promise异步回调。
3932

J
jidong 已提交
3933
**系统接口:** 此接口为系统接口。
3934 3935 3936 3937 3938 3939 3940 3941 3942

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

| 参数名    | 类型                                                   | 必填 | 说明                                |
| -------- | ------------------------------------------------------ | ---- | ---------------------------------- |
3943
| request  | [GetPropertyRequest](#getpropertyrequest8) | 是   | 请求信息,包括认证类型和属性类型列表。 |
3944 3945 3946 3947 3948

**返回值:**

| 类型                                                              | 说明                                                 |
| :---------------------------------------------------------------- | :-------------------------------------------------- |
J
jidong 已提交
3949
| Promise&lt;[ExecutorProperty](#executorproperty8)&gt; | Promise对象,返回执行者属性信息。 |
3950

J
jidong 已提交
3951 3952 3953 3954 3955 3956 3957
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |

3958
**示例:**
3959
  ```js
J
jidong 已提交
3960 3961 3962 3963 3964 3965 3966 3967 3968 3969
  let userAuth = new account_osAccount.UserAuth();
  let keys = [
    account_osAccount.GetPropertyType.AUTH_SUB_TYPE, 
    account_osAccount.GetPropertyType.REMAIN_TIMES,
    account_osAccount.GetPropertyType.FREEZING_TIME
  ];
  let request = {
    authType: account_osAccount.AuthType.PIN,
    keys: keys
  };
3970 3971 3972 3973 3974 3975 3976 3977 3978
  try {
    userAuth.getProperty(request).then((result) => {
      console.log('getProperty result = ' + JSON.stringify(result));
    }).catch((err) => {
      console.log('getProperty error = ' + JSON.stringify(err));
    });
  } catch (e) {
    console.log('getProperty exception = ' + JSON.stringify(e));
  }
3979 3980 3981 3982
  ```

### setProperty<sup>8+</sup>

3983
setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;void&gt;): void;
3984

J
jidong 已提交
3985
设置可用于初始化算法的属性。使用callback异步回调。
3986

J
jidong 已提交
3987
**系统接口:** 此接口为系统接口。
3988 3989 3990 3991 3992 3993 3994 3995 3996

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

| 参数名    | 类型                                                  | 必填 | 说明                                                                    |
| -------- | ----------------------------------------------------- | ---- | ---------------------------------------------------------------------- |
3997
| request  | [SetPropertyRequest](#setpropertyrequest8)| 是   | 请求信息,包括认证类型和要设置的密钥值。                                   |
3998
| callback | AsyncCallback&lt;void&gt;                           | 是   | 回调函数。如果设置成功,err为null,否则为错误对象。 |
3999

J
jidong 已提交
4000 4001 4002 4003 4004 4005 4006
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |

4007
**示例:**
4008
  ```js
J
jidong 已提交
4009 4010 4011 4012 4013 4014
  let userAuth = new account_osAccount.UserAuth();
  let request = {
    authType: account_osAccount.AuthType.PIN,
    key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
    setInfo: new Uint8Array([0])
  };
4015
  try {
4016 4017 4018 4019 4020 4021
    userAuth.setProperty(request, (err) => {
      if (err) {
        console.log('setProperty failed, error = ' + JSON.stringify(err));
      } else {
        console.log('setProperty successfully');
      }
4022 4023 4024 4025
    });
  } catch (e) {
    console.log('setProperty exception = ' + JSON.stringify(e));
  }
4026 4027 4028 4029
  ```

### setProperty<sup>8+</sup>

4030
setProperty(request: SetPropertyRequest): Promise&lt;void&gt;;
4031

J
jidong 已提交
4032
设置可用于初始化算法的属性。使用Promise异步回调。
4033

J
jidong 已提交
4034
**系统接口:** 此接口为系统接口。
4035 4036 4037 4038 4039 4040 4041

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

J
jidong 已提交
4042 4043
| 参数名    | 类型                                       | 必填 | 说明                                      |
| -------- | ------------------------------------------ | ---- | ---------------------------------------- |
4044
| request  | [SetPropertyRequest](#setpropertyrequest8) | 是   | 请求信息,包括身份验证类型和要设置的密钥值。 |
4045 4046 4047

**返回值:**

J
jidong 已提交
4048 4049
| 类型                  | 说明                                                           |
| :-------------------- | :------------------------------------------------------------ |
A
Annie_wang 已提交
4050
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
4051

J
jidong 已提交
4052 4053 4054 4055 4056 4057 4058
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |

4059
**示例:**
4060
  ```js
J
jidong 已提交
4061 4062 4063 4064 4065 4066
  let userAuth = new account_osAccount.UserAuth();
  let request = {
    authType: account_osAccount.AuthType.PIN,
    key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
    setInfo: new Uint8Array([0])
  };
4067
  try {
4068 4069
    userAuth.setProperty(request).then(() => {
      console.log('setProperty successfully');
4070
    }).catch((err) => {
4071
      console.log('setProperty failed, error = ' + JSON.stringify(err));
4072 4073 4074 4075
    });
  } catch (e) {
    console.log('setProperty exception = ' + JSON.stringify(e));
  }
4076 4077 4078 4079 4080 4081
  ```

### auth<sup>8+</sup>

auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

J
jidong 已提交
4082
认证当前用户。使用callback异步回调。
4083

J
jidong 已提交
4084
**系统接口:** 此接口为系统接口。
4085 4086 4087 4088 4089 4090 4091

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

J
jidong 已提交
4092 4093
| 参数名           | 类型                                     | 必填 | 说明                                |
| --------------- | ---------------------------------------- | --- | ------------------------------------ |
J
jidong 已提交
4094
| challenge       | Uint8Array                               | 是  | 指示挑战值,挑战值为一个随机数,用于提升安全性。|
4095 4096
| authType        | [AuthType](#authtype8)                   | 是  | 指示认证类型。                        |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8)       | 是  | 指示认证结果的信任级别。               |
J
jidong 已提交
4097
| callback        | [IUserAuthCallback](#iuserauthcallback8) | 是  | 回调对象,返回认证结果。  |
4098 4099 4100 4101

**返回值:**

| 类型        | 说明               |
J
jidong 已提交
4102
| ---------- | ------------------ |
4103 4104
| Uint8Array | 返回取消的上下文ID。 |

J
jidong 已提交
4105 4106 4107 4108 4109 4110 4111 4112 4113
**错误码:**

| 错误码ID | 错误信息          |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid challenge or authType or authTrustLevel. |
| 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. |
C
chennian 已提交
4114
| 12300110 | Authentication is locked. |
J
jidong 已提交
4115
| 12300111 | Authentication timeout. |
C
chennian 已提交
4116
| 12300112 | Authentication service is busy. |
J
jidong 已提交
4117

4118
**示例:**
4119
  ```js
J
jidong 已提交
4120 4121 4122 4123
  let userAuth = new account_osAccount.UserAuth();
  let challenge = new Uint8Array([0]);
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
4124 4125 4126 4127 4128 4129 4130 4131 4132 4133
  try {
    userAuth.auth(challenge, authType, authTrustLevel, {
      onResult: function(result,extraInfo){
          console.log('auth result = ' + result);
          console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
      }
    });
  } catch (e) {
    console.log('auth exception = ' + JSON.stringify(e));
  }
4134 4135 4136 4137 4138 4139
  ```

### authUser<sup>8+</sup>

authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

J
jidong 已提交
4140
认证指定用户。使用callback异步回调。
4141

J
jidong 已提交
4142
**系统接口:** 此接口为系统接口。
4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

| 参数名           | 类型                                                 | 必填 | 说明                                |
| --------------- | ---------------------------------------------------- | --- | ------------------------------------ |
| userId          | number                                               | 是  | 指示用户身份。                        |
| challenge       | Uint8Array                                           | 是  | 指示挑战值,挑战值为一个随机数,用于提升安全性。                          |
4154 4155
| authType        | [AuthType](#authtype8)                   | 是  | 指示认证类型。                        |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8)       | 是  | 指示认证结果的信任级别。               |
J
jidong 已提交
4156
| callback        | [IUserAuthCallback](#iuserauthcallback8) | 是  | 回调对象,返回认证结果。  |
4157 4158 4159 4160

**返回值:**

| 类型        | 说明               |
J
jidong 已提交
4161
| ---------- | ------------------ |
4162 4163
| Uint8Array | 返回取消的上下文ID。 |

J
jidong 已提交
4164 4165 4166 4167 4168 4169 4170 4171 4172
**错误码:**

| 错误码ID | 错误信息          |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid userId or challenge or authType or authTrustLevel. |
| 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. |
C
chennian 已提交
4173
| 12300110 | Authentication is locked. |
J
jidong 已提交
4174
| 12300111 | Authentication timeout. |
C
chennian 已提交
4175
| 12300112 | Authentication service is busy. |
J
jidong 已提交
4176

4177
**示例:**
4178
  ```js
J
jidong 已提交
4179
  let userAuth = new account_osAccount.UserAuth();
4180
  let userID = 100;
J
jidong 已提交
4181 4182 4183
  let challenge = new Uint8Array([0]);
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
4184 4185 4186
  try {
    userAuth.authUser(userID, challenge, authType, authTrustLevel, {
      onResult: function(result,extraInfo){
J
jidong 已提交
4187 4188
        console.log('authUser result = ' + result);
        console.log('authUser extraInfo = ' + JSON.stringify(extraInfo));
4189 4190 4191 4192 4193
      }
    });
  } catch (e) {
    console.log('authUser exception = ' + JSON.stringify(e));
  }
4194 4195 4196 4197
  ```

### cancelAuth<sup>8+</sup>

4198
cancelAuth(contextID: Uint8Array): void;
4199

J
jidong 已提交
4200
取消指定的认证操作。
4201

J
jidong 已提交
4202
**系统接口:** 此接口为系统接口。
4203 4204 4205 4206 4207 4208 4209 4210 4211

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

| 参数名    | 类型       | 必填  | 说明                                        |
| ----------| ---------- | ---- | ------------------------------------------ |
J
jidong 已提交
4212 4213 4214 4215 4216 4217 4218 4219
| contextId | Uint8Array | 是   | 指示身份验证上下文ID,此ID动态生成没有具体值。 |

**错误码:**

| 错误码ID | 错误信息            |
| -------- | ------------------ |
| 12300001 | System service exception. |
| 12300002 | Invalid contextId. |
4220

4221
**示例:**
4222
  ```js
J
jidong 已提交
4223 4224 4225
  let userAuth = new account_osAccount.UserAuth();
  let pinAuth = new account_osAccount.PINAuth();
  let challenge = new Uint8Array([0]);
J
jidong 已提交
4226
  let contextId = userAuth.auth(challenge, account_osAccount.AuthType.PIN, account_osAccount.AuthTrustLevel.ATL1, {
J
jidong 已提交
4227
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
4228 4229
      console.log('auth result = ' + result);
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
4230 4231
    }
  });
4232
  try {
J
jidong 已提交
4233
    userAuth.cancelAuth(contextId);
4234 4235 4236
  } catch (e) {
    console.log('cancelAuth exception = ' + JSON.stringify(e));
  }
4237 4238 4239 4240
  ```

## PINAuth<sup>8+</sup>

W
wangyihui 已提交
4241
PIN码认证基类。
4242

J
jidong 已提交
4243
**系统接口:** 此接口为系统接口。
4244

4245 4246 4247 4248
### constructor<sup>8+</sup>

constructor()

W
wangyihui 已提交
4249
创建PIN码认证的实例。
4250

J
jidong 已提交
4251
**系统接口:** 此接口为系统接口。
L
lichenchen 已提交
4252

4253 4254
**系统能力**:SystemCapability.Account.OsAccount

4255
**示例:**  
4256
  ```js
J
jidong 已提交
4257
  let pinAuth = new account_osAccount.PINAuth();
4258 4259
  ```

4260
### registerInputer<sup>8+</sup>
4261

J
jidong 已提交
4262
registerInputer(inputer: IInputer): void;
4263

J
jidong 已提交
4264
注册PIN码输入器。
4265

J
jidong 已提交
4266
**系统接口:** 此接口为系统接口。
4267 4268 4269 4270 4271 4272 4273

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_PIN_AUTH

**参数:**

J
jidong 已提交
4274 4275 4276
| 参数名    | 类型                     | 必填 | 说明                      |
| ----------| ----------------------- | --- | -------------------------- |
| inputer   | [IInputer](#iinputer8)  | 是  | PIN码输入器,用于获取PIN码。 |
4277

J
jidong 已提交
4278 4279 4280 4281 4282
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
C
chennian 已提交
4283
| 12300002 | Invalid inputer. |
J
jidong 已提交
4284 4285
| 12300103 | Inputer already registered. |

4286
**示例:**
4287
  ```js
J
jidong 已提交
4288
  let pinAuth = new account_osAccount.PINAuth();
J
jidong 已提交
4289
  let password = new Uint8Array([0, 0, 0, 0, 0]);
4290 4291
  try {
    let result = pinAuth.registerInputer({
W
wangyihui 已提交
4292 4293
        onGetData: (authSubType, callback) => {
          callback.onSetData(authSubType, password);
4294 4295 4296 4297 4298 4299
        }
    });
    console.log('registerInputer result = ' + result);
  } catch (e) {
    console.log('registerInputer exception = ' + JSON.stringify(e));
  }
4300 4301
  ```

4302
### unregisterInputer<sup>8+</sup>
4303 4304 4305

unregisterInputer(): void;

J
jidong 已提交
4306
解注册PIN码输入器。
4307

J
jidong 已提交
4308
**系统接口:** 此接口为系统接口。
4309 4310 4311 4312 4313

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_PIN_AUTH

4314
**示例:**
4315
  ```js
J
jidong 已提交
4316
  let pinAuth = new account_osAccount.PINAuth();
4317 4318 4319
  pinAuth.unregisterInputer();
  ```

J
jidong 已提交
4320
## InputerManager <sup>9+</sup>
W
wangyihui 已提交
4321 4322 4323

凭据输入管理器。

J
jidong 已提交
4324
### registerInputer<sup>9+</sup>
W
wangyihui 已提交
4325

J
jidong 已提交
4326
static registerInputer(authType: AuthType, inputer: IInputer): void
W
wangyihui 已提交
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347

注册凭据输入器。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL 或 ohos.permission.MANAGE_USER_IDM

**参数:**

| 参数名    | 类型                     | 必填 | 说明                      |
| ----------| ----------------------- | --- | -------------------------- |
| authType   | [AuthType](#authtype8)  | 是  | 认证类型。 |
| inputer   | [IInputer](#iinputer8)  | 是  | 凭据输入器,用于获取凭据。 |

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
C
chennian 已提交
4348
| 12300002 | Invalid authType or inputer. |
W
wangyihui 已提交
4349 4350 4351 4352 4353 4354 4355 4356
| 12300103 | The credential inputer has been registered. |
| 12300106 | Unsupported authType. |

**示例:**
  ```js
  let authType = account_osAccount.AuthType.DOMAIN;
  let password = new Uint8Array([0, 0, 0, 0, 0]);
  try {
J
jidong 已提交
4357
    account_osAccount.InputerManager.registerInputer(authType, {
W
wangyihui 已提交
4358 4359 4360 4361 4362 4363 4364 4365 4366 4367
        onGetData: (authSubType, callback) => {
          callback.onSetData(authSubType, password);
        }
    });
    console.log('registerInputer success.');
  } catch (e) {
    console.log('registerInputer exception = ' + JSON.stringify(e));
  }
  ```

J
jidong 已提交
4368
### unregisterInputer<sup>9+</sup>
W
wangyihui 已提交
4369

J
jidong 已提交
4370
static unregisterInputer(authType: AuthType): void
W
wangyihui 已提交
4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395

解注册凭据输入器。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL 或 ohos.permission.MANAGE_USER_IDM

**参数:**

| 参数名    | 类型                     | 必填 | 说明                      |
| ----------| ----------------------- | --- | -------------------------- |
| authType   | [AuthType](#authtype8)  | 是  | 认证类型。 |

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300002  | Invalid authType. |

**示例:**
  ```js
  let authType = account_osAccount.AuthType.DOMAIN;
  try {
J
jidong 已提交
4396
    account_osAccount.InputerManager.unregisterInputer(authType);
W
wangyihui 已提交
4397 4398 4399 4400 4401 4402
    console.log('unregisterInputer success.');
  } catch(err) {
    console.log("unregisterInputer err:" + JSON.stringify(err));
  }
  ```

J
jidong 已提交
4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429
## DomainPlugin<sup>9+</sup>

域插件,提供域帐号认证功能。

**系统接口:** 此接口为系统接口。

### auth<sup>9+</sup>

auth(domainAccountInfo: DomainAccountInfo, credential: Uint8Array, callback: IUserAuthCallback): void

认证指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| credential   | Uint8Array  | 是   | 指示域帐号的凭据。|
| callback   | [IUserAuthCallback](#iuserauthcallback8)  | 是   | 指示认证结果回调。|

**示例:**
  ```js
  let plugin = {
J
jidong 已提交
4430
    auth: (domainAccountInfo, credential, callback) => {
J
jidong 已提交
4431
      // mock authentication
J
jidong 已提交
4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443
      // notify authentication result
      callback.onResult(0, {
        token: new Uint8Array([0]),
        remainTimes: 5,
        freezingTime: 0
      });
    },
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {},
J
jidong 已提交
4444 4445 4446
    unbindAccount: (domainAccountInfo, callback) => {},
    isAccountTokenValid: (domainAccountInfo, callback) => {},
    getAccessToken: (options, callback) => {}
J
jidong 已提交
4447 4448 4449 4450
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin);
  let userAuth = new account_osAccount.UserAuth();
  let challenge = new Uint8Array([0]);
J
jidong 已提交
4451
  let authType = account_osAccount.AuthType.DOMAIN;
J
jidong 已提交
4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
  try {
    userAuth.auth(challenge, authType, authTrustLevel, {
      onResult: (resultCode, authResult) => {
          console.log('auth resultCode = ' + resultCode);
          console.log('auth authResult = ' + JSON.stringify(authResult));
      }
    });
  } catch (err) {
    console.log('auth exception = ' + JSON.stringify(err));
  }
  ```

J
jidong 已提交
4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498
### authWithPopup<sup>10+</sup>

authWithPopup(domainAccountInfo: DomainAccountInfo, callback: IUserAuthCallback): void

弹窗认证指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| callback   | [IUserAuthCallback](#iuserauthcallback8)  | 是   | 指示认证结果回调。|

**示例:**
  ```js
  let plugin = {
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {
      // mock authentication
      // notify authentication result
      callback.onResult(0, {
        token: new Uint8Array([0]),
        remainTimes: 5,
        freezingTime: 0
      });
    },
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {},
J
jidong 已提交
4499 4500 4501
    unbindAccount: (domainAccountInfo, callback) => {},
    isAccountTokenValid: (domainAccountInfo, callback) => {},
    getAccessToken: (options, callback) => {}
J
jidong 已提交
4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin)
  ```

### authWithToken<sup>10+</sup>

authWithToken(domainAccountInfo: DomainAccountInfo, token: Uint8Array, callback: IUserAuthCallback): void

使用授权令牌认证指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| token   | Uint8Array  | 是   | 指示PIN码或生物识别认证成功时生成的授权令牌。|
| callback   | [IUserAuthCallback](#iuserauthcallback8)  | 是   | 指示认证结果回调。|

**示例:**
  ```js
  let plugin = {
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {
      // mock authentication
      // notify authentication result
      callback.onResult(0, {
        token: new Uint8Array([0]),
        remainTimes: 5,
        freezingTime: 0
      });
    },
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {},
J
jidong 已提交
4541 4542 4543
    unbindAccount: (domainAccountInfo, callback) => {},
    isAccountTokenValid: (domainAccountInfo, callback) => {},
    getAccessToken: (options, callback) => {}
J
jidong 已提交
4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin)
  ```

### getAccountInfo<sup>10+</sup>

getAccountInfo(domain: string, accountName: string, callback: AsyncCallback&lt;DomainAccountInfo&gt;): void

查询指定域帐号的信息。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domain   | string  | 是   | 指示帐号所属域。|
| accountName   | string  | 是   | 指示帐号的名称。|
| callback   | AsyncCallback&lt;[DomainAccountInfo](#domainaccountinfo8)&gt; | 是   | 指示查询结果回调。|

**示例:**
  ```js
  let plugin = {
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {
      // mock getting account information
      // notify result
      callback({
        code: 0
      }, {
        domain: domain,
        accountName: accountName,
        accountId: "xxxx"
      })
    },
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {},
J
jidong 已提交
4585 4586 4587
    unbindAccount: (domainAccountInfo, callback) => {},
    isAccountTokenValid: (domainAccountInfo, callback) => {},
    getAccessToken: (options, callback) => {}
J
jidong 已提交
4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin)
  ```

### getAuthStatusInfo<sup>10+</sup>

getAuthStatusInfo(domainAccountInfo: DomainAccountInfo, callback: AsyncCallback&lt;AuthStatusInfo&gt;): void

查询指定域帐号的认证状态信息。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| callback   | AsyncCallback&lt;[AuthStatusInfo](#authstatusinfo10)&gt; | 是   | 指示查询结果回调。|

**示例:**
  ```js
  let plugin = {
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {
      callback({
        code: 0
      }, {
        remainTimes: 5,
        freezingTime: 0
      })
    },
    bindAccount: (domainAccountInfo, localId, callback) => {},
J
jidong 已提交
4625 4626 4627
    unbindAccount: (domainAccountInfo, callback) => {},
    isAccountTokenValid: (domainAccountInfo, callback) => {},
    getAccessToken: (options, callback) => {}
J
jidong 已提交
4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin)
  ```

### bindAccount<sup>10+</sup>

bindAccount(domainAccountInfo: DomainAccountInfo, localId: number, callback: AsyncCallback&lt;void&gt;): void

绑定指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| callback   | AsyncCallback&lt;void&gt; | 是   | 指示绑定结果回调。|

**示例:**
  ```js
  let plugin = {
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {
      // mock unbinding operation
      // notify binding result
      callback({code: 0})
    },
J
jidong 已提交
4662 4663 4664
    unbindAccount: (domainAccountInfo, callback) => {},
    isAccountTokenValid: (domainAccountInfo, callback) => {},
    getAccessToken: (options, callback) => {}
J
jidong 已提交
4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin)
  ```

### unbindAccount<sup>10+</sup>

unbindAccount(domainAccountInfo: DomainAccountInfo, callback: AsyncCallback&lt;void&gt;): void

解绑指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| callback   | AsyncCallback&lt;void&gt; | 是   | 指示绑定结果回调。|

**示例:**
  ```js
  let plugin = {
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {},
    unbindAccount: (domainAccountInfo, callback) => {
      // mock unbinding operation
      // notify unbinding result
      callback({code: 0})
J
jidong 已提交
4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776
    },
    isAccountTokenValid: (domainAccountInfo, callback) => {},
    getAccessToken: (options, callback) => {}
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin)
  ```

### isAccountTokenValid<sup>10+</sup>

isAccountTokenValid(domainAccountInfo: DomainAccountInfo, token: Uint8Array, callback: AsyncCallback&lt;boolean&gt;): void

检查指定的域帐号令牌是否有效。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| token | Uint8Array | 是 | 指示域帐号令牌。 |
| callback   | AsyncCallback&lt;boolean&gt; | 是   | 指示检查结果回调。|

**示例:**
  ```js
  let plugin = {
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {},
    unbindAccount: (domainAccountInfo, callback) => {},
    isAccountTokenValid: (domainAccountInfo, callback) => {
      // mock checking operation
      // notify checking result
      callback({code: 0}, true);
    },
    getAccessToken: (options, callback) => {}
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin)
  ```

### getAccessToken<sup>10+</sup>

getAccessToken(options: GetDomainAccessTokenOptions, callback: AsyncCallback&lt;Uint8Array&gt;): void

根据指定的选项获取域访问令牌。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| options | [GetDomainAccessTokenOptions](#getdomainaccesstokenoptions10)  | 是   | 指示获取域访问令牌的选项。|
| callback   | AsyncCallback&lt;Uint8Array&gt; | 是   | 指示结果回调。|

**示例:**
  ```js
  let plugin = {
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {},
    unbindAccount: (domainAccountInfo, callback) => {},
    isAccountTokenValid: (domainAccountInfo, callback) => {},
    getAccessToken: (options, callback) => {
      // mock getting operation
      let token = new Uint8Array([0]);
      // notify result
      callback({code: 0}, token);
J
jidong 已提交
4777 4778 4779 4780 4781
    }
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin)
  ```

J
jidong 已提交
4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806
## DomainAccountManager <sup>9+</sup>
域帐号管理器类。

### registerPlugin<sup>9+</sup>

static registerPlugin(plugin: DomainPlugin): void

注册域插件。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**参数:**

| 参数名    | 类型                     | 必填 | 说明                      |
| ----------| ----------------------- | --- | -------------------------- |
| plugin   | [DomainPlugin](#domainplugin9)  | 是  | 指示域插件。 |

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
C
chennian 已提交
4807
| 12300201 | The domain plugin has been registered. |
J
jidong 已提交
4808 4809 4810 4811

**示例:**
  ```js
  let plugin = {
J
jidong 已提交
4812 4813 4814 4815 4816 4817 4818
    auth: (domainAccountInfo, credential, callback) => {},
    authWithPopup: (domainAccountInfo, callback) => {},
    authWithToken: (domainAccountInfo, callback) => {},
    getAccountInfo: (domain, accountName, callback) => {},
    getAuthStatusInfo: (domainAccountInfo, callback) => {},
    bindAccount: (domainAccountInfo, localId, callback) => {},
    unbindAccount: (domainAccountInfo, callback) => {}
J
jidong 已提交
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849
  }
  try {
    account_osAccount.DomainAccountManager.registerPlugin(plugin);
    console.log('registerPlugin success.');
  } catch(err) {
    console.log("registerPlugin err:" + JSON.stringify(err));
  }
  ```

### unregisterPlugin<sup>9+</sup>

static unregisterPlugin(): void

注销域插件。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**示例:**
  ```js
  try {
    account_osAccount.DomainAccountManager.unregisterPlugin();
    console.log('unregisterPlugin success.');
  } catch(err) {
    console.log("unregisterPlugin err:" + JSON.stringify(err));
  }
  ```

J
jidong 已提交
4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873
### auth<sup>10+</sup>

auth(domainAccountInfo: DomainAccountInfo, credential: Uint8Array, callback: IUserAuthCallback): void

认证指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| credential   | Uint8Array  | 是   | 指示域帐号的凭据。|
| callback   | [IUserAuthCallback](#iuserauthcallback8)  | 是   | 指示认证结果回调。|

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
C
chennian 已提交
4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884
| 12300001 | System service exception. |
| 12300002 | Invalid domainAccountInfo or credential. |
| 12300003 | Domain account does not exist. |
| 12300013 | Network exception. |
| 12300101 | Authentication failed. |
| 12300109 | Authentication is canceled. |
| 12300110 | Authentication is locked. |
| 12300111 | Authentication timeout. |
| 12300112 | Authentication service is busy. |
| 12300113 | Authentication service does not exist. |
| 12300114 | Authentication service exception. |
J
jidong 已提交
4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926

**示例:**
  ```js
  let domainAccountInfo = {
    domain: "CHINA",
    accountName: "zhangsan"
  }
  let credential = new Uint8Array([0])
  try {
    account_osAccount.DomainAccountManager.auth(domainAccountInfo, credential, {
      onResult: (resultCode, authResult) => {
        console.log('auth resultCode = ' + resultCode);
        console.log('auth authResult = ' + JSON.stringify(authResult));
      }
    });
  } catch (err) {
    console.log('auth exception = ' + JSON.stringify(err));
  }
  ```

### authWithPopup<sup>10+</sup>

authWithPopup(callback: IUserAuthCallback): void

弹框认证指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| callback   | [IUserAuthCallback](#iuserauthcallback8)  | 是   | 指示认证结果回调。|

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
C
chennian 已提交
4927 4928 4929 4930 4931 4932 4933 4934 4935 4936
| 12300001 | System service exception. |
| 12300003 | No domain account is bound. |
| 12300013 | Network exception. |
| 12300101 | Authentication failed. |
| 12300109 | Authentication is canceled. |
| 12300110 | Authentication is locked. |
| 12300111 | Authentication timeout. |
| 12300112 | Authentication service is busy. |
| 12300113 | Authentication service does not exist. |
| 12300114 | Authentication service exception. |
J
jidong 已提交
4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974

**示例:**
  ```js
  try {
    account_osAccount.DomainAccountManager.authWithPopup({
      onResult: (resultCode, authResult) => {
        console.log('auth resultCode = ' + resultCode);
        console.log('auth authResult = ' + JSON.stringify(authResult));
      }
    })
  } catch (err) {
    console.log('auth exception = ' + JSON.stringify(err));
  }
  ```

### authWithPopup<sup>10+</sup>

authWithPopup(localId: number, callback: IUserAuthCallback): void

弹框认证指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.ACCESS_USER_AUTH_INTERNAL

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| localId   | number  | 是   | 指示绑定域帐号的系统帐号的本地标识。|
| callback   | [IUserAuthCallback](#iuserauthcallback8)  | 是   | 指示认证结果回调。|

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
C
chennian 已提交
4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | No domain account is bound. |
| 12300013 | Network exception. |
| 12300101 | Authentication failed. |
| 12300109 | Authentication is canceled. |
| 12300110 | Authentication is locked. |
| 12300111 | Authentication timeout. |
| 12300112 | Authentication service is busy. |
| 12300113 | Authentication service does not exist. |
| 12300114 | Authentication service exception. |
J
jidong 已提交
4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023

**示例:**
  ```js
  try {
    account_osAccount.DomainAccountManager.authWithPopup(100, {
      onResult: (resultCode, authResult) => {
        console.log('authWithPopup resultCode = ' + resultCode);
        console.log('authWithPopup authResult = ' + JSON.stringify(authResult));
      }
    })
  } catch (err) {
    console.log('authWithPopup exception = ' + JSON.stringify(err));
  }
  ```

### hasAccount<sup>10+</sup>

hasAccount(domainAccountInfo: DomainAccountInfo, callback: AsyncCallback&lt;boolean&gt;): void

检查是否存在指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| callback   | AsyncCallback&lt;boolean&gt;  | 是   | 指示检查结果回调。|

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
C
chennian 已提交
5024 5025 5026
| 12300001 | System service exception. |
| 12300002 | Invalid domainAccountInfo. |
| 12300013 | Network exception. |
J
jidong 已提交
5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074

**示例:**
  ```js
  let domainAccountInfo = {
    domain: "CHINA",
    accountName: "zhangsan"
  }
  try {
    account_osAccount.DomainAccountManager.hasAccount(domainAccountInfo, (err, result) => {
      if (err) {
        console.log("call hasAccount failed, error: " + JSON.stringify(err));
      } else {
        console.log("hasAccount result: " + result);
      }
    });
  } catch (err) {
    console.log('hasAccount exception = ' + JSON.stringify(err));
  }
  ```

### hasAccount<sup>10+</sup>

hasAccount(domainAccountInfo: DomainAccountInfo): Promise&lt;boolean&gt;

检查是否存在指定的域帐号。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo   | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|

**返回值:**

| 类型                      | 说明                     |
| :------------------------ | ----------------------- |
| Promise&lt;boolean&gt; | Promise对象,返回指定的域帐号是否存在。 |

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
C
chennian 已提交
5075 5076 5077
| 12300001 | System service exception. |
| 12300002 | Invalid domainAccountInfo. |
| 12300013 | Network exception. |
J
jidong 已提交
5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095

**示例:**
  ```js
  let domainAccountInfo = {
    domain: "CHINA",
    accountName: "zhangsan"
  }
  try {
    account_osAccount.DomainAccountManager.hasAccount(domainAccountInfo).then((result) => {
      console.log("hasAccount result: " + result);
    }).catch((err) => {
        console.log("call hasAccount failed, error: " + JSON.stringify(err));
    });
  } catch (err) {
    console.log('hasAccount exception = ' + JSON.stringify(err));
  }
  ```

J
jidong 已提交
5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196
### updateAccountToken<sup>10+</sup>

updateAccountToken(domainAccountInfo: DomainAccountInfo, token: Uint8Array, callback: AsyncCallback&lt;void&gt;): void;

更新指定域帐号的令牌,空令牌表示目标域帐号的令牌失效。使用callback异步回调。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| token | Uint8Array  | 是   | 指示域帐号的令牌。|
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。如果更新成功,err为null,否则为错误对象。|

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid token. |
| 12300003 | Account not found. |

**示例:**
  ```js
  let domainAccountInfo = {
    domain: "CHINA",
    accountName: "zhangsan",
    accountId: "123456"
  }
  let token = new Uint8Array([0])
  try {
    account_osAccount.DomainAccountManager.updateAccountToken(domainAccountInfo, token, (err) => {
      if (err != null) {
        console.log("updateAccountToken failed, error: " + JSON.stringify(err));
      } else {
        console.log("updateAccountToken successfully");
      }
    })
  } catch (err) {
    console.log('updateAccountToken exception = ' + JSON.stringify(err));
  }
  ```

### updateAccountToken<sup>10+</sup>

updateAccountToken(domainAccountInfo: DomainAccountInfo, token: Uint8Array): Promise&lt;void&gt;

更新指定域帐号的令牌,空令牌表示目标域帐号的令牌失效。使用Promise异步回调。

**系统接口:** 此接口为系统接口。

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
| domainAccountInfo | [DomainAccountInfo](#domainaccountinfo8)  | 是   | 指示域帐号信息。|
| token | Uint8Array  | 是   | 指示域帐号的令牌。|

**返回值:**

| 类型                      | 说明                     |
| :------------------------ | ----------------------- |
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid token. |
| 12300003 | Account not found. |

**示例:**
  ```js
  let domainAccountInfo = {
    domain: "CHINA",
    accountName: "zhangsan",
    accountId: "123456"
  }
  let token = new Uint8Array([0])
  try {
    account_osAccount.DomainAccountManager.updateAccountToken(domainAccountInfo, token).then(() => {
      console.log("updateAccountToken successfully");
    }).catch((err) => {
        console.log("updateAccountToken failed, error: " + JSON.stringify(err));
    });
  } catch (err) {
    console.log('updateAccountToken exception = ' + JSON.stringify(err));
  }
  ```

5197 5198 5199 5200
## UserIdentityManager<sup>8+</sup>

获取用户身份管理类。

J
jidong 已提交
5201
**系统接口:** 此接口为系统接口。
5202

5203 5204 5205 5206
### constructor<sup>8+</sup>

constructor()

J
jidong 已提交
5207
用户身份管理类的默认构造函数。
5208

J
jidong 已提交
5209
**系统接口:** 此接口为系统接口。
5210

5211 5212
**系统能力**:SystemCapability.Account.OsAccount

5213
**示例:**  
5214
  ```js
J
jidong 已提交
5215
  let userIDM = new account_osAccount.UserIdentityManager();
5216 5217 5218 5219 5220 5221
  ```

### openSession<sup>8+</sup>

openSession(callback: AsyncCallback&lt;Uint8Array&gt;): void;

J
jidong 已提交
5222
打开会话,获取挑战值。使用callback异步回调。
5223

J
jidong 已提交
5224
**系统接口:** 此接口为系统接口。
5225 5226 5227 5228 5229 5230 5231

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_USER_IDM

**参数:**

J
jidong 已提交
5232 5233 5234
| 参数名    | 类型                             | 必填 | 说明                                                            |
| -------- | -------------------------------- | ---- | -------------------------------------------------------------- |
| callback | AsyncCallback&lt;Uint8Array&gt;  | 是   | 回调函数。如果打开会话成功,err为null,data为挑战值;否则为错误对象。|
5235

J
jidong 已提交
5236 5237 5238 5239 5240 5241
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |

5242
**示例:**
5243
  ```js
J
jidong 已提交
5244
  let userIDM = new account_osAccount.UserIdentityManager();
5245 5246 5247 5248 5249 5250 5251 5252
  try {
    userIDM.openSession((err, challenge) => {
        console.log('openSession error = ' + JSON.stringify(err));
        console.log('openSession challenge = ' + JSON.stringify(challenge));
    });
  } catch (e) {
    console.log('openSession exception = ' + JSON.stringify(e));
  }
5253 5254 5255 5256 5257 5258
  ```

### openSession<sup>8+</sup>

openSession(): Promise&lt;Uint8Array&gt;;

J
jidong 已提交
5259
打开会话,获取挑战值。使用Promise异步回调。
5260

J
jidong 已提交
5261
**系统接口:** 此接口为系统接口。
5262 5263 5264 5265 5266 5267 5268

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_USER_IDM

**返回值:**

J
jidong 已提交
5269 5270 5271
| 类型                      | 说明                     |
| :------------------------ | ----------------------- |
| Promise&lt;Uint8Array&gt; | Promise对象,返回挑战值。 |
5272

J
jidong 已提交
5273 5274 5275 5276 5277 5278
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |

5279
**示例:**
5280
  ```js
J
jidong 已提交
5281
  let userIDM = new account_osAccount.UserIdentityManager();
5282 5283 5284 5285 5286 5287 5288 5289 5290
  try {
    userIDM.openSession().then((challenge) => {
        console.info('openSession challenge = ' + JSON.stringify(challenge));
    }).catch((err) => {
        console.info('openSession error = ' + JSON.stringify(err));
    });
  } catch (e) {
    console.log('openSession exception = ' + JSON.stringify(e));
  }
5291 5292 5293 5294 5295 5296
  ```

### addCredential<sup>8+</sup>

addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

J
jidong 已提交
5297
添加凭据,添加用户凭据信息,传入凭据添加方法和凭据信息(凭据类型,子类,如果添加用户的非密码凭据,则传入密码身份验证令牌),并获取结果/获取信息。
5298

J
jidong 已提交
5299
**系统接口:** 此接口为系统接口。
5300 5301 5302 5303 5304 5305 5306

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_USER_IDM

**参数:**

J
jidong 已提交
5307
| 参数名           | 类型                                 | 必填 | 说明                        |
J
jidong 已提交
5308
| --------------- | ------------------------------------ | --- | ---------------------------- |
J
jidong 已提交
5309 5310
| credentialInfo  | [CredentialInfo](#credentialinfo8)   | 是  | 指示凭据信息。                |
| callback        | [IIdmCallback](#iidmcallback8)       | 是  | 回调对象,返回添加凭据的结果。  |
5311

J
jidong 已提交
5312 5313 5314 5315 5316 5317 5318 5319 5320
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialInfo, i.e. authType or authSubType. |
| 12300101 | Token is invalid. |
| 12300106 | Unsupported authType. |

5321
**示例:**
5322
  ```js
J
jidong 已提交
5323 5324 5325
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let pinAuth = new account_osAccount.PINAuth();
  pinAuth.registerInputer({
W
wangyihui 已提交
5326 5327
    onGetData: (authSubType, callback) => {
      callback.onSetData(authSubType, password);
J
jidong 已提交
5328 5329 5330 5331 5332 5333 5334 5335 5336
    }
  });
  let credentialInfo = {
    credType: account_osAccount.AuthType.PIN,
    credSubType: account_osAccount.AuthSubType.PIN_SIX,
    token: null
  };
  let userIDM = new account_osAccount.UserIdentityManager();
  userIDM.openSession((err, challenge) => {
5337
    try {
J
jidong 已提交
5338 5339
    userIDM.addCredential(credentialInfo, {
      onResult: (result, extraInfo) => {
W
wangyihui 已提交
5340 5341
        console.log('addCredential result = ' + result);
        console.log('addCredential extraInfo = ' + extraInfo);
5342
      }
J
jidong 已提交
5343
    });
5344
    } catch (e) {
W
wangyihui 已提交
5345
      console.log('addCredential exception = ' + JSON.stringify(e));
5346
    }
J
jidong 已提交
5347
  });
5348 5349 5350 5351 5352 5353
  ```

### updateCredential<sup>8+</sup>

updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

J
jidong 已提交
5354
更新凭据。使用callback异步回调。
5355

J
jidong 已提交
5356
**系统接口:** 此接口为系统接口。
5357 5358 5359 5360 5361 5362 5363

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_USER_IDM

**参数:**

J
jidong 已提交
5364 5365 5366 5367
| 参数名           | 类型                                  | 必填 | 说明                     |
| --------------- | ------------------------------------- | --- | ------------------------- |
| credentialInfo  | [CredentialInfo](#credentialinfo8)    | 是  | 指示凭据信息。             |
| callback        | [IIdmCallback](#iidmcallback8)        | 是  | 回调对象,返回更新凭据的结果。 |
5368

J
jidong 已提交
5369 5370 5371 5372 5373 5374 5375 5376 5377
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialInfo, i.e. authType or authSubType or token. |
| 12300101 | Token is invalid. |
| 12300106 | Unsupported authType. |

5378
**示例:**
5379
  ```js
J
jidong 已提交
5380 5381 5382 5383 5384 5385 5386 5387 5388 5389
  let userIDM = new account_osAccount.UserIdentityManager();
  let userAuth = new account_osAccount.UserAuth();
  let pinAuth = new account_osAccount.PINAuth();
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let credentialInfo = {
    credType: account_osAccount.AuthType.PIN,
    credSubType: account_osAccount.AuthSubType.PIN_SIX,
    token: null
  };
  pinAuth.registerInputer({
W
wangyihui 已提交
5390 5391
    onGetData: (authSubType, callback) => {
      callback.onSetData(authSubType, password);
J
jidong 已提交
5392 5393 5394
    }
  });
  userIDM.openSession((err, challenge) => {
J
jidong 已提交
5395
    userAuth.auth(challenge, credentialInfo.credType, account_osAccount.AuthTrustLevel.ATL1, {
J
jidong 已提交
5396 5397 5398 5399 5400
      onResult: (result, extraInfo) => {
        if (result != account_osAccount.ResultCode.SUCCESS) {
          return;
        }
        credentialInfo.token = extraInfo.token;
5401 5402 5403 5404 5405 5406 5407 5408 5409 5410
        try {
          userIDM.updateCredential(credentialInfo, {
            onResult: (result, extraInfo) => {
                console.log('updateCredential result = ' + result);
                console.log('updateCredential extraInfo = ' + extraInfo);
            }
          });
        } catch (e) {
          console.log('updateCredential exception = ' + JSON.stringify(e));
        }
5411
      }
J
jidong 已提交
5412 5413
    });
  });
5414 5415 5416 5417 5418 5419
  ```

### closeSession<sup>8+</sup>

closeSession(): void;

J
jidong 已提交
5420
关闭会话,结束IDM操作。
5421

J
jidong 已提交
5422
**系统接口:** 此接口为系统接口。
5423 5424 5425 5426 5427

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_USER_IDM

5428
**示例:**
5429
  ```js
J
jidong 已提交
5430
  let userIDM = new account_osAccount.UserIdentityManager();
5431 5432 5433 5434 5435
  userIDM.closeSession();
  ```

### cancel<sup>8+</sup>

5436
cancel(challenge: Uint8Array): void;
5437 5438 5439

根据挑战值取消条目。

J
jidong 已提交
5440
**系统接口:** 此接口为系统接口。
5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_USER_IDM

**参数:**

| 参数名    | 类型        | 必填 | 说明   |
| -------- | ----------- | ---- | ----- |
| challenge | Uint8Array | 是   | 挑战值。 |

J
jidong 已提交
5452 5453 5454 5455 5456 5457
**错误码:**

| 错误码ID | 错误信息            |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid challenge. |
5458

5459
**示例:**
5460
  ```js
J
jidong 已提交
5461
  let userIDM = new account_osAccount.UserIdentityManager();
J
jidong 已提交
5462
  let challenge = new Uint8Array([0]);
5463 5464 5465 5466 5467
  try {
    userIDM.cancel(challenge);
  } catch(err) {
    console.log("cancel err:" + JSON.stringify(err));
  }
5468 5469 5470 5471 5472 5473 5474 5475
  ```

### delUser<sup>8+</sup>

delUser(token: Uint8Array, callback: IIdmCallback): void;

删除具有身份验证令牌的用户,使用callback方式异步返回结果。

J
jidong 已提交
5476
**系统接口:** 此接口为系统接口。
5477 5478 5479 5480 5481 5482 5483

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_USER_IDM

**参数:**

J
jidong 已提交
5484 5485 5486 5487
| 参数名    | 类型                           | 必填 | 说明                      |
| -------- | ------------------------------ | --- | ------------------------- |
| token    | Uint8Array                     | 是  | 身份验证令牌。             |
| callback | [IIdmCallback](#iidmcallback8) | 是  | 回调对象,返回删除用户的结果。|
5488

J
jidong 已提交
5489 5490 5491 5492 5493 5494 5495
**错误码:**

| 错误码ID | 错误信息        |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300101 | Token is invalid. |

5496
**示例:**
5497
  ```js
J
jidong 已提交
5498 5499
  let userIDM = new account_osAccount.UserIdentityManager();
  let token = new Uint8Array([0]);
5500 5501 5502 5503 5504 5505 5506 5507 5508 5509
  try {
    userIDM.delUser(token, {
      onResult: (result, extraInfo) => {
        console.log('delUser result = ' + result);
        console.log('delUser extraInfo = ' + JSON.stringify(extraInfo));
      }
    });
  } catch (e) {
    console.log('delUser exception = ' + JSON.stringify(e));
  }
5510 5511 5512 5513 5514 5515
  ```

### delCred<sup>8+</sup>

delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): void;

J
jidong 已提交
5516
删除用户凭据信息。
5517

J
jidong 已提交
5518
**系统接口:** 此接口为系统接口。
5519 5520 5521 5522 5523 5524 5525 5526

**系统能力:** SystemCapability.Account.OsAccount

**需要权限:** ohos.permission.MANAGE_USER_IDM

**参数:**

| 参数名           | 类型                                            | 必填 | 说明                      |
J
jidong 已提交
5527 5528 5529 5530
| --------------- | ----------------------------------- | --- | ---------------------------|
| credentialId    | Uint8Array                          | 是  | 凭证索引。                  |
| token           | Uint8Array                          | 是  | 身份验证令牌。               |
| callback        | [IIdmCallback](#iidmcallback8)      | 是  | 回调对象,返回删除凭据的结果。 |
5531

J
jidong 已提交
5532 5533 5534 5535 5536 5537 5538 5539 5540
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialId. |
| 12300101 | Token is invalid. |
| 12300102 | Credential not found. |

5541
**示例:**
5542
  ```js
J
jidong 已提交
5543 5544 5545
  let userIDM = new account_osAccount.UserIdentityManager();
  let credentialId = new Uint8Array([0]);
  let token = new Uint8Array([0]);
5546 5547 5548 5549 5550 5551 5552 5553 5554 5555
  try {
    userIDM.delCred(credentialId, token, {
      onResult: (result, extraInfo) => {
          console.log('delCred result = ' + result);
          console.log('delCred extraInfo = ' + JSON.stringify(extraInfo));
      }
    });
  } catch (e) {
    console.log('delCred exception = ' + JSON.stringify(e));
  }
5556 5557 5558 5559
  ```

### getAuthInfo<sup>8+</sup>

5560
getAuthInfo(callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;
5561

J
jidong 已提交
5562
获取认证信息。使用callback异步回调。
5563

J
jidong 已提交
5564
**系统接口:** 此接口为系统接口。
5565 5566 5567

**系统能力:** SystemCapability.Account.OsAccount

5568
**需要权限:** ohos.permission.USE_USER_IDM
5569 5570 5571

**参数:**

J
jidong 已提交
5572 5573
| 参数名    | 类型                                                                     | 必填 | 说明                                                 |
| -------- | ------------------------------------------------------------------------ | ---- | --------------------------------------------- |
J
jidong 已提交
5574
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是   | 回调函数。如果成功,err为null,data为当前用户的所有已注册凭据信息;否则为错误对象。|
5575

J
jidong 已提交
5576 5577 5578 5579 5580
**错误码:**

| 错误码ID | 错误信息               |
| -------- | --------------------- |
| 12300001 | System service exception. |
5581

5582
**示例:**
5583
  ```js
J
jidong 已提交
5584
  let userIDM = new account_osAccount.UserIdentityManager();
5585 5586 5587 5588 5589 5590 5591 5592
  try {
    userIDM.getAuthInfo((err, result) => {
      console.log('getAuthInfo err = ' + JSON.stringify(err));
      console.log('getAuthInfo result = ' + JSON.stringify(result));
    });
  } catch (e) {
    console.log('getAuthInfo exception = ' + JSON.stringify(e));
  }
5593 5594 5595 5596 5597 5598
  ```

### getAuthInfo<sup>8+</sup>

getAuthInfo(authType: AuthType, callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;

J
jidong 已提交
5599
获取指定类型的认证信息。使用callback异步回调。
5600

J
jidong 已提交
5601
**系统接口:** 此接口为系统接口。
5602 5603 5604

**系统能力:** SystemCapability.Account.OsAccount

5605
**需要权限:** ohos.permission.USE_USER_IDM
5606 5607 5608 5609 5610 5611

**参数:**

| 参数名    | 类型                                               | 必填 | 说明                                                |
| -------- | -------------------------------------------------- | ---- | -------------------------------------------------- |
| authType | [AuthType](#authtype8) | 是   | 认证类型。                                          |
J
jidong 已提交
5612 5613 5614 5615 5616
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是   | 回调函数,如果获取成功,err为null,data为当前用户指定类型的所有已注册凭据信息;否则为错误对象。 |

**错误码:**

| 错误码ID | 错误信息               |
J
jidong 已提交
5617 5618 5619
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType. |
5620

5621
**示例:**
5622
  ```js
J
jidong 已提交
5623
  let userIDM = new account_osAccount.UserIdentityManager();
5624 5625 5626 5627 5628 5629 5630 5631
  try {
    userIDM.getAuthInfo(account_osAccount.AuthType.PIN, (err, result) => {
      console.log('getAuthInfo err = ' + JSON.stringify(err));
      console.log('getAuthInfo result = ' + JSON.stringify(result));
    });
  } catch (e) {
    console.log('getAuthInfo exception = ' + JSON.stringify(e));
  }
5632 5633 5634 5635 5636 5637
  ```

### getAuthInfo<sup>8+</sup>

getAuthInfo(authType?: AuthType): Promise&lt;Array&lt;EnrolledCredInfo&gt;&gt;;

J
jidong 已提交
5638
获取认证信息。使用Promise异步回调。
5639

J
jidong 已提交
5640
**系统接口:** 此接口为系统接口。
5641 5642 5643

**系统能力:** SystemCapability.Account.OsAccount

5644
**需要权限:** ohos.permission.USE_USER_IDM
5645 5646 5647 5648 5649

**参数:**

| 参数名    | 类型                                | 必填 | 说明      |
| -------- | ----------------------------------- | ---- | -------- |
J
jidong 已提交
5650
| authType | [AuthType](#authtype8)              | 否   | 认证类型。|
5651 5652 5653

**返回值:**

J
jidong 已提交
5654
| 类型                                         | 说明                                                                     |
J
jidong 已提交
5655
| :------------------------------------------- | :----------------------------------------------------------------------- |
J
jidong 已提交
5656 5657 5658 5659 5660
| Promise&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | Promise对象,返回当前用户指定类型的所有已注册凭据信息。|

**错误码:**

| 错误码ID | 错误信息               |
J
jidong 已提交
5661 5662 5663
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType. |
5664

5665
**示例:**
5666
  ```js
J
jidong 已提交
5667
  let userIDM = new account_osAccount.UserIdentityManager();
5668 5669 5670 5671 5672 5673 5674 5675 5676
  try {
    userIDM.getAuthInfo(account_osAccount.AuthType.PIN).then((result) => {
      console.log('getAuthInfo result = ' + JSON.stringify(result))
    }).catch((err) => {
      console.log('getAuthInfo error = ' + JSON.stringify(err));
    });
  } catch (e) {
    console.log('getAuthInfo exception = ' + JSON.stringify(e));
  }
5677 5678 5679 5680 5681 5682
  ```

## IInputData<sup>8+</sup>

密码数据回调。

J
jidong 已提交
5683
**系统接口:** 此接口为系统接口。
5684

5685 5686
### onSetData<sup>8+</sup>

W
wangyihui 已提交
5687
onSetData: (authSubType: AuthSubType, data: Uint8Array) => void;
5688

J
jidong 已提交
5689
**系统接口:** 此接口为系统接口。
5690

5691 5692 5693 5694 5695 5696 5697 5698
通知设置数据。

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                     | 必填 | 说明                                            |
| ---------- | ---------------------------------------- | ---- | ----------------------------------------------- |
W
wangyihui 已提交
5699
| authSubType | [AuthSubType](#authsubtype8)             | 是   | 用于认证的凭据子类型。                            |
5700 5701
| data       | Uint8Array                               | 是   | 要设置的数据是凭据,用来在认证、添加、修改凭据操作。 |

C
chennian 已提交
5702 5703 5704 5705 5706 5707
**错误码:**

| 错误码ID | 错误信息               |
| -------- | ------------------- |
| 12300002 | Invalid pinSubType. |

5708
**示例:**
5709
  ```js
J
jidong 已提交
5710 5711 5712
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let passwordNumber = new Uint8Array([1, 2, 3, 4]);
  let inputer = {
W
wangyihui 已提交
5713 5714 5715
    onGetData: (authSubType, callback) => {
        if (authSubType == account_osAccount.AuthSubType.PIN_NUMBER) {
          callback.onSetData(authSubType, passwordNumber);
J
jidong 已提交
5716
        } else {
W
wangyihui 已提交
5717
          callback.onSetData(authSubType, password);
J
jidong 已提交
5718 5719 5720
        }
    }
  };
5721 5722 5723 5724
  ```

## IInputer<sup>8+</sup>

W
wangyihui 已提交
5725
凭据输入器回调。
5726

J
jidong 已提交
5727
**系统接口:** 此接口为系统接口。
5728

5729 5730
### onGetData<sup>8+</sup>

W
wangyihui 已提交
5731
onGetData: (authSubType: AuthSubType, callback: IInputData) => void;
5732 5733 5734

通知获取数据。

J
jidong 已提交
5735
**系统接口:** 此接口为系统接口。
5736

5737 5738 5739 5740 5741 5742
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
5743
| callback   | [IInputData](#iinputdata8)  | 是   | 指示密码数据回调。|
5744

5745
**示例:**
5746
  ```js
J
jidong 已提交
5747 5748 5749
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let passwordNumber = new Uint8Array([1, 2, 3, 4]);
  let inputer = {
W
wangyihui 已提交
5750 5751 5752
    onGetData: (authSubType, callback) => {
        if (authSubType == account_osAccount.AuthSubType.PIN_NUMBER) {
          callback.onSetData(authSubType, passwordNumber);
J
jidong 已提交
5753
        } else {
W
wangyihui 已提交
5754
          callback.onSetData(authSubType, password);
J
jidong 已提交
5755 5756 5757 5758 5759
        }
    }
  };
  let pinAuth = new account_osAccount.PINAuth();
  let result = pinAuth.registerInputer(inputer);
F
fanchenxuan 已提交
5760
  console.log('registerInputer result: ' + result);
5761 5762 5763 5764
  ```

## IUserAuthCallback<sup>8+</sup>

J
jidong 已提交
5765
表示用户认证回调类。
5766

J
jidong 已提交
5767
**系统接口:** 此接口为系统接口。
5768

5769 5770 5771 5772
### onResult<sup>8+</sup>

onResult: (result: number, extraInfo: AuthResult) => void;

J
jidong 已提交
5773
身份认证结果回调函数,返回结果码和认证结果信息。
5774

J
jidong 已提交
5775
**系统接口:** 此接口为系统接口。
5776

5777 5778 5779 5780 5781 5782 5783
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名     | 类型                                    | 必填 | 说明                 |
| --------- | --------------------------------------- | ---- | ------------------- |
| result    | number                                   | 是   | 表示身份认证结果代码。|
5784
| extraInfo | [AuthResult](#authresult8)  | 是   | 表示不同情况下的具体信息,如果认证通过,则在extrainfo中返回认证令牌,如果身份验证失败,则在extrainfo中返回剩余的身份验证时间,如果身份验证执行器被锁定,冻结时间将在extrainfo中返回。|
5785

5786
**示例:**
5787
  ```js
J
jidong 已提交
5788 5789
  let authCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
5790 5791
      console.log('auth result = ' + result);
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
5792 5793
    }
  };
5794 5795 5796 5797 5798 5799
  ```

### onAcquireInfo?<sup>8+</sup>

onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;

J
jidong 已提交
5800
身份认证信息获取回调函数。
5801

J
jidong 已提交
5802
**系统接口:** 此接口为系统接口。
5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名    | 类型     | 必填 | 说明                           |
| --------- | ------- | ---- | ----------------------------- |
| module    | number  | 是   | 指示用于身份验证的执行器类型。   |
| acquire   | number  | 是   | 指示不同身份验证执行器的tip代码。|
| extraInfo | any     | 是   | 保留参数。                     |

5814
**示例:**
5815
  ```js
J
jidong 已提交
5816 5817
  let authCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
5818 5819
      console.log('auth result = ' + result)
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
5820 5821
    },
    onAcquireInfo: (module, acquire, extraInfo) => {
F
fanchenxuan 已提交
5822 5823
      console.log('auth module = ' + module);
      console.log('auth acquire = ' + acquire);
J
jidong 已提交
5824 5825 5826
      console.info('auth extraInfo = ' + JSON.stringify(extraInfo));
    }
  };
5827 5828 5829 5830
  ```

## IIdmCallback<sup>8+</sup>

J
jidong 已提交
5831
表示身份管理回调类。
5832

J
jidong 已提交
5833
**系统接口:** 此接口为系统接口。
5834

5835 5836
### onResult<sup>8+</sup>

5837
onResult: (result: number, extraInfo: RequestResult) => void;
5838

J
jidong 已提交
5839
身份管理操作结果回调函数,返回结果码和请求结果信息。
5840

J
jidong 已提交
5841
**系统接口:** 此接口为系统接口。
5842 5843 5844 5845 5846 5847 5848 5849

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名     | 类型                                    | 必填 | 说明                     |
| --------- | --------------------------------------- | ---- | ----------------------- |
| result    | number                                  | 是   | 表示身份认证结果代码。    |
5850
| extraInfo | [RequestResult](#requestresult8)  | 是   | 针对不同情况传递具体信息。|
5851

5852
**示例:**
5853
  ```js
F
fanchenxuan 已提交
5854
  let idmCallback = {
J
jidong 已提交
5855
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
5856
      console.log('callback result = ' + result)
J
jidong 已提交
5857 5858 5859
      console.info('callback extraInfo = ' + JSON.stringify(extraInfo));
    }
  };
5860 5861 5862 5863 5864 5865
  ```

### onAcquireInfo?<sup>8+</sup>

onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;

J
jidong 已提交
5866
身份管理信息获取回调函数。
5867

J
jidong 已提交
5868
**系统接口:** 此接口为系统接口。
5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879

**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名    | 类型     | 必填 | 说明                           |
| --------- | ------- | ---- | ----------------------------- |
| module    | number  | 是   | 指示用于身份验证的执行器类型。   |
| acquire   | number  | 是   | 指示不同身份验证执行器的tip代码。|
| extraInfo | any     | 是   | 保留参数。                     |

5880
**示例:**
5881
  ```js
J
jidong 已提交
5882 5883
  let idmCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
5884 5885
      console.log('callback result = ' + result)
      console.log('callback onResult = ' + JSON.stringify(extraInfo));
J
jidong 已提交
5886 5887
    },
    onAcquireInfo: (module, acquire, extraInfo) => {
F
fanchenxuan 已提交
5888 5889
      console.log('callback module = ' + module);
      console.log('callback acquire = ' + acquire);
J
jidong 已提交
5890 5891 5892
      console.log('callback onacquireinfo = ' + JSON.stringify(extraInfo));
    }
  };
5893 5894 5895 5896 5897 5898
  ```

## GetPropertyRequest<sup>8+</sup>

提供获取属性请求的信息。

J
jidong 已提交
5899
**系统接口:** 此接口为系统接口。
5900

5901 5902
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5903
| 名称    | 类型                                                          | 必填   | 说明                   |
5904
| -------- | ------------------------------------------------------------- | ----- | ----------------------- |
5905 5906
| authType | [AuthType](#authtype8)                            | 是    | 身份验证凭据类型。        |
| keys     | Array&lt;[GetPropertyType](#getpropertytype8)&gt; | 是    | 指示要获取的属性类型数组。 |
5907 5908 5909 5910 5911

## SetPropertyRequest<sup>8+</sup>

提供设置属性请求的信息。

J
jidong 已提交
5912
**系统接口:** 此接口为系统接口。
5913

5914 5915
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5916
| 名称    | 类型                                             | 必填   | 说明                 |
5917
| -------- | ------------------------------------------------ | ----- | -------------------- |
5918 5919
| authType | [AuthType](#authtype8)               | 是    | 身份验证凭据类型。     |
| key     | [SetPropertyType](#setpropertytype8) | 是    | 指示要设置的属性类型。 |
5920 5921 5922 5923 5924 5925
| setInfo  | Uint8Array                                       | 是    | 指示要设置的信息。     |

## ExecutorProperty<sup>8+</sup>

提供执行器的属性。

J
jidong 已提交
5926
**系统接口:** 此接口为系统接口。
5927

5928 5929
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5930
| 名称        | 类型                                     | 必填   | 说明              |
5931 5932
| ------------ | ---------------------------------------- | ----- | ----------------- |
| result       | number                                   | 是    | 指示结果。         |
5933
| authSubType  | [AuthSubType](#authsubtype8) | 是    | 指示认证凭据子类型。|
J
jidong 已提交
5934
| remainTimes  | number                                   | 否    | 指示剩余次数。     |
5935 5936 5937 5938
| freezingTime | number                                   | 否    | 指示冻结时间。     |

## AuthResult<sup>8+</sup>

J
jidong 已提交
5939
表示认证结果的信息。
5940

J
jidong 已提交
5941
**系统接口:** 此接口为系统接口。
5942

5943 5944
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5945
| 名称        | 类型        | 必填   | 说明              |
5946 5947
| ------------ | ----------- | ----- | ----------------- |
| token        | Uint8Array  | 否    | 指示认证令牌。     |
J
jidong 已提交
5948
| remainTimes  | number      | 否    | 指示剩余次数。     |
5949 5950 5951 5952
| freezingTime | number      | 否    | 指示冻结时间。     |

## CredentialInfo<sup>8+</sup>

J
jidong 已提交
5953
表示凭证信息。
5954

J
jidong 已提交
5955
**系统接口:** 此接口为系统接口。
5956

5957 5958
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5959
| 名称        | 类型                                     | 必填   | 说明              |
5960
| ------------ | ---------------------------------------- | ----- | ----------------- |
5961 5962
| credType     | [AuthType](#authtype8)       | 是    | 指示凭据类型。     |
| credSubType  | [AuthSubType](#authsubtype8) | 是    | 指示凭据子类型。   |
J
jidong 已提交
5963
| token        | Uint8Array                           | 是    | 指示认证令牌。     |
5964 5965 5966

## RequestResult<sup>8+</sup>

J
jidong 已提交
5967
表示请求结果的信息。
5968

J
jidong 已提交
5969
**系统接口:** 此接口为系统接口。
5970

5971 5972
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5973
| 名称        | 类型        | 必填   | 说明              |
5974 5975 5976 5977 5978
| ------------ | ----------- | ----- | ----------------- |
| credentialId | Uint8Array  | 否    | 指示凭据索引。     |

## EnrolledCredInfo<sup>8+</sup>

J
jidong 已提交
5979
表示已注册凭据的信息。
5980

J
jidong 已提交
5981
**系统接口:** 此接口为系统接口。
5982

5983 5984
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5985
| 名称        | 类型                                     | 必填   | 说明              |
5986 5987
| ------------ | ---------------------------------------- | ----- | ------------------- |
| credentialId | Uint8Array                               | 是    | 指示凭据索引。       |
5988 5989
| authType     | [AuthType](#authtype8)       | 是    | 指示认证凭据类型。   |
| authSubType  | [AuthSubType](#authsubtype8) | 是    | 指示认证凭据子类型。 |
5990 5991 5992 5993
| templateId   | Uint8Array                               | 是    | 指示凭据模板ID。     |

## GetPropertyType<sup>8+</sup>

J
jidong 已提交
5994
表示要获取的属性类型的枚举。
5995

J
jidong 已提交
5996
**系统接口:** 此接口为系统接口。
5997

5998 5999
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6000
| 名称           | 值 | 说明      |
6001 6002 6003 6004 6005 6006 6007
| ------------- | ------ | --------- |
| AUTH_SUB_TYPE | 1      | 认证子类型。 |
| REMAIN_TIMES  | 2      | 剩余时间。   |
| FREEZING_TIME | 3      | 冻结时间。   |

## SetPropertyType<sup>8+</sup>

J
jidong 已提交
6008
表示要设置的属性类型的枚举。
6009

J
jidong 已提交
6010
**系统接口:** 此接口为系统接口。
6011

6012 6013
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6014
| 名称           | 值 | 说明        |
6015 6016 6017 6018 6019
| -------------- | ----- | ----------- |
| INIT_ALGORITHM | 1     | 初始化算法。 |

## AuthType<sup>8+</sup>

J
jidong 已提交
6020
表示身份验证的凭据类型的枚举。
6021

J
jidong 已提交
6022
**系统接口:** 此接口为系统接口。
6023

6024 6025
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6026
| 名称  | 值 | 说明             |
6027
| ----- | ----- | ---------------- |
W
wangyihui 已提交
6028 6029 6030
| PIN   | 1     | 表示PIN认证类型。 |
| FACE  | 2     | 表示脸部认证类型。|
| FINGERPRINT<sup>10+</sup>   | 4     | 表示指纹认证类型。 |
Z
zhouyan 已提交
6031
| DOMAIN<sup>9+</sup>  | 1024     | 表示域认证类型。|
6032 6033 6034

## AuthSubType<sup>8+</sup>

J
jidong 已提交
6035
表示用于认证的凭据子类型的枚举。
6036

J
jidong 已提交
6037
**系统接口:** 此接口为系统接口。
6038

6039 6040
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6041
| 名称       | 值 | 说明               |
6042 6043 6044 6045
| ---------- | ----- | ------------------ |
| PIN_SIX    | 10000 | 表示6位凭证。       |
| PIN_NUMBER | 10001 | 表示自定义数字凭证。 |
| PIN_MIXED  | 10002 | 表示自定义混合凭据。 |
W
wangyihui 已提交
6046 6047
| FACE_2D    | 20000 | 表示2D 人脸凭证。   |
| FACE_3D    | 20001 | 表示3D 人脸凭证。   |
Z
zhouyan 已提交
6048
| DOMAIN_MIXED<sup>9+</sup>    | 10240001 | 表示域认证混合凭证。   |
6049 6050 6051

## AuthTrustLevel<sup>8+</sup>

J
jidong 已提交
6052
表示认证结果的受信任级别的枚举。
6053

J
jidong 已提交
6054
**系统接口:** 此接口为系统接口。
6055

6056 6057
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6058
| 名称  | 值 | 说明        |
6059 6060 6061 6062 6063 6064 6065 6066
| ---- | ------ | ----------- |
| ATL1 | 10000  | 信任级别 1。 |
| ATL2 | 20000  | 信任级别 2。 |
| ATL3 | 30000  | 信任级别 3。 |
| ATL4 | 40000  | 信任级别 4。 |

## Module<sup>8+</sup>

J
jidong 已提交
6067
表示获取信息的模块的枚举。
6068

J
jidong 已提交
6069
**系统接口:** 此接口为系统接口。
6070

6071 6072
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6073
| 名称       | 值 | 说明                     |
6074 6075 6076 6077 6078
| --------- | ------ | ------------------------ |
| FACE_AUTH | 1      | 表示从人脸认证获取的信息。 |

## ResultCode<sup>8+</sup>

J
jidong 已提交
6079
表示身份验证结果码。
6080

J
jidong 已提交
6081
**系统接口:** 此接口为系统接口。
6082

6083 6084
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6085
| 名称                    | 值 | 说明                                     |
6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100
| ----------------------- | ----- | ---------------------------------------- |
| SUCCESS                 | 0     | 表示身份验证成功或支持此功能。             |
| FAIL                    | 1     | 表示验证器无法识别用户。                   |
| GENERAL_ERROR           | 2     | 表示其他错误。                            |
| CANCELED                | 3     | 表示身份验证已取消。                       |
| TIMEOUT                 | 4     | 表示身份验证已超时。                       |
| TYPE_NOT_SUPPORT        | 5     | 表示不支持此身份验证类型。                 |
| TRUST_LEVEL_NOT_SUPPORT | 6     | 表示不支持身份验证信任级别。               |
| BUSY                    | 7     | 表示身份验证任务正忙。等待几秒钟,然后重试。 |
| INVALID_PARAMETERS      | 8     | 表示参数不正确。                          |
| LOCKED                  | 9     | 指示身份验证器已锁定。                     |
| NOT_ENROLLED            | 10    | 表示用户尚未注册验证器。                   |

## FaceTipsCode<sup>8+</sup>

J
jidong 已提交
6101
表示人脸验证过程中提示的枚举。
6102

J
jidong 已提交
6103
**系统接口:** 此接口为系统接口。
6104

6105 6106
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6107
| 名称                          | 值 | 说明                                     |
6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120
| ----------------------------- | ----- | ---------------------------------------- |
| FACE_AUTH_TIP_TOO_BRIGHT      | 1     | 表示由于高照明,获得的面部图像太亮。         |
| FACE_AUTH_TIP_TOO_DARK        | 2     | 表示由于照明度低,获得的面部图像太暗。       |
| FACE_AUTH_TIP_TOO_CLOSE       | 3     | 表示面部离设备太近。                       |
| FACE_AUTH_TIP_TOO_FAR         | 4     | 表示面部离设备太远。                       |
| FACE_AUTH_TIP_TOO_HIGH        | 5     | 表示设备太高,仅捕捉面部上部。              |
| FACE_AUTH_TIP_TOO_LOW         | 6     | 表示设备太低,仅捕捉面部下部。              |
| FACE_AUTH_TIP_TOO_RIGHT       | 7     | 指示设备向右偏移,并且仅捕捉面部的右侧部分。 |
| FACE_AUTH_TIP_TOO_LEFT        | 8     | 指示设备向左偏移,并且仅捕捉面部的左侧部分。 |
| FACE_AUTH_TIP_TOO_MUCH_MOTION | 9     | 表示面部信息收集过程中面部移动过快。         |
| FACE_AUTH_TIP_POOR_GAZE       | 10    | 表示面未朝向设备。                         |
| FACE_AUTH_TIP_NOT_DETECTED    | 11    | 表示未检测到人脸。                         |

Z
zengyawen 已提交
6121
## FingerprintTips<sup>8+</sup>
6122

J
jidong 已提交
6123
表示指纹身份验证过程中提示的枚举。
6124

J
jidong 已提交
6125
**系统接口:** 此接口为系统接口。
6126

6127 6128
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

6129
| 名称                          | 值 | 说明                                            |
6130 6131 6132 6133 6134 6135 6136 6137
| ----------------------------- | ----- | ----------------------------------------------- |
| FINGERPRINT_TIP_GOOD          | 0     | 表明采集的图像良好。                              |
| FINGERPRINT_TIP_IMAGER_DIRTY  | 1     | 表示由于传感器上可疑或检测到污垢,指纹图像噪声过大。 |
| FINGERPRINT_TIP_INSUFFICIENT  | 2     | 表示由于检测到的情况,指纹图像噪声太大,无法处理。   |
| FINGERPRINT_TIP_PARTIAL       | 3     | 指示仅检测到部分指纹图像。                         |
| FINGERPRINT_TIP_TOO_FAST      | 4     | 表示指纹图像由于快速运动而不完整。                  |
| FINGERPRINT_TIP_TOO_SLOW      | 5     | 表示由于缺少运动,指纹图像无法读取。                |

Z
zhangalong 已提交
6138
## OsAccountInfo
Z
zengyawen 已提交
6139

J
jidong 已提交
6140
表示系统帐号信息。
Z
zengyawen 已提交
6141 6142 6143

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

6144
| 名称                         | 类型                                                         | 必填 | 说明                              |
Z
zengyawen 已提交
6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157
| ------------------------------ | ------------------------------------------------------------ | ---- | --------------------------------- |
| localId                        | number                                                       | 是   | 系统帐号ID。                      |
| localName                      | string                                                       | 是   | 系统帐号名称。                    |
| type                           | [OsAccountType](#osaccounttype)                              | 是   | 系统帐号类型                      |
| constraints                    | Array&lt;string&gt;                                          | 否   | 系统帐号[约束](#系统帐号约束列表) |
| isVerified<sup>8+</sup>        | boolean                                                      | 是   | 帐号是否锁屏                      |
| photo<sup>8+</sup>             | string                                                       | 否   | 系统帐号头像                      |
| createTime<sup>8+</sup>        | number                                                       | 是   | 系统帐号创建时间                  |
| lastLoginTime<sup>8+</sup>     | number                                                       | 否   | 系统帐号最后一次登录时间          |
| serialNumber<sup>8+</sup>      | number                                                       | 是   | 系统帐号SN码                      |
| isActived<sup>8+</sup>         | boolean                                                      | 是   | 系统帐号激活状态                  |
| isCreateCompleted<sup>8+</sup> | boolean                                                      | 是   | 系统帐号创建是否完整              |
| distributedInfo                | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否   | 分布式帐号信息                    |
6158
| domainInfo<sup>8+</sup>        | [DomainAccountInfo](#domainaccountinfo8)                      | 否   | 域帐号信息                        |
Z
zengyawen 已提交
6159 6160

## DomainAccountInfo<sup>8+</sup>
Z
zengyawen 已提交
6161

J
jidong 已提交
6162
表示域帐号信息。
Z
zengyawen 已提交
6163 6164 6165

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

6166
| 名称      | 类型   | 必填 | 说明       |
Z
zengyawen 已提交
6167 6168 6169
| ----------- | ------ | ---- | ---------- |
| domain      | string | 是   | 域名。     |
| accountName | string | 是   | 域帐号名。 |
C
chennian 已提交
6170
| accountId<sup>10+</sup> | string | 否   | 域帐号标识。<br>**系统接口:** 此接口为系统接口。 |
Z
zhangalong 已提交
6171 6172 6173

## 系统帐号约束列表

Z
zengyawen 已提交
6174 6175
| 约束                                  | 说明                           |
| ------------------------------------- | ------------------------------ |
Z
zengyawen 已提交
6176 6177
| constraint.wifi                       | 禁止使用Wi-Fi                  |
| constraint.wifi.set                   | 禁止配置Wi-Fi                  |
Z
zengyawen 已提交
6178 6179 6180 6181 6182 6183
| constraint.locale.set                 | 禁止配置设备语言               |
| constraint.app.accounts               | 禁止添加和删除应用帐号         |
| constraint.apps.install               | 禁止安装应用                   |
| constraint.apps.uninstall             | 禁止卸载应用                   |
| constraint.location.shared            | 禁止打开位置共享               |
| constraint.unknown.sources.install    | 禁止安装未知来源的应用         |
Z
zhangalong 已提交
6184
| constraint.global.unknown.app.install | 禁止所有用户安装未知来源的应用 |
Z
zengyawen 已提交
6185 6186
| constraint.bluetooth.set              | 禁止配置蓝牙                   |
| constraint.bluetooth | 禁止使用蓝牙 |
Z
zhangalong 已提交
6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205
| constraint.bluetooth.share | 禁止共享使用蓝牙 |
| constraint.usb.file.transfer | 禁止通过USB传输文件 |
| constraint.credentials.set | 禁止配置用户凭据 |
| constraint.os.account.remove | 禁止删除用户 |
| constraint.managed.profile.remove | 禁止删除此用户的托管配置文件 |
| constraint.debug.features.use | J禁止启用或访问调试功能 |
| constraint.vpn.set | 禁止配置VPN |
| constraint.date.time.set | 禁止配置日期时间和时区 |
| constraint.tethering.config | 禁止配置Tethering |
| constraint.network.reset | 禁止重置网络设置 |
| constraint.factory.reset | 禁止出厂设置 |
| constraint.os.account.create | 禁止创建新用户 |
| constraint.add.managed.profile | 禁止添加托管配置文件 |
| constraint.apps.verify.disable | 强制应用程序验证 |
| constraint.cell.broadcasts.set | 禁止配置小区广播 |
| constraint.mobile.networks.set | 禁止配置移动网络 |
| constraint.control.apps | 禁止在设置或启动模块中修改应用程序 |
| constraint.physical.media | 禁止装载物理外部介质 |
| constraint.microphone | 禁止使用麦克风 |
L
lichenchen 已提交
6206 6207
| constraint.microphone.unmute | 禁止取消麦克风静音 |
| constraint.volume.adjust | 禁止调整音量 |
Z
zhangalong 已提交
6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224
| constraint.calls.outgoing | 禁止拨打外呼电话 |
| constraint.sms.use | 禁止发送或接收短信 |
| constraint.fun | 禁止享受乐趣 |
| constraint.windows.create | 禁止创建应用程序窗口以外的窗口 |
| constraint.system.error.dialogs | 禁止显示崩溃或无响应应用程序的系统错误对话框 |
| constraint.cross.profile.copy.paste | 禁止通过将数据粘贴到其他用户或配置文件来导出剪贴板内容 |
| constraint.beam.outgoing | 禁止使用NFC从应用程序传送数据 |
| constraint.wallpaper | 禁止管理壁纸 |
| constraint.safe.boot | 禁止进入安全引导模式 |
| constraint.parent.profile.app.linking | 允许父配置文件中的应用程序处理来自托管配置文件的Web链接 |
| constraint.audio.record | 禁止录制音频 |
| constraint.camera.use | 禁止使用摄像机 |
| constraint.os.account.background.run | 禁止在后台运行 |
| constraint.data.roam | 禁止漫游通话时使用蜂窝数据 |
| constraint.os.account.set.icon | 禁止修改用户头像 |
| constraint.wallpaper.set | 禁止设置壁纸 |
| constraint.oem.unlock | 禁止启用oem解锁 |
L
lichenchen 已提交
6225
| constraint.device.unmute | 禁止取消设备静音 |
Z
zhangalong 已提交
6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237
| constraint.password.unified | 禁止托管配置文件与主用户进行统一锁屏质询 |
| constraint.autofill | 禁止使用自动填充服务 |
| constraint.content.capture | 禁止捕获用户屏幕 |
| constraint.content.suggestions | 禁止接收内容建议 |
| constraint.os.account.start | 禁止切换用户 |
| constraint.location.set | 禁止配置位置服务 |
| constraint.airplane.mode.set | 禁止飞行模式 |
| constraint.brightness.set | 禁止配置亮度 |
| constraint.share.into.profile | 禁止将主要用户的文件/图片/数据共享到托管配置文件中 |
| constraint.ambient.display | 禁止显示环境 |
| constraint.screen.timeout.set | 禁止配置屏幕关闭的超时 |
| constraint.print | 禁止打印 |
6238 6239 6240 6241
| constraint.private.dns.set | 禁止配置专用DNS |

## ConstraintSourceTypeInfo<sup>9+</sup>

J
jidong 已提交
6242
表示约束来源类型信息。
6243

J
jidong 已提交
6244
**系统接口:** 此接口为系统接口。
J
jidong 已提交
6245

6246 6247
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

6248
| 名称      | 类型   | 必填 | 说明       |
6249 6250 6251 6252 6253 6254
| ----------- | ------ | ---- | ---------- |
| localId      | number | 是   | 系统帐号ID     |
| type | [ConstraintSourceType](#constraintsourcetype) | 是   | 约束来源类型 |

## ConstraintSourceType<sup>9+</sup>

J
jidong 已提交
6255
表示约束来源类型的枚举。
6256

J
jidong 已提交
6257
**系统接口:** 此接口为系统接口。
J
jidong 已提交
6258

6259 6260
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

6261
| 名称   | 值 | 说明         |
6262 6263 6264 6265
| ------ | ------ | ------------ |
| CONSTRAINT_NOT_EXIST  | 0      | 约束不存在 |
| CONSTRAINT_TYPE_BASE | 1      | 约束源自系统设置   |
| CONSTRAINT_TYPE_DEVICE_OWNER  | 2   | 约束源自设备所有者设置   |
J
jidong 已提交
6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279
| CONSTRAINT_TYPE_PROFILE_OWNER  | 3  | 约束源自资料所有者设置   |

## AuthStatusInfo<sup>10+</sup>

表示认证状态信息。

**系统接口:** 此接口为系统接口。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

| 名称      | 类型   | 必填 | 说明       |
| ----------- | ------ | ---- | ---------- |
| remainTimes  | number | 是   | 剩余次数   |
| freezingTime | number | 是   | 冻结时间 |
J
jidong 已提交
6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294

## GetDomainAccessTokenOptions<sup>10+</sup>

表示获取域访问令牌的选项。

**系统接口:** 此接口为系统接口。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

| 名称      | 类型   | 必填 | 说明       |
| ----------- | ------ | ---- | ---------- |
| domainAccountInfo  | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号的信息   |
| domainAccountToken | Uint8Array | 是   | 域帐号的令牌 |
| businessParams | { [key: string]: object } | 是   | 业务参数,由业务方根据请求协议自定义 |
| callerUid | number | 是   | 调用方唯一标识符 |