js-apis-osAccount.md 201.6 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 | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
329
| 12300001 | System service exception. |
J
jidong 已提交
330
| 12300002 | Invalid localId.    |
J
jidong 已提交
331
| 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 | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
379
| 12300001 | System service exception. |
J
jidong 已提交
380
| 12300002 | Invalid localId.    |
J
jidong 已提交
381
| 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
zhangalong 已提交
478
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
Z
zengyawen 已提交
479 480 481 482

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

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

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

J
jidong 已提交
488
**错误码:**
Z
zhangalong 已提交
489

J
jidong 已提交
490 491
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
492
| 12300001 | System service exception. |
J
jidong 已提交
493
| 12300002 | Invalid localId.    |
J
jidong 已提交
494
| 12300003 | Account not found. |
Z
zhangalong 已提交
495

J
jidong 已提交
496
**示例:**
Z
zhangalong 已提交
497

Z
zhangalong 已提交
498
  ```js
F
fanchenxuan 已提交
499
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
500 501 502 503 504 505 506 507 508 509 510
  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 已提交
511 512
  ```

J
jidong 已提交
513
### checkOsAccountVerified<sup>9+</sup>
514

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

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

J
jidong 已提交
519
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
520 521 522 523 524

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

**参数:**

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

J
jidong 已提交
530 531 532 533
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
534
| 12300001 | System service exception. |
J
jidong 已提交
535
| 12300002 | Invalid localId.    |
J
jidong 已提交
536
| 12300003 | Account not found. |
J
jidong 已提交
537 538

**示例:**
539 540 541 542 543

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

J
jidong 已提交
556
### checkOsAccountVerified<sup>9+</sup>
557

J
jidong 已提交
558
checkOsAccountVerified(localId?: number): Promise&lt;boolean&gt;
559

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

J
jidong 已提交
562
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
563 564 565 566 567

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

**参数:**

J
jidong 已提交
568 569 570
| 参数名  | 类型   | 必填 | 说明                                                              |
| ------- | ------ | ---- | --------------------------------------------------------------- |
| localId | number | 否   | 系统帐号ID。不填则检查当前系统帐号是否已验证。 |
571 572 573

**返回值:**

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

J
jidong 已提交
578 579 580 581
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
582
| 12300001 | System service exception. |
J
jidong 已提交
583
| 12300002 | Invalid localId.    |
J
jidong 已提交
584
| 12300003 | Account not found. |
J
jidong 已提交
585 586

**示例:**
587 588 589 590 591

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

J
jidong 已提交
602
### removeOsAccount
Z
zhangalong 已提交
603

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

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

J
jidong 已提交
608
**系统接口:** 此接口为系统接口。
609

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

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

Z
zengyawen 已提交
614 615
**参数:**

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

J
jidong 已提交
621 622 623 624
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
625
| 12300001 | System service exception. |
J
jidong 已提交
626
| 12300002 | Invalid localId.    |
J
jidong 已提交
627 628
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
629 630

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

Z
zhangalong 已提交
632
  ```js
F
fanchenxuan 已提交
633
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
634 635 636 637 638 639 640 641 642 643 644 645 646 647
  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 已提交
648 649
  ```

J
jidong 已提交
650
### removeOsAccount
Z
zhangalong 已提交
651

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

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

J
jidong 已提交
656
**系统接口:** 此接口为系统接口。
657

Z
zengyawen 已提交
658 659 660
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

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

Z
zengyawen 已提交
662
**参数:**
Z
zhangalong 已提交
663

J
jidong 已提交
664 665 666
| 参数名  | 类型   | 必填 | 说明                               |
| ------- | ------ | ---- | --------------------------------- |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
667

Z
zengyawen 已提交
668
**返回值:**
Z
zhangalong 已提交
669

J
jidong 已提交
670 671
| 类型                | 说明                                  |
| ------------------- | ------------------------------------ |
A
Annie_wang 已提交
672
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
Z
zhangalong 已提交
673

J
jidong 已提交
674 675 676 677
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
678
| 12300001 | System service exception. |
J
jidong 已提交
679
| 12300002 | Invalid localId.    |
J
jidong 已提交
680 681
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
682 683

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

Z
zhangalong 已提交
685
  ```js
F
fanchenxuan 已提交
686
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
687 688 689 690 691 692 693 694 695 696 697 698
  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 已提交
699 700
  ```

J
jidong 已提交
701 702 703 704 705
### setOsAccountConstraints

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

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

J
jidong 已提交
707
**系统接口:** 此接口为系统接口。
708

J
jidong 已提交
709
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
710 711 712 713 714

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

**参数:**

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

J
jidong 已提交
722 723 724 725
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
726
| 12300001 | System service exception. |
J
jidong 已提交
727
| 12300002 | Invalid localId.    |
J
jidong 已提交
728 729
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
730 731

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

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

J
jidong 已提交
750 751 752 753 754
### setOsAccountConstraints

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

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

J
jidong 已提交
756
**系统接口:** 此接口为系统接口。
757

J
jidong 已提交
758
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
759 760 761

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

J
jidong 已提交
762 763 764 765 766 767 768 769
**参数:**

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

770 771
**返回值:**

J
jidong 已提交
772 773
| 类型                | 说明                                 |
| :------------------ | :----------------------------------- |
A
Annie_wang 已提交
774
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
775

J
jidong 已提交
776 777 778 779
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
780
| 12300001 | System service exception. |
J
jidong 已提交
781
| 12300002 | Invalid localId.    |
J
jidong 已提交
782 783
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
784 785

**示例:** 删除ID为100的系统帐号的禁止使用Wi-Fi的约束
786 787 788

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

J
jidong 已提交
801
### setOsAccountName
Z
zhangalong 已提交
802

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

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

J
jidong 已提交
807 808 809
**系统接口:** 此接口为系统接口。

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

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

Z
zengyawen 已提交
813
**参数:**
Z
zhangalong 已提交
814

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

J
jidong 已提交
821 822 823 824
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
825 826 827 828
| 12300001 | System service exception. |
| 12300002 | Invalid localId or localName. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
829 830

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

Z
zhangalong 已提交
832
  ```js
F
fanchenxuan 已提交
833
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
834 835 836 837 838 839 840 841 842 843 844 845 846
  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 已提交
847 848
  ```

J
jidong 已提交
849
### setOsAccountName
Z
zhangalong 已提交
850

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

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

J
jidong 已提交
855 856 857
**系统接口:** 此接口为系统接口。

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

Z
zengyawen 已提交
859 860
**系统能力:** SystemCapability.Account.OsAccount

J
jidong 已提交
861 862 863 864 865 866 867
**参数:**

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

Z
zengyawen 已提交
868
**返回值:**
Z
zhangalong 已提交
869

J
jidong 已提交
870
| 类型                | 说明                                  |
J
jidong 已提交
871
| ------------------- | ------------------------------------ |
A
Annie_wang 已提交
872
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
Z
zhangalong 已提交
873

J
jidong 已提交
874 875 876 877
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
878 879 880 881
| 12300001 | System service exception. |
| 12300002 | Invalid localId or localName.    |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
J
jidong 已提交
882 883

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

Z
zhangalong 已提交
885
  ```js
F
fanchenxuan 已提交
886
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
887 888 889 890 891 892 893 894 895 896 897
  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 已提交
898 899
  ```

J
jidong 已提交
900
### getOsAccountCount<sup>9+</sup>
901

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

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

J
jidong 已提交
906
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
907 908 909 910 911

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

**参数:**

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

J
jidong 已提交
916 917 918 919 920 921
**错误码:**

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

922 923 924 925 926
**示例:**

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

J
jidong 已提交
939
### getOsAccountCount<sup>9+</sup>
940

J
jidong 已提交
941
getOsAccountCount(): Promise&lt;number&gt;
942

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

J
jidong 已提交
945
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
946 947 948

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

J
jidong 已提交
949
**返回值:**
950

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

J
jidong 已提交
955 956 957 958 959 960
**错误码:**

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

961 962 963 964 965
**示例:**

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

C
cclicn 已提交
976
### getOsAccountLocalId<sup>9+</sup>
977

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

J
jidong 已提交
980
获取当前进程所属的系统帐号ID,使用callback异步回调。
981 982 983 984 985

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

**参数:**

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

J
jidong 已提交
990 991 992 993 994 995
**错误码:**

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

996 997 998 999 1000
**示例:**

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

C
cclicn 已提交
1013
### getOsAccountLocalId<sup>9+</sup>
Z
zhangalong 已提交
1014

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

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

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

J
jidong 已提交
1021
**返回值:**
Z
zhangalong 已提交
1022

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

J
jidong 已提交
1027 1028 1029 1030 1031 1032
**错误码:**

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

1033
**示例:**
Z
zhangalong 已提交
1034

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

C
cclicn 已提交
1048
### getOsAccountLocalIdForUid<sup>9+</sup>
Z
zhangalong 已提交
1049

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

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

Z
zengyawen 已提交
1054 1055 1056
**系统能力:** SystemCapability.Account.OsAccount

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

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

J
jidong 已提交
1063 1064 1065
**错误码:**

| 错误码ID | 错误信息         |
J
jidong 已提交
1066 1067
| -------- | --------------- |
| 12300001 | System service exception. |
J
jidong 已提交
1068 1069 1070
| 12300002 | Invalid uid.    |

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

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

C
cclicn 已提交
1087
### getOsAccountLocalIdForUid<sup>9+</sup>
Z
zhangalong 已提交
1088

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

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

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

Z
zengyawen 已提交
1095
**参数:**
Z
zhangalong 已提交
1096

J
jidong 已提交
1097 1098 1099
| 参数名 | 类型   | 必填 | 说明      |
| ------ | ------ | ---- | --------- |
| uid    | number | 是   | 进程uid。 |
Z
zhangalong 已提交
1100

Z
zengyawen 已提交
1101
**返回值:**
Z
zhangalong 已提交
1102

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

J
jidong 已提交
1107 1108 1109
**错误码:**

| 错误码ID | 错误信息       |
J
jidong 已提交
1110 1111
| -------- | ------------- |
| 12300001 | System service exception. |
J
jidong 已提交
1112 1113 1114
| 12300002 | Invalid uid. |

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

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

C
cclicn 已提交
1130
### getOsAccountLocalIdForDomain<sup>9+</sup>
Z
zhangalong 已提交
1131

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

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

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

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

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

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

J
jidong 已提交
1147 1148 1149 1150 1151 1152 1153
**错误码:**

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

1154
**示例:**
Z
zhangalong 已提交
1155

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

C
cclicn 已提交
1172
### getOsAccountLocalIdForDomain<sup>9+</sup>
Z
zhangalong 已提交
1173

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

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

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

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

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

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

Z
zengyawen 已提交
1188
**返回值:**
Z
zhangalong 已提交
1189

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

J
jidong 已提交
1194 1195 1196 1197 1198 1199 1200
**错误码:**

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

1201
**示例:**
Z
zhangalong 已提交
1202

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

J
jidong 已提交
1217
### queryMaxOsAccountNumber
Z
zhangalong 已提交
1218

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

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

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

Z
zengyawen 已提交
1225 1226 1227 1228
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

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

J
jidong 已提交
1233 1234 1235 1236 1237 1238
**错误码:**

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

J
jidong 已提交
1239
**示例:**
Z
zhangalong 已提交
1240

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

J
jidong 已提交
1256
### queryMaxOsAccountNumber
Z
zhangalong 已提交
1257

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

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

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

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

Z
zengyawen 已提交
1266 1267
**返回值:**

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

J
jidong 已提交
1272 1273 1274 1275 1276 1277
**错误码:**

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

J
jidong 已提交
1278
**示例:**
Z
zhangalong 已提交
1279

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

J
jidong 已提交
1293
### getOsAccountConstraints<sup>9+</sup>
Z
zhangalong 已提交
1294

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

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

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

Z
zengyawen 已提交
1301 1302 1303
**系统能力:** SystemCapability.Account.OsAccount

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

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

J
jidong 已提交
1310 1311 1312 1313
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
1314
| 12300001 | System service exception. |
J
jidong 已提交
1315
| 12300002 | Invalid localId.    |
J
jidong 已提交
1316
| 12300003 | Account not found. |
J
jidong 已提交
1317 1318

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

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

J
jidong 已提交
1336
### getOsAccountConstraints<sup>9+</sup>
Z
zhangalong 已提交
1337

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

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

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

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

Z
zengyawen 已提交
1346
**参数:**
Z
zhangalong 已提交
1347

J
jidong 已提交
1348 1349 1350
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
1351

Z
zengyawen 已提交
1352 1353
**返回值:**

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

J
jidong 已提交
1358 1359 1360 1361
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
1362
| 12300001 | System service exception. |
J
jidong 已提交
1363
| 12300002 | Invalid localId.    |
J
jidong 已提交
1364
| 12300003 | Account not found. |
J
jidong 已提交
1365 1366

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

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

J
jidong 已提交
1382
### queryAllCreatedOsAccounts
1383

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

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

J
jidong 已提交
1388
**系统接口:** 此接口为系统接口。
1389 1390 1391

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

J
jidong 已提交
1392 1393
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

1394 1395
**参数:**

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

J
jidong 已提交
1400 1401 1402 1403 1404 1405
**错误码:**

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

1406 1407 1408 1409 1410
**示例:**

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

J
jidong 已提交
1420
### queryAllCreatedOsAccounts
1421

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

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

J
jidong 已提交
1426
**系统接口:** 此接口为系统接口。
1427 1428 1429

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

J
jidong 已提交
1430 1431
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

1432 1433
**返回值:**

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

J
jidong 已提交
1438 1439 1440 1441 1442 1443
**错误码:**

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

1444 1445 1446 1447 1448
**示例:**

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

C
cclicn 已提交
1459
### getActivatedOsAccountLocalIds<sup>9+</sup>
Z
zhangalong 已提交
1460

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

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

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

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

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

J
jidong 已提交
1473 1474 1475 1476 1477 1478
**错误码:**

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

1479
**示例:**
Z
zhangalong 已提交
1480

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

C
cclicn 已提交
1496
### getActivatedOsAccountLocalIds<sup>9+</sup>
Z
zhangalong 已提交
1497

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

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

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

Z
zengyawen 已提交
1504 1505
**返回值:**

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

J
jidong 已提交
1510 1511 1512 1513 1514 1515
**错误码:**

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

1516
**示例:**
Z
zhangalong 已提交
1517

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

J
jidong 已提交
1531
### createOsAccount
1532

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

J
jidong 已提交
1535 1536 1537 1538 1539
创建一个系统帐号。使用callback异步回调。

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

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1540 1541 1542 1543 1544

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

**参数:**

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

**错误码:**
J
jidong 已提交
1552 1553 1554 1555

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

**示例:**

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

J
jidong 已提交
1575
### createOsAccount
1576

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

J
jidong 已提交
1579 1580 1581 1582 1583
创建一个系统帐号。使用Promise异步回调。 

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

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1584 1585 1586

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

J
jidong 已提交
1587 1588 1589 1590 1591 1592 1593
**参数:**

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

1594 1595
**返回值:**

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

**错误码:**
J
jidong 已提交
1601 1602 1603 1604

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

**示例:**

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

J
jidong 已提交
1625
### createOsAccountForDomain<sup>8+</sup>
Z
zhangalong 已提交
1626

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

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

J
jidong 已提交
1631 1632 1633
**系统接口:** 此接口为系统接口。

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

Z
zengyawen 已提交
1635 1636 1637
**系统能力:** SystemCapability.Account.OsAccount

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

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

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

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

1655
**示例:**
Z
zhangalong 已提交
1656

Z
zhangalong 已提交
1657
  ```js
F
fanchenxuan 已提交
1658
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1659 1660 1661 1662 1663 1664 1665 1666 1667
  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 已提交
1668 1669
  ```

J
jidong 已提交
1670
### createOsAccountForDomain<sup>8+</sup>
Z
zhangalong 已提交
1671

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

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

J
jidong 已提交
1676 1677 1678
**系统接口:** 此接口为系统接口。

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

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

J
jidong 已提交
1682 1683 1684 1685 1686 1687 1688
**参数:**

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

Z
zengyawen 已提交
1689
**返回值:**
Z
zhangalong 已提交
1690

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

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

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

1705
**示例:**
Z
zhangalong 已提交
1706

Z
zhangalong 已提交
1707
  ```js
F
fanchenxuan 已提交
1708
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718
  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 已提交
1719 1720
  ```

J
jidong 已提交
1721
### getCurrentOsAccount<sup>9+</sup>
1722

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

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

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1728 1729 1730 1731 1732

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

**参数:**

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

J
jidong 已提交
1737 1738 1739 1740 1741 1742
**错误码:**

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

J
jidong 已提交
1743
**示例:**
1744 1745 1746 1747

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

J
jidong 已提交
1757
### getCurrentOsAccount<sup>9+</sup>
1758

J
jidong 已提交
1759
getCurrentOsAccount(): Promise&lt;OsAccountInfo&gt;
1760

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

J
jidong 已提交
1763
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
1764

J
jidong 已提交
1765
**系统能力:** SystemCapability.Account.OsAccount
1766 1767 1768

**返回值:**

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

J
jidong 已提交
1773 1774 1775 1776 1777 1778
**错误码:**

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

J
jidong 已提交
1779
**示例:**
1780 1781 1782 1783

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

J
jidong 已提交
1794
### queryOsAccountById
Z
zhangalong 已提交
1795

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

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

J
jidong 已提交
1800 1801 1802
**系统接口:** 此接口为系统接口。

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

Z
zengyawen 已提交
1804 1805 1806
**系统能力:** SystemCapability.Account.OsAccount

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

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

J
jidong 已提交
1813
**错误码:**
J
jidong 已提交
1814

J
jidong 已提交
1815 1816
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
1817
| 12300001 | System service exception. |
J
jidong 已提交
1818
| 12300002 | Invalid localId.    |
J
jidong 已提交
1819
| 12300003 | Account not found. |
J
jidong 已提交
1820 1821

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

Z
zhangalong 已提交
1823
  ```js
F
fanchenxuan 已提交
1824
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1825 1826 1827 1828 1829 1830 1831 1832 1833
  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 已提交
1834 1835
  ```

J
jidong 已提交
1836
### queryOsAccountById
Z
zhangalong 已提交
1837

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

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

J
jidong 已提交
1842 1843 1844
**系统接口:** 此接口为系统接口。

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

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

Z
zengyawen 已提交
1848
**参数:**
Z
zhangalong 已提交
1849

J
jidong 已提交
1850 1851 1852
| 参数名  | 类型   | 必填 | 说明                 |
| ------- | ------ | ---- | -------------------- |
| localId | number | 是   | 要查询的系统帐号的ID |
Z
zhangalong 已提交
1853

Z
zengyawen 已提交
1854
**返回值:**
Z
zhangalong 已提交
1855

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

J
jidong 已提交
1860
**错误码:**
J
jidong 已提交
1861

J
jidong 已提交
1862 1863
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
1864
| 12300001 | System service exception. |
J
jidong 已提交
1865
| 12300002 | Invalid localId.    |
J
jidong 已提交
1866
| 12300003 | Account not found. |
J
jidong 已提交
1867 1868

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

Z
zhangalong 已提交
1870
  ```js
F
fanchenxuan 已提交
1871
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
  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 已提交
1882 1883
  ```

J
jidong 已提交
1884
### getOsAccountType<sup>9+</sup>
1885

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

J
jidong 已提交
1888
查询当前进程所属的系统帐号的帐号类型。使用callback异步回调。
1889 1890 1891 1892 1893

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

**参数:**

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

J
jidong 已提交
1898 1899 1900 1901 1902 1903
**错误码:**

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

1904 1905 1906 1907 1908
**示例:**

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

J
jidong 已提交
1918
### getOsAccountType<sup>9+</sup>
1919

J
jidong 已提交
1920
getOsAccountType(): Promise&lt;OsAccountType&gt;
1921

J
jidong 已提交
1922
查询当前进程所属的系统帐号的帐号类型。使用Promise异步回调。
1923 1924 1925 1926 1927

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

**返回值:**

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

J
jidong 已提交
1932 1933 1934 1935 1936 1937
**错误码:**

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

1938 1939 1940 1941 1942
**示例:**

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

J
jidong 已提交
1953
### queryDistributedVirtualDeviceId<sup>9+</sup>
Z
zhangalong 已提交
1954

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

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

J
jidong 已提交
1959
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
1960 1961

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

Z
zengyawen 已提交
1963
**参数:**
Z
zhangalong 已提交
1964

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

J
jidong 已提交
1969 1970 1971 1972 1973 1974
**错误码:**

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

1975
**示例:**
Z
zhangalong 已提交
1976

Z
zhangalong 已提交
1977
  ```js
F
fanchenxuan 已提交
1978
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1979 1980 1981 1982 1983 1984 1985 1986
  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 已提交
1987 1988
  ```

J
jidong 已提交
1989
### queryDistributedVirtualDeviceId<sup>9+</sup>
Z
zhangalong 已提交
1990

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

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

J
jidong 已提交
1995
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
1996 1997 1998 1999

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

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

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

J
jidong 已提交
2005 2006 2007 2008 2009 2010
**错误码:**

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

2011
**示例:**
Z
zhangalong 已提交
2012

Z
zhangalong 已提交
2013
  ```js
F
fanchenxuan 已提交
2014
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2015 2016 2017 2018 2019 2020 2021 2022 2023
  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 已提交
2024 2025
  ```

J
jidong 已提交
2026
### getOsAccountProfilePhoto
Z
zhangalong 已提交
2027

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

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

J
jidong 已提交
2032 2033 2034
**系统接口:** 此接口为系统接口。

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

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

Z
zengyawen 已提交
2038 2039
**参数:**

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

J
jidong 已提交
2045
**错误码:**
J
jidong 已提交
2046

J
jidong 已提交
2047 2048
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
2049
| 12300001 | System service exception. |
J
jidong 已提交
2050
| 12300002 | Invalid localId.    |
J
jidong 已提交
2051
| 12300003 | Account not found. |
J
jidong 已提交
2052 2053

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

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

J
jidong 已提交
2068
### getOsAccountProfilePhoto
Z
zhangalong 已提交
2069

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

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

J
jidong 已提交
2074 2075 2076
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
2077 2078 2079

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

J
jidong 已提交
2080 2081 2082 2083 2084 2085
**参数:**

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

Z
zengyawen 已提交
2086
**返回值:**
Z
zhangalong 已提交
2087

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

J
jidong 已提交
2092
**错误码:**
J
jidong 已提交
2093

J
jidong 已提交
2094 2095
| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
2096
| 12300001 | System service exception. |
J
jidong 已提交
2097
| 12300002 | Invalid localId.    |
J
jidong 已提交
2098
| 12300003 | Account not found. |
J
jidong 已提交
2099 2100

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

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

J
jidong 已提交
2116
### setOsAccountProfilePhoto
2117

J
jidong 已提交
2118 2119 2120
setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback&lt;void&gt;): void

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

J
jidong 已提交
2122
**系统接口:** 此接口为系统接口。
2123

J
jidong 已提交
2124
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
2125 2126 2127 2128 2129

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

**参数:**

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

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

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

J
jidong 已提交
2145
**示例:** 给ID为100的系统帐号设置头像
2146 2147 2148 2149

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

J
jidong 已提交
2163
### setOsAccountProfilePhoto
2164

J
jidong 已提交
2165 2166 2167
setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt;

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

J
jidong 已提交
2169
**系统接口:** 此接口为系统接口。
2170

J
jidong 已提交
2171
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
2172 2173 2174 2175 2176 2177 2178 2179

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

**参数:**

| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
J
jidong 已提交
2180
| photo   | string | 是   | 头像信息。   |
2181 2182 2183

**返回值:**

J
jidong 已提交
2184
| 类型                | 说明                                 |
J
jidong 已提交
2185
| ------------------- | ------------------------------------ |
A
Annie_wang 已提交
2186
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
2187

J
jidong 已提交
2188
**错误码:**
J
jidong 已提交
2189

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

**示例:** 给ID为100的系统帐号设置头像
2198 2199 2200 2201

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

C
cclicn 已提交
2217
### getOsAccountLocalIdForSerialNumber<sup>9+</sup>
Z
zhangalong 已提交
2218

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

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

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

Z
zengyawen 已提交
2225 2226
**参数:**

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

J
jidong 已提交
2232
**错误码:**
J
jidong 已提交
2233

J
jidong 已提交
2234
| 错误码ID | 错误信息               |
J
jidong 已提交
2235 2236
| -------- | ------------------- |
| 12300001 | System service exception. |
J
jidong 已提交
2237
| 12300002 | Invalid serialNumber. |
J
jidong 已提交
2238
| 12300003 | Account not found. |
J
jidong 已提交
2239 2240

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

Z
zhangalong 已提交
2242
  ```js
F
fanchenxuan 已提交
2243
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2244 2245
  let serialNumber = 12345;
  try {
C
cclicn 已提交
2246
    accountManager.getOsAccountLocalIdForSerialNumber(serialNumber, (err, localId)=>{
J
jidong 已提交
2247 2248 2249 2250 2251 2252
      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 已提交
2253 2254
  ```

C
cclicn 已提交
2255
### getOsAccountLocalIdForSerialNumber<sup>9+</sup>
2256

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

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

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

Z
zengyawen 已提交
2263
**参数:**
Z
zhangalong 已提交
2264

J
jidong 已提交
2265 2266 2267
| 参数名       | 类型   | 必填 | 说明       |
| ------------ | ------ | ---- | ---------- |
| serialNumber | number | 是   | 帐号SN码。 |
Z
zhangalong 已提交
2268

Z
zengyawen 已提交
2269
**返回值:**
Z
zhangalong 已提交
2270

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

J
jidong 已提交
2275
**错误码:**
J
jidong 已提交
2276

J
jidong 已提交
2277
| 错误码ID | 错误信息               |
J
jidong 已提交
2278 2279
| -------- | ------------------- |
| 12300001 | System service exception. |
J
jidong 已提交
2280
| 12300002 | Invalid serialNumber. |
J
jidong 已提交
2281
| 12300003 | Account not found. |
J
jidong 已提交
2282 2283

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

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

C
cclicn 已提交
2299
### getSerialNumberForOsAccountLocalId<sup>9+</sup>
Z
zhangalong 已提交
2300

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

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

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

Z
zengyawen 已提交
2307
**参数:**
Z
zhangalong 已提交
2308

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

J
jidong 已提交
2314 2315 2316 2317
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
2318
| 12300001 | System service exception. |
J
jidong 已提交
2319
| 12300002 | Invalid localId.    |
J
jidong 已提交
2320
| 12300003 | Account not found. |
J
jidong 已提交
2321 2322

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

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

C
cclicn 已提交
2337
### getSerialNumberForOsAccountLocalId<sup>9+</sup>
Z
zhangalong 已提交
2338

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

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

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

J
jidong 已提交
2345 2346 2347 2348 2349
**参数:**

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

Z
zengyawen 已提交
2351
**返回值:**
Z
zhangalong 已提交
2352

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

J
jidong 已提交
2357 2358 2359 2360
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
J
jidong 已提交
2361
| 12300001 | System service exception. |
J
jidong 已提交
2362
| 12300002 | Invalid localId.    |
J
jidong 已提交
2363
| 12300003 | Account not found. |
J
jidong 已提交
2364 2365

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

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

J
jidong 已提交
2381
### on
2382

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

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

J
jidong 已提交
2387 2388 2389
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
2390 2391 2392 2393 2394

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

**参数:**

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

J
jidong 已提交
2401 2402 2403 2404 2405 2406 2407 2408
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or name. |
| 12300011 | Callback has been registered. |

2409 2410 2411 2412
**示例:**

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

J
jidong 已提交
2423
### off
2424

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

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

J
jidong 已提交
2429 2430 2431
**系统接口:** 此接口为系统接口。

**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
2432 2433 2434

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

J
jidong 已提交
2435
**参数:**
2436

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

J
jidong 已提交
2443 2444 2445 2446 2447 2448 2449 2450
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or name. |
| 12300012 | Callback has not been registered. |

2451 2452 2453 2454
**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2455 2456 2457
  function offCallback(){
    console.log('off enter')
  }
2458
  try {
J
jidong 已提交
2459
    accountManager.off('activating', 'osAccountOnOffNameA', offCallback);
2460
  } catch (e) {
J
jidong 已提交
2461
    console.log('off exception:' + JSON.stringify(e));
2462
  }
Z
zhangalong 已提交
2463 2464
  ```

C
cclicn 已提交
2465
### getBundleIdForUid<sup>9+</sup>
Z
zhangalong 已提交
2466

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

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

J
jidong 已提交
2471
**系统接口:** 此接口为系统接口。
2472

Z
zengyawen 已提交
2473 2474 2475
**系统能力:** SystemCapability.Account.OsAccount

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

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

J
jidong 已提交
2482 2483 2484 2485 2486 2487 2488
**错误码:**

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

2489
**示例:**
Z
zhangalong 已提交
2490

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

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

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

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

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

J
jidong 已提交
2513 2514 2515 2516 2517 2518
**参数:**

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

Z
zengyawen 已提交
2519
**返回值:**
Z
zhangalong 已提交
2520

J
jidong 已提交
2521 2522 2523
| 类型                  | 说明                                  |
| --------------------- | ------------------------------------ |
| Promise&lt;number&gt; | Promise对象,返回与uid对应的bundleId。 |
Z
zengyawen 已提交
2524

J
jidong 已提交
2525 2526 2527 2528 2529 2530 2531
**错误码:**

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

2532
**示例:**
Z
zhangalong 已提交
2533

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

J
jidong 已提交
2548 2549 2550
### isMainOsAccount<sup>9+</sup>

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

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

J
jidong 已提交
2554
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
2555 2556

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

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

Z
zengyawen 已提交
2560 2561
**参数:**

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

J
jidong 已提交
2566 2567 2568 2569 2570 2571
**错误码:**

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

2572
**示例:**
Z
zhangalong 已提交
2573

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

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

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

J
jidong 已提交
2591
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
2592 2593 2594 2595

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

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

Z
zengyawen 已提交
2597
**返回值:**
Z
zhangalong 已提交
2598

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

J
jidong 已提交
2603 2604 2605 2606 2607 2608
**错误码:**

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

2609
**示例:**
Z
zhangalong 已提交
2610

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

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

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

J
jidong 已提交
2629
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
2630 2631 2632 2633

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

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

Z
zengyawen 已提交
2635
**参数:**
Z
zhangalong 已提交
2636

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

J
jidong 已提交
2643 2644 2645 2646 2647 2648 2649 2650
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId or constraint. |
| 12300003 | Account not found. |

2651
**示例:**
Z
zhangalong 已提交
2652

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

C
cclicn 已提交
2665
### getOsAccountConstraintSourceTypes<sup>9+</sup>
Z
zhangalong 已提交
2666

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

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

J
jidong 已提交
2671
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
2672 2673 2674 2675 2676 2677

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

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

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

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

Z
zengyawen 已提交
2684
**返回值:**
Z
zhangalong 已提交
2685

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

J
jidong 已提交
2690 2691 2692 2693 2694 2695 2696 2697
**错误码:**

| 错误码ID | 错误信息       |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId or constraint. |
| 12300003 | Account not found. |

2698
**示例:**
Z
zhangalong 已提交
2699

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

J
jidong 已提交
2713
### isMultiOsAccountEnable<sup>(deprecated)</sup>
2714

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

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

A
Annie_wang 已提交
2719
> **说明:** 
J
jidong 已提交
2720
>
A
Annie_wang 已提交
2721
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkMultiOsAccountEnabled](#checkmultiosaccountenabled9)。
2722 2723 2724 2725 2726

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

**参数:**

J
jidong 已提交
2727 2728 2729
| 参数名   | 类型                         | 必填 | 说明                                                     |
| -------- | ---------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示支持多系统帐号;返回false表示不支持。 |
2730 2731 2732 2733 2734

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2735
  accountManager.isMultiOsAccountEnable((err, isEnabled) => {
J
jidong 已提交
2736 2737 2738 2739 2740 2741
    if (err) {
      console.log("isMultiOsAccountEnable failed, error: " + JSON.stringify(err));
    } else {
    console.log("isMultiOsAccountEnable successfully, isEnabled: " + isEnabled);
    }
  });
2742 2743
  ```

J
jidong 已提交
2744
### isMultiOsAccountEnable<sup>(deprecated)</sup>
2745

J
jidong 已提交
2746
isMultiOsAccountEnable(): Promise&lt;boolean&gt;
2747

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

A
Annie_wang 已提交
2750
> **说明:** 
J
jidong 已提交
2751
>
A
Annie_wang 已提交
2752
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkMultiOsAccountEnabled](#checkmultiosaccountenabled9-1)。
2753 2754 2755 2756 2757

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

**返回值:**

J
jidong 已提交
2758 2759 2760
| 类型                   | 说明                                                       |
| :--------------------- | :--------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示支持多系统帐号;返回false表示不支持。 |
2761 2762 2763 2764 2765

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2766 2767 2768 2769 2770
  accountManager.isMultiOsAccountEnable().then((isEnabled) => {
    console.log('isMultiOsAccountEnable successfully, isEnabled: ' + isEnabled);
  }).catch((err) => {
    console.log('isMultiOsAccountEnable failed, error: '  + JSON.stringify(err));
  });
Z
zhangalong 已提交
2771 2772 2773
  ```


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

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

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

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

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

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

Z
zengyawen 已提交
2788 2789
**参数:**

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

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

Z
zhangalong 已提交
2797
  ```js
F
fanchenxuan 已提交
2798
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2799 2800 2801 2802 2803 2804 2805
  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 已提交
2806 2807 2808
  });
  ```

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

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

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

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

J
jidong 已提交
2819
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
Z
zengyawen 已提交
2820 2821 2822

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

J
jidong 已提交
2823 2824 2825 2826 2827 2828
**参数:**

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

Z
zengyawen 已提交
2829
**返回值:**
Z
zhangalong 已提交
2830

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

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

Z
zhangalong 已提交
2837
  ```js
F
fanchenxuan 已提交
2838
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2839 2840 2841
  let localId = 100;
  accountManager.isOsAccountActived(localId).then((isActived) => {
    console.log('isOsAccountActived successfully, isActived: ' + isActived);
Z
zhangalong 已提交
2842
  }).catch((err) => {
J
jidong 已提交
2843
    console.log('isOsAccountActived failed, error: '  + JSON.stringify(err));
Z
zhangalong 已提交
2844 2845 2846
  });
  ```

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

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

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

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

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

Z
zengyawen 已提交
2859 2860 2861 2862
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

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

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

Z
zhangalong 已提交
2871
  ```js
F
fanchenxuan 已提交
2872 2873
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
J
jidong 已提交
2874 2875 2876 2877 2878 2879 2880 2881
  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 已提交
2882 2883
  ```

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

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

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

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

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

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

Z
zengyawen 已提交
2898
**参数:**
Z
zhangalong 已提交
2899

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

Z
zengyawen 已提交
2905 2906
**返回值:**

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

J
jidong 已提交
2911
**示例:** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
2912 2913 2914 2915

  ```js
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
J
jidong 已提交
2916 2917 2918 2919 2920 2921
  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));
  });
2922 2923
  ```

J
jidong 已提交
2924
### isTestOsAccount<sup>(deprecated)</sup>
2925

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

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

A
Annie_wang 已提交
2930
> **说明:** 
J
jidong 已提交
2931
>
A
Annie_wang 已提交
2932
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountTestable](#checkosaccounttestable9)。
2933 2934 2935 2936 2937

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

**参数:**

J
jidong 已提交
2938 2939 2940
| 参数名   | 类型                         | 必填 | 说明                                                                   |
| -------- | ---------------------------- | ---- | --------------------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示当前帐号为测试帐号;返回false表示当前帐号非测试帐号。 |
2941 2942 2943 2944 2945

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2946 2947 2948 2949 2950 2951 2952
  accountManager.isTestOsAccount((err, isTestable) => {
    if (err) {
      console.log("isTestOsAccount failed, error: " + JSON.stringify(err));
    } else {
      console.log("isTestOsAccount successfully, isTestable: " + isTestable);
    }
  });
2953 2954
  ```

J
jidong 已提交
2955
### isTestOsAccount<sup>(deprecated)</sup>
2956

J
jidong 已提交
2957 2958 2959
isTestOsAccount(): Promise&lt;boolean&gt;

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

A
Annie_wang 已提交
2961
> **说明:** 
J
jidong 已提交
2962
>
A
Annie_wang 已提交
2963
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountTestable](#checkosaccounttestable9-1)。
2964 2965 2966 2967 2968

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

**返回值:**

J
jidong 已提交
2969 2970 2971
| 类型                   | 说明                                                                      |
| ---------------------- | ------------------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise对象。返回true表示当前帐号为测试帐号;返回false表示当前帐号非测试帐号。 |
2972 2973 2974 2975 2976

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
2977 2978 2979 2980 2981
  accountManager.isTestOsAccount().then((isTestable) => {
      console.log("isTestOsAccount successfully, isTestable: " + isTestable);
  }).catch((err) => {
      console.log("isTestOsAccount failed, error: " + JSON.stringify(err));
  });
2982 2983
  ```

J
jidong 已提交
2984
### isOsAccountVerified<sup>(deprecated)</sup>
2985

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

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

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

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

2996 2997 2998 2999
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3000 3001 3002
| 参数名   | 类型                         | 必填 | 说明                                                            |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是   | 回调函数。返回true表示指定帐号已验证;返回false表示指定帐号未验证。 |
3003 3004 3005 3006 3007

**示例:**

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3008 3009 3010 3011 3012 3013
  accountManager.isOsAccountVerified((err, isVerified) => {
    if (err) {
      console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
    } else {
      console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
    }
3014 3015 3016
  });
  ```

J
jidong 已提交
3017
### isOsAccountVerified<sup>(deprecated)</sup>
3018

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

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

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

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

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

J
jidong 已提交
3031
**参数:**
3032

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

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

Z
zhangalong 已提交
3040
  ```js
F
fanchenxuan 已提交
3041
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3042 3043 3044 3045 3046 3047 3048
  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 已提交
3049 3050 3051
  });
  ```

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

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

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

A
Annie_wang 已提交
3058
> **说明:** 
J
jidong 已提交
3059
>
A
Annie_wang 已提交
3060
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkOsAccountVerified](#checkosaccountverified9-2)。
J
jidong 已提交
3061 3062

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

Z
zengyawen 已提交
3064 3065 3066
**系统能力:** SystemCapability.Account.OsAccount

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

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

Z
zengyawen 已提交
3072
**返回值:**
Z
zhangalong 已提交
3073

J
jidong 已提交
3074 3075 3076
| 类型                   | 说明                                                               |
| ---------------------- | ----------------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回true表示指定帐号已验证;返回false表示指定帐号未验证。 |
Z
zengyawen 已提交
3077

3078
**示例:**
Z
zhangalong 已提交
3079

Z
zhangalong 已提交
3080
  ```js
F
fanchenxuan 已提交
3081
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3082 3083 3084 3085 3086
  accountManager.isOsAccountVerified(localId).then((isVerified) => {
    console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
  }).catch((err) => {
    console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
  });
Z
zhangalong 已提交
3087 3088
  ```

J
jidong 已提交
3089
### getCreatedOsAccountsCount<sup>(deprecated)</sup>
Z
zhangalong 已提交
3090

J
jidong 已提交
3091
getCreatedOsAccountsCount(callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
3092

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

A
Annie_wang 已提交
3095
> **说明:** 
3096
>
A
Annie_wang 已提交
3097
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountCount](#getosaccountcount9)。
3098

J
jidong 已提交
3099
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
3100 3101

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

Z
zengyawen 已提交
3103
**参数:**
Z
zhangalong 已提交
3104

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

3109
**示例:**
Z
zhangalong 已提交
3110

Z
zhangalong 已提交
3111
  ```js
F
fanchenxuan 已提交
3112
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3113 3114 3115 3116 3117 3118
  accountManager.getCreatedOsAccountsCount((err, count)=>{
    if (err) {
      console.log("getCreatedOsAccountsCount failed, error: " + JSON.stringify(err));
    } else {
      console.log("getCreatedOsAccountsCount successfully, count: " + count);
    }
Z
zhangalong 已提交
3119 3120 3121
  });
  ```

J
jidong 已提交
3122
### getCreatedOsAccountsCount<sup>(deprecated)</sup>
Z
zhangalong 已提交
3123

J
jidong 已提交
3124
getCreatedOsAccountsCount(): Promise&lt;number&gt;
Z
zhangalong 已提交
3125

J
jidong 已提交
3126
获取已创建的系统帐号数量,使用Promise异步回调。
Z
zhangalong 已提交
3127

A
Annie_wang 已提交
3128
> **说明:** 
3129
>
A
Annie_wang 已提交
3130
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountCount](#getosaccountcount9-1)。
3131

J
jidong 已提交
3132
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
3133 3134

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

Z
zengyawen 已提交
3136
**返回值:**
Z
zhangalong 已提交
3137

J
jidong 已提交
3138 3139 3140
| 类型                  | 说明                                    |
| --------------------- | -------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回已创建的系统帐号的数量。 |
Z
zengyawen 已提交
3141

3142
**示例:**
Z
zhangalong 已提交
3143

Z
zhangalong 已提交
3144
  ```js
F
fanchenxuan 已提交
3145
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3146 3147
  accountManager.getCreatedOsAccountsCount().then((count) => {
    console.log("getCreatedOsAccountsCount successfully, count: " + count);
Z
zhangalong 已提交
3148
  }).catch((err) => {
J
jidong 已提交
3149
    console.log("getCreatedOsAccountsCount failed, error: "  + JSON.stringify(err));
Z
zhangalong 已提交
3150 3151 3152
  });
  ```

J
jidong 已提交
3153
### getOsAccountLocalIdFromProcess<sup>(deprecated)</sup>
Z
zhangalong 已提交
3154

J
jidong 已提交
3155
getOsAccountLocalIdFromProcess(callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
3156

J
jidong 已提交
3157
获取当前进程所属的系统帐号ID,使用callback异步回调。
Z
zengyawen 已提交
3158

A
Annie_wang 已提交
3159
> **说明:** 
J
jidong 已提交
3160
>
C
cclicn 已提交
3161
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalId](#getosaccountlocalid9)。
Z
zengyawen 已提交
3162 3163 3164 3165

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

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

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

J
jidong 已提交
3171
**示例:**
Z
zhangalong 已提交
3172

Z
zhangalong 已提交
3173
  ```js
F
fanchenxuan 已提交
3174
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3175 3176 3177 3178 3179 3180 3181
  accountManager.getOsAccountLocalIdFromProcess((err, localId) => {
    if (err) {
      console.log("getOsAccountLocalIdFromProcess failed, error: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountLocalIdFromProcess successfully, localId: " + localId);
    }
  });
Z
zhangalong 已提交
3182 3183
  ```

J
jidong 已提交
3184
### getOsAccountLocalIdFromProcess<sup>(deprecated)</sup>
Z
zhangalong 已提交
3185

J
jidong 已提交
3186
getOsAccountLocalIdFromProcess(): Promise&lt;number&gt;
Z
zhangalong 已提交
3187

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

A
Annie_wang 已提交
3190
> **说明:**
J
jidong 已提交
3191
>
C
cclicn 已提交
3192
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalId](#getosaccountlocalid9-1)。
Z
zhangalong 已提交
3193

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

Z
zengyawen 已提交
3196 3197
**返回值:**

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

J
jidong 已提交
3202
**示例:**
Z
zhangalong 已提交
3203

Z
zhangalong 已提交
3204
  ```js
F
fanchenxuan 已提交
3205
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3206 3207 3208 3209 3210
  accountManager.getOsAccountLocalIdFromProcess().then((localId) => {
    console.log('getOsAccountLocalIdFromProcess successfully, localId: ' + localId);
  }).catch((err) => {
    console.log('getOsAccountLocalIdFromProcess failed, error: '  + JSON.stringify(err));
  });
Z
zhangalong 已提交
3211 3212
  ```

J
jidong 已提交
3213
### getOsAccountLocalIdFromUid<sup>(deprecated)</sup>
Z
zhangalong 已提交
3214

J
jidong 已提交
3215
getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback&lt;number&gt;): void
Z
zhangalong 已提交
3216

J
jidong 已提交
3217
根据uid查询对应的系统帐号ID。使用callback异步回调。
Z
zengyawen 已提交
3218

A
Annie_wang 已提交
3219
> **说明:** 
J
jidong 已提交
3220
>
C
cclicn 已提交
3221
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForUid](#getosaccountlocalidforuid9)。
Z
zhangalong 已提交
3222

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

Z
zengyawen 已提交
3225 3226
**参数:**

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

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

Z
zhangalong 已提交
3234
  ```js
F
fanchenxuan 已提交
3235
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3236 3237 3238 3239 3240 3241 3242 3243
  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 已提交
3244 3245
  ```

J
jidong 已提交
3246
### getOsAccountLocalIdFromUid<sup>(deprecated)</sup>
Z
zhangalong 已提交
3247

J
jidong 已提交
3248
getOsAccountLocalIdFromUid(uid: number): Promise&lt;number&gt;
Z
zhangalong 已提交
3249

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

A
Annie_wang 已提交
3252
> **说明:** 
J
jidong 已提交
3253
>
C
cclicn 已提交
3254
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForUid](#getosaccountlocalidforuid9-1)。
Z
zhangalong 已提交
3255

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

Z
zengyawen 已提交
3258
**参数:**
Z
zhangalong 已提交
3259

J
jidong 已提交
3260 3261 3262
| 参数名 | 类型   | 必填 | 说明      |
| ------ | ------ | ---- | --------- |
| uid    | number | 是   | 进程uid。 |
Z
zhangalong 已提交
3263

Z
zengyawen 已提交
3264 3265
**返回值:**

J
jidong 已提交
3266 3267 3268
| 类型                  | 说明                                  |
| :-------------------- | :----------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回uid对应的系统帐号ID。 |
Z
zengyawen 已提交
3269

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

Z
zhangalong 已提交
3272
  ```js
F
fanchenxuan 已提交
3273
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3274 3275 3276 3277 3278 3279
  let uid = 12345678;
  accountManager.getOsAccountLocalIdFromUid(uid).then((localId) => {
    console.log("getOsAccountLocalIdFromUid successfully, localId: " + localId);
  }).catch((err) => {
    console.log("getOsAccountLocalIdFromUid failed, error: "  + JSON.stringify(err));
  });
3280 3281
  ```

J
jidong 已提交
3282
### getOsAccountLocalIdFromDomain<sup>(deprecated)</sup>
3283

J
jidong 已提交
3284 3285 3286 3287
getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;number&gt;): void

根据域帐号信息,获取与其关联的系统帐号的帐号ID。使用callback异步回调。

A
Annie_wang 已提交
3288
> **说明:** 
J
jidong 已提交
3289
>
C
cclicn 已提交
3290
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForDomain](#getosaccountlocalidfordomain9)。
3291

J
jidong 已提交
3292
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
3293 3294 3295 3296 3297

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

**参数:**

J
jidong 已提交
3298 3299 3300 3301
| 参数名     | 类型                                    | 必填 | 说明                                                                         |
| ---------- | --------------------------------------- | ---- | --------------------------------------------------------------------------- |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。                                                                |
| callback   | AsyncCallback&lt;number&gt;             | 是   | 回调函数,如果获取成功,err为null,data为域帐号关联的系统帐号ID;否则为错误对象。 |
3302

J
jidong 已提交
3303
**示例:**
3304 3305

  ```js
J
jidong 已提交
3306
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
3307
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3308 3309 3310 3311 3312 3313 3314
  accountManager.getOsAccountLocalIdFromDomain(domainInfo, (err, localId) => {
    if (err) {
      console.log("getOsAccountLocalIdFromDomain failed, error: " + JSON.stringify(err));
    } else {
      console.log("getOsAccountLocalIdFromDomain successfully, localId: " + localId);
    }
  });
3315 3316
  ```

J
jidong 已提交
3317
### getOsAccountLocalIdFromDomain<sup>(deprecated)</sup>
3318

J
jidong 已提交
3319 3320 3321 3322
getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise&lt;number&gt;

根据域帐号信息,获取与其关联的系统帐号的帐号ID。使用Promise异步回调。

A
Annie_wang 已提交
3323
> **说明:** 
J
jidong 已提交
3324
>
C
cclicn 已提交
3325
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForDomain](#getosaccountlocalidfordomain9-1)。
3326

J
jidong 已提交
3327
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS
3328 3329 3330 3331 3332

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

**参数:**

J
jidong 已提交
3333 3334 3335
| 参数名     | 类型                                    | 必填 | 说明         |
| ---------- | --------------------------------------- | ---- | ------------ |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。 |
3336 3337 3338

**返回值:**

J
jidong 已提交
3339 3340 3341
| 类型                  | 说明                                    |
| :-------------------- | :------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回域帐号关联的系统帐号ID。 |
3342

J
jidong 已提交
3343
**示例:**
3344 3345 3346

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3347 3348 3349 3350 3351 3352
  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 已提交
3353 3354
  ```

J
jidong 已提交
3355
### getOsAccountAllConstraints<sup>(deprecated)</sup>
Z
zhangalong 已提交
3356

J
jidong 已提交
3357
getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
Z
zhangalong 已提交
3358

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

A
Annie_wang 已提交
3361
> **说明:** 
3362
>
A
Annie_wang 已提交
3363
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountConstraints](#getosaccountconstraints9)。
J
jidong 已提交
3364 3365

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

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

Z
zengyawen 已提交
3369
**参数:**
Z
zhangalong 已提交
3370

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

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

Z
zhangalong 已提交
3378
  ```js
F
fanchenxuan 已提交
3379
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3380 3381 3382 3383
  let localId = 100;
  accountManager.getOsAccountAllConstraints(localId, (err, constraints)=>{
    console.log('getOsAccountAllConstraints err:' + JSON.stringify(err));
    console.log('getOsAccountAllConstraints:' + JSON.stringify(constraints));
Z
zhangalong 已提交
3384 3385 3386
  });
  ```

J
jidong 已提交
3387
### getOsAccountAllConstraints<sup>(deprecated)</sup>
Z
zhangalong 已提交
3388

J
jidong 已提交
3389
getOsAccountAllConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt;
Z
zhangalong 已提交
3390

A
Annie_wang 已提交
3391
> **说明:** 
3392
>
A
Annie_wang 已提交
3393
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountConstraints](#getosaccountconstraints9-1)。
J
jidong 已提交
3394 3395 3396 3397

获取指定系统帐号的全部约束。使用Promise异步回调。

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

Z
zengyawen 已提交
3399 3400 3401
**系统能力:** SystemCapability.Account.OsAccount

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

J
jidong 已提交
3403 3404 3405
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
3406

Z
zengyawen 已提交
3407
**返回值:**
Z
zhangalong 已提交
3408

J
jidong 已提交
3409 3410 3411
| 类型                               | 说明                                                         |
| :--------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象,返回指定系统帐号的全部[约束](#系统帐号约束列表)。 |
Z
zhangalong 已提交
3412

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

Z
zhangalong 已提交
3415
  ```js
F
fanchenxuan 已提交
3416
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3417 3418 3419
  let localId = 100;
  accountManager.getOsAccountAllConstraints(localId).then((constraints) => {
    console.log('getOsAccountAllConstraints, constraints: ' + constraints);
Z
zhangalong 已提交
3420
  }).catch((err) => {
J
jidong 已提交
3421
    console.log('getOsAccountAllConstraints err: '  + JSON.stringify(err));
Z
zhangalong 已提交
3422 3423 3424
  });
  ```

J
jidong 已提交
3425
### queryActivatedOsAccountIds<sup>(deprecated)</sup>
3426

J
jidong 已提交
3427 3428 3429
queryActivatedOsAccountIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void

查询当前处于激活状态的系统帐号的ID列表。使用callback异步回调。
3430

A
Annie_wang 已提交
3431
> **说明:** 
J
jidong 已提交
3432
>
C
cclicn 已提交
3433
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getActivatedOsAccountLocalIds](#getactivatedosaccountlocalids9)。
3434 3435 3436 3437 3438

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

**参数:**

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

J
jidong 已提交
3443
**示例:**
3444 3445 3446

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3447 3448 3449 3450 3451 3452 3453
  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]);
    }
  });
3454 3455
  ```

J
jidong 已提交
3456
### queryActivatedOsAccountIds<sup>(deprecated)</sup>
3457

J
jidong 已提交
3458
queryActivatedOsAccountIds(): Promise&lt;Array&lt;number&gt;&gt;
3459

A
Annie_wang 已提交
3460
> **说明:** 
J
jidong 已提交
3461
>
C
cclicn 已提交
3462
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getActivatedOsAccountLocalIds](#getactivatedosaccountlocalids9-1)。
3463

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

J
jidong 已提交
3466
**系统能力:** SystemCapability.Account.OsAccount
3467 3468 3469

**返回值:**

J
jidong 已提交
3470 3471 3472
| 类型                               | 说明                                               |
| ---------------------------------- | ------------------------------------------------- |
| Promise&lt;Array&lt;number&gt;&gt; | Promise对象,返回当前处于激活状态的系统帐号的ID列表。 |
3473

J
jidong 已提交
3474
**示例:**
3475 3476 3477

  ```js
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3478 3479 3480 3481 3482
  accountManager.queryActivatedOsAccountIds().then((idArray) => {
    console.log('queryActivatedOsAccountIds, idArray: ' + idArray);
  }).catch((err) => {
    console.log('queryActivatedOsAccountIds err: '  + JSON.stringify(err));
  });
3483 3484
  ```

J
jidong 已提交
3485
### queryCurrentOsAccount<sup>(deprecated)</sup>
Z
zhangalong 已提交
3486

J
jidong 已提交
3487
queryCurrentOsAccount(callback: AsyncCallback&lt;OsAccountInfo&gt;): void
Z
zhangalong 已提交
3488

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

A
Annie_wang 已提交
3491
> **说明:** 
3492
>
A
Annie_wang 已提交
3493
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCurrentOsAccount](#getcurrentosaccount9)。
J
jidong 已提交
3494 3495

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

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

Z
zengyawen 已提交
3499
**参数:**
Z
zhangalong 已提交
3500

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

J
jidong 已提交
3505
**示例:**
Z
zhangalong 已提交
3506

Z
zhangalong 已提交
3507
  ```js
F
fanchenxuan 已提交
3508
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3509 3510 3511
  accountManager.queryCurrentOsAccount((err, curAccountInfo)=>{
    console.log('queryCurrentOsAccount err:' + JSON.stringify(err));
    console.log('queryCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
Z
zhangalong 已提交
3512 3513 3514
  });
  ```

J
jidong 已提交
3515
### queryCurrentOsAccount<sup>(deprecated)</sup>
Z
zhangalong 已提交
3516

J
jidong 已提交
3517
queryCurrentOsAccount(): Promise&lt;OsAccountInfo&gt;
Z
zhangalong 已提交
3518

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

A
Annie_wang 已提交
3521
> **说明:** 
3522
>
A
Annie_wang 已提交
3523
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCurrentOsAccount](#getcurrentosaccount9-1)。
Z
zengyawen 已提交
3524

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

J
jidong 已提交
3527
**系统能力:** SystemCapability.Account.OsAccount
Z
zhangalong 已提交
3528

Z
zengyawen 已提交
3529
**返回值:**
Z
zhangalong 已提交
3530

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

J
jidong 已提交
3535
**示例:**
Z
zhangalong 已提交
3536

Z
zhangalong 已提交
3537
  ```js
F
fanchenxuan 已提交
3538
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3539 3540
  accountManager.queryCurrentOsAccount().then((accountInfo) => {
    console.log('queryCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
Z
zhangalong 已提交
3541
  }).catch((err) => {
J
jidong 已提交
3542
    console.log('queryCurrentOsAccount err: '  + JSON.stringify(err));
Z
zhangalong 已提交
3543 3544 3545
  });
  ```

J
jidong 已提交
3546
### getOsAccountTypeFromProcess<sup>(deprecated)</sup>
Z
zhangalong 已提交
3547

J
jidong 已提交
3548
getOsAccountTypeFromProcess(callback: AsyncCallback&lt;OsAccountType&gt;): void
Z
zhangalong 已提交
3549

J
jidong 已提交
3550
查询当前进程所属的系统帐号的帐号类型。使用callback异步回调。
Z
zengyawen 已提交
3551

A
Annie_wang 已提交
3552
> **说明:** 
J
jidong 已提交
3553
>
A
Annie_wang 已提交
3554
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountType](#getosaccounttype9)。
Z
zhangalong 已提交
3555

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

Z
zengyawen 已提交
3558 3559
**参数:**

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

3564
**示例:**
Z
zhangalong 已提交
3565

Z
zhangalong 已提交
3566
  ```js
F
fanchenxuan 已提交
3567
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3568 3569 3570 3571
  accountManager.getOsAccountTypeFromProcess((err, accountType) => {
    console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err));
    console.log('getOsAccountTypeFromProcess accountType: ' + accountType);
  });
Z
zhangalong 已提交
3572 3573
  ```

J
jidong 已提交
3574
### getOsAccountTypeFromProcess<sup>(deprecated)</sup>
Z
zhangalong 已提交
3575

J
jidong 已提交
3576
getOsAccountTypeFromProcess(): Promise&lt;OsAccountType&gt;
Z
zhangalong 已提交
3577

J
jidong 已提交
3578
查询当前进程所属的系统帐号的帐号类型。使用Promise异步回调。
Z
zengyawen 已提交
3579

A
Annie_wang 已提交
3580
> **说明:**
J
jidong 已提交
3581
>
A
Annie_wang 已提交
3582
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getOsAccountType](#getosaccounttype9-1)。
Z
zengyawen 已提交
3583 3584

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

J
jidong 已提交
3586
**返回值:**
Z
zhangalong 已提交
3587

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

3592
**示例:**
Z
zhangalong 已提交
3593

Z
zhangalong 已提交
3594
  ```js
F
fanchenxuan 已提交
3595
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3596 3597 3598 3599 3600
  accountManager.getOsAccountTypeFromProcess().then((accountType) => {
    console.log('getOsAccountTypeFromProcess, accountType: ' + accountType);
  }).catch((err) => {
    console.log('getOsAccountTypeFromProcess err: '  + JSON.stringify(err));
  });
Z
zhangalong 已提交
3601 3602
  ```

J
jidong 已提交
3603
### getDistributedVirtualDeviceId<sup>(deprecated)</sup>
3604

J
jidong 已提交
3605
getDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void
3606

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

A
Annie_wang 已提交
3609
> **说明:** 
J
jidong 已提交
3610
>
A
Annie_wang 已提交
3611
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[queryDistributedVirtualDeviceId](#querydistributedvirtualdeviceid9)。
3612

J
jidong 已提交
3613
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS
3614 3615 3616 3617 3618

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

**参数:**

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

3623
**示例:**
3624 3625

  ```js
F
fanchenxuan 已提交
3626
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3627 3628 3629 3630
  accountManager.getDistributedVirtualDeviceId((err, virtualID) => {
    console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err));
    console.log('getDistributedVirtualDeviceId virtualID: ' + virtualID);
  });
3631 3632
  ```

J
jidong 已提交
3633
### getDistributedVirtualDeviceId<sup>(deprecated)</sup>
3634

J
jidong 已提交
3635
getDistributedVirtualDeviceId(): Promise&lt;string&gt;
3636

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

A
Annie_wang 已提交
3639
> **说明:** 
J
jidong 已提交
3640
>
A
Annie_wang 已提交
3641
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[queryDistributedVirtualDeviceId](#querydistributedvirtualdeviceid9-1)。
3642

J
jidong 已提交
3643
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS
3644

J
jidong 已提交
3645
**系统能力:** SystemCapability.Account.OsAccount
3646 3647 3648

**返回值:**

J
jidong 已提交
3649 3650 3651
| 类型                  | 说明                              |
| --------------------- | --------------------------------- |
| Promise&lt;string&gt; | Promise对象,返回分布式虚拟设备ID。 |
3652

3653
**示例:**
3654 3655

  ```js
F
fanchenxuan 已提交
3656
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3657 3658 3659 3660 3661
  accountManager.getDistributedVirtualDeviceId().then((virtualID) => {
    console.log('getDistributedVirtualDeviceId, virtualID: ' + virtualID);
  }).catch((err) => {
    console.log('getDistributedVirtualDeviceId err: '  + JSON.stringify(err));
  });
3662 3663
  ```

J
jidong 已提交
3664
### getOsAccountLocalIdBySerialNumber<sup>(deprecated)</sup>
3665

J
jidong 已提交
3666
getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback&lt;number&gt;): void
3667

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

A
Annie_wang 已提交
3670
> **说明:** 
J
jidong 已提交
3671
>
C
cclicn 已提交
3672
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForSerialNumber](#getosaccountlocalidforserialnumber9)。
3673

3674 3675 3676 3677
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

J
jidong 已提交
3678 3679 3680 3681
| 参数名       | 类型                        | 必填 | 说明                                                                               |
| ------------ | --------------------------- | ---- | -------------------------------------------------------------------------------- |
| serialNumber | number                      | 是   | 帐号SN码。                                                                        |
| callback     | AsyncCallback&lt;number&gt; | 是   | 回调函数。如果查询成功,err为null,data为与SN码关联的系统帐号的帐号ID;否则为错误对象。 |
3682

J
jidong 已提交
3683
**示例:** 查询与SN码12345关联的系统帐号的ID
3684 3685

  ```js
F
fanchenxuan 已提交
3686
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3687 3688 3689 3690 3691
  let serialNumber = 12345;
  accountManager.getOsAccountLocalIdBySerialNumber(serialNumber, (err, localId)=>{
    console.log('ger localId err:' + JSON.stringify(err));
    console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
  });
3692 3693
  ```

J
jidong 已提交
3694
### getOsAccountLocalIdBySerialNumber<sup>(deprecated)</sup>
3695

J
jidong 已提交
3696
getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt;
3697

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

A
Annie_wang 已提交
3700
> **说明:** 
J
jidong 已提交
3701
>
C
cclicn 已提交
3702
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getOsAccountLocalIdForSerialNumber](#getosaccountlocalidforserialnumber9-1)。
3703

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

J
jidong 已提交
3706 3707 3708 3709 3710 3711
**参数:**

| 参数名       | 类型   | 必填 | 说明       |
| ------------ | ------ | ---- | ---------- |
| serialNumber | number | 是   | 帐号SN码。 |

3712 3713 3714
**返回值:**

| 类型                  | 说明                                                         |
J
jidong 已提交
3715 3716
| --------------------- | -------------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回与SN码关联的系统帐号的帐号ID。 |
3717

J
jidong 已提交
3718
**示例:** 查询与SN码12345关联的系统帐号的ID
3719 3720

  ```js
F
fanchenxuan 已提交
3721
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3722 3723 3724 3725 3726 3727
  let serialNumber = 12345;
  accountManager.getOsAccountLocalIdBySerialNumber(serialNumber).then((localId) => {
    console.log('getOsAccountLocalIdBySerialNumber localId: ' + localId);
  }).catch((err) => {
    console.log('getOsAccountLocalIdBySerialNumber err: '  + JSON.stringify(err));
  });
3728 3729
  ```

J
jidong 已提交
3730
### getSerialNumberByOsAccountLocalId<sup>(deprecated)</sup>
3731

J
jidong 已提交
3732
getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;number&gt;): void
3733

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

A
Annie_wang 已提交
3736
> **说明:** 
J
jidong 已提交
3737
>
C
cclicn 已提交
3738
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getSerialNumberForOsAccountLocalId](#getserialnumberforosaccountlocalid9)。
3739 3740 3741 3742 3743

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

**参数:**

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

J
jidong 已提交
3749
**示例:** 获取ID为100的系统帐号关联的SN码
3750 3751

  ```js
F
fanchenxuan 已提交
3752
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3753 3754 3755 3756 3757
  let localId = 100;
  accountManager.getSerialNumberByOsAccountLocalId(localId, (err, serialNumber)=>{
    console.log('ger serialNumber err:' + JSON.stringify(err));
    console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
  });
3758 3759
  ```

J
jidong 已提交
3760
### getSerialNumberByOsAccountLocalId<sup>(deprecated)</sup>
3761

J
jidong 已提交
3762
getSerialNumberByOsAccountLocalId(localId: number): Promise&lt;number&gt;
3763

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

A
Annie_wang 已提交
3766
> **说明:** 
J
jidong 已提交
3767
>
C
cclicn 已提交
3768
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getSerialNumberForOsAccountLocalId](#getserialnumberforosaccountlocalid9-1)。
3769 3770 3771 3772 3773

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

**参数:**

J
jidong 已提交
3774 3775 3776
| 参数名  | 类型   | 必填 | 说明          |
| ------- | ------ | ---- | ----------- |
| localId | number | 是   | 系统帐号ID。 |
3777 3778 3779

**返回值:**

J
jidong 已提交
3780 3781 3782
| 类型                  | 说明                                    |
| --------------------- | -------------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回与该系统帐号关联的SN码。 |
3783

J
jidong 已提交
3784
**示例:** 获取ID为100的系统帐号关联的SN码
3785 3786

  ```js
F
fanchenxuan 已提交
3787
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
3788 3789 3790 3791 3792 3793
  let localId = 100;
  accountManager.getSerialNumberByOsAccountLocalId(localId).then((serialNumber) => {
    console.log('getSerialNumberByOsAccountLocalId serialNumber: ' + serialNumber);
  }).catch((err) => {
    console.log('getSerialNumberByOsAccountLocalId err: '  + JSON.stringify(err));
  });
3794 3795
  ```

3796 3797 3798 3799
## UserAuth<sup>8+</sup>

用户认证类。

J
jidong 已提交
3800
**系统接口:** 此接口为系统接口。
3801

3802 3803 3804 3805 3806 3807
### constructor<sup>8+</sup>

constructor()

创建用户认证的实例。

J
jidong 已提交
3808
**系统接口:** 此接口为系统接口。
3809

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

3812
**示例:**  
3813
  ```js
J
jidong 已提交
3814
  let userAuth = new account_osAccount.UserAuth();
3815 3816 3817 3818 3819 3820 3821 3822
  ```

### getVersion<sup>8+</sup>

getVersion(): number;

返回版本信息。

J
jidong 已提交
3823
**系统接口:** 此接口为系统接口。
3824 3825 3826 3827 3828 3829 3830 3831 3832

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

**返回值:**

| 类型   | 说明         |
| :----- | :----------- |
| number | 返回版本信息。|

3833
**示例:**  
3834
  ```js
J
jidong 已提交
3835 3836
  let userAuth = new account_osAccount.UserAuth();
  let version = userAuth.getVersion();
F
fanchenxuan 已提交
3837
  console.log('getVersion version = ' + version);
3838 3839 3840 3841 3842 3843
  ```

### getAvailableStatus<sup>8+</sup>

getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;

J
jidong 已提交
3844
获取指定认证类型和认证可信等级的认证能力的可用状态。
3845

J
jidong 已提交
3846
**系统接口:** 此接口为系统接口。
3847 3848 3849 3850 3851 3852 3853

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

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

**参数:**

J
jidong 已提交
3854 3855 3856 3857
| 参数名           | 类型                               | 必填 | 说明                       |
| --------------- | -----------------------------------| ---- | ------------------------- |
| authType        | [AuthType](#authtype8)             | 是   | 认证类型。     |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8) | 是   | 认证的可信等级。 |
3858 3859 3860

**返回值:**

J
jidong 已提交
3861 3862 3863 3864 3865 3866 3867 3868 3869 3870
| 类型   | 说明                           |
| ------ | ----------------------------- |
| number | 返回认证能力的可用状态。 |

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType or authTrustLevel. |
3871

3872
**示例:**  
3873
  ```js
J
jidong 已提交
3874 3875 3876
  let userAuth = new account_osAccount.UserAuth();
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
3877 3878 3879 3880 3881 3882
  try {
    let status = userAuth.getAvailableStatus(authType, authTrustLevel);
    console.log('getAvailableStatus status = ' + status);
  } catch (e) {
    console.log('getAvailableStatus exception = ' + JSON.stringify(e));
  }
3883 3884 3885 3886 3887 3888
  ```

### getProperty<sup>8+</sup>

getProperty(request: GetPropertyRequest, callback: AsyncCallback&lt;ExecutorProperty&gt;): void;

J
jidong 已提交
3889
基于指定的请求信息获取属性。使用callback异步回调。
3890

J
jidong 已提交
3891
**系统接口:** 此接口为系统接口。
3892 3893 3894 3895 3896 3897 3898 3899

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

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

**参数:**

| 参数名    | 类型                                                                    | 必填 | 说明                                |
J
jidong 已提交
3900
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------ |
3901
| request  | [GetPropertyRequest](#getpropertyrequest8)                  | 是   | 请求信息,包括认证类型和属性类型列表。 |
J
jidong 已提交
3902 3903 3904 3905 3906 3907 3908 3909
| callback | AsyncCallback&lt;[ExecutorProperty](#executorproperty8)&gt; | 是   | 回调函数。如果获取成功,err为null,data为执行器属性信息;否则为错误对象。|

**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |
3910

3911
**示例:**
3912
  ```js
J
jidong 已提交
3913 3914 3915 3916 3917 3918 3919 3920 3921 3922
  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
  };
3923 3924 3925 3926 3927 3928 3929 3930
  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));
  }
3931 3932 3933 3934
  ```

### getProperty<sup>8+</sup>

3935
getProperty(request: GetPropertyRequest): Promise&lt;ExecutorProperty&gt;;
3936

J
jidong 已提交
3937
基于指定的请求信息获取属性。使用Promise异步回调。
3938

J
jidong 已提交
3939
**系统接口:** 此接口为系统接口。
3940 3941 3942 3943 3944 3945 3946 3947 3948

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

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

**参数:**

| 参数名    | 类型                                                   | 必填 | 说明                                |
| -------- | ------------------------------------------------------ | ---- | ---------------------------------- |
3949
| request  | [GetPropertyRequest](#getpropertyrequest8) | 是   | 请求信息,包括认证类型和属性类型列表。 |
3950 3951 3952 3953 3954

**返回值:**

| 类型                                                              | 说明                                                 |
| :---------------------------------------------------------------- | :-------------------------------------------------- |
J
jidong 已提交
3955
| Promise&lt;[ExecutorProperty](#executorproperty8)&gt; | Promise对象,返回执行者属性信息。 |
3956

J
jidong 已提交
3957 3958 3959 3960 3961 3962 3963
**错误码:**

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

3964
**示例:**
3965
  ```js
J
jidong 已提交
3966 3967 3968 3969 3970 3971 3972 3973 3974 3975
  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
  };
3976 3977 3978 3979 3980 3981 3982 3983 3984
  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));
  }
3985 3986 3987 3988
  ```

### setProperty<sup>8+</sup>

3989
setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;void&gt;): void;
3990

J
jidong 已提交
3991
设置可用于初始化算法的属性。使用callback异步回调。
3992

J
jidong 已提交
3993
**系统接口:** 此接口为系统接口。
3994 3995 3996 3997 3998 3999 4000 4001 4002

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

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

**参数:**

| 参数名    | 类型                                                  | 必填 | 说明                                                                    |
| -------- | ----------------------------------------------------- | ---- | ---------------------------------------------------------------------- |
4003
| request  | [SetPropertyRequest](#setpropertyrequest8)| 是   | 请求信息,包括认证类型和要设置的密钥值。                                   |
4004
| callback | AsyncCallback&lt;void&gt;                           | 是   | 回调函数。如果设置成功,err为null,否则为错误对象。 |
4005

J
jidong 已提交
4006 4007 4008 4009 4010 4011 4012
**错误码:**

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

4013
**示例:**
4014
  ```js
J
jidong 已提交
4015 4016 4017 4018 4019 4020
  let userAuth = new account_osAccount.UserAuth();
  let request = {
    authType: account_osAccount.AuthType.PIN,
    key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
    setInfo: new Uint8Array([0])
  };
4021
  try {
4022 4023 4024 4025 4026 4027
    userAuth.setProperty(request, (err) => {
      if (err) {
        console.log('setProperty failed, error = ' + JSON.stringify(err));
      } else {
        console.log('setProperty successfully');
      }
4028 4029 4030 4031
    });
  } catch (e) {
    console.log('setProperty exception = ' + JSON.stringify(e));
  }
4032 4033 4034 4035
  ```

### setProperty<sup>8+</sup>

4036
setProperty(request: SetPropertyRequest): Promise&lt;void&gt;;
4037

J
jidong 已提交
4038
设置可用于初始化算法的属性。使用Promise异步回调。
4039

J
jidong 已提交
4040
**系统接口:** 此接口为系统接口。
4041 4042 4043 4044 4045 4046 4047

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

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

**参数:**

J
jidong 已提交
4048 4049
| 参数名    | 类型                                       | 必填 | 说明                                      |
| -------- | ------------------------------------------ | ---- | ---------------------------------------- |
4050
| request  | [SetPropertyRequest](#setpropertyrequest8) | 是   | 请求信息,包括身份验证类型和要设置的密钥值。 |
4051 4052 4053

**返回值:**

J
jidong 已提交
4054 4055
| 类型                  | 说明                                                           |
| :-------------------- | :------------------------------------------------------------ |
A
Annie_wang 已提交
4056
| Promise&lt;void&gt; | Promise对象,无返回结果的Promise对象。 |
4057

J
jidong 已提交
4058 4059 4060 4061 4062 4063 4064
**错误码:**

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

4065
**示例:**
4066
  ```js
J
jidong 已提交
4067 4068 4069 4070 4071 4072
  let userAuth = new account_osAccount.UserAuth();
  let request = {
    authType: account_osAccount.AuthType.PIN,
    key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
    setInfo: new Uint8Array([0])
  };
4073
  try {
4074 4075
    userAuth.setProperty(request).then(() => {
      console.log('setProperty successfully');
4076
    }).catch((err) => {
4077
      console.log('setProperty failed, error = ' + JSON.stringify(err));
4078 4079 4080 4081
    });
  } catch (e) {
    console.log('setProperty exception = ' + JSON.stringify(e));
  }
4082 4083 4084 4085 4086 4087
  ```

### auth<sup>8+</sup>

auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

J
jidong 已提交
4088
认证当前用户。使用callback异步回调。
4089

J
jidong 已提交
4090
**系统接口:** 此接口为系统接口。
4091 4092 4093 4094 4095 4096 4097

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

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

**参数:**

J
jidong 已提交
4098 4099
| 参数名           | 类型                                     | 必填 | 说明                                |
| --------------- | ---------------------------------------- | --- | ------------------------------------ |
J
jidong 已提交
4100
| challenge       | Uint8Array                               | 是  | 指示挑战值,挑战值为一个随机数,用于提升安全性。|
4101 4102
| authType        | [AuthType](#authtype8)                   | 是  | 指示认证类型。                        |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8)       | 是  | 指示认证结果的信任级别。               |
J
jidong 已提交
4103
| callback        | [IUserAuthCallback](#iuserauthcallback8) | 是  | 回调对象,返回认证结果。  |
4104 4105 4106 4107

**返回值:**

| 类型        | 说明               |
J
jidong 已提交
4108
| ---------- | ------------------ |
4109 4110
| Uint8Array | 返回取消的上下文ID。 |

J
jidong 已提交
4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123
**错误码:**

| 错误码ID | 错误信息          |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid challenge or authType or authTrustLevel. |
| 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. |
| 12300110 | Authentication locked. |
| 12300111 | Authentication timeout. |
| 12300112 | Authentication service busy. |

4124
**示例:**
4125
  ```js
J
jidong 已提交
4126 4127 4128 4129
  let userAuth = new account_osAccount.UserAuth();
  let challenge = new Uint8Array([0]);
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
4130 4131 4132 4133 4134 4135 4136 4137 4138 4139
  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));
  }
4140 4141 4142 4143 4144 4145
  ```

### authUser<sup>8+</sup>

authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

J
jidong 已提交
4146
认证指定用户。使用callback异步回调。
4147

J
jidong 已提交
4148
**系统接口:** 此接口为系统接口。
4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159

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

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

**参数:**

| 参数名           | 类型                                                 | 必填 | 说明                                |
| --------------- | ---------------------------------------------------- | --- | ------------------------------------ |
| userId          | number                                               | 是  | 指示用户身份。                        |
| challenge       | Uint8Array                                           | 是  | 指示挑战值,挑战值为一个随机数,用于提升安全性。                          |
4160 4161
| authType        | [AuthType](#authtype8)                   | 是  | 指示认证类型。                        |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8)       | 是  | 指示认证结果的信任级别。               |
J
jidong 已提交
4162
| callback        | [IUserAuthCallback](#iuserauthcallback8) | 是  | 回调对象,返回认证结果。  |
4163 4164 4165 4166

**返回值:**

| 类型        | 说明               |
J
jidong 已提交
4167
| ---------- | ------------------ |
4168 4169
| Uint8Array | 返回取消的上下文ID。 |

J
jidong 已提交
4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182
**错误码:**

| 错误码ID | 错误信息          |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid userId or challenge or authType or authTrustLevel. |
| 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. |
| 12300110 | Authentication locked. |
| 12300111 | Authentication timeout. |
| 12300112 | Authentication service busy. |

4183
**示例:**
4184
  ```js
J
jidong 已提交
4185
  let userAuth = new account_osAccount.UserAuth();
4186
  let userID = 100;
J
jidong 已提交
4187 4188 4189
  let challenge = new Uint8Array([0]);
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
4190 4191 4192
  try {
    userAuth.authUser(userID, challenge, authType, authTrustLevel, {
      onResult: function(result,extraInfo){
J
jidong 已提交
4193 4194
        console.log('authUser result = ' + result);
        console.log('authUser extraInfo = ' + JSON.stringify(extraInfo));
4195 4196 4197 4198 4199
      }
    });
  } catch (e) {
    console.log('authUser exception = ' + JSON.stringify(e));
  }
4200 4201 4202 4203
  ```

### cancelAuth<sup>8+</sup>

4204
cancelAuth(contextID: Uint8Array): void;
4205

J
jidong 已提交
4206
取消指定的认证操作。
4207

J
jidong 已提交
4208
**系统接口:** 此接口为系统接口。
4209 4210 4211 4212 4213 4214 4215 4216 4217

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

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

**参数:**

| 参数名    | 类型       | 必填  | 说明                                        |
| ----------| ---------- | ---- | ------------------------------------------ |
J
jidong 已提交
4218 4219 4220 4221 4222 4223 4224 4225
| contextId | Uint8Array | 是   | 指示身份验证上下文ID,此ID动态生成没有具体值。 |

**错误码:**

| 错误码ID | 错误信息            |
| -------- | ------------------ |
| 12300001 | System service exception. |
| 12300002 | Invalid contextId. |
4226

4227
**示例:**
4228
  ```js
J
jidong 已提交
4229 4230 4231
  let userAuth = new account_osAccount.UserAuth();
  let pinAuth = new account_osAccount.PINAuth();
  let challenge = new Uint8Array([0]);
J
jidong 已提交
4232
  let contextId = userAuth.auth(challenge, account_osAccount.AuthType.PIN, account_osAccount.AuthTrustLevel.ATL1, {
J
jidong 已提交
4233
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
4234 4235
      console.log('auth result = ' + result);
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
4236 4237
    }
  });
4238
  try {
J
jidong 已提交
4239
    userAuth.cancelAuth(contextId);
4240 4241 4242
  } catch (e) {
    console.log('cancelAuth exception = ' + JSON.stringify(e));
  }
4243 4244 4245 4246
  ```

## PINAuth<sup>8+</sup>

W
wangyihui 已提交
4247
PIN码认证基类。
4248

J
jidong 已提交
4249
**系统接口:** 此接口为系统接口。
4250

4251 4252 4253 4254
### constructor<sup>8+</sup>

constructor()

W
wangyihui 已提交
4255
创建PIN码认证的实例。
4256

J
jidong 已提交
4257
**系统接口:** 此接口为系统接口。
L
lichenchen 已提交
4258

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

4261
**示例:**  
4262
  ```js
J
jidong 已提交
4263
  let pinAuth = new account_osAccount.PINAuth();
4264 4265
  ```

4266
### registerInputer<sup>8+</sup>
4267

J
jidong 已提交
4268
registerInputer(inputer: IInputer): void;
4269

J
jidong 已提交
4270
注册PIN码输入器。
4271

J
jidong 已提交
4272
**系统接口:** 此接口为系统接口。
4273 4274 4275 4276 4277 4278 4279

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

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

**参数:**

J
jidong 已提交
4280 4281 4282
| 参数名    | 类型                     | 必填 | 说明                      |
| ----------| ----------------------- | --- | -------------------------- |
| inputer   | [IInputer](#iinputer8)  | 是  | PIN码输入器,用于获取PIN码。 |
4283

J
jidong 已提交
4284 4285 4286 4287 4288
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | --------------------------- |
| 12300001 | System service exception. |
W
wangyihui 已提交
4289
| 12300102 | Invalid inputer. |
J
jidong 已提交
4290 4291
| 12300103 | Inputer already registered. |

4292
**示例:**
4293
  ```js
J
jidong 已提交
4294
  let pinAuth = new account_osAccount.PINAuth();
J
jidong 已提交
4295
  let password = new Uint8Array([0, 0, 0, 0, 0]);
4296 4297
  try {
    let result = pinAuth.registerInputer({
W
wangyihui 已提交
4298 4299
        onGetData: (authSubType, callback) => {
          callback.onSetData(authSubType, password);
4300 4301 4302 4303 4304 4305
        }
    });
    console.log('registerInputer result = ' + result);
  } catch (e) {
    console.log('registerInputer exception = ' + JSON.stringify(e));
  }
4306 4307
  ```

4308
### unregisterInputer<sup>8+</sup>
4309 4310 4311

unregisterInputer(): void;

J
jidong 已提交
4312
解注册PIN码输入器。
4313

J
jidong 已提交
4314
**系统接口:** 此接口为系统接口。
4315 4316 4317 4318 4319

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

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

4320
**示例:**
4321
  ```js
J
jidong 已提交
4322
  let pinAuth = new account_osAccount.PINAuth();
4323 4324 4325
  pinAuth.unregisterInputer();
  ```

J
jidong 已提交
4326
## InputerManager <sup>9+</sup>
W
wangyihui 已提交
4327 4328 4329

凭据输入管理器。

J
jidong 已提交
4330
### registerInputer<sup>9+</sup>
W
wangyihui 已提交
4331

J
jidong 已提交
4332
static registerInputer(authType: AuthType, inputer: IInputer): void
W
wangyihui 已提交
4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362

注册凭据输入器。

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

**系统能力:** 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. |
| 12300102 | Invalid authType or inputer. |
| 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 已提交
4363
    account_osAccount.InputerManager.registerInputer(authType, {
W
wangyihui 已提交
4364 4365 4366 4367 4368 4369 4370 4371 4372 4373
        onGetData: (authSubType, callback) => {
          callback.onSetData(authSubType, password);
        }
    });
    console.log('registerInputer success.');
  } catch (e) {
    console.log('registerInputer exception = ' + JSON.stringify(e));
  }
  ```

J
jidong 已提交
4374
### unregisterInputer<sup>9+</sup>
W
wangyihui 已提交
4375

J
jidong 已提交
4376
static unregisterInputer(authType: AuthType): void
W
wangyihui 已提交
4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401

解注册凭据输入器。

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

**系统能力:** 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 已提交
4402
    account_osAccount.InputerManager.unregisterInputer(authType);
W
wangyihui 已提交
4403 4404 4405 4406 4407 4408
    console.log('unregisterInputer success.');
  } catch(err) {
    console.log("unregisterInputer err:" + JSON.stringify(err));
  }
  ```

J
jidong 已提交
4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 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 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522
## 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 = {
    auth: (domainInfo, credential, callback) => {
      // mock authentication
      callback.onResult(0, {});
    }
  }
  account_osAccount.DomainAccountManager.registerPlugin(plugin);
  let userAuth = new account_osAccount.UserAuth();
  let challenge = new Uint8Array([0]);
  let authType = account_osAccount.AuthType.PIN;
  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));
  }
  ```

## 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 | 错误信息                     |
| -------- | --------------------------- |
| 12300201 | The domain plugin has been registered. |

**示例:**
  ```js
  let plugin = {
    auth: (domainInfo, credential, callback) => {
      // mock authentication
      callback.onResult(0, {});
    }
  }
  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));
  }
  ```

4523 4524 4525 4526
## UserIdentityManager<sup>8+</sup>

获取用户身份管理类。

J
jidong 已提交
4527
**系统接口:** 此接口为系统接口。
4528

4529 4530 4531 4532
### constructor<sup>8+</sup>

constructor()

J
jidong 已提交
4533
用户身份管理类的默认构造函数。
4534

J
jidong 已提交
4535
**系统接口:** 此接口为系统接口。
4536

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

4539
**示例:**  
4540
  ```js
J
jidong 已提交
4541
  let userIDM = new account_osAccount.UserIdentityManager();
4542 4543 4544 4545 4546 4547
  ```

### openSession<sup>8+</sup>

openSession(callback: AsyncCallback&lt;Uint8Array&gt;): void;

J
jidong 已提交
4548
打开会话,获取挑战值。使用callback异步回调。
4549

J
jidong 已提交
4550
**系统接口:** 此接口为系统接口。
4551 4552 4553 4554 4555 4556 4557

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

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

**参数:**

J
jidong 已提交
4558 4559 4560
| 参数名    | 类型                             | 必填 | 说明                                                            |
| -------- | -------------------------------- | ---- | -------------------------------------------------------------- |
| callback | AsyncCallback&lt;Uint8Array&gt;  | 是   | 回调函数。如果打开会话成功,err为null,data为挑战值;否则为错误对象。|
4561

J
jidong 已提交
4562 4563 4564 4565 4566 4567
**错误码:**

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

4568
**示例:**
4569
  ```js
J
jidong 已提交
4570
  let userIDM = new account_osAccount.UserIdentityManager();
4571 4572 4573 4574 4575 4576 4577 4578
  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));
  }
4579 4580 4581 4582 4583 4584
  ```

### openSession<sup>8+</sup>

openSession(): Promise&lt;Uint8Array&gt;;

J
jidong 已提交
4585
打开会话,获取挑战值。使用Promise异步回调。
4586

J
jidong 已提交
4587
**系统接口:** 此接口为系统接口。
4588 4589 4590 4591 4592 4593 4594

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

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

**返回值:**

J
jidong 已提交
4595 4596 4597
| 类型                      | 说明                     |
| :------------------------ | ----------------------- |
| Promise&lt;Uint8Array&gt; | Promise对象,返回挑战值。 |
4598

J
jidong 已提交
4599 4600 4601 4602 4603 4604
**错误码:**

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

4605
**示例:**
4606
  ```js
J
jidong 已提交
4607
  let userIDM = new account_osAccount.UserIdentityManager();
4608 4609 4610 4611 4612 4613 4614 4615 4616
  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));
  }
4617 4618 4619 4620 4621 4622
  ```

### addCredential<sup>8+</sup>

addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

J
jidong 已提交
4623
添加凭据,添加用户凭据信息,传入凭据添加方法和凭据信息(凭据类型,子类,如果添加用户的非密码凭据,则传入密码身份验证令牌),并获取结果/获取信息。
4624

J
jidong 已提交
4625
**系统接口:** 此接口为系统接口。
4626 4627 4628 4629 4630 4631 4632

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

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

**参数:**

J
jidong 已提交
4633
| 参数名           | 类型                                 | 必填 | 说明                        |
J
jidong 已提交
4634
| --------------- | ------------------------------------ | --- | ---------------------------- |
J
jidong 已提交
4635 4636
| credentialInfo  | [CredentialInfo](#credentialinfo8)   | 是  | 指示凭据信息。                |
| callback        | [IIdmCallback](#iidmcallback8)       | 是  | 回调对象,返回添加凭据的结果。  |
4637

J
jidong 已提交
4638 4639 4640 4641 4642 4643 4644 4645 4646
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialInfo, i.e. authType or authSubType. |
| 12300101 | Token is invalid. |
| 12300106 | Unsupported authType. |

4647
**示例:**
4648
  ```js
J
jidong 已提交
4649 4650 4651
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let pinAuth = new account_osAccount.PINAuth();
  pinAuth.registerInputer({
W
wangyihui 已提交
4652 4653
    onGetData: (authSubType, callback) => {
      callback.onSetData(authSubType, password);
J
jidong 已提交
4654 4655 4656 4657 4658 4659 4660 4661 4662
    }
  });
  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) => {
4663
    try {
J
jidong 已提交
4664 4665
    userIDM.addCredential(credentialInfo, {
      onResult: (result, extraInfo) => {
W
wangyihui 已提交
4666 4667
        console.log('addCredential result = ' + result);
        console.log('addCredential extraInfo = ' + extraInfo);
4668
      }
J
jidong 已提交
4669
    });
4670
    } catch (e) {
W
wangyihui 已提交
4671
      console.log('addCredential exception = ' + JSON.stringify(e));
4672
    }
J
jidong 已提交
4673
  });
4674 4675 4676 4677 4678 4679
  ```

### updateCredential<sup>8+</sup>

updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

J
jidong 已提交
4680
更新凭据。使用callback异步回调。
4681

J
jidong 已提交
4682
**系统接口:** 此接口为系统接口。
4683 4684 4685 4686 4687 4688 4689

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

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

**参数:**

J
jidong 已提交
4690 4691 4692 4693
| 参数名           | 类型                                  | 必填 | 说明                     |
| --------------- | ------------------------------------- | --- | ------------------------- |
| credentialInfo  | [CredentialInfo](#credentialinfo8)    | 是  | 指示凭据信息。             |
| callback        | [IIdmCallback](#iidmcallback8)        | 是  | 回调对象,返回更新凭据的结果。 |
4694

J
jidong 已提交
4695 4696 4697 4698 4699 4700 4701 4702 4703
**错误码:**

| 错误码ID | 错误信息                     |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialInfo, i.e. authType or authSubType or token. |
| 12300101 | Token is invalid. |
| 12300106 | Unsupported authType. |

4704
**示例:**
4705
  ```js
J
jidong 已提交
4706 4707 4708 4709 4710 4711 4712 4713 4714 4715
  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 已提交
4716 4717
    onGetData: (authSubType, callback) => {
      callback.onSetData(authSubType, password);
J
jidong 已提交
4718 4719 4720
    }
  });
  userIDM.openSession((err, challenge) => {
J
jidong 已提交
4721
    userAuth.auth(challenge, credentialInfo.credType, account_osAccount.AuthTrustLevel.ATL1, {
J
jidong 已提交
4722 4723 4724 4725 4726
      onResult: (result, extraInfo) => {
        if (result != account_osAccount.ResultCode.SUCCESS) {
          return;
        }
        credentialInfo.token = extraInfo.token;
4727 4728 4729 4730 4731 4732 4733 4734 4735 4736
        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));
        }
4737
      }
J
jidong 已提交
4738 4739
    });
  });
4740 4741 4742 4743 4744 4745
  ```

### closeSession<sup>8+</sup>

closeSession(): void;

J
jidong 已提交
4746
关闭会话,结束IDM操作。
4747

J
jidong 已提交
4748
**系统接口:** 此接口为系统接口。
4749 4750 4751 4752 4753

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

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

4754
**示例:**
4755
  ```js
J
jidong 已提交
4756
  let userIDM = new account_osAccount.UserIdentityManager();
4757 4758 4759 4760 4761
  userIDM.closeSession();
  ```

### cancel<sup>8+</sup>

4762
cancel(challenge: Uint8Array): void;
4763 4764 4765

根据挑战值取消条目。

J
jidong 已提交
4766
**系统接口:** 此接口为系统接口。
4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777

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

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

**参数:**

| 参数名    | 类型        | 必填 | 说明   |
| -------- | ----------- | ---- | ----- |
| challenge | Uint8Array | 是   | 挑战值。 |

J
jidong 已提交
4778 4779 4780 4781 4782 4783
**错误码:**

| 错误码ID | 错误信息            |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid challenge. |
4784

4785
**示例:**
4786
  ```js
J
jidong 已提交
4787
  let userIDM = new account_osAccount.UserIdentityManager();
J
jidong 已提交
4788
  let challenge = new Uint8Array([0]);
4789 4790 4791 4792 4793
  try {
    userIDM.cancel(challenge);
  } catch(err) {
    console.log("cancel err:" + JSON.stringify(err));
  }
4794 4795 4796 4797 4798 4799 4800 4801
  ```

### delUser<sup>8+</sup>

delUser(token: Uint8Array, callback: IIdmCallback): void;

删除具有身份验证令牌的用户,使用callback方式异步返回结果。

J
jidong 已提交
4802
**系统接口:** 此接口为系统接口。
4803 4804 4805 4806 4807 4808 4809

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

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

**参数:**

J
jidong 已提交
4810 4811 4812 4813
| 参数名    | 类型                           | 必填 | 说明                      |
| -------- | ------------------------------ | --- | ------------------------- |
| token    | Uint8Array                     | 是  | 身份验证令牌。             |
| callback | [IIdmCallback](#iidmcallback8) | 是  | 回调对象,返回删除用户的结果。|
4814

J
jidong 已提交
4815 4816 4817 4818 4819 4820 4821
**错误码:**

| 错误码ID | 错误信息        |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300101 | Token is invalid. |

4822
**示例:**
4823
  ```js
J
jidong 已提交
4824 4825
  let userIDM = new account_osAccount.UserIdentityManager();
  let token = new Uint8Array([0]);
4826 4827 4828 4829 4830 4831 4832 4833 4834 4835
  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));
  }
4836 4837 4838 4839 4840 4841
  ```

### delCred<sup>8+</sup>

delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): void;

J
jidong 已提交
4842
删除用户凭据信息。
4843

J
jidong 已提交
4844
**系统接口:** 此接口为系统接口。
4845 4846 4847 4848 4849 4850 4851 4852

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

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

**参数:**

| 参数名           | 类型                                            | 必填 | 说明                      |
J
jidong 已提交
4853 4854 4855 4856
| --------------- | ----------------------------------- | --- | ---------------------------|
| credentialId    | Uint8Array                          | 是  | 凭证索引。                  |
| token           | Uint8Array                          | 是  | 身份验证令牌。               |
| callback        | [IIdmCallback](#iidmcallback8)      | 是  | 回调对象,返回删除凭据的结果。 |
4857

J
jidong 已提交
4858 4859 4860 4861 4862 4863 4864 4865 4866
**错误码:**

| 错误码ID | 错误信息             |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialId. |
| 12300101 | Token is invalid. |
| 12300102 | Credential not found. |

4867
**示例:**
4868
  ```js
J
jidong 已提交
4869 4870 4871
  let userIDM = new account_osAccount.UserIdentityManager();
  let credentialId = new Uint8Array([0]);
  let token = new Uint8Array([0]);
4872 4873 4874 4875 4876 4877 4878 4879 4880 4881
  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));
  }
4882 4883 4884 4885
  ```

### getAuthInfo<sup>8+</sup>

4886
getAuthInfo(callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;
4887

J
jidong 已提交
4888
获取认证信息。使用callback异步回调。
4889

J
jidong 已提交
4890
**系统接口:** 此接口为系统接口。
4891 4892 4893

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

4894
**需要权限:** ohos.permission.USE_USER_IDM
4895 4896 4897

**参数:**

J
jidong 已提交
4898 4899
| 参数名    | 类型                                                                     | 必填 | 说明                                                 |
| -------- | ------------------------------------------------------------------------ | ---- | --------------------------------------------- |
J
jidong 已提交
4900
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是   | 回调函数。如果成功,err为null,data为当前用户的所有已注册凭据信息;否则为错误对象。|
4901

J
jidong 已提交
4902 4903 4904 4905 4906 4907
**错误码:**

| 错误码ID | 错误信息               |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300102 | Credential not found. |
4908

4909
**示例:**
4910
  ```js
J
jidong 已提交
4911
  let userIDM = new account_osAccount.UserIdentityManager();
4912 4913 4914 4915 4916 4917 4918 4919
  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));
  }
4920 4921 4922 4923 4924 4925
  ```

### getAuthInfo<sup>8+</sup>

getAuthInfo(authType: AuthType, callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;

J
jidong 已提交
4926
获取指定类型的认证信息。使用callback异步回调。
4927

J
jidong 已提交
4928
**系统接口:** 此接口为系统接口。
4929 4930 4931

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

4932
**需要权限:** ohos.permission.USE_USER_IDM
4933 4934 4935 4936 4937 4938

**参数:**

| 参数名    | 类型                                               | 必填 | 说明                                                |
| -------- | -------------------------------------------------- | ---- | -------------------------------------------------- |
| authType | [AuthType](#authtype8) | 是   | 认证类型。                                          |
J
jidong 已提交
4939 4940 4941 4942 4943
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是   | 回调函数,如果获取成功,err为null,data为当前用户指定类型的所有已注册凭据信息;否则为错误对象。 |

**错误码:**

| 错误码ID | 错误信息               |
J
jidong 已提交
4944 4945 4946 4947
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType. |
| 12300102 | Credential not found. |
4948

4949
**示例:**
4950
  ```js
J
jidong 已提交
4951
  let userIDM = new account_osAccount.UserIdentityManager();
4952 4953 4954 4955 4956 4957 4958 4959
  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));
  }
4960 4961 4962 4963 4964 4965
  ```

### getAuthInfo<sup>8+</sup>

getAuthInfo(authType?: AuthType): Promise&lt;Array&lt;EnrolledCredInfo&gt;&gt;;

J
jidong 已提交
4966
获取认证信息。使用Promise异步回调。
4967

J
jidong 已提交
4968
**系统接口:** 此接口为系统接口。
4969 4970 4971

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

4972
**需要权限:** ohos.permission.USE_USER_IDM
4973 4974 4975 4976 4977

**参数:**

| 参数名    | 类型                                | 必填 | 说明      |
| -------- | ----------------------------------- | ---- | -------- |
J
jidong 已提交
4978
| authType | [AuthType](#authtype8)              | 否   | 认证类型。|
4979 4980 4981

**返回值:**

J
jidong 已提交
4982
| 类型                                         | 说明                                                                     |
J
jidong 已提交
4983
| :------------------------------------------- | :----------------------------------------------------------------------- |
J
jidong 已提交
4984 4985 4986 4987 4988
| Promise&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | Promise对象,返回当前用户指定类型的所有已注册凭据信息。|

**错误码:**

| 错误码ID | 错误信息               |
J
jidong 已提交
4989 4990 4991 4992
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType. |
| 12300102 | Credential not found. |
4993

4994
**示例:**
4995
  ```js
J
jidong 已提交
4996
  let userIDM = new account_osAccount.UserIdentityManager();
4997 4998 4999 5000 5001 5002 5003 5004 5005
  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));
  }
5006 5007 5008 5009 5010 5011
  ```

## IInputData<sup>8+</sup>

密码数据回调。

J
jidong 已提交
5012
**系统接口:** 此接口为系统接口。
5013

5014 5015
### onSetData<sup>8+</sup>

W
wangyihui 已提交
5016
onSetData: (authSubType: AuthSubType, data: Uint8Array) => void;
5017

J
jidong 已提交
5018
**系统接口:** 此接口为系统接口。
5019

5020 5021 5022 5023 5024 5025 5026 5027
通知设置数据。

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

**参数:**

| 参数名      | 类型                                     | 必填 | 说明                                            |
| ---------- | ---------------------------------------- | ---- | ----------------------------------------------- |
W
wangyihui 已提交
5028
| authSubType | [AuthSubType](#authsubtype8)             | 是   | 用于认证的凭据子类型。                            |
5029 5030
| data       | Uint8Array                               | 是   | 要设置的数据是凭据,用来在认证、添加、修改凭据操作。 |

5031
**示例:**
5032
  ```js
J
jidong 已提交
5033 5034 5035
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let passwordNumber = new Uint8Array([1, 2, 3, 4]);
  let inputer = {
W
wangyihui 已提交
5036 5037 5038
    onGetData: (authSubType, callback) => {
        if (authSubType == account_osAccount.AuthSubType.PIN_NUMBER) {
          callback.onSetData(authSubType, passwordNumber);
J
jidong 已提交
5039
        } else {
W
wangyihui 已提交
5040
          callback.onSetData(authSubType, password);
J
jidong 已提交
5041 5042 5043
        }
    }
  };
5044 5045 5046 5047
  ```

## IInputer<sup>8+</sup>

W
wangyihui 已提交
5048
凭据输入器回调。
5049

J
jidong 已提交
5050
**系统接口:** 此接口为系统接口。
5051

5052 5053
### onGetData<sup>8+</sup>

W
wangyihui 已提交
5054
onGetData: (authSubType: AuthSubType, callback: IInputData) => void;
5055 5056 5057

通知获取数据。

J
jidong 已提交
5058
**系统接口:** 此接口为系统接口。
5059

5060 5061 5062 5063 5064 5065
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
5066
| callback   | [IInputData](#iinputdata8)  | 是   | 指示密码数据回调。|
5067

5068
**示例:**
5069
  ```js
J
jidong 已提交
5070 5071 5072
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let passwordNumber = new Uint8Array([1, 2, 3, 4]);
  let inputer = {
W
wangyihui 已提交
5073 5074 5075
    onGetData: (authSubType, callback) => {
        if (authSubType == account_osAccount.AuthSubType.PIN_NUMBER) {
          callback.onSetData(authSubType, passwordNumber);
J
jidong 已提交
5076
        } else {
W
wangyihui 已提交
5077
          callback.onSetData(authSubType, password);
J
jidong 已提交
5078 5079 5080 5081 5082
        }
    }
  };
  let pinAuth = new account_osAccount.PINAuth();
  let result = pinAuth.registerInputer(inputer);
F
fanchenxuan 已提交
5083
  console.log('registerInputer result: ' + result);
5084 5085 5086 5087
  ```

## IUserAuthCallback<sup>8+</sup>

J
jidong 已提交
5088
表示用户认证回调类。
5089

J
jidong 已提交
5090
**系统接口:** 此接口为系统接口。
5091

5092 5093 5094 5095
### onResult<sup>8+</sup>

onResult: (result: number, extraInfo: AuthResult) => void;

J
jidong 已提交
5096
身份认证结果回调函数,返回结果码和认证结果信息。
5097

J
jidong 已提交
5098
**系统接口:** 此接口为系统接口。
5099

5100 5101 5102 5103 5104 5105 5106
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名     | 类型                                    | 必填 | 说明                 |
| --------- | --------------------------------------- | ---- | ------------------- |
| result    | number                                   | 是   | 表示身份认证结果代码。|
5107
| extraInfo | [AuthResult](#authresult8)  | 是   | 表示不同情况下的具体信息,如果认证通过,则在extrainfo中返回认证令牌,如果身份验证失败,则在extrainfo中返回剩余的身份验证时间,如果身份验证执行器被锁定,冻结时间将在extrainfo中返回。|
5108

5109
**示例:**
5110
  ```js
J
jidong 已提交
5111 5112
  let authCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
5113 5114
      console.log('auth result = ' + result);
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
5115 5116
    }
  };
5117 5118 5119 5120 5121 5122
  ```

### onAcquireInfo?<sup>8+</sup>

onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;

J
jidong 已提交
5123
身份认证信息获取回调函数。
5124

J
jidong 已提交
5125
**系统接口:** 此接口为系统接口。
5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136

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

**参数:**

| 参数名    | 类型     | 必填 | 说明                           |
| --------- | ------- | ---- | ----------------------------- |
| module    | number  | 是   | 指示用于身份验证的执行器类型。   |
| acquire   | number  | 是   | 指示不同身份验证执行器的tip代码。|
| extraInfo | any     | 是   | 保留参数。                     |

5137
**示例:**
5138
  ```js
J
jidong 已提交
5139 5140
  let authCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
5141 5142
      console.log('auth result = ' + result)
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
5143 5144
    },
    onAcquireInfo: (module, acquire, extraInfo) => {
F
fanchenxuan 已提交
5145 5146
      console.log('auth module = ' + module);
      console.log('auth acquire = ' + acquire);
J
jidong 已提交
5147 5148 5149
      console.info('auth extraInfo = ' + JSON.stringify(extraInfo));
    }
  };
5150 5151 5152 5153
  ```

## IIdmCallback<sup>8+</sup>

J
jidong 已提交
5154
表示身份管理回调类。
5155

J
jidong 已提交
5156
**系统接口:** 此接口为系统接口。
5157

5158 5159
### onResult<sup>8+</sup>

5160
onResult: (result: number, extraInfo: RequestResult) => void;
5161

J
jidong 已提交
5162
身份管理操作结果回调函数,返回结果码和请求结果信息。
5163

J
jidong 已提交
5164
**系统接口:** 此接口为系统接口。
5165 5166 5167 5168 5169 5170 5171 5172

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

**参数:**

| 参数名     | 类型                                    | 必填 | 说明                     |
| --------- | --------------------------------------- | ---- | ----------------------- |
| result    | number                                  | 是   | 表示身份认证结果代码。    |
5173
| extraInfo | [RequestResult](#requestresult8)  | 是   | 针对不同情况传递具体信息。|
5174

5175
**示例:**
5176
  ```js
F
fanchenxuan 已提交
5177
  let idmCallback = {
J
jidong 已提交
5178
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
5179
      console.log('callback result = ' + result)
J
jidong 已提交
5180 5181 5182
      console.info('callback extraInfo = ' + JSON.stringify(extraInfo));
    }
  };
5183 5184 5185 5186 5187 5188
  ```

### onAcquireInfo?<sup>8+</sup>

onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;

J
jidong 已提交
5189
身份管理信息获取回调函数。
5190

J
jidong 已提交
5191
**系统接口:** 此接口为系统接口。
5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202

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

**参数:**

| 参数名    | 类型     | 必填 | 说明                           |
| --------- | ------- | ---- | ----------------------------- |
| module    | number  | 是   | 指示用于身份验证的执行器类型。   |
| acquire   | number  | 是   | 指示不同身份验证执行器的tip代码。|
| extraInfo | any     | 是   | 保留参数。                     |

5203
**示例:**
5204
  ```js
J
jidong 已提交
5205 5206
  let idmCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
5207 5208
      console.log('callback result = ' + result)
      console.log('callback onResult = ' + JSON.stringify(extraInfo));
J
jidong 已提交
5209 5210
    },
    onAcquireInfo: (module, acquire, extraInfo) => {
F
fanchenxuan 已提交
5211 5212
      console.log('callback module = ' + module);
      console.log('callback acquire = ' + acquire);
J
jidong 已提交
5213 5214 5215
      console.log('callback onacquireinfo = ' + JSON.stringify(extraInfo));
    }
  };
5216 5217 5218 5219 5220 5221
  ```

## GetPropertyRequest<sup>8+</sup>

提供获取属性请求的信息。

J
jidong 已提交
5222
**系统接口:** 此接口为系统接口。
5223

5224 5225
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5226
| 名称    | 类型                                                          | 必填   | 说明                   |
5227
| -------- | ------------------------------------------------------------- | ----- | ----------------------- |
5228 5229
| authType | [AuthType](#authtype8)                            | 是    | 身份验证凭据类型。        |
| keys     | Array&lt;[GetPropertyType](#getpropertytype8)&gt; | 是    | 指示要获取的属性类型数组。 |
5230 5231 5232 5233 5234

## SetPropertyRequest<sup>8+</sup>

提供设置属性请求的信息。

J
jidong 已提交
5235
**系统接口:** 此接口为系统接口。
5236

5237 5238
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5239
| 名称    | 类型                                             | 必填   | 说明                 |
5240
| -------- | ------------------------------------------------ | ----- | -------------------- |
5241 5242
| authType | [AuthType](#authtype8)               | 是    | 身份验证凭据类型。     |
| key     | [SetPropertyType](#setpropertytype8) | 是    | 指示要设置的属性类型。 |
5243 5244 5245 5246 5247 5248
| setInfo  | Uint8Array                                       | 是    | 指示要设置的信息。     |

## ExecutorProperty<sup>8+</sup>

提供执行器的属性。

J
jidong 已提交
5249
**系统接口:** 此接口为系统接口。
5250

5251 5252
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5253
| 名称        | 类型                                     | 必填   | 说明              |
5254 5255
| ------------ | ---------------------------------------- | ----- | ----------------- |
| result       | number                                   | 是    | 指示结果。         |
5256
| authSubType  | [AuthSubType](#authsubtype8) | 是    | 指示认证凭据子类型。|
5257 5258 5259 5260 5261
| remainTimes  | number                                   | 否    | 指示剩余时间。     |
| freezingTime | number                                   | 否    | 指示冻结时间。     |

## AuthResult<sup>8+</sup>

J
jidong 已提交
5262
表示认证结果的信息。
5263

J
jidong 已提交
5264
**系统接口:** 此接口为系统接口。
5265

5266 5267
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5268
| 名称        | 类型        | 必填   | 说明              |
5269 5270 5271 5272 5273 5274 5275
| ------------ | ----------- | ----- | ----------------- |
| token        | Uint8Array  | 否    | 指示认证令牌。     |
| remainTimes  | number      | 否    | 指示剩余时间。     |
| freezingTime | number      | 否    | 指示冻结时间。     |

## CredentialInfo<sup>8+</sup>

J
jidong 已提交
5276
表示凭证信息。
5277

J
jidong 已提交
5278
**系统接口:** 此接口为系统接口。
5279

5280 5281
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5282
| 名称        | 类型                                     | 必填   | 说明              |
5283
| ------------ | ---------------------------------------- | ----- | ----------------- |
5284 5285
| credType     | [AuthType](#authtype8)       | 是    | 指示凭据类型。     |
| credSubType  | [AuthSubType](#authsubtype8) | 是    | 指示凭据子类型。   |
J
jidong 已提交
5286
| token        | Uint8Array                           | 是    | 指示认证令牌。     |
5287 5288 5289

## RequestResult<sup>8+</sup>

J
jidong 已提交
5290
表示请求结果的信息。
5291

J
jidong 已提交
5292
**系统接口:** 此接口为系统接口。
5293

5294 5295
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5296
| 名称        | 类型        | 必填   | 说明              |
5297 5298 5299 5300 5301
| ------------ | ----------- | ----- | ----------------- |
| credentialId | Uint8Array  | 否    | 指示凭据索引。     |

## EnrolledCredInfo<sup>8+</sup>

J
jidong 已提交
5302
表示已注册凭据的信息。
5303

J
jidong 已提交
5304
**系统接口:** 此接口为系统接口。
5305

5306 5307
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5308
| 名称        | 类型                                     | 必填   | 说明              |
5309 5310
| ------------ | ---------------------------------------- | ----- | ------------------- |
| credentialId | Uint8Array                               | 是    | 指示凭据索引。       |
5311 5312
| authType     | [AuthType](#authtype8)       | 是    | 指示认证凭据类型。   |
| authSubType  | [AuthSubType](#authsubtype8) | 是    | 指示认证凭据子类型。 |
5313 5314 5315 5316
| templateId   | Uint8Array                               | 是    | 指示凭据模板ID。     |

## GetPropertyType<sup>8+</sup>

J
jidong 已提交
5317
表示要获取的属性类型的枚举。
5318

J
jidong 已提交
5319
**系统接口:** 此接口为系统接口。
5320

5321 5322
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5323
| 名称           | 值 | 说明      |
5324 5325 5326 5327 5328 5329 5330
| ------------- | ------ | --------- |
| AUTH_SUB_TYPE | 1      | 认证子类型。 |
| REMAIN_TIMES  | 2      | 剩余时间。   |
| FREEZING_TIME | 3      | 冻结时间。   |

## SetPropertyType<sup>8+</sup>

J
jidong 已提交
5331
表示要设置的属性类型的枚举。
5332

J
jidong 已提交
5333
**系统接口:** 此接口为系统接口。
5334

5335 5336
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5337
| 名称           | 值 | 说明        |
5338 5339 5340 5341 5342
| -------------- | ----- | ----------- |
| INIT_ALGORITHM | 1     | 初始化算法。 |

## AuthType<sup>8+</sup>

J
jidong 已提交
5343
表示身份验证的凭据类型的枚举。
5344

J
jidong 已提交
5345
**系统接口:** 此接口为系统接口。
5346

5347 5348
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5349
| 名称  | 值 | 说明             |
5350
| ----- | ----- | ---------------- |
W
wangyihui 已提交
5351 5352 5353 5354
| PIN   | 1     | 表示PIN认证类型。 |
| FACE  | 2     | 表示脸部认证类型。|
| FINGERPRINT<sup>10+</sup>   | 4     | 表示指纹认证类型。 |
| DOMAIN<sup>10+</sup>  | 1024     | 表示域认证类型。|
5355 5356 5357

## AuthSubType<sup>8+</sup>

J
jidong 已提交
5358
表示用于认证的凭据子类型的枚举。
5359

J
jidong 已提交
5360
**系统接口:** 此接口为系统接口。
5361

5362 5363
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5364
| 名称       | 值 | 说明               |
5365 5366 5367 5368
| ---------- | ----- | ------------------ |
| PIN_SIX    | 10000 | 表示6位凭证。       |
| PIN_NUMBER | 10001 | 表示自定义数字凭证。 |
| PIN_MIXED  | 10002 | 表示自定义混合凭据。 |
W
wangyihui 已提交
5369 5370 5371
| FACE_2D    | 20000 | 表示2D 人脸凭证。   |
| FACE_3D    | 20001 | 表示3D 人脸凭证。   |
| DOMAIN_MIXED<sup>10+</sup>    | 10240001 | 表示域认证混合凭证。   |
5372 5373 5374

## AuthTrustLevel<sup>8+</sup>

J
jidong 已提交
5375
表示认证结果的受信任级别的枚举。
5376

J
jidong 已提交
5377
**系统接口:** 此接口为系统接口。
5378

5379 5380
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5381
| 名称  | 值 | 说明        |
5382 5383 5384 5385 5386 5387 5388 5389
| ---- | ------ | ----------- |
| ATL1 | 10000  | 信任级别 1。 |
| ATL2 | 20000  | 信任级别 2。 |
| ATL3 | 30000  | 信任级别 3。 |
| ATL4 | 40000  | 信任级别 4。 |

## Module<sup>8+</sup>

J
jidong 已提交
5390
表示获取信息的模块的枚举。
5391

J
jidong 已提交
5392
**系统接口:** 此接口为系统接口。
5393

5394 5395
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5396
| 名称       | 值 | 说明                     |
5397 5398 5399 5400 5401
| --------- | ------ | ------------------------ |
| FACE_AUTH | 1      | 表示从人脸认证获取的信息。 |

## ResultCode<sup>8+</sup>

J
jidong 已提交
5402
表示身份验证结果码。
5403

J
jidong 已提交
5404
**系统接口:** 此接口为系统接口。
5405

5406 5407
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5408
| 名称                    | 值 | 说明                                     |
5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423
| ----------------------- | ----- | ---------------------------------------- |
| 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 已提交
5424
表示人脸验证过程中提示的枚举。
5425

J
jidong 已提交
5426
**系统接口:** 此接口为系统接口。
5427

5428 5429
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5430
| 名称                          | 值 | 说明                                     |
5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443
| ----------------------------- | ----- | ---------------------------------------- |
| 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 已提交
5444
## FingerprintTips<sup>8+</sup>
5445

J
jidong 已提交
5446
表示指纹身份验证过程中提示的枚举。
5447

J
jidong 已提交
5448
**系统接口:** 此接口为系统接口。
5449

5450 5451
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

5452
| 名称                          | 值 | 说明                                            |
5453 5454 5455 5456 5457 5458 5459 5460
| ----------------------------- | ----- | ----------------------------------------------- |
| 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 已提交
5461
## OsAccountInfo
Z
zengyawen 已提交
5462

J
jidong 已提交
5463
表示系统帐号信息。
Z
zengyawen 已提交
5464 5465 5466

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

5467
| 名称                         | 类型                                                         | 必填 | 说明                              |
Z
zengyawen 已提交
5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480
| ------------------------------ | ------------------------------------------------------------ | ---- | --------------------------------- |
| 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) | 否   | 分布式帐号信息                    |
5481
| domainInfo<sup>8+</sup>        | [DomainAccountInfo](#domainaccountinfo8)                      | 否   | 域帐号信息                        |
Z
zengyawen 已提交
5482 5483

## DomainAccountInfo<sup>8+</sup>
Z
zengyawen 已提交
5484

J
jidong 已提交
5485
表示域帐号信息。
Z
zengyawen 已提交
5486 5487 5488

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

5489
| 名称      | 类型   | 必填 | 说明       |
Z
zengyawen 已提交
5490 5491 5492
| ----------- | ------ | ---- | ---------- |
| domain      | string | 是   | 域名。     |
| accountName | string | 是   | 域帐号名。 |
Z
zhangalong 已提交
5493 5494 5495

## 系统帐号约束列表

Z
zengyawen 已提交
5496 5497
| 约束                                  | 说明                           |
| ------------------------------------- | ------------------------------ |
Z
zengyawen 已提交
5498 5499
| constraint.wifi                       | 禁止使用Wi-Fi                  |
| constraint.wifi.set                   | 禁止配置Wi-Fi                  |
Z
zengyawen 已提交
5500 5501 5502 5503 5504 5505
| constraint.locale.set                 | 禁止配置设备语言               |
| constraint.app.accounts               | 禁止添加和删除应用帐号         |
| constraint.apps.install               | 禁止安装应用                   |
| constraint.apps.uninstall             | 禁止卸载应用                   |
| constraint.location.shared            | 禁止打开位置共享               |
| constraint.unknown.sources.install    | 禁止安装未知来源的应用         |
Z
zhangalong 已提交
5506
| constraint.global.unknown.app.install | 禁止所有用户安装未知来源的应用 |
Z
zengyawen 已提交
5507 5508
| constraint.bluetooth.set              | 禁止配置蓝牙                   |
| constraint.bluetooth | 禁止使用蓝牙 |
Z
zhangalong 已提交
5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527
| 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 已提交
5528 5529
| constraint.microphone.unmute | 禁止取消麦克风静音 |
| constraint.volume.adjust | 禁止调整音量 |
Z
zhangalong 已提交
5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546
| 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 已提交
5547
| constraint.device.unmute | 禁止取消设备静音 |
Z
zhangalong 已提交
5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559
| 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 | 禁止打印 |
5560 5561 5562 5563
| constraint.private.dns.set | 禁止配置专用DNS |

## ConstraintSourceTypeInfo<sup>9+</sup>

J
jidong 已提交
5564
表示约束来源类型信息。
5565

J
jidong 已提交
5566
**系统接口:** 此接口为系统接口。
J
jidong 已提交
5567

5568 5569
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

5570
| 名称      | 类型   | 必填 | 说明       |
5571 5572 5573 5574 5575 5576
| ----------- | ------ | ---- | ---------- |
| localId      | number | 是   | 系统帐号ID     |
| type | [ConstraintSourceType](#constraintsourcetype) | 是   | 约束来源类型 |

## ConstraintSourceType<sup>9+</sup>

J
jidong 已提交
5577
表示约束来源类型的枚举。
5578

J
jidong 已提交
5579
**系统接口:** 此接口为系统接口。
J
jidong 已提交
5580

5581 5582
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

5583
| 名称   | 值 | 说明         |
5584 5585 5586 5587 5588
| ------ | ------ | ------------ |
| CONSTRAINT_NOT_EXIST  | 0      | 约束不存在 |
| CONSTRAINT_TYPE_BASE | 1      | 约束源自系统设置   |
| CONSTRAINT_TYPE_DEVICE_OWNER  | 2   | 约束源自设备所有者设置   |
| CONSTRAINT_TYPE_PROFILE_OWNER  | 3  | 约束源自资料所有者设置   |