js-apis-osAccount.md 127.4 KB
Newer Older
Z
zhangalong 已提交
1 2
#    系统帐号管理

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

Z
zhangalong 已提交
5 6 7 8 9 10
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

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

## account_osAccount.getAccountManager

getAccountManager(): AccountManager

获取系统帐号能力的实例。

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

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

Z
zengyawen 已提交
25 26 27 28 29
| 类型                              | 说明                     |
| --------------------------------- | ------------------------ |
| [AccountManager](#accountmanager) | 获取系统帐号能力的实例。 |

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

## OsAccountType
Z
zengyawen 已提交
35

Z
zhangalong 已提交
36
枚举,系统帐号类型。
Z
zengyawen 已提交
37 38 39 40 41 42 43 44

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

| 参数   | 默认值 | 说明         |
| ------ | ------ | ------------ |
| ADMIN  | 0      | 管理员帐号。 |
| NORMAL | 1      | 普通帐号。   |
| GUEST  | 2      | 访客帐号。   |
Z
zhangalong 已提交
45 46 47 48 49 50 51 52 53 54 55

## AccountManager

管理系统帐号能力的类。

### activateOsAccount

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

激活指定系统帐号,使用callback回调异步返回结果。

Z
zengyawen 已提交
56 57
此接口为系统接口,三方应用不支持调用。

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

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

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

Z
zengyawen 已提交
64 65 66 67 68 69
| 参数名   | 类型                      | 必填 | 说明                 |
| -------- | ------------------------- | ---- | -------------------- |
| localId  | number                    | 是   | 要激活的系统帐号ID。 |
| callback | AsyncCallback<void> | 是   | 回调结果。           |

**示例:**激活ID为100的系统帐号
Z
zhangalong 已提交
70
  ```js
F
fanchenxuan 已提交
71 72
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
73
  accountManager.activateOsAccount(localId, (err)=>{
F
fanchenxuan 已提交
74
    console.log('activateOsAccount err:' + JSON.stringify(err));
Z
zhangalong 已提交
75 76 77 78 79 80 81 82 83
  });
  ```

### activateOsAccount

activateOsAccount(localId: number): Promise<void>

激活指定系统帐号,使用Promise方式异步返回结果。

Z
zengyawen 已提交
84 85
此接口为系统接口,三方应用不支持调用。

Z
zhangalong 已提交
86 87
**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

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

Z
zengyawen 已提交
90
**参数:**
Z
zhangalong 已提交
91

Z
zengyawen 已提交
92 93 94
| 参数名  | 类型   | 必填 | 说明                 |
| ------- | ------ | ---- | -------------------- |
| localId | number | 是   | 要激活的系统帐号ID。 |
Z
zhangalong 已提交
95

Z
zengyawen 已提交
96
**返回值:**
Z
zhangalong 已提交
97

Z
zengyawen 已提交
98 99 100 101 102
| 类型                | 说明                                |
| :------------------ | :---------------------------------- |
| Promise<void> | Promise实例,用于获取异步返回结果。 |

**示例:**激活ID为100的系统帐号
Z
zhangalong 已提交
103
  ```js
F
fanchenxuan 已提交
104 105
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
106
  accountManager.activateOsAccount(localId).then(() => {
F
fanchenxuan 已提交
107
    console.log('activateOsAccount success');
Z
zhangalong 已提交
108
  }).catch((err) => {
F
fanchenxuan 已提交
109
    console.log('activateOsAccount err:' + JSON.stringify(err));
Z
zhangalong 已提交
110 111 112 113 114 115 116 117 118
  });
  ```

### isMultiOsAccountEnable

isMultiOsAccountEnable(callback: AsyncCallback<boolean>): void

判断是否支持多系统帐号,使用callback回调异步返回结果。

Z
zengyawen 已提交
119 120 121
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
123 124 125
| 参数名   | 类型                         | 必填 | 说明                                                |
| -------- | ---------------------------- | ---- | --------------------------------------------------- |
| callback | AsyncCallback<boolean> | 是   | 回调结果,支持多系统帐号则返回true,否则返回false。 |
Z
zhangalong 已提交
126

Z
zengyawen 已提交
127
**示例:**
Z
zhangalong 已提交
128

Z
zhangalong 已提交
129
  ```js
F
fanchenxuan 已提交
130
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
131
  accountManager.isMultiOsAccountEnable((err, isEnabled) => {
F
fanchenxuan 已提交
132
    console.log('isMultiOsAccountEnable err: ' + JSON.stringify(err));
Z
zhangalong 已提交
133 134 135 136 137 138 139 140 141 142
    console.log('isMultiOsAccountEnable isEnabled: ' + isEnabled);
  });
  ```

### isMultiOsAccountEnable

isMultiOsAccountEnable(): Promise<boolean>

判断是否支持多系统帐号,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
145
**返回值:**
Z
zhangalong 已提交
146

Z
zengyawen 已提交
147 148 149 150 151
| 类型                   | 说明                                                         |
| :--------------------- | :----------------------------------------------------------- |
| Promise<boolean> | Promise实例,用于获取异步返回结果,支持多系统帐号则返回true,否则返回false。 |

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

Z
zhangalong 已提交
153
  ```js
F
fanchenxuan 已提交
154
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
155 156 157
  accountManager.isMultiOsAccountEnable().then((isEnabled) => {
    console.log('isMultiOsAccountEnable, isEnabled: ' + isEnabled);
  }).catch((err) => {
F
fanchenxuan 已提交
158
    console.log('isMultiOsAccountEnable err: '  + JSON.stringify(err));
Z
zhangalong 已提交
159 160 161 162 163 164 165 166 167
  });
  ```

### isOsAccountActived

isOsAccountActived(localId: number, callback: AsyncCallback<boolean>): void

判断指定系统帐号是否处于激活状态,使用callback回调异步返回结果。

Z
zhangalong 已提交
168
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
Z
zengyawen 已提交
169 170

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

Z
zengyawen 已提交
172
**参数:**
Z
zhangalong 已提交
173

Z
zengyawen 已提交
174 175 176 177 178 179
| 参数名   | 类型                         | 必填 | 说明                                              |
| -------- | ---------------------------- | ---- | ------------------------------------------------- |
| localId  | number                       | 是   | 系统帐号ID。                                      |
| callback | AsyncCallback<boolean> | 是   | 回调结果,处于激活状态则返回true,否则返回false。 |

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

Z
zhangalong 已提交
181
  ```js
F
fanchenxuan 已提交
182 183
  let accountManager = account_osAccount.getAccountManager();
  let osLocalId = 100;
Z
zhangalong 已提交
184
  accountManager.isOsAccountActived(osLocalId, (err, isActive)=>{
F
fanchenxuan 已提交
185 186
    console.log('isOsAccountActived err:' + JSON.stringify(err));
    console.log('isOsAccountActived isActive:' + isActive);
Z
zhangalong 已提交
187 188 189 190 191 192 193 194 195
  });
  ```

### isOsAccountActived

isOsAccountActived(localId: number): Promise<boolean>

判断指定系统帐号是否处于激活状态,使用Promise方式异步返回结果。

Z
zhangalong 已提交
196
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
Z
zengyawen 已提交
197 198 199 200

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

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

Z
zengyawen 已提交
202 203 204
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
205

Z
zengyawen 已提交
206
**返回值:**
Z
zhangalong 已提交
207

Z
zengyawen 已提交
208 209 210
| 类型                   | 说明                                                         |
| :--------------------- | :----------------------------------------------------------- |
| Promise<boolean> | Promise实例,用于获取异步返回结果,处于激活状态则返回true,否则返回false。 |
Z
zhangalong 已提交
211

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

Z
zhangalong 已提交
214
  ```js
F
fanchenxuan 已提交
215 216
  let accountManager = account_osAccount.getAccountManager();
  let osLocalId = 100;
Z
zhangalong 已提交
217 218 219
  accountManager.isOsAccountActived(osLocalId).then((isActive) => {
    console.log('isOsAccountActived, isActive: ' + isActive);
  }).catch((err) => {
F
fanchenxuan 已提交
220
    console.log('isOsAccountActived err: '  + JSON.stringify(err));
Z
zhangalong 已提交
221 222 223 224 225 226 227
  });
  ```

### isOsAccountConstraintEnable

isOsAccountConstraintEnable(localId: number, constraint: string, callback: AsyncCallback<boolean>): void

Z
zengyawen 已提交
228
判断指定系统帐号是否具有指定约束,使用callback回调异步返回结果。
Z
zhangalong 已提交
229

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

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

Z
zengyawen 已提交
234 235 236 237 238 239 240 241 242
**参数:**

| 参数名     | 类型                         | 必填 | 说明                                              |
| ---------- | ---------------------------- | ---- | ------------------------------------------------- |
| localId    | number                       | 是   | 指定的系统帐号ID。                                |
| constraint | string                       | 是   | 指定的[约束](#系统帐号约束列表)名称。             |
| callback   | AsyncCallback<boolean> | 是   | 回调结果,具有指定约束则返回true,否则返回false。 |

**示例:**判断ID为100的系统帐号是否有禁止使用wifi的约束
Z
zhangalong 已提交
243

Z
zhangalong 已提交
244
  ```js
F
fanchenxuan 已提交
245 246 247 248 249
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  accountManager.isOsAccountConstraintEnable(localId, 'constraint.wifi', (err, isConstraintEnabled)=>{
    console.log('isOsAccountConstraintEnable err:' + JSON.stringify(err));
    console.log('isOsAccountConstraintEnable isConstraintEnabled:' + isConstraintEnabled);
Z
zhangalong 已提交
250 251 252 253 254 255 256
  });
  ```

### isOsAccountConstraintEnable

isOsAccountConstraintEnable(localId: number, constraint: string): Promise<boolean>

Z
zengyawen 已提交
257 258 259 260 261
判断指定系统帐号是否具有指定约束,使用Promise方式异步返回结果。

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

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

Z
zengyawen 已提交
263
**参数:**
Z
zhangalong 已提交
264

Z
zengyawen 已提交
265 266 267 268
| 参数名     | 类型   | 必填 | 说明                                  |
| ---------- | ------ | ---- | ------------------------------------- |
| localId    | number | 是   | 指定的系统帐号ID。                    |
| constraint | string | 是   | 指定的[约束](#系统帐号约束列表)名称。 |
Z
zhangalong 已提交
269

Z
zengyawen 已提交
270
**返回值:**
Z
zhangalong 已提交
271

Z
zengyawen 已提交
272 273 274
| 类型                   | 说明                                                         |
| :--------------------- | :----------------------------------------------------------- |
| Promise<boolean> | Promise实例,用于获取异步返回结果,具有指定约束则返回true,否则返回false。 |
Z
zhangalong 已提交
275

Z
zengyawen 已提交
276
**示例:**判断ID为100的系统帐号是否有禁止使用wifi的约束
Z
zhangalong 已提交
277

Z
zhangalong 已提交
278
  ```js
F
fanchenxuan 已提交
279 280 281
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  accountManager.isOsAccountConstraintEnable(localId, 'constraint.wifi').then((isConstraintEnabled) => {
Z
zhangalong 已提交
282 283
    console.log('isOsAccountConstraintEnable, isConstraintEnabled: ' + isConstraintEnabled);
  }).catch((err) => {
F
fanchenxuan 已提交
284
    console.log('isOsAccountConstraintEnable err: '  + JSON.stringify(err));
Z
zhangalong 已提交
285 286 287 288 289 290 291 292 293
  });
  ```

### isTestOsAccount

isTestOsAccount(callback: AsyncCallback<boolean>): void

检查当前系统帐号是否为测试帐号,使用callback回调异步返回结果。

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

Z
zengyawen 已提交
296
**参数:**
Z
zhangalong 已提交
297

Z
zengyawen 已提交
298 299 300 301 302
| 参数名   | 类型                         | 必填 | 说明                                            |
| -------- | ---------------------------- | ---- | ----------------------------------------------- |
| callback | AsyncCallback<boolean> | 是   | 回调结果,是测试帐号则返回true,否则返回false。 |

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

Z
zhangalong 已提交
304
  ```js
F
fanchenxuan 已提交
305
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
306
  accountManager.isTestOsAccount((err, isTest) => {
F
fanchenxuan 已提交
307
    console.log('isTestOsAccount err: ' + JSON.stringify(err));
Z
zhangalong 已提交
308 309 310 311 312 313 314 315 316 317
    console.log('isTestOsAccount isTest: ' + isTest);
  });
  ```

### isTestOsAccount

isTestOsAccount(): Promise<boolean>

检查当前系统帐号是否为测试帐号,使用Promise方式异步返回结果。

Z
zengyawen 已提交
318 319 320
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
322 323 324
| 类型                   | 说明                                                         |
| :--------------------- | :----------------------------------------------------------- |
| Promise<boolean> | Promise实例,用于获取异步返回结果,是测试帐号则返回true,否则返回false。 |
Z
zhangalong 已提交
325

Z
zengyawen 已提交
326
**示例:**
Z
zhangalong 已提交
327

Z
zhangalong 已提交
328
  ```js
F
fanchenxuan 已提交
329
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
330 331 332
  accountManager.isTestOsAccount().then((isTest) => {
    console.log('isTestOsAccount, isTest: ' + isTest);
  }).catch((err) => {
F
fanchenxuan 已提交
333
    console.log('isTestOsAccount err: '  + JSON.stringify(err));
Z
zhangalong 已提交
334 335 336 337 338 339 340 341 342
  });
  ```

### isOsAccountVerified

isOsAccountVerified(callback: AsyncCallback<boolean>): void

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

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

Z
zengyawen 已提交
345
**参数:**
Z
zhangalong 已提交
346

Z
zengyawen 已提交
347 348 349 350 351
| 参数名   | 类型                         | 必填 | 说明                                        |
| -------- | ---------------------------- | ---- | ------------------------------------------- |
| callback | AsyncCallback<boolean> | 是   | 回调结果,已验证则返回true,否则返回false。 |

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

Z
zhangalong 已提交
353
  ```js
F
fanchenxuan 已提交
354
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
355
  accountManager.isOsAccountVerified((err, isVerified) => {
F
fanchenxuan 已提交
356
    console.log('isOsAccountVerified err: ' + JSON.stringify(err));
Z
zhangalong 已提交
357 358 359 360 361 362 363 364 365 366
    console.log('isOsAccountVerified isVerified: ' + isVerified);
  });
  ```

### isOsAccountVerified

isOsAccountVerified(localId: number, callback: AsyncCallback<boolean>): void

检查指定系统帐号是否已验证,使用callback回调异步返回结果。

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

Z
zengyawen 已提交
369 370 371
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
373 374 375 376
| 参数名   | 类型                         | 必填 | 说明                                        |
| -------- | ---------------------------- | ---- | ------------------------------------------- |
| localId  | number                       | 否   | 指定的系统帐号ID。                          |
| callback | AsyncCallback<boolean> | 是   | 回调结果,已验证则返回true,否则返回false。 |
Z
zhangalong 已提交
377

Z
zengyawen 已提交
378
**示例:**
Z
zhangalong 已提交
379

Z
zhangalong 已提交
380
  ```js
F
fanchenxuan 已提交
381
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
382
  accountManager.isOsAccountVerified((err, isVerified) => {
F
fanchenxuan 已提交
383
    console.log('isOsAccountVerified err: ' + JSON.stringify(err));
Z
zhangalong 已提交
384 385 386 387 388 389
    console.log('isOsAccountVerified isVerified: ' + isVerified);
  });
  ```

### isOsAccountVerified

Z
zengyawen 已提交
390
isOsAccountVerified(localId?: number): Promise<boolean>
Z
zhangalong 已提交
391 392 393

检查指定系统帐号是否已验证,使用Promise方式异步返回结果。

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

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

Z
zengyawen 已提交
398
**参数:**
Z
zhangalong 已提交
399

Z
zengyawen 已提交
400 401 402
| 参数名  | 类型   | 必填 | 说明               |
| ------- | ------ | ---- | ------------------ |
| localId | number | 否   | 指定的系统帐号ID。 |
Z
zhangalong 已提交
403

Z
zengyawen 已提交
404
**返回值:**
Z
zhangalong 已提交
405

Z
zengyawen 已提交
406 407 408 409 410
| 类型                   | 说明                                                         |
| :--------------------- | :----------------------------------------------------------- |
| Promise<boolean> | Promise实例,用于获取异步返回结果,已验证则返回true,否则返回false。 |

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

Z
zhangalong 已提交
412
  ```js
F
fanchenxuan 已提交
413
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
414 415 416
  accountManager.isOsAccountVerified().then((isVerified) => {
    console.log('isOsAccountVerified, isVerified: ' + isVerified);
  }).catch((err) => {
F
fanchenxuan 已提交
417
    console.log('isOsAccountVerified err: '  + JSON.stringify(err));
Z
zhangalong 已提交
418 419 420 421 422 423 424 425 426
  });
  ```

### removeOsAccount

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

删除指定系统帐号,使用callback回调异步返回结果。

Z
zengyawen 已提交
427 428 429 430 431 432 433
此接口为系统接口,三方应用不支持调用。

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

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

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

Z
zengyawen 已提交
435 436 437 438
| 参数名   | 类型                      | 必填 | 说明                 |
| -------- | ------------------------- | ---- | -------------------- |
| localId  | number                    | 是   | 要删除的系统帐号ID。 |
| callback | AsyncCallback<void> | 是   | 回调结果。           |
Z
zhangalong 已提交
439

Z
zengyawen 已提交
440
**示例:**
Z
zhangalong 已提交
441

Z
zhangalong 已提交
442
  ```js
F
fanchenxuan 已提交
443 444
  let accountManager = account_osAccount.getAccountManager();
  accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo) => {
J
jidong 已提交
445
    accountManager.removeOsAccount(osAccountInfo.localId, (err)=>{
F
fanchenxuan 已提交
446
      console.log('removeOsAccount err:' + JSON.stringify(err));
J
jidong 已提交
447
    });
Z
zhangalong 已提交
448 449 450 451 452 453 454 455 456
  });
  ```

### removeOsAccount

removeOsAccount(localId: number): Promise<void>

删除指定系统帐号,使用Promise方式异步返回结果。

Z
zengyawen 已提交
457 458 459 460 461 462 463
此接口为系统接口,三方应用不支持调用。

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

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

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

Z
zengyawen 已提交
465 466 467
| 参数名  | 类型   | 必填 | 说明                 |
| ------- | ------ | ---- | -------------------- |
| localId | number | 是   | 要删除的系统帐号ID。 |
Z
zhangalong 已提交
468

Z
zengyawen 已提交
469
**返回值:**
Z
zhangalong 已提交
470

Z
zengyawen 已提交
471 472 473
| 类型                | 说明                                |
| :------------------ | :---------------------------------- |
| Promise<void> | Promise实例,用于获取异步返回结果。 |
Z
zhangalong 已提交
474

Z
zengyawen 已提交
475
**示例:**
Z
zhangalong 已提交
476

Z
zhangalong 已提交
477
  ```js
F
fanchenxuan 已提交
478 479
  let accountManager = account_osAccount.getAccountManager();
  accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{
J
jidong 已提交
480 481 482
    accountManager.removeOsAccount(osAccountInfo.localId).then(() => {
      console.log('removeOsAccount Success');
    }).catch(() => {
F
fanchenxuan 已提交
483
      console.log('removeOsAccount err: '  + JSON.stringify(err));
J
jidong 已提交
484
    });
Z
zhangalong 已提交
485 486 487 488 489 490 491
  });
  ```

### setOsAccountConstraints

setOsAccountConstraints(localId: number, constraints: Array<string>, enable: boolean,callback: AsyncCallback<void>): void

Z
zengyawen 已提交
492
为指定系统帐号设置/删除约束,使用callback回调异步返回结果。
Z
zhangalong 已提交
493

Z
zengyawen 已提交
494
此接口为系统接口,三方应用不支持调用。
Z
zhangalong 已提交
495

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

Z
zengyawen 已提交
498 499 500 501 502 503 504 505 506 507 508 509
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                      | 必填 | 说明                                         |
| ----------- | ------------------------- | ---- | -------------------------------------------- |
| localId     | number                    | 是   | 系统帐号ID。                                 |
| constraints | Array<string>       | 是   | 待设置/删除的[约束](#系统帐号约束列表)列表。 |
| enable      | boolean                   | 是   | 设置(true)/删除(false)                       |
| callback    | AsyncCallback<void> | 是   | 回调结果。                                   |

**示例:**给ID为100的系统帐号设置禁止使用wifi的约束
Z
zhangalong 已提交
510

Z
zhangalong 已提交
511
  ```js
F
fanchenxuan 已提交
512 513 514 515
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  accountManager.setOsAccountConstraints(localId, ['constraint.wifi'], true, (err)=>{
    console.log('setOsAccountConstraints err:' + JSON.stringify(err));
Z
zhangalong 已提交
516 517 518 519 520 521 522
  });
  ```

### setOsAccountConstraints

setOsAccountConstraints(localId: number, constraints: Array<string>, enable: boolean): Promise<void>

Z
zengyawen 已提交
523
为指定系统帐号设置/删除约束,使用Promise方式异步返回结果。
Z
zengyawen 已提交
524 525

此接口为系统接口,三方应用不支持调用。
Z
zhangalong 已提交
526

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

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

Z
zengyawen 已提交
531
**参数:**
Z
zhangalong 已提交
532

Z
zengyawen 已提交
533 534 535 536 537
| 参数名      | 类型                | 必填 | 说明                                         |
| ----------- | ------------------- | ---- | -------------------------------------------- |
| localId     | number              | 是   | 系统帐号ID。                                 |
| constraints | Array<string> | 是   | 待设置/删除的[约束](#系统帐号约束列表)列表。 |
| enable      | boolean             | 是   | 设置(true)/删除(false)。                     |
Z
zhangalong 已提交
538

Z
zengyawen 已提交
539 540 541 542 543 544 545
**返回值:**

| 类型                | 说明                                |
| :------------------ | :---------------------------------- |
| Promise<void> | Promise实例,用于获取异步返回结果。 |

**示例:**删除ID为100的系统帐号的禁止使用wifi的约束
Z
zhangalong 已提交
546

Z
zhangalong 已提交
547
  ```js
F
fanchenxuan 已提交
548 549 550
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  accountManager.setOsAccountConstraints(localId, ['constraint.location.set'], false).then(() => {
Z
zhangalong 已提交
551 552
    console.log('setOsAccountConstraints Success');
  }).catch((err) => {
F
fanchenxuan 已提交
553
    console.log('setOsAccountConstraints err: '  + JSON.stringify(err));
Z
zhangalong 已提交
554 555 556 557 558 559 560 561 562
  });
  ```

### setOsAccountName

setOsAccountName(localId: number, localName: string, callback: AsyncCallback<void>): void

设置指定系统帐号的帐号名,使用callback回调异步返回结果。

Z
zengyawen 已提交
563 564
此接口为系统接口,三方应用不支持调用。

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

Z
zengyawen 已提交
567 568 569
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
571 572 573 574 575
| 参数名    | 类型                      | 必填 | 说明         |
| :-------- | ------------------------- | ---- | ------------ |
| localId   | number                    | 是   | 系统帐号ID。 |
| localName | string                    | 是   | 帐号名。     |
| callback  | AsyncCallback<void> | 是   | 回调结果。   |
Z
zhangalong 已提交
576

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

Z
zhangalong 已提交
579
  ```js
F
fanchenxuan 已提交
580 581 582
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  let newName = 'demoName';
Z
zhangalong 已提交
583
  accountManager.setOsAccountName(localId, newName, (err)=>{
F
fanchenxuan 已提交
584
    console.debug('setOsAccountName err:' + JSON.stringify(err));
Z
zhangalong 已提交
585 586 587 588 589 590 591 592 593
  });
  ```

### setOsAccountName

setOsAccountName(localId: number, localName: string): Promise<void>

设置指定系统帐号的帐号名,使用Promise方式异步返回结果。 

Z
zengyawen 已提交
594
此接口为系统接口,三方应用不支持调用。
Z
zhangalong 已提交
595

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

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

Z
zengyawen 已提交
600
**参数:**
Z
zhangalong 已提交
601

Z
zengyawen 已提交
602 603 604 605
| 参数名    | 类型   | 必填 | 说明         |
| --------- | ------ | ---- | ------------ |
| localId   | number | 是   | 系统帐号ID。 |
| localName | string | 是   | 帐号名。     |
Z
zhangalong 已提交
606

Z
zengyawen 已提交
607 608 609 610 611 612 613
**返回值:**

| 类型                | 说明                                |
| :------------------ | :---------------------------------- |
| Promise<void> | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
615
  ```js
F
fanchenxuan 已提交
616 617 618
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  let nameLimit = 'demoName';
Z
zhangalong 已提交
619 620 621
  accountManager.setOsAccountName(localId, nameLimit).then(() => {
    console.log('setOsAccountName Success');
  }).catch((err) => {
F
fanchenxuan 已提交
622
    console.log('setOsAccountName err: '  + JSON.stringify(err));
Z
zhangalong 已提交
623 624 625 626 627 628 629 630 631
  });
  ```

### getCreatedOsAccountsCount

getCreatedOsAccountsCount(callback: AsyncCallback<number>): void

获取已创建的系统帐号数量,使用callback回调异步返回结果。

Z
zengyawen 已提交
632 633 634 635 636
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

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

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

Z
zengyawen 已提交
638 639 640
| 参数名   | 类型                        | 必填 | 说明                                       |
| -------- | --------------------------- | ---- | ------------------------------------------ |
| callback | AsyncCallback<number> | 是   | 回调结果,返回的是已创建的系统帐号的数量。 |
Z
zhangalong 已提交
641

Z
zengyawen 已提交
642
**示例:**
Z
zhangalong 已提交
643

Z
zhangalong 已提交
644
  ```js
F
fanchenxuan 已提交
645
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
646
  accountManager.getCreatedOsAccountsCount((err, accountCnt)=>{
F
fanchenxuan 已提交
647 648
    console.log('obtains the number of all os accounts created err:' + JSON.stringify(err));
    console.log('obtains the number of all os accounts created accountCnt:' + accountCnt);
Z
zhangalong 已提交
649 650 651 652 653 654 655 656 657
  });
  ```

### getCreatedOsAccountsCount

getCreatedOsAccountsCount(): Promise<number>

获取已创建的系统帐号数量,使用Promise方式异步返回结果。

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

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

Z
zengyawen 已提交
662 663 664 665 666 667 668
**返回值:**

| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise<number> | Promise实例,用于获取异步返回结果,返回的是已创建的系统帐号的数量。 |

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

Z
zhangalong 已提交
670
  ```js
F
fanchenxuan 已提交
671
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
672 673 674
  accountManager.getCreatedOsAccountsCount().then((accountCnt) => {
    console.log('getCreatedOsAccountsCount, accountCnt: ' + accountCnt);
  }).catch((err) => {
F
fanchenxuan 已提交
675
    console.log('getCreatedOsAccountsCount err: '  + JSON.stringify(err));
Z
zhangalong 已提交
676 677 678 679 680 681 682 683 684
  });
  ```

### getOsAccountLocalIdFromProcess

getOsAccountLocalIdFromProcess(callback: AsyncCallback<number>): void

获取当前进程所属的系统帐号的帐号ID,使用callback回调异步返回结果。

Z
zengyawen 已提交
685 686 687
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
689 690 691
| 参数名   | 类型                        | 必填 | 说明                                               |
| -------- | --------------------------- | ---- | -------------------------------------------------- |
| callback | AsyncCallback<number> | 是   | 回调结果,返回的是当前进程所属的系统帐号的帐号ID。 |
Z
zhangalong 已提交
692

Z
zengyawen 已提交
693
**示例:**
Z
zhangalong 已提交
694

Z
zhangalong 已提交
695
  ```js
F
fanchenxuan 已提交
696
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
697
  accountManager.getOsAccountLocalIdFromProcess((err, accountID) => {
F
fanchenxuan 已提交
698
    console.log('getOsAccountLocalIdFromProcess err: ' + JSON.stringify(err));
Z
zhangalong 已提交
699 700 701 702 703 704 705 706 707 708
    console.log('getOsAccountLocalIdFromProcess accountID: ' + accountID);
  });
  ```

### getOsAccountLocalIdFromProcess

getOsAccountLocalIdFromProcess(): Promise<number>

获取当前进程所属的系统帐号的帐号ID,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
711
**返回值:**
Z
zhangalong 已提交
712

Z
zengyawen 已提交
713 714 715 716 717
| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise<number> | Promise实例,用于获取异步返回结果,返回的是当前进程所属的系统帐号的帐号ID。 |

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

Z
zhangalong 已提交
719
  ```js
F
fanchenxuan 已提交
720
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
721 722 723
  accountManager.getOsAccountLocalIdFromProcess().then((accountID) => {
    console.log('getOsAccountLocalIdFromProcess, accountID: ' + accountID);
  }).catch((err) => {
F
fanchenxuan 已提交
724
    console.log('getOsAccountLocalIdFromProcess err: '  + JSON.stringify(err));
Z
zhangalong 已提交
725 726 727 728 729 730 731 732 733
  });
  ```

### getOsAccountLocalIdFromUid

getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback<number>): void

从进程uid中获取该uid所属的系统帐号的帐号ID,使用callback回调异步返回结果。

Z
zengyawen 已提交
734 735 736
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
738 739 740 741
| 参数名   | 类型                        | 必填 | 说明                                          |
| -------- | --------------------------- | ---- | --------------------------------------------- |
| uid      | number                      | 是   | 进程uid。                                     |
| callback | AsyncCallback<number> | 是   | 回调结果,返回的是uid所属的系统帐号的帐号ID。 |
Z
zhangalong 已提交
742

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

Z
zhangalong 已提交
745
  ```js
F
fanchenxuan 已提交
746
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
747 748
  let uid = 12345678;
  accountManager.getOsAccountLocalIdFromUid(uid, (err, accountID) => {
F
fanchenxuan 已提交
749
    console.log('getOsAccountLocalIdFromUid err: ' + JSON.stringify(err));
Z
zhangalong 已提交
750 751 752 753 754 755 756 757 758 759
    console.log('getOsAccountLocalIdFromUid: ' + accountID);
  });
  ```

### getOsAccountLocalIdFromUid

getOsAccountLocalIdFromUid(uid: number): Promise<number>

从进程uid中获取该uid所属的系统帐号的帐号ID,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
762
**参数:**
Z
zhangalong 已提交
763

Z
zengyawen 已提交
764 765 766
| 参数名 | 类型   | 必填 | 说明      |
| ------ | ------ | ---- | --------- |
| uid    | number | 是   | 进程uid。 |
Z
zhangalong 已提交
767

Z
zengyawen 已提交
768
**返回值:**
Z
zhangalong 已提交
769

Z
zengyawen 已提交
770 771 772 773 774
| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise<number> | Promise实例,用于获取异步返回结果,返回的是uid所属的系统帐号的帐号ID。 |

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

Z
zhangalong 已提交
776
  ```js
F
fanchenxuan 已提交
777
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
778 779 780 781
  let uid = 12345678;
  accountManager.getOsAccountLocalIdFromUid(uid).then((accountID) => {
    console.log('getOsAccountLocalIdFromUid: ' + accountID);
  }).catch((err) => {
F
fanchenxuan 已提交
782
    console.log('getOsAccountLocalIdFromUid err: '  + JSON.stringify(err));
Z
zhangalong 已提交
783 784 785
  });
  ```

Z
zengyawen 已提交
786
### getOsAccountLocalIdFromDomain<sup>8+</sup>
Z
zhangalong 已提交
787 788 789 790 791

getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;number&gt;): void

根据域帐号信息,获取与其关联的系统帐号的帐号ID。

Z
zengyawen 已提交
792 793 794
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

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

Z
zengyawen 已提交
796
**参数:**
Z
zhangalong 已提交
797

Z
zengyawen 已提交
798 799
| 参数名     | 类型                                    | 必填 | 说明                                         |
| ---------- | --------------------------------------- | ---- | -------------------------------------------- |
800
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。                                 |
Z
zengyawen 已提交
801 802 803
| callback   | AsyncCallback&lt;number&gt;             | 是   | 回调结果,返回的是和域帐号关联的系统帐号ID。 |

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

Z
zhangalong 已提交
805
  ```js
F
fanchenxuan 已提交
806 807
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
808
  accountManager.getOsAccountLocalIdFromDomain(domainInfo, (err, accountID) => {
F
fanchenxuan 已提交
809
    console.log('getOsAccountLocalIdFromDomain: ' + JSON.stringify(err));
Z
zhangalong 已提交
810 811 812 813
    console.log('getOsAccountLocalIdFromDomain: ' + accountID);
  });
  ```

Z
zengyawen 已提交
814
### getOsAccountLocalIdFromDomain<sup>8+</sup>
Z
zhangalong 已提交
815 816 817 818 819

getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise&lt;number&gt;

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

Z
zengyawen 已提交
820 821 822 823 824
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

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

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

Z
zengyawen 已提交
826 827
| 参数名     | 类型                                    | 必填 | 说明         |
| ---------- | --------------------------------------- | ---- | ------------ |
828
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。 |
Z
zhangalong 已提交
829

Z
zengyawen 已提交
830
**返回值:**
Z
zhangalong 已提交
831

Z
zengyawen 已提交
832 833 834
| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是和域帐号关联的系统帐号ID。 |
Z
zhangalong 已提交
835

Z
zengyawen 已提交
836
**示例:**
Z
zhangalong 已提交
837

Z
zhangalong 已提交
838
  ```js
F
fanchenxuan 已提交
839 840
  let accountManager = account_osAccount.getAccountManager();
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
Z
zhangalong 已提交
841 842 843
  accountManager.getOsAccountLocalIdFromDomain(domainInfo).then((accountID) => {
    console.log('getOsAccountLocalIdFromDomain: ' + accountID);
  }).catch((err) => {
F
fanchenxuan 已提交
844
    console.log('getOsAccountLocalIdFromDomain err: '  + JSON.stringify(err));
Z
zhangalong 已提交
845 846 847 848 849 850 851 852 853
  });
  ```

### queryMaxOsAccountNumber

queryMaxOsAccountNumber(callback: AsyncCallback&lt;number&gt;): void

查询允许创建的系统帐号的最大数量,使用callback回调异步返回结果。

Z
zengyawen 已提交
854
此接口为系统接口,三方应用不支持调用。
Z
zhangalong 已提交
855

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

Z
zengyawen 已提交
858 859 860 861 862 863 864
**参数:**

| 参数名   | 类型                        | 必填 | 说明                                             |
| -------- | --------------------------- | ---- | ------------------------------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调结果,返回的是允许创建的系统帐号的最大数量。 |

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

Z
zhangalong 已提交
866
  ```js
F
fanchenxuan 已提交
867
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
868
  accountManager.queryMaxOsAccountNumber((err, maxCnt)=>{
F
fanchenxuan 已提交
869 870
    console.log('queryMaxOsAccountNumber err:' + JSON.stringify(err));
    console.log('queryMaxOsAccountNumber maxCnt:' + maxCnt);
Z
zhangalong 已提交
871 872 873 874 875 876 877 878 879
  });
  ```

### queryMaxOsAccountNumber

queryMaxOsAccountNumber(): Promise&lt;number&gt;

查询允许创建的系统帐号的最大数量,使用Promise方式异步返回结果。

Z
zengyawen 已提交
880 881 882 883 884
此接口为系统接口,三方应用不支持调用。

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

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

Z
zengyawen 已提交
886 887 888
| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是允许创建的系统帐号的最大数量。 |
Z
zhangalong 已提交
889

Z
zengyawen 已提交
890
**示例:**
Z
zhangalong 已提交
891

Z
zhangalong 已提交
892
  ```js
F
fanchenxuan 已提交
893
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
894 895 896
  accountManager.queryMaxOsAccountNumber().then((maxCnt) => {
    console.log('queryMaxOsAccountNumber, maxCnt: ' + maxCnt);
  }).catch((err) => {
F
fanchenxuan 已提交
897
    console.log('queryMaxOsAccountNumber err: '  + JSON.stringify(err));
Z
zhangalong 已提交
898 899 900 901 902 903 904
  });
  ```

### getOsAccountAllConstraints

getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void

Z
zengyawen 已提交
905
获取指定系统帐号的全部约束,使用callback回调异步返回结果。
Z
zhangalong 已提交
906

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

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

Z
zengyawen 已提交
911 912 913 914 915 916 917 918
**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| localId  | number                                   | 是   | 系统帐号ID。                                                 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是   | 回调结果,返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 |

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

Z
zhangalong 已提交
920
  ```js
F
fanchenxuan 已提交
921 922
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
923
  accountManager.getOsAccountAllConstraints(localId, (err, constraints)=>{
F
fanchenxuan 已提交
924 925
    console.log('getOsAccountAllConstraints err:' + JSON.stringify(err));
    console.log('getOsAccountAllConstraints:' + JSON.stringify(constraints));
Z
zhangalong 已提交
926 927 928 929 930 931 932
  });
  ```

### getOsAccountAllConstraints

getOsAccountAllConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt;

Z
zengyawen 已提交
933 934 935
获取指定系统帐号的全部约束,使用Promise方式异步返回结果。

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

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

Z
zengyawen 已提交
939
**参数:**
Z
zhangalong 已提交
940

Z
zengyawen 已提交
941 942 943
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
944

Z
zengyawen 已提交
945
**返回值:**
Z
zhangalong 已提交
946

Z
zengyawen 已提交
947 948 949 950 951
| 类型                               | 说明                                                         |
| :--------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例,用于获取异步返回结果,返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 |

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

Z
zhangalong 已提交
953
  ```js
F
fanchenxuan 已提交
954 955
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
956
  accountManager.getOsAccountAllConstraints(localId).then((constraints) => {
F
fanchenxuan 已提交
957
    console.log('getOsAccountAllConstraints, constraints: ' + constraints);
Z
zhangalong 已提交
958
  }).catch((err) => {
F
fanchenxuan 已提交
959
    console.log('getOsAccountAllConstraints err: '  + JSON.stringify(err));
Z
zhangalong 已提交
960 961 962 963 964 965 966 967 968
  });
  ```

### queryAllCreatedOsAccounts

queryAllCreatedOsAccounts(callback: AsyncCallback&lt;Array&lt;OsAccountInfo&gt;&gt;): void

查询已创建的所有系统帐号的信息列表,使用callback回调异步返回结果。

Z
zengyawen 已提交
969 970 971
此接口为系统接口,三方应用不支持调用。

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

L
lichenchen 已提交
973 974
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

Z
zengyawen 已提交
975
**参数:**
Z
zhangalong 已提交
976

Z
zengyawen 已提交
977 978 979 980 981
| 参数名   | 类型                                                         | 必填 | 说明                                               |
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | 是   | 回调结果,返回的是已创建的所有系统帐号的信息列表。 |

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

Z
zhangalong 已提交
983
  ```js
F
fanchenxuan 已提交
984
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
985
  accountManager.queryAllCreatedOsAccounts((err, accountArr)=>{
F
fanchenxuan 已提交
986 987
    console.log('queryAllCreatedOsAccounts err:' + JSON.stringify(err));
    console.log('queryAllCreatedOsAccounts accountArr:' + JSON.stringify(accountArr));
Z
zhangalong 已提交
988 989 990 991 992 993 994 995 996
  });
  ```

### queryAllCreatedOsAccounts

queryAllCreatedOsAccounts(): Promise&lt;Array&lt;OsAccountInfo&gt;&gt;

查询已创建的所有系统帐号的信息列表,使用Promise方式异步返回结果。

Z
zengyawen 已提交
997 998 999
此接口为系统接口,三方应用不支持调用。

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

L
lichenchen 已提交
1001 1002
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

Z
zengyawen 已提交
1003
**返回值:**
Z
zhangalong 已提交
1004

Z
zengyawen 已提交
1005 1006 1007 1008 1009
| 类型                                                        | 说明                                                         |
| :---------------------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | Promise实例,用于获取异步返回结果,返回的是已创建的所有系统帐号的信息列表。 |

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

Z
zhangalong 已提交
1011
  ```js
F
fanchenxuan 已提交
1012
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1013 1014 1015
  accountManager.queryAllCreatedOsAccounts().then((accountArr) => {
    console.log('queryAllCreatedOsAccounts, accountArr: ' + JSON.stringify(accountArr));
  }).catch((err) => {
F
fanchenxuan 已提交
1016
    console.log('queryAllCreatedOsAccounts err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1017 1018 1019
  });
  ```

Z
zengyawen 已提交
1020
### queryActivatedOsAccountIds<sup>8+</sup>
Z
zhangalong 已提交
1021 1022 1023 1024 1025

queryActivatedOsAccountIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void

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

Z
zengyawen 已提交
1026 1027 1028
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
1030 1031 1032
| 参数名   | 类型                                     | 必填 | 说明                                                   |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是   | 回调结果,返回的是当前处于激活状态的系统帐号的ID列表。 |
Z
zhangalong 已提交
1033

Z
zengyawen 已提交
1034
**示例:**
Z
zhangalong 已提交
1035

Z
zhangalong 已提交
1036
  ```js
F
fanchenxuan 已提交
1037
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1038
  accountManager.queryActivatedOsAccountIds((err, idArray)=>{
F
fanchenxuan 已提交
1039 1040 1041 1042
    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]);
Z
zhangalong 已提交
1043 1044 1045 1046
    }
  });
  ```

Z
zengyawen 已提交
1047
### queryActivatedOsAccountIds<sup>8+</sup>
Z
zhangalong 已提交
1048 1049 1050 1051 1052

queryActivatedOsAccountIds(): Promise&lt;Array&lt;number&gt;&gt;

查询当前处于激活状态的系统帐号的ID列表,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
1055
**返回值:**
Z
zhangalong 已提交
1056

Z
zengyawen 已提交
1057 1058 1059 1060 1061
| 类型                               | 说明                                                         |
| :--------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;number&gt;&gt; | Promise实例,用于获取异步返回结果,返回的是当前处于激活状态的系统帐号的ID列表。 |

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

Z
zhangalong 已提交
1063
  ```js
F
fanchenxuan 已提交
1064
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1065 1066 1067
  accountManager.queryActivatedOsAccountIds().then((idArray) => {
    console.log('queryActivatedOsAccountIds, idArray: ' + idArray);
  }).catch((err) => {
F
fanchenxuan 已提交
1068
    console.log('queryActivatedOsAccountIds err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077
  });
  ```

### createOsAccount

createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback&lt;OsAccountInfo&gt;): void

创建一个系统帐号,使用callback回调异步返回结果。

Z
zengyawen 已提交
1078 1079 1080
此接口为系统接口,三方应用不支持调用。

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

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

Z
zengyawen 已提交
1084 1085 1086 1087 1088 1089 1090 1091 1092
**参数:**

| 参数名    | 类型                                                 | 必填 | 说明                                       |
| :-------- | ---------------------------------------------------- | ---- | ------------------------------------------ |
| localName | string                                               | 是   | 创建的系统帐号的名称。                     |
| type      | [OsAccountType](#osaccounttype)                      | 是   | 创建的系统帐号的类型。                     |
| callback  | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调结果,返回的是新创建的系统帐号的信息。 |

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

Z
zhangalong 已提交
1094
  ```js
F
fanchenxuan 已提交
1095 1096 1097 1098
  let accountManager = account_osAccount.getAccountManager();
  accountManager.createOsAccount('testName', account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{
    console.log('createOsAccount err:' + JSON.stringify(err));
    console.log('createOsAccount osAccountInfo:' + JSON.stringify(osAccountInfo));
Z
zhangalong 已提交
1099 1100 1101 1102 1103 1104 1105 1106 1107
  });
  ```

### createOsAccount

createOsAccount(localName: string, type: OsAccountType): Promise&lt;OsAccountInfo&gt;

创建一个系统帐号,使用Promise方式异步返回结果。 

Z
zengyawen 已提交
1108 1109 1110 1111 1112
此接口为系统接口,三方应用不支持调用。

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

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

Z
zengyawen 已提交
1114
**参数:**
Z
zhangalong 已提交
1115

Z
zengyawen 已提交
1116 1117 1118 1119
| 参数名    | 类型                            | 必填 | 说明                   |
| --------- | ------------------------------- | ---- | ---------------------- |
| localName | string                          | 是   | 创建的系统帐号的名称。 |
| type      | [OsAccountType](#osaccounttype) | 是   | 创建的系统帐号的类型。 |
Z
zhangalong 已提交
1120

Z
zengyawen 已提交
1121
**返回值:**
Z
zhangalong 已提交
1122

Z
zengyawen 已提交
1123 1124 1125 1126 1127
| 类型                                           | 说明                                                         |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例,用于获取异步返回结果,返回的是新创建的系统帐号的信息。 |

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

Z
zhangalong 已提交
1129
  ```js
F
fanchenxuan 已提交
1130 1131 1132
  let accountManager = account_osAccount.getAccountManager();
  accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL).then((accountInfo) => {
    console.log('createOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
Z
zhangalong 已提交
1133
  }).catch((err) => {
F
fanchenxuan 已提交
1134
    console.log('createOsAccount err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1135 1136 1137
  });
  ```

Z
zengyawen 已提交
1138
### createOsAccountForDomain<sup>8+</sup>
Z
zhangalong 已提交
1139 1140 1141 1142 1143

createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;OsAccountInfo&gt;): void

根据域帐号信息,创建一个系统帐号并将其与域帐号关联,使用callback回调异步返回结果。

Z
zengyawen 已提交
1144 1145 1146 1147 1148
此接口为系统接口,三方应用不支持调用。

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

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

Z
zengyawen 已提交
1150
**参数:**
Z
zhangalong 已提交
1151

Z
zengyawen 已提交
1152 1153 1154
| 参数名     | 类型                                                 | 必填 | 说明                                       |
| :--------- | ---------------------------------------------------- | ---- | ------------------------------------------ |
| type       | [OsAccountType](#osaccounttype)                      | 是   | 创建的系统帐号的类型。                     |
1155
| domainInfo | [DomainAccountInfo](#domainaccountinfo8)              | 是   | 域帐号信息。                               |
Z
zengyawen 已提交
1156 1157 1158
| callback   | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调结果,返回的是新创建的系统帐号的信息。 |

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

Z
zhangalong 已提交
1160
  ```js
F
fanchenxuan 已提交
1161 1162
  let accountManager = account_osAccount.getAccountManager();
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
J
jidong 已提交
1163
  accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo, (err, osAccountInfo)=>{
F
fanchenxuan 已提交
1164 1165
    console.log('createOsAccountForDomain err:' + JSON.stringify(err));
    console.log('createOsAccountForDomain osAccountInfo:' + JSON.stringify(osAccountInfo));
Z
zhangalong 已提交
1166 1167 1168
  });
  ```

Z
zengyawen 已提交
1169
### createOsAccountForDomain<sup>8+</sup>
Z
zhangalong 已提交
1170 1171 1172 1173 1174

createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo): Promise&lt;OsAccountInfo&gt;

根据传入的域帐号信息,创建与其关联的系统帐号,使用Promise方式异步返回结果。 

Z
zengyawen 已提交
1175 1176 1177 1178 1179 1180 1181
此接口为系统接口,三方应用不支持调用。

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

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

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

Z
zengyawen 已提交
1183 1184 1185
| 参数名     | 类型                                    | 必填 | 说明                   |
| ---------- | --------------------------------------- | ---- | ---------------------- |
| type       | [OsAccountType](#osaccounttype)         | 是   | 创建的系统帐号的类型。 |
1186
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是   | 域帐号信息。           |
Z
zhangalong 已提交
1187

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

Z
zengyawen 已提交
1190 1191 1192
| 类型                                           | 说明                                                         |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例,用于获取异步返回结果,返回的是新创建的系统帐号的信息。 |
Z
zhangalong 已提交
1193

Z
zengyawen 已提交
1194
**示例:**
Z
zhangalong 已提交
1195

Z
zhangalong 已提交
1196
  ```js
F
fanchenxuan 已提交
1197 1198
  let accountManager = account_osAccount.getAccountManager();
  let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
J
jidong 已提交
1199
  accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo).then((accountInfo) => {
F
fanchenxuan 已提交
1200
    console.log('createOsAccountForDomain, account info: ' + JSON.stringify(accountInfo));
Z
zhangalong 已提交
1201
  }).catch((err) => {
F
fanchenxuan 已提交
1202
    console.log('createOsAccountForDomain err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1203 1204 1205 1206 1207 1208 1209 1210 1211
  });
  ```

### queryCurrentOsAccount

queryCurrentOsAccount(callback: AsyncCallback&lt;OsAccountInfo&gt;): void

查询当前进程所属的系统帐号的信息,使用callback回调异步返回结果。

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

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

Z
zengyawen 已提交
1216 1217 1218 1219 1220 1221 1222
**参数:**

| 参数名   | 类型                                                 | 必填 | 说明                                           |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调结果,返回的是当前进程所属的系统帐号信息。 |

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

Z
zhangalong 已提交
1224
  ```js
F
fanchenxuan 已提交
1225
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1226
  accountManager.queryCurrentOsAccount((err, curAccountInfo)=>{
F
fanchenxuan 已提交
1227 1228
    console.log('queryCurrentOsAccount err:' + JSON.stringify(err));
    console.log('queryCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
Z
zhangalong 已提交
1229 1230 1231 1232 1233 1234 1235 1236 1237
  });
  ```

### queryCurrentOsAccount

queryCurrentOsAccount(): Promise&lt;OsAccountInfo&gt;

查询当前进程所属的系统帐号的信息,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1238 1239 1240 1241 1242
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS

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

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

Z
zengyawen 已提交
1244 1245 1246
| 类型                                           | 说明                                                         |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例,用于获取异步返回结果,返回的是当前进程所属的系统帐号信息。 |
Z
zhangalong 已提交
1247

Z
zengyawen 已提交
1248
**示例:**
Z
zhangalong 已提交
1249

Z
zhangalong 已提交
1250
  ```js
F
fanchenxuan 已提交
1251
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1252
  accountManager.queryCurrentOsAccount().then((accountInfo) => {
F
fanchenxuan 已提交
1253
    console.log('queryCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
Z
zhangalong 已提交
1254
  }).catch((err) => {
F
fanchenxuan 已提交
1255
    console.log('queryCurrentOsAccount err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1256 1257 1258 1259 1260 1261 1262 1263 1264
  });
  ```

### queryOsAccountById

queryOsAccountById(localId: number, callback: AsyncCallback&lt;OsAccountInfo&gt;): void

查询指定系统帐号的信息,使用callback回调异步返回结果。

Z
zengyawen 已提交
1265
此接口为系统接口,三方应用不支持调用。
Z
zhangalong 已提交
1266

Z
zhangalong 已提交
1267
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
Z
zhangalong 已提交
1268

Z
zengyawen 已提交
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名   | 类型                                                 | 必填 | 说明                                     |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------- |
| localId  | number                                               | 是   | 要查询的系统帐号的ID                     |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是   | 回调结果,返回的是查到的系统帐号的信息。 |

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

Z
zhangalong 已提交
1280
  ```js
F
fanchenxuan 已提交
1281 1282
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
1283
  accountManager.queryOsAccountById(localId, (err, accountInfo)=>{
F
fanchenxuan 已提交
1284 1285
    console.log('queryOsAccountById err:' + JSON.stringify(err));
    console.log('queryOsAccountById accountInfo:' + JSON.stringify(accountInfo));
Z
zhangalong 已提交
1286 1287 1288 1289 1290 1291 1292 1293 1294
  });
  ```

### queryOsAccountById

queryOsAccountById(localId: number): Promise&lt;OsAccountInfo&gt;

查询指定系统帐号的信息,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1295 1296
此接口为系统接口,三方应用不支持调用。

Z
zhangalong 已提交
1297
**需要权限:** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
Z
zhangalong 已提交
1298

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

Z
zengyawen 已提交
1301
**参数:**
Z
zhangalong 已提交
1302

Z
zengyawen 已提交
1303 1304 1305
| 参数名  | 类型   | 必填 | 说明                 |
| ------- | ------ | ---- | -------------------- |
| localId | number | 是   | 要查询的系统帐号的ID |
Z
zhangalong 已提交
1306

Z
zengyawen 已提交
1307 1308 1309 1310 1311 1312 1313
**返回值:**

| 类型                                           | 说明                                                         |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例,用于获取异步返回结果,返回的是查到的系统帐号的信息。 |

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

Z
zhangalong 已提交
1315
  ```js
F
fanchenxuan 已提交
1316 1317
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
1318
  accountManager.queryOsAccountById(localId).then((accountInfo) => {
F
fanchenxuan 已提交
1319
    console.log('queryOsAccountById, accountInfo: ' + JSON.stringify(accountInfo));
Z
zhangalong 已提交
1320
  }).catch((err) => {
F
fanchenxuan 已提交
1321
    console.log('queryOsAccountById err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1322 1323 1324 1325 1326 1327 1328 1329 1330
  });
  ```

### getOsAccountTypeFromProcess

getOsAccountTypeFromProcess(callback: AsyncCallback&lt;OsAccountType&gt;): void

查询当前进程所属的系统帐号的帐号类型,使用callback回调异步返回结果。

Z
zengyawen 已提交
1331 1332 1333
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
1335 1336 1337
| 参数名   | 类型                                                 | 必填 | 说明                                                 |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountType](#osaccounttype)&gt; | 是   | 回调结果,返回的是当前进程所属的系统帐号的帐号类型。 |
Z
zhangalong 已提交
1338

Z
zengyawen 已提交
1339
**示例:**
Z
zhangalong 已提交
1340

Z
zhangalong 已提交
1341
  ```js
F
fanchenxuan 已提交
1342
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1343
  accountManager.getOsAccountTypeFromProcess((err, accountType) => {
F
fanchenxuan 已提交
1344
    console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err));
Z
zhangalong 已提交
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
    console.log('getOsAccountTypeFromProcess accountType: ' + accountType);
  });
  ```

### getOsAccountTypeFromProcess

getOsAccountTypeFromProcess(): Promise&lt;OsAccountType&gt;

查询当前进程所属的系统帐号的帐号类型,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
1357
**返回值:**
Z
zhangalong 已提交
1358

Z
zengyawen 已提交
1359 1360 1361 1362 1363
| 类型                                           | 说明                                                         |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountType](#osaccounttype)&gt; | Promise实例,用于获取异步返回结果,返回的是当前进程所属的系统帐号的帐号类型。 |

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

Z
zhangalong 已提交
1365
  ```js
F
fanchenxuan 已提交
1366
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1367 1368 1369
  accountManager.getOsAccountTypeFromProcess().then((accountType) => {
    console.log('getOsAccountTypeFromProcess, accountType: ' + accountType);
  }).catch((err) => {
F
fanchenxuan 已提交
1370
    console.log('getOsAccountTypeFromProcess err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1371 1372 1373 1374 1375 1376 1377 1378 1379
  });
  ```

### getDistributedVirtualDeviceId

getDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void

获取分布式虚拟设备ID,使用callback回调异步返回结果。

Z
zhangalong 已提交
1380
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
1381 1382

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

Z
zengyawen 已提交
1384
**参数:**
Z
zhangalong 已提交
1385

Z
zengyawen 已提交
1386 1387 1388 1389 1390
| 参数名   | 类型                        | 必填 | 说明                                 |
| -------- | --------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调结果,返回的是分布式虚拟设备ID。 |

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

Z
zhangalong 已提交
1392
  ```js
F
fanchenxuan 已提交
1393
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1394
  accountManager.getDistributedVirtualDeviceId((err, virtualID) => {
F
fanchenxuan 已提交
1395
    console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err));
Z
zhangalong 已提交
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
    console.log('getDistributedVirtualDeviceId virtualID: ' + virtualID);
  });
  ```

### getDistributedVirtualDeviceId

getDistributedVirtualDeviceId(): Promise&lt;string&gt;

获取分布式虚拟设备ID,使用Promise方式异步返回结果。

Z
zhangalong 已提交
1406
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS
Z
zengyawen 已提交
1407 1408

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

Z
zengyawen 已提交
1410
**返回值:**
Z
zhangalong 已提交
1411

Z
zengyawen 已提交
1412 1413 1414 1415 1416
| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;string&gt; | Promise实例,用于获取异步返回结果,返回的是分布式虚拟设备ID。 |

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

Z
zhangalong 已提交
1418
  ```js
F
fanchenxuan 已提交
1419
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1420 1421 1422
  accountManager.getDistributedVirtualDeviceId().then((virtualID) => {
    console.log('getDistributedVirtualDeviceId, virtualID: ' + virtualID);
  }).catch((err) => {
F
fanchenxuan 已提交
1423
    console.log('getDistributedVirtualDeviceId err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1424 1425 1426 1427 1428 1429 1430 1431 1432
  });
  ```

### getOsAccountProfilePhoto

getOsAccountProfilePhoto(localId: number, callback: AsyncCallback&lt;string&gt;): void

获取指定系统帐号的头像信息,使用callback回调异步返回结果。

Z
zengyawen 已提交
1433 1434 1435 1436 1437 1438 1439
此接口为系统接口,三方应用不支持调用。

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

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

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

Z
zengyawen 已提交
1441 1442 1443 1444
| 参数名   | 类型                        | 必填 | 说明                                     |
| -------- | --------------------------- | ---- | ---------------------------------------- |
| localId  | number                      | 是   | 系统帐号ID。                             |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调结果,返回的是该系统帐号的头像信息。 |
Z
zhangalong 已提交
1445

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

Z
zhangalong 已提交
1448
  ```js
F
fanchenxuan 已提交
1449 1450
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
1451
  accountManager.getOsAccountProfilePhoto(localId, (err, photo)=>{
F
fanchenxuan 已提交
1452 1453
    console.log('getOsAccountProfilePhoto err:' + JSON.stringify(err));
    console.log('get photo:' + photo + ' by localId: ' + localId);
Z
zhangalong 已提交
1454 1455 1456 1457 1458 1459 1460 1461 1462
  });
  ```

### getOsAccountProfilePhoto

getOsAccountProfilePhoto(localId: number): Promise&lt;string&gt;

获取指定系统帐号的头像信息,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1463
此接口为系统接口,三方应用不支持调用。
Z
zhangalong 已提交
1464

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

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

Z
zengyawen 已提交
1469
**参数:**
Z
zhangalong 已提交
1470

Z
zengyawen 已提交
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |

**返回值:**

| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;string&gt; | Promise实例,用于获取异步返回结果,返回的是该系统帐号的头像信息。 |

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

Z
zhangalong 已提交
1483
  ```js
F
fanchenxuan 已提交
1484 1485
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
1486
  accountManager.getOsAccountProfilePhoto(localId).then((photo) => {
F
fanchenxuan 已提交
1487
    console.log('getOsAccountProfilePhoto: ' + photo);
Z
zhangalong 已提交
1488
  }).catch((err) => {
F
fanchenxuan 已提交
1489
    console.log('getOsAccountProfilePhoto err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1490 1491 1492 1493 1494 1495 1496 1497 1498
  });
  ```

### setOsAccountProfilePhoto

setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback&lt;void&gt;): void

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

Z
zengyawen 已提交
1499 1500 1501
此接口为系统接口,三方应用不支持调用。

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

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

Z
zengyawen 已提交
1505 1506 1507 1508 1509 1510 1511 1512 1513
**参数:**

| 参数名   | 类型                      | 必填 | 说明         |
| -------- | ------------------------- | ---- | ------------ |
| localId  | number                    | 是   | 系统帐号ID。 |
| photo    | string                    | 是   | 头像信息。   |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调结果。   |

**示例:**给ID为100的系统帐号设置头像
Z
zhangalong 已提交
1514

Z
zhangalong 已提交
1515
  ```js
F
fanchenxuan 已提交
1516 1517 1518 1519 1520 1521
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  let photo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
  'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
  'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
  '+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
J
jidong 已提交
1522
  accountManager.setOsAccountProfilePhoto(localId, photo, (err)=>{
F
fanchenxuan 已提交
1523
    console.log('setOsAccountProfilePhoto err:' + JSON.stringify(err));
Z
zhangalong 已提交
1524 1525 1526 1527 1528 1529 1530 1531 1532
  });
  ```

### setOsAccountProfilePhoto

setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt;

为指定系统帐号设置头像信息,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1533 1534 1535
此接口为系统接口,三方应用不支持调用。

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

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

Z
zengyawen 已提交
1539
**参数:**
Z
zhangalong 已提交
1540

Z
zengyawen 已提交
1541 1542 1543 1544
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
| photo   | string | 是   | 头像信息。   |
Z
zhangalong 已提交
1545

Z
zengyawen 已提交
1546 1547 1548 1549 1550 1551 1552
**返回值:**

| 类型                | 说明                                |
| :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |

**示例:**给ID为100的系统帐号设置头像
Z
zhangalong 已提交
1553

Z
zhangalong 已提交
1554
  ```js
F
fanchenxuan 已提交
1555 1556 1557 1558 1559 1560
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
  let photo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
  'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
  'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
  '+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
Z
zhangalong 已提交
1561
  accountManager.setOsAccountProfilePhoto(localId, photo).then(() => {
F
fanchenxuan 已提交
1562
    console.log('setOsAccountProfilePhoto success');
Z
zhangalong 已提交
1563
  }).catch((err) => {
F
fanchenxuan 已提交
1564
    console.log('setOsAccountProfilePhoto err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1565 1566 1567
  });
  ```

Z
zengyawen 已提交
1568
### getOsAccountLocalIdBySerialNumber<sup>8+</sup>
Z
zhangalong 已提交
1569 1570 1571 1572 1573

getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback&lt;number&gt;): void

通过SN码查询与其关联的系统帐号的帐号ID,使用callback回调异步返回结果。

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

Z
zengyawen 已提交
1576
**参数:**
Z
zhangalong 已提交
1577

Z
zengyawen 已提交
1578 1579 1580 1581 1582 1583
| 参数名       | 类型                        | 必填 | 说明                                             |
| ------------ | --------------------------- | ---- | ------------------------------------------------ |
| serialNumber | number                      | 是   | 帐号SN码。                                       |
| callback     | AsyncCallback&lt;number&gt; | 是   | 回调结果,返回的是与SN码关联的系统帐号的帐号ID。 |

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

Z
zhangalong 已提交
1585
  ```js
F
fanchenxuan 已提交
1586 1587
  let accountManager = account_osAccount.getAccountManager();
  let serialNumber = 12345;
Z
zhangalong 已提交
1588
  accountManager.getOsAccountLocalIdBySerialNumber(serialNumber, (err, localId)=>{
F
fanchenxuan 已提交
1589 1590
    console.log('ger localId err:' + JSON.stringify(err));
    console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
Z
zhangalong 已提交
1591 1592 1593
  });
  ```

Z
zengyawen 已提交
1594
### getOsAccountLocalIdBySerialNumber<sup>8+</sup>
Z
zhangalong 已提交
1595 1596 1597 1598 1599

getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt;

通过SN码查询与其关联的系统帐号的帐号ID,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1600 1601 1602
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
1604 1605 1606
| 参数名       | 类型   | 必填 | 说明       |
| ------------ | ------ | ---- | ---------- |
| serialNumber | number | 是   | 帐号SN码。 |
Z
zhangalong 已提交
1607

Z
zengyawen 已提交
1608
**返回值:**
Z
zhangalong 已提交
1609

Z
zengyawen 已提交
1610 1611 1612
| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是与SN码关联的系统帐号的帐号ID。 |
Z
zhangalong 已提交
1613

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

Z
zhangalong 已提交
1616
  ```js
F
fanchenxuan 已提交
1617 1618
  let accountManager = account_osAccount.getAccountManager();
  let serialNumber = 12345;
Z
zhangalong 已提交
1619
  accountManager.getOsAccountLocalIdBySerialNumber(serialNumber).then((localId) => {
F
fanchenxuan 已提交
1620
    console.log('getOsAccountLocalIdBySerialNumber localId: ' + localId);
Z
zhangalong 已提交
1621
  }).catch((err) => {
F
fanchenxuan 已提交
1622
    console.log('getOsAccountLocalIdBySerialNumber err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1623 1624 1625
  });
  ```

Z
zengyawen 已提交
1626
### getSerialNumberByOsAccountLocalId<sup>8+</sup>
Z
zhangalong 已提交
1627 1628 1629 1630 1631

getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;number&gt;): void

通过系统帐号ID获取与该系统帐号关联的SN码,使用callback回调异步返回结果。

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

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

Z
zengyawen 已提交
1636 1637 1638 1639 1640 1641
| 参数名   | 类型                        | 必填 | 说明                                       |
| -------- | --------------------------- | ---- | ------------------------------------------ |
| localId  | number                      | 是   | 系统帐号ID。                               |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调结果,返回的是与该系统帐号关联的SN码。 |

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

Z
zhangalong 已提交
1643
  ```js
F
fanchenxuan 已提交
1644 1645
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
1646
  accountManager.getSerialNumberByOsAccountLocalId(localId, (err, serialNumber)=>{
F
fanchenxuan 已提交
1647 1648
    console.log('ger serialNumber err:' + JSON.stringify(err));
    console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
Z
zhangalong 已提交
1649 1650 1651
  });
  ```

Z
zengyawen 已提交
1652
### getSerialNumberByOsAccountLocalId<sup>8+</sup>
Z
zhangalong 已提交
1653 1654 1655 1656 1657

getSerialNumberByOsAccountLocalId(localId: number): Promise&lt;number&gt;

通过系统帐号ID获取与该系统帐号关联的SN码,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1658 1659 1660
**系统能力:** SystemCapability.Account.OsAccount

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

Z
zengyawen 已提交
1662 1663 1664
| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId | number | 是   | 系统帐号ID。 |
Z
zhangalong 已提交
1665

Z
zengyawen 已提交
1666
**返回值:**
Z
zhangalong 已提交
1667

Z
zengyawen 已提交
1668 1669 1670
| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是与该系统帐号关联的SN码。 |
Z
zhangalong 已提交
1671

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

Z
zhangalong 已提交
1674
  ```js
F
fanchenxuan 已提交
1675 1676
  let accountManager = account_osAccount.getAccountManager();
  let localId = 100;
Z
zhangalong 已提交
1677
  accountManager.getSerialNumberByOsAccountLocalId(localId).then((serialNumber) => {
F
fanchenxuan 已提交
1678
    console.log('getSerialNumberByOsAccountLocalId serialNumber: ' + serialNumber);
Z
zhangalong 已提交
1679
  }).catch((err) => {
F
fanchenxuan 已提交
1680
    console.log('getSerialNumberByOsAccountLocalId err: '  + JSON.stringify(err));
Z
zhangalong 已提交
1681 1682 1683 1684 1685 1686 1687 1688 1689
  });
  ```

### on

on(type: 'activate' | 'activating', name: string, callback: Callback&lt;number&gt;): void

订阅系统帐号的变动信息,使用callback回调异步返回结果。

Z
zengyawen 已提交
1690 1691 1692
此接口为系统接口,三方应用不支持调用。

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

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

Z
zengyawen 已提交
1696 1697 1698 1699 1700 1701 1702 1703 1704
**参数:**

| 参数名   | 类型                       | 必填 | 说明                                                         |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| type     | 'activate' \| 'activating' | 是   | 订阅类型,activate表示订阅的是帐号已激活完成的事件,activating表示订阅的是帐号正在激活的事件。 |
| name     | string                     | 是   | 订阅名称,可自定义,要求非空且长度不超过1024字节。           |
| callback | Callback&lt;number&gt;     | 是   | 订阅系统帐号变动信息的回调,表示当前事件对应的系统帐号ID。   |

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

Z
zhangalong 已提交
1706
  ```js
F
fanchenxuan 已提交
1707
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1708
  function onCallback(receiveLocalId){
F
fanchenxuan 已提交
1709
    console.log('receive localId:' + receiveLocalId);
Z
zhangalong 已提交
1710
  }
F
fanchenxuan 已提交
1711
  accountManager.on('activating', 'osAccountOnOffNameA', onCallback);
Z
zhangalong 已提交
1712 1713 1714 1715 1716 1717 1718 1719
  ```

### off

off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number&gt;): void

取消订阅系统帐号的变动信息,使用callback回调异步返回结果。

Z
zengyawen 已提交
1720 1721 1722 1723 1724
此接口为系统接口,三方应用不支持调用。

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

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

Z
zengyawen 已提交
1726
**参数:**
Z
zhangalong 已提交
1727

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

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

Z
zhangalong 已提交
1736
  ```js
F
fanchenxuan 已提交
1737
  let accountManager = account_osAccount.getAccountManager();
Z
zhangalong 已提交
1738
  function offCallback(){
F
fanchenxuan 已提交
1739
    console.log('off enter')
Z
zhangalong 已提交
1740
  }
F
fanchenxuan 已提交
1741
  accountManager.off('activating', 'osAccountOnOffNameA', offCallback);
Z
zhangalong 已提交
1742 1743
  ```

1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
### getBundleIdFromUid<sup>9+</sup>

getBundleIdFromUid(uid: number, callback: AsyncCallback&lt;number&gt;): void;

通过uid查询对应的bundleId。

此接口为系统接口,三方应用不支持调用。

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

**参数:**

| 参数名   | 类型                       | 必填 | 说明                                                         |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| uid     | number | 是   |  进程uid。 |
| callback | AsyncCallback&lt;number&gt;     | 是   | 回调结果,返回的是与uid对应的bundleId。                      |

**示例:**

  ```js
F
fanchenxuan 已提交
1764 1765
  let accountManager = account_osAccount.getAccountManager();
  let testUid = 1000000;
J
jidong 已提交
1766
  accountManager.getBundleIdFromUid(testUid, (err, bundleId) => {
F
fanchenxuan 已提交
1767 1768
    console.info('getBundleIdFromUid errInfo:' + JSON.stringify(err));
    console.info('getBundleIdFromUid bundleId:' + JSON.stringify(bundleId));
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
  });
  ```
### getBundleIdFromUid<sup>9+</sup>

getBundleIdFromUid(uid: number): Promise&lt;number&gt;;

通过uid查询对应的bundleId。

此接口为系统接口,三方应用不支持调用。

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

**参数:**

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

**返回值:**

| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回的是与uid对应的bundleId。 |

**示例:**

  ```js
F
fanchenxuan 已提交
1796 1797
  let accountManager = account_osAccount.getAccountManager();
  let testUid = 1000000;
J
jidong 已提交
1798
  accountManager.getBundleIdFromUid(testUid).then((result) => {
F
fanchenxuan 已提交
1799
    console.info('getBundleIdFromUid bundleId:' + JSON.stringify(result));
J
jidong 已提交
1800
  }).catch((err)=>{
F
fanchenxuan 已提交
1801
    console.info('getBundleIdFromUid errInfo:' + JSON.stringify(err));
J
jidong 已提交
1802
  });
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812
  ```

### isMainOsAccount<sup>9+</sup>

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

查询当前进程是否处于主用户。

此接口为系统接口,三方应用不支持调用。

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

1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名   | 类型                       | 必填 | 说明                                                         |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt;     | 是   | 回调结果,返回的是当前进程是否处于主用户,是则返回true,否则返回false。                      |

**示例:**

  ```js
F
fanchenxuan 已提交
1826
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1827
  accountManager.isMainOsAccount((err,result)=>{
F
fanchenxuan 已提交
1828 1829
    console.info('isMainOsAccount errInfo:' + JSON.stringify(err));
    console.info('isMainOsAccount result:' + JSON.stringify(result));
1830 1831 1832 1833 1834 1835 1836 1837 1838 1839
  });
  ```
### isMainOsAccount<sup>9+</sup>

isMainOsAccount(): Promise&lt;boolean&gt;;

查询当前进程是否处于主用户。

此接口为系统接口,三方应用不支持调用。

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

1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
**系统能力:** SystemCapability.Account.OsAccount

**返回值:**

| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例,用于获取异步返回结果,回调结果,返回的是当前进程是否处于主用户,是则返回true,否则返回false。 |

**示例:**

  ```js
F
fanchenxuan 已提交
1853
  let accountManager = account_osAccount.getAccountManager();
J
jidong 已提交
1854
  accountManager.isMainOsAccount().then((result) => {
F
fanchenxuan 已提交
1855
    console.info('isMainOsAccount result:' + JSON.stringify(result));
J
jidong 已提交
1856
  }).catch((err)=>{
F
fanchenxuan 已提交
1857
    console.info('isMainOsAccount errInfo:' + JSON.stringify(err));
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
  });
  ```
### queryOsAccountConstraintSourceTypes<sup>9+</sup>

queryOsAccountConstraintSourceTypes(localId: number, constraint: string, callback: AsyncCallback&lt;Array&lt;ConstraintSourceTypeInfo&gt;&gt;): void;

查询指定系统帐号的指定约束来源信息。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名   | 类型                       | 必填 | 说明                                                         |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| localId     | number | 是   |  要查询的系统帐号ID |
| constraint     | string | 是   |  要查询的[约束](#系统帐号约束列表)名称 |
| callback | AsyncCallback&lt;Array&lt;[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)&gt;&gt;     | 是   | 回调结果,返回的是指定系统帐号的指定[约束](#系统帐号约束列表)来源信息。                      |

**示例:**

  ```js
F
fanchenxuan 已提交
1883 1884 1885 1886
  let accountManager = account_osAccount.getAccountManager();
  accountManager.queryOsAccountConstraintSourceTypes(100, 'constraint.wifi',(err,sourceTypeInfos)=>{
    console.info('queryOsAccountConstraintSourceType errInfo:' + JSON.stringify(err));
    console.info('queryOsAccountConstraintSourceType sourceTypeInfos:' + JSON.stringify(sourceTypeInfos));
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
  });
  ```

### queryOsAccountConstraintSourceTypes<sup>9+</sup>

queryOsAccountConstraintSourceTypes(localId: number, constraint: string): Promise&lt;Array&lt;ConstraintSourceTypeInfo&gt;&gt;;

查询指定系统帐号的指定约束来源信息。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名  | 类型   | 必填 | 说明         |
| ------- | ------ | ---- | ------------ |
| localId     | number | 是   |  要查询的系统帐号ID |
| constraint     | string | 是   |  要查询的[约束](#系统帐号约束列表)名称 |

**返回值:**

| 类型                  | 说明                                                         |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)&gt;&gt; | Promise实例,用于获取异步返回结果,返回的是指定系统帐号的指定[约束](#系统帐号约束列表)来源信息。 |

**示例:**

  ```js
F
fanchenxuan 已提交
1918 1919 1920
  let accountManager = account_osAccount.getAccountManager();
  accountManager.queryOsAccountConstraintSourceTypes(100, 'constraint.wifi').then((result) => {
    console.info('queryOsAccountConstraintSourceType sourceTypeInfos:' + JSON.stringify(result));
J
jidong 已提交
1921
  }).catch((err)=>{
F
fanchenxuan 已提交
1922
    console.info('queryOsAccountConstraintSourceType errInfo:' + JSON.stringify(err));
J
jidong 已提交
1923
  });
1924 1925
  ```

1926 1927 1928 1929
## UserAuth<sup>8+</sup>

用户认证类。

1930 1931
此接口为系统接口,三方应用不支持调用。

1932 1933 1934 1935 1936 1937
### constructor<sup>8+</sup>

constructor()

创建用户认证的实例。

1938 1939
此接口为系统接口,三方应用不支持调用。

1940 1941 1942 1943
**系统能力**:SystemCapability.Account.OsAccount

**示例:** 
  ```js
J
jidong 已提交
1944
  let userAuth = new account_osAccount.UserAuth();
1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
  ```


### getVersion<sup>8+</sup>

getVersion(): number;

返回版本信息。

此接口为系统接口,三方应用不支持调用。

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

**返回值:**

| 类型   | 说明         |
| :----- | :----------- |
| number | 返回版本信息。|

**示例:** 
  ```js
J
jidong 已提交
1966 1967
  let userAuth = new account_osAccount.UserAuth();
  let version = userAuth.getVersion();
F
fanchenxuan 已提交
1968
  console.log('getVersion version = ' + version);
1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986
  ```

### getAvailableStatus<sup>8+</sup>

getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;

检查身份认证功能是否可用。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名           | 类型                                           | 必填 | 说明                       |
| --------------- | -----------------------------------------------| ---- | ------------------------- |
1987 1988
| authType        | [AuthType](#authtype8)             | 是   | 指示用于认证的凭据类型。     |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8) | 是   | 表示身份验证结果的信任级别。 |
1989 1990 1991 1992 1993

**返回值:**

| 类型   | 说明                                       |
| :----- | :---------------------------------------- |
1994
| number | 返回验证[结果](#resultcode8)。 | 
1995 1996 1997

**示例:** 
  ```js
J
jidong 已提交
1998 1999 2000 2001
  let userAuth = new account_osAccount.UserAuth();
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
  let status = userAuth.getAvailableStatus(authType, authTrustLevel);
F
fanchenxuan 已提交
2002
  console.log('getAvailableStatus status = ' + status);
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
  ```

### getProperty<sup>8+</sup>

getProperty(request: GetPropertyRequest, callback: AsyncCallback&lt;ExecutorProperty&gt;): void;

基于指定的请求信息获取属性,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型                                                                    | 必填 | 说明                                |
| -------- | ----------------------------------------------------------------------- | ---- | ---------------------------------- |
2021 2022
| request  | [GetPropertyRequest](#getpropertyrequest8)                  | 是   | 请求信息,包括认证类型和属性类型列表。 |
| callback | AsyncCallback&lt;[ExecutorProperty](#executorproperty8)&gt; | 是   | 回调结果,返回的是调用者属性。        |
2023 2024 2025

**示例:**
  ```js
J
jidong 已提交
2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036
  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
  };
  userAuth.getProperty(request, (err, result) => {
F
fanchenxuan 已提交
2037 2038
    console.log('getProperty err = ' + JSON.stringify(err));
    console.log('getProperty result = ' + JSON.stringify(result));
J
jidong 已提交
2039
  });
2040 2041 2042 2043
  ```

### getProperty<sup>8+</sup>

2044
getProperty(request: GetPropertyRequest): Promise&lt;ExecutorProperty&gt;;
2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057

基于指定的请求信息获取属性,使用Promise方式异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型                                                   | 必填 | 说明                                |
| -------- | ------------------------------------------------------ | ---- | ---------------------------------- |
2058
| request  | [GetPropertyRequest](#getpropertyrequest8) | 是   | 请求信息,包括认证类型和属性类型列表。 |
2059 2060 2061 2062 2063

**返回值:**

| 类型                                                              | 说明                                                 |
| :---------------------------------------------------------------- | :-------------------------------------------------- |
2064
| Promise&lt;[ExecutorProperty](#executorproperty8)&gt; | Promise实例,用于获取异步返回结果,返回的是调用者属性。 |
2065 2066 2067

**示例:**
  ```js
J
jidong 已提交
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
  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
  };
  userAuth.getProperty(request).then((result) => {
F
fanchenxuan 已提交
2079
    console.log('getProperty result = ' + JSON.stringify(result));
J
jidong 已提交
2080
  }).catch((err) => {
F
fanchenxuan 已提交
2081
    console.log('getProperty error = ' + JSON.stringify(err));
2082 2083 2084 2085 2086
  });
  ```

### setProperty<sup>8+</sup>

2087
setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;number&gt;): void;
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100

设置可用于初始化算法的属性,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型                                                  | 必填 | 说明                                                                    |
| -------- | ----------------------------------------------------- | ---- | ---------------------------------------------------------------------- |
2101 2102
| request  | [SetPropertyRequest](#setpropertyrequest8)| 是   | 请求信息,包括认证类型和要设置的密钥值。                                   |
| callback | AsyncCallback&lt;number&gt;                           | 是   | 回调结果,返回一个[数值](#resultcode8),指示属性设置是否成功。 |
2103 2104 2105

**示例:**
  ```js
J
jidong 已提交
2106 2107 2108 2109 2110 2111 2112
  let userAuth = new account_osAccount.UserAuth();
  let request = {
    authType: account_osAccount.AuthType.PIN,
    key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
    setInfo: new Uint8Array([0])
  };
  userAuth.setProperty(request, (err, result) => {
F
fanchenxuan 已提交
2113 2114
      console.log('setProperty error = ' + JSON.stringify(err));
      console.log('setProperty result = ' + JSON.stringify(result));
2115 2116 2117 2118 2119
  });
  ```

### setProperty<sup>8+</sup>

2120
setProperty(request: SetPropertyRequest): Promise&lt;number&gt;;
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133

设置可用于初始化算法的属性,使用Promise方式异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型                                                   | 必填 | 说明                                      |
| -------- | ------------------------------------------------------ | ---- | ---------------------------------------- |
2134
| request  | [SetPropertyRequest](#setpropertyrequest8) | 是   | 请求信息,包括身份验证类型和要设置的密钥值。 |
2135 2136 2137 2138 2139

**返回值:**

| 类型                  | 说明                                                                                           |
| :-------------------- | :-------------------------------------------------------------------------------------------- |
2140
| Promise&lt;number&gt; | Promise实例,用于获取异步返回结果,返回一个[数值](#resultcode8),指示属性设置是否成功。 |
2141 2142 2143

**示例:**
  ```js
J
jidong 已提交
2144 2145 2146 2147 2148 2149 2150
  let userAuth = new account_osAccount.UserAuth();
  let request = {
    authType: account_osAccount.AuthType.PIN,
    key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
    setInfo: new Uint8Array([0])
  };
  userAuth.setProperty(request).then((result) => {
F
fanchenxuan 已提交
2151
    console.log('setProperty result = ' + JSON.stringify(result));
J
jidong 已提交
2152
  }).catch((err) => {
F
fanchenxuan 已提交
2153
    console.log('setProperty error = ' + JSON.stringify(err));
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173
  });
  ```

### auth<sup>8+</sup>

auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

执行认证,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名           | 类型                                                 | 必填 | 说明                                |
| --------------- | ---------------------------------------------------- | --- | ------------------------------------ |
| challenge       | Uint8Array                                           | 是  | 指示挑战值,挑战值为一个随机数,用于提升安全性。|
2174 2175 2176
| authType        | [AuthType](#authtype8)                   | 是  | 指示认证类型。                        |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8)       | 是  | 指示认证结果的信任级别。               |
| callback        | [IUserAuthCallback](#iuserauthcallback8) | 是  | 回调结果,返回的是结果和所获取的信息。  |
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186


**返回值:**

| 类型        | 说明               |
| :--------- | :----------------- |
| Uint8Array | 返回取消的上下文ID。 |

**示例:**
  ```js
J
jidong 已提交
2187 2188 2189 2190 2191 2192
  let userAuth = new account_osAccount.UserAuth();
  let challenge = new Uint8Array([0]);
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
  userAuth.auth(challenge, authType, authTrustLevel, {
    onResult: function(result,extraInfo){
F
fanchenxuan 已提交
2193 2194
        console.log('auth result = ' + result);
        console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
2195
    }
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216
  });
  ```

### authUser<sup>8+</sup>

authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

执行用户认证,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名           | 类型                                                 | 必填 | 说明                                |
| --------------- | ---------------------------------------------------- | --- | ------------------------------------ |
| userId          | number                                               | 是  | 指示用户身份。                        |
| challenge       | Uint8Array                                           | 是  | 指示挑战值,挑战值为一个随机数,用于提升安全性。                          |
2217 2218 2219
| authType        | [AuthType](#authtype8)                   | 是  | 指示认证类型。                        |
| authTrustLevel  | [AuthTrustLevel](#authtrustlevel8)       | 是  | 指示认证结果的信任级别。               |
| callback        | [IUserAuthCallback](#iuserauthcallback8) | 是  | 回调结果,返回的是结果和所获取的信息。  |
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229


**返回值:**

| 类型        | 说明               |
| :--------- | :----------------- |
| Uint8Array | 返回取消的上下文ID。 |

**示例:**
  ```js
J
jidong 已提交
2230
  let userAuth = new account_osAccount.UserAuth();
2231
  let userID = 100;
J
jidong 已提交
2232 2233 2234
  let challenge = new Uint8Array([0]);
  let authType = account_osAccount.AuthType.PIN;
  let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
2235
  userAuth.authUser(userID, challenge, authType, authTrustLevel, {
J
jidong 已提交
2236
    onResult: function(result,extraInfo){
F
fanchenxuan 已提交
2237 2238
        console.log('authUser result = ' + result);
        console.log('authUser extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
2239
    }
2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
  });
  ```

### cancelAuth<sup>8+</sup>

cancelAuth(contextID: Uint8Array): number;

取消特定的认证。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型       | 必填  | 说明                                        |
| ----------| ---------- | ---- | ------------------------------------------ |
| contextID | Uint8Array | 是   | 指示身份验证上下文ID,此ID动态生成没有具体值。 |

**返回值:**

| 类型   | 说明                                                       |
| :----- | :-------------------------------------------------------- |
2265
| number | 返回一个[数字](#resultcode8),指示取消是否成功。 |
2266 2267 2268

**示例:**
  ```js
J
jidong 已提交
2269 2270 2271 2272 2273
  let userAuth = new account_osAccount.UserAuth();
  let pinAuth = new account_osAccount.PINAuth();
  let challenge = new Uint8Array([0]);
  let contextID = userAuth.auth(challenge, account_osAccount.AuthType.PIN, account_osAccount.AuthTrustLevel.ATL1, {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2274 2275
      console.log('auth result = ' + result);
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
2276 2277 2278
    }
  });
  let result = userAuth.cancelAuth(contextID);
F
fanchenxuan 已提交
2279
  console.log('cancelAuth result = ' + result);
2280 2281 2282 2283 2284 2285
  ```

## PINAuth<sup>8+</sup>

Pin码认证功能基类。

2286 2287
此接口为系统接口,三方应用不支持调用。

2288 2289 2290 2291 2292 2293
### constructor<sup>8+</sup>

constructor()

创建Pin码认证的实例。

L
lichenchen 已提交
2294 2295
此接口为系统接口,三方应用不支持调用。

2296 2297 2298 2299
**系统能力**:SystemCapability.Account.OsAccount

**示例:** 
  ```js
J
jidong 已提交
2300
  let pinAuth = new account_osAccount.PINAuth();
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318
  ```

### registerInputer

registerInputer(inputer: IInputer): boolean;

注册输入器。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型                                 | 必填 | 说明               |
| ----------| ----------------------------------- | --- | ------------------ |
2319
| inputer   | [IInputer](#iinputer8)  | 是  | 指示密码输入框回调。 |
2320 2321 2322 2323 2324 2325 2326 2327 2328

**返回值:**

| 类型    | 说明                                           |
| :------ | :-------------------------------------------- |
| boolean | 返回布尔值,true表示注册成功,false表示注册失败。 |

**示例:**
  ```js
J
jidong 已提交
2329
  let pinAuth = new account_osAccount.PINAuth();
J
jidong 已提交
2330
  let password = new Uint8Array([0, 0, 0, 0, 0]);
J
jidong 已提交
2331 2332 2333
  let result = pinAuth.registerInputer({
      onGetData: (pinSubType, callback) => {
        callback.onSetData(pinSubType, password);
2334
      }
J
jidong 已提交
2335
  });
F
fanchenxuan 已提交
2336
  console.log('registerInputer result = ' + result);
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
  ```

### unregisterInputer

unregisterInputer(): void;

卸载输入器。

此接口为系统接口,三方应用不支持调用。

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

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

**示例:**
  ```js
J
jidong 已提交
2353
  let pinAuth = new account_osAccount.PINAuth();
2354 2355 2356 2357 2358 2359 2360
  pinAuth.unregisterInputer();
  ```

## UserIdentityManager<sup>8+</sup>

获取用户身份管理类。

2361 2362
此接口为系统接口,三方应用不支持调用。

2363 2364 2365 2366 2367 2368
### constructor<sup>8+</sup>

constructor()

创建用户认证的实例。

2369 2370
此接口为系统接口,三方应用不支持调用。

2371 2372 2373 2374
**系统能力**:SystemCapability.Account.OsAccount

**示例:** 
  ```js
J
jidong 已提交
2375
  let userIDM = new account_osAccount.UserIdentityManager();
2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397
  ```

### openSession<sup>8+</sup>

openSession(callback: AsyncCallback&lt;Uint8Array&gt;): void;

打开会话,启动IDM操作以获取挑战值,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型                             | 必填 | 说明                              |
| -------- | -------------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback&lt;Uint8Array&gt;  | 是   | 回调结果,返回的是挑战值,非0即成功,为0则失败。|

**示例:**
  ```js
J
jidong 已提交
2398 2399
  let userIDM = new account_osAccount.UserIdentityManager();
  userIDM.openSession((err, challenge) => {
F
fanchenxuan 已提交
2400 2401
      console.log('openSession error = ' + JSON.stringify(err));
      console.log('openSession challenge = ' + JSON.stringify(challenge));
2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424
  });
  ```

### openSession<sup>8+</sup>

openSession(): Promise&lt;Uint8Array&gt;;

打开会话,启动IDM操作以获取挑战值,使用Promise方式异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**返回值:**

| 类型                      | 说明                                                      |
| :------------------------ | :------------------------------------------------------- |
| Promise&lt;Uint8Array&gt; | Promise实例,用于获取异步返回结果,返回的是挑战值,非0即成功,为0则失败。|

**示例:**
  ```js
J
jidong 已提交
2425 2426
  let userIDM = new account_osAccount.UserIdentityManager();
  userIDM.openSession().then((challenge) => {
F
fanchenxuan 已提交
2427
      console.info('openSession challenge = ' + JSON.stringify(challenge));
J
jidong 已提交
2428
  }).catch((err) => {
F
fanchenxuan 已提交
2429
      console.info('openSession error = ' + JSON.stringify(err));
J
jidong 已提交
2430
  });
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448
  ```

### addCredential<sup>8+</sup>

addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

添加凭据,添加用户凭据信息,传入凭据添加方法和凭据信息(凭据类型,子类,如果添加用户的非密码凭据,则传入密码身份验证令牌),并获取结果/获取信息,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名           | 类型                                             | 必填 | 说明                            |
| --------------- | ------------------------------------------------ | --- | -------------------------------- |
2449 2450
| credentialInfo  | [CredentialInfo](#credentialinfo8)   | 是  | 指示凭据信息。                      |
| callback        | [IIdmCallback](#iidmcallback8)       | 是  | 回调结果,返回的是结果和获取信息。  |
2451 2452 2453

**示例:**
  ```js
J
jidong 已提交
2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let pinAuth = new account_osAccount.PINAuth();
  pinAuth.registerInputer({
    onGetData: (pinSubType, callback) => {
      callback.onSetData(pinSubType, password);
    }
  });
  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) => {
    userIDM.addCredential(credentialInfo, {
      onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2470 2471
        console.log('updateCredential result = ' + result);
        console.log('updateCredential extraInfo = ' + extraInfo);
2472
      }
J
jidong 已提交
2473 2474
    });
  });
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492
  ```

### updateCredential<sup>8+</sup>

updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

更新凭据,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名           | 类型                                              | 必填 | 说明                            |
| --------------- | ------------------------------------------------- | --- | -------------------------------- |
2493 2494
| credentialInfo  | [CredentialInfo](#credentialinfo8)    | 是  | 指示凭据信息。                    |
| callback        | [IIdmCallback](#iidmcallback8)        | 是  | 回调结果,返回的是结果和获取信息。  |
2495 2496 2497

**示例:**
  ```js
J
jidong 已提交
2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512
  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({
    onGetData: (pinSubType, callback) => {
      callback.onSetData(pinSubType, password);
    }
  });
  userIDM.openSession((err, challenge) => {
J
jidong 已提交
2513
    userAuth.auth(challenge, credentialInfo.credType, account_osAccount.AuthTrustLevel.ATL1, {
J
jidong 已提交
2514 2515 2516 2517 2518 2519 2520
      onResult: (result, extraInfo) => {
        if (result != account_osAccount.ResultCode.SUCCESS) {
          return;
        }
        credentialInfo.token = extraInfo.token;
        userIDM.updateCredential(credentialInfo, {
          onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2521 2522
              console.log('updateCredential result = ' + result);
              console.log('updateCredential extraInfo = ' + extraInfo);
2523
          }
J
jidong 已提交
2524
        });
2525
      }
J
jidong 已提交
2526 2527
    });
  });
2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
  ```

### closeSession<sup>8+</sup>

closeSession(): void;

关闭会话,结束IDM操作

此接口为系统接口,三方应用不支持调用。

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

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

**示例:**
  ```js
J
jidong 已提交
2544
  let userIDM = new account_osAccount.UserIdentityManager();
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569
  userIDM.closeSession();
  ```

### cancel<sup>8+</sup>

cancel(challenge: Uint8Array): number;

根据挑战值取消条目。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型        | 必填 | 说明   |
| -------- | ----------- | ---- | ----- |
| challenge | Uint8Array | 是   | 挑战值。 |

**返回值:**

| 类型   | 说明                                                       |
| :----- | :-------------------------------------------------------- |
2570
| number | 返回一个[数字](#resultcode8),指示取消是否成功。 |
2571 2572 2573

**示例:**
  ```js
J
jidong 已提交
2574
  let userIDM = new account_osAccount.UserIdentityManager();
J
jidong 已提交
2575 2576
  let challenge = new Uint8Array([0]);
  let result = userIDM.cancel(challenge);
F
fanchenxuan 已提交
2577
  console.log('cancel result: ' + result);
2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596
  ```

### delUser<sup>8+</sup>

delUser(token: Uint8Array, callback: IIdmCallback): void;

删除具有身份验证令牌的用户,使用callback方式异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名    | 类型                                       | 必填 | 说明                      |
| -------- | ------------------------------------------ | --- | ------------------------- |
| token    | Uint8Array                                 | 是  | 身份验证令牌。             |
2597
| callback | [IIdmCallback](#iidmcallback8) | 是  | 回调结果,返回的是删除结果。|
2598 2599 2600

**示例:**
  ```js
J
jidong 已提交
2601 2602
  let userIDM = new account_osAccount.UserIdentityManager();
  let token = new Uint8Array([0]);
2603
  userIDM.delUser(token, {
J
jidong 已提交
2604
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2605 2606
      console.log('delUser result = ' + result);
      console.log('delUser extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
2607 2608
    }
  });
2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628
  ```

### delCred<sup>8+</sup>

delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): void;

删除用户凭据信息,使用callback方式异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

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

**参数:**

| 参数名           | 类型                                            | 必填 | 说明                      |
| --------------- | ----------------------------------------------- | --- | ---------------------------|
| credentialId    | Uint8Array                                      | 是  | 凭证索引。                  |
| token           | Uint8Array                                      | 是  | 身份验证令牌。              |
2629
| callback        | [IIdmCallback](#iidmcallback8)      | 是  | 回调结果,返回的是删除结果。 |
2630 2631 2632

**示例:**
  ```js
J
jidong 已提交
2633 2634 2635 2636 2637
  let userIDM = new account_osAccount.UserIdentityManager();
  let credentialId = new Uint8Array([0]);
  let token = new Uint8Array([0]);
  userIDM.delCred(credentialId, token, {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2638 2639
        console.log('delCred result = ' + result);
        console.log('delCred extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
2640 2641
    }
  });
2642 2643 2644 2645
  ```

### getAuthInfo<sup>8+</sup>

2646
getAuthInfo(callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;
2647 2648 2649 2650 2651 2652 2653

获取认证信息,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

2654
**需要权限:** ohos.permission.USE_USER_IDM
2655 2656 2657 2658 2659

**参数:**

| 参数名    | 类型                                               | 必填 | 说明                                                |
| -------- | -------------------------------------------------- | ---- | -------------------------------------------------- |
2660 2661 2662 2663 2664
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是   | 回调结果,返回的是当前用户指定类型的所有已注册凭据信息。|


**示例:**
  ```js
J
jidong 已提交
2665 2666
  let userIDM = new account_osAccount.UserIdentityManager();
  userIDM.getAuthInfo((err, result) => {
F
fanchenxuan 已提交
2667 2668
    console.log('getAuthInfo err = ' + JSON.stringify(err));
    console.log('getAuthInfo result = ' + JSON.stringify(result));
J
jidong 已提交
2669
  });
2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681
  ```

### getAuthInfo<sup>8+</sup>

getAuthInfo(authType: AuthType, callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;

获取指定类型的认证信息,使用callback回调异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

2682
**需要权限:** ohos.permission.USE_USER_IDM
2683 2684 2685 2686 2687 2688 2689

**参数:**

| 参数名    | 类型                                               | 必填 | 说明                                                |
| -------- | -------------------------------------------------- | ---- | -------------------------------------------------- |
| authType | [AuthType](#authtype8) | 是   | 认证类型。                                          |
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是   | 回调结果,返回的是当前用户指定类型的所有已注册凭据信息。|
2690 2691 2692

**示例:**
  ```js
J
jidong 已提交
2693 2694
  let userIDM = new account_osAccount.UserIdentityManager();
  userIDM.getAuthInfo(account_osAccount.AuthType.PIN, (err, result) => {
F
fanchenxuan 已提交
2695 2696
    console.log('getAuthInfo err = ' + JSON.stringify(err));
    console.log('getAuthInfo result = ' + JSON.stringify(result));
J
jidong 已提交
2697
  });
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709
  ```

### getAuthInfo<sup>8+</sup>

getAuthInfo(authType?: AuthType): Promise&lt;Array&lt;EnrolledCredInfo&gt;&gt;;

获取认证信息,使用Promise方式异步返回结果。

此接口为系统接口,三方应用不支持调用。

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

2710
**需要权限:** ohos.permission.USE_USER_IDM
2711 2712 2713 2714 2715

**参数:**

| 参数名    | 类型                                | 必填 | 说明      |
| -------- | ----------------------------------- | ---- | -------- |
2716
| authType | [AuthType](#authtype8)  | 否   | 认证类型。|
2717 2718 2719 2720 2721

**返回值:**

| 类型                                         | 说明                                                                       |
| :------------------------------------------- | :------------------------------------------------------------------------ |
2722
| Promise&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | Promise实例,用于获取异步返回结果,返回的是当前用户指定类型的所有已注册凭据信息。|
2723 2724 2725

**示例:**
  ```js
J
jidong 已提交
2726 2727
  let userIDM = new account_osAccount.UserIdentityManager();
  userIDM.getAuthInfo(account_osAccount.AuthType.PIN).then((result) => {
F
fanchenxuan 已提交
2728
    console.log('getAuthInfo result = ' + JSON.stringify(result))
J
jidong 已提交
2729
  }).catch((err) => {
F
fanchenxuan 已提交
2730
    console.log('getAuthInfo error = ' + JSON.stringify(err));
J
jidong 已提交
2731
  });
2732 2733 2734 2735 2736 2737
  ```

## IInputData<sup>8+</sup>

密码数据回调。

2738 2739
此接口为系统接口,三方应用不支持调用。

2740 2741 2742 2743
### onSetData<sup>8+</sup>

onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void;

2744 2745
此接口为系统接口,三方应用不支持调用。

2746 2747 2748 2749 2750 2751 2752 2753
通知设置数据。

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

**参数:**

| 参数名      | 类型                                     | 必填 | 说明                                            |
| ---------- | ---------------------------------------- | ---- | ----------------------------------------------- |
2754
| pinSubType | [AuthSubType](#authsubtype8) | 是   | 用于认证的凭据子类型。                            |
2755 2756 2757 2758
| data       | Uint8Array                               | 是   | 要设置的数据是凭据,用来在认证、添加、修改凭据操作。 |

**示例:**
  ```js
J
jidong 已提交
2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let passwordNumber = new Uint8Array([1, 2, 3, 4]);
  let inputer = {
    onGetData: (pinSubType, callback) => {
        if (pinSubType == account_osAccount.AuthSubType.PIN_NUMBER) {
          callback.onSetData(pinSubType, passwordNumber);
        } else {
          callback.onSetData(pinSubType, password);
        }
    }
  };
2770 2771 2772 2773 2774 2775
  ```

## IInputer<sup>8+</sup>

密码输入框回调。

2776 2777
此接口为系统接口,三方应用不支持调用。

2778 2779
### onGetData<sup>8+</sup>

2780
onGetData: (pinSubType: AuthSubType, callback: IInputData) => void;
2781 2782 2783

通知获取数据。

2784 2785
此接口为系统接口,三方应用不支持调用。

2786 2787 2788 2789 2790 2791
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名      | 类型                                    | 必填 | 说明             |
| ---------- | --------------------------------------- | ---- | --------------- |
2792
| callback   | [IInputData](#iinputdata8)  | 是   | 指示密码数据回调。|
2793 2794 2795

**示例:**
  ```js
J
jidong 已提交
2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808
  let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
  let passwordNumber = new Uint8Array([1, 2, 3, 4]);
  let inputer = {
    onGetData: (pinSubType, callback) => {
        if (pinSubType == account_osAccount.AuthSubType.PIN_NUMBER) {
          callback.onSetData(pinSubType, passwordNumber);
        } else {
          callback.onSetData(pinSubType, password);
        }
    }
  };
  let pinAuth = new account_osAccount.PINAuth();
  let result = pinAuth.registerInputer(inputer);
F
fanchenxuan 已提交
2809
  console.log('registerInputer result: ' + result);
2810 2811 2812 2813 2814 2815
  ```

## IUserAuthCallback<sup>8+</sup>

用户认证回调。

2816 2817
此接口为系统接口,三方应用不支持调用。

2818 2819 2820 2821 2822 2823
### onResult<sup>8+</sup>

onResult: (result: number, extraInfo: AuthResult) => void;

身份认证结果代码通过回调返回。

2824 2825
此接口为系统接口,三方应用不支持调用。

2826 2827 2828 2829 2830 2831 2832
**系统能力:** SystemCapability.Account.OsAccount

**参数:**

| 参数名     | 类型                                    | 必填 | 说明                 |
| --------- | --------------------------------------- | ---- | ------------------- |
| result    | number                                   | 是   | 表示身份认证结果代码。|
2833
| extraInfo | [AuthResult](#authresult8)  | 是   | 表示不同情况下的具体信息,如果认证通过,则在extrainfo中返回认证令牌,如果身份验证失败,则在extrainfo中返回剩余的身份验证时间,如果身份验证执行器被锁定,冻结时间将在extrainfo中返回。|
2834 2835 2836

**示例:**
  ```js
J
jidong 已提交
2837 2838
  let authCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2839 2840
      console.log('auth result = ' + result);
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
2841 2842
    }
  };
2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864
  ```

### onAcquireInfo?<sup>8+</sup>

onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;

在身份验证期间,TipsCode通过回调返回。

此接口为系统接口,三方应用不支持调用。

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

**参数:**

| 参数名    | 类型     | 必填 | 说明                           |
| --------- | ------- | ---- | ----------------------------- |
| module    | number  | 是   | 指示用于身份验证的执行器类型。   |
| acquire   | number  | 是   | 指示不同身份验证执行器的tip代码。|
| extraInfo | any     | 是   | 保留参数。                     |

**示例:**
  ```js
J
jidong 已提交
2865 2866
  let authCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2867 2868
      console.log('auth result = ' + result)
      console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
J
jidong 已提交
2869 2870
    },
    onAcquireInfo: (module, acquire, extraInfo) => {
F
fanchenxuan 已提交
2871 2872
      console.log('auth module = ' + module);
      console.log('auth acquire = ' + acquire);
J
jidong 已提交
2873 2874 2875
      console.info('auth extraInfo = ' + JSON.stringify(extraInfo));
    }
  };
2876 2877 2878 2879 2880 2881
  ```

## IIdmCallback<sup>8+</sup>

身份管理回调。

2882 2883
此接口为系统接口,三方应用不支持调用。

2884 2885
### onResult<sup>8+</sup>

2886
onResult: (result: number, extraInfo: RequestResult) => void;
2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898

身份认证结果代码通过回调返回。

此接口为系统接口,三方应用不支持调用。

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

**参数:**

| 参数名     | 类型                                    | 必填 | 说明                     |
| --------- | --------------------------------------- | ---- | ----------------------- |
| result    | number                                  | 是   | 表示身份认证结果代码。    |
2899
| extraInfo | [AuthResult](#authresult8)  | 是   | 针对不同情况传递具体信息。|
2900 2901 2902

**示例:**
  ```js
F
fanchenxuan 已提交
2903
  let idmCallback = {
J
jidong 已提交
2904
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2905
      console.log('callback result = ' + result)
J
jidong 已提交
2906 2907 2908
      console.info('callback extraInfo = ' + JSON.stringify(extraInfo));
    }
  };
2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930
  ```

### onAcquireInfo?<sup>8+</sup>

onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;

在身份验证期间,TipsCode通过回调返回。

此接口为系统接口,三方应用不支持调用。

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

**参数:**

| 参数名    | 类型     | 必填 | 说明                           |
| --------- | ------- | ---- | ----------------------------- |
| module    | number  | 是   | 指示用于身份验证的执行器类型。   |
| acquire   | number  | 是   | 指示不同身份验证执行器的tip代码。|
| extraInfo | any     | 是   | 保留参数。                     |

**示例:**
  ```js
J
jidong 已提交
2931 2932
  let idmCallback = {
    onResult: (result, extraInfo) => {
F
fanchenxuan 已提交
2933 2934
      console.log('callback result = ' + result)
      console.log('callback onResult = ' + JSON.stringify(extraInfo));
J
jidong 已提交
2935 2936
    },
    onAcquireInfo: (module, acquire, extraInfo) => {
F
fanchenxuan 已提交
2937 2938
      console.log('callback module = ' + module);
      console.log('callback acquire = ' + acquire);
J
jidong 已提交
2939 2940 2941
      console.log('callback onacquireinfo = ' + JSON.stringify(extraInfo));
    }
  };
2942 2943 2944 2945 2946 2947
  ```

## GetPropertyRequest<sup>8+</sup>

提供获取属性请求的信息。

2948 2949
此接口为系统接口,三方应用不支持调用。

2950 2951 2952 2953
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数名    | 类型                                                          | 必填   | 说明                   |
| -------- | ------------------------------------------------------------- | ----- | ----------------------- |
2954 2955
| authType | [AuthType](#authtype8)                            | 是    | 身份验证凭据类型。        |
| keys     | Array&lt;[GetPropertyType](#getpropertytype8)&gt; | 是    | 指示要获取的属性类型数组。 |
2956 2957 2958 2959 2960

## SetPropertyRequest<sup>8+</sup>

提供设置属性请求的信息。

2961 2962
此接口为系统接口,三方应用不支持调用。

2963 2964 2965 2966
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数名    | 类型                                             | 必填   | 说明                 |
| -------- | ------------------------------------------------ | ----- | -------------------- |
2967 2968
| authType | [AuthType](#authtype8)               | 是    | 身份验证凭据类型。     |
| key     | [SetPropertyType](#setpropertytype8) | 是    | 指示要设置的属性类型。 |
2969 2970 2971 2972 2973 2974
| setInfo  | Uint8Array                                       | 是    | 指示要设置的信息。     |

## ExecutorProperty<sup>8+</sup>

提供执行器的属性。

2975 2976
此接口为系统接口,三方应用不支持调用。

2977 2978 2979 2980 2981
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数名        | 类型                                     | 必填   | 说明              |
| ------------ | ---------------------------------------- | ----- | ----------------- |
| result       | number                                   | 是    | 指示结果。         |
2982
| authSubType  | [AuthSubType](#authsubtype8) | 是    | 指示认证凭据子类型。|
2983 2984 2985 2986 2987 2988 2989
| remainTimes  | number                                   | 否    | 指示剩余时间。     |
| freezingTime | number                                   | 否    | 指示冻结时间。     |

## AuthResult<sup>8+</sup>

指示认证结果的信息。

2990 2991
此接口为系统接口,三方应用不支持调用。

2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数名        | 类型        | 必填   | 说明              |
| ------------ | ----------- | ----- | ----------------- |
| token        | Uint8Array  | 否    | 指示认证令牌。     |
| remainTimes  | number      | 否    | 指示剩余时间。     |
| freezingTime | number      | 否    | 指示冻结时间。     |

## CredentialInfo<sup>8+</sup>

指示凭证信息。

3004 3005
此接口为系统接口,三方应用不支持调用。

3006 3007 3008 3009
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数名        | 类型                                     | 必填   | 说明              |
| ------------ | ---------------------------------------- | ----- | ----------------- |
3010 3011
| credType     | [AuthType](#authtype8)       | 是    | 指示凭据类型。     |
| credSubType  | [AuthSubType](#authsubtype8) | 是    | 指示凭据子类型。   |
3012 3013 3014 3015 3016 3017
| token        | Uint8Array                               | 是    | 指示认证令牌。     |

## RequestResult<sup>8+</sup>

指示请求结果的信息。

3018 3019
此接口为系统接口,三方应用不支持调用。

3020 3021 3022 3023 3024 3025 3026 3027 3028 3029
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数名        | 类型        | 必填   | 说明              |
| ------------ | ----------- | ----- | ----------------- |
| credentialId | Uint8Array  | 否    | 指示凭据索引。     |

## EnrolledCredInfo<sup>8+</sup>

指示已注册凭据的信息。

3030 3031
此接口为系统接口,三方应用不支持调用。

3032 3033 3034 3035 3036
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数名        | 类型                                     | 必填   | 说明              |
| ------------ | ---------------------------------------- | ----- | ------------------- |
| credentialId | Uint8Array                               | 是    | 指示凭据索引。       |
3037 3038
| authType     | [AuthType](#authtype8)       | 是    | 指示认证凭据类型。   |
| authSubType  | [AuthSubType](#authsubtype8) | 是    | 指示认证凭据子类型。 |
3039 3040 3041 3042 3043 3044
| templateId   | Uint8Array                               | 是    | 指示凭据模板ID。     |

## GetPropertyType<sup>8+</sup>

枚举,指示要获取的属性类型。

3045 3046
此接口为系统接口,三方应用不支持调用。

3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数           | 默认值 | 说明      |
| ------------- | ------ | --------- |
| AUTH_SUB_TYPE | 1      | 认证子类型。 |
| REMAIN_TIMES  | 2      | 剩余时间。   |
| FREEZING_TIME | 3      | 冻结时间。   |

## SetPropertyType<sup>8+</sup>

枚举,指示要设置的属性类型。

3059 3060
此接口为系统接口,三方应用不支持调用。

3061 3062 3063 3064 3065 3066 3067 3068 3069 3070
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数           | 默认值 | 说明        |
| -------------- | ----- | ----------- |
| INIT_ALGORITHM | 1     | 初始化算法。 |

## AuthType<sup>8+</sup>

枚举,指示身份验证的凭据类型。

3071 3072
此接口为系统接口,三方应用不支持调用。

3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数  | 默认值 | 说明             |
| ----- | ----- | ---------------- |
| PIN   | 1     | 指示PIN认证类型。 |
| FACE  | 2     | 指示脸部认证类型。|

## AuthSubType<sup>8+</sup>

枚举,指示用于认证的凭据子类型。

3084 3085
此接口为系统接口,三方应用不支持调用。

3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数       | 默认值 | 说明               |
| ---------- | ----- | ------------------ |
| PIN_SIX    | 10000 | 表示6位凭证。       |
| PIN_NUMBER | 10001 | 表示自定义数字凭证。 |
| PIN_MIXED  | 10002 | 表示自定义混合凭据。 |
| FACE_2D    | 20000 | 指示2D 人脸凭证。   |
| FACE_3D    | 20001 | 指示3D 人脸凭证。   |

## AuthTrustLevel<sup>8+</sup>

枚举,指示认证结果的受信任级别。

3100 3101
此接口为系统接口,三方应用不支持调用。

3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数  | 默认值 | 说明        |
| ---- | ------ | ----------- |
| ATL1 | 10000  | 信任级别 1。 |
| ATL2 | 20000  | 信任级别 2。 |
| ATL3 | 30000  | 信任级别 3。 |
| ATL4 | 40000  | 信任级别 4。 |

## Module<sup>8+</sup>

枚举,表示获取信息的模块。

3115 3116
此接口为系统接口,三方应用不支持调用。

3117 3118 3119 3120 3121 3122 3123 3124 3125 3126
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数       | 默认值 | 说明                     |
| --------- | ------ | ------------------------ |
| FACE_AUTH | 1      | 表示从人脸认证获取的信息。 |

## ResultCode<sup>8+</sup>

枚举,指示身份验证结果代码。

3127 3128
此接口为系统接口,三方应用不支持调用。

3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数                    | 默认值 | 说明                                     |
| ----------------------- | ----- | ---------------------------------------- |
| 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>

枚举,指示人脸验证过程中提示代码。

3149 3150
此接口为系统接口,三方应用不支持调用。

3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数                          | 默认值 | 说明                                     |
| ----------------------------- | ----- | ---------------------------------------- |
| 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    | 表示未检测到人脸。                         |

## ingerprintTips<sup>8+</sup>

枚举,指示指纹身份验证过程中提示代码。

3171 3172
此接口为系统接口,三方应用不支持调用。

3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

| 参数                          | 默认值 | 说明                                            |
| ----------------------------- | ----- | ----------------------------------------------- |
| 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 已提交
3184
## OsAccountInfo
Z
zengyawen 已提交
3185

Z
zengyawen 已提交
3186 3187 3188 3189
系统帐号信息。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

Z
zengyawen 已提交
3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203
| 参数名                         | 类型                                                         | 必填 | 说明                              |
| ------------------------------ | ------------------------------------------------------------ | ---- | --------------------------------- |
| 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) | 否   | 分布式帐号信息                    |
3204
| domainInfo<sup>8+</sup>        | [DomainAccountInfo](#domainaccountinfo8)                      | 否   | 域帐号信息                        |
Z
zengyawen 已提交
3205 3206

## DomainAccountInfo<sup>8+</sup>
Z
zengyawen 已提交
3207

Z
zengyawen 已提交
3208 3209 3210 3211 3212 3213 3214 3215
域帐号信息。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

| 参数名      | 类型   | 必填 | 说明       |
| ----------- | ------ | ---- | ---------- |
| domain      | string | 是   | 域名。     |
| accountName | string | 是   | 域帐号名。 |
Z
zhangalong 已提交
3216 3217 3218

## 系统帐号约束列表

Z
zengyawen 已提交
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228
| 约束                                  | 说明                           |
| ------------------------------------- | ------------------------------ |
| constraint.wifi                       | 禁止使用wifi                   |
| constraint.wifi.set                   | 禁止配置wifi                   |
| constraint.locale.set                 | 禁止配置设备语言               |
| constraint.app.accounts               | 禁止添加和删除应用帐号         |
| constraint.apps.install               | 禁止安装应用                   |
| constraint.apps.uninstall             | 禁止卸载应用                   |
| constraint.location.shared            | 禁止打开位置共享               |
| constraint.unknown.sources.install    | 禁止安装未知来源的应用         |
Z
zhangalong 已提交
3229
| constraint.global.unknown.app.install | 禁止所有用户安装未知来源的应用 |
Z
zengyawen 已提交
3230 3231
| constraint.bluetooth.set              | 禁止配置蓝牙                   |
| constraint.bluetooth | 禁止使用蓝牙 |
Z
zhangalong 已提交
3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250
| 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 已提交
3251 3252
| constraint.microphone.unmute | 禁止取消麦克风静音 |
| constraint.volume.adjust | 禁止调整音量 |
Z
zhangalong 已提交
3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269
| 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 已提交
3270
| constraint.device.unmute | 禁止取消设备静音 |
Z
zhangalong 已提交
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282
| 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 | 禁止打印 |
3283 3284 3285 3286
| constraint.private.dns.set | 禁止配置专用DNS |

## ConstraintSourceTypeInfo<sup>9+</sup>

L
lichenchen 已提交
3287
约束来源类型信息。
3288

J
jidong 已提交
3289 3290
此接口为系统接口。

3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

| 参数名      | 类型   | 必填 | 说明       |
| ----------- | ------ | ---- | ---------- |
| localId      | number | 是   | 系统帐号ID     |
| type | [ConstraintSourceType](#constraintsourcetype) | 是   | 约束来源类型 |

## ConstraintSourceType<sup>9+</sup>

枚举,约束来源类型。

J
jidong 已提交
3302 3303
此接口为系统接口。

3304 3305 3306 3307 3308 3309 3310 3311
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。

| 参数   | 默认值 | 说明         |
| ------ | ------ | ------------ |
| CONSTRAINT_NOT_EXIST  | 0      | 约束不存在 |
| CONSTRAINT_TYPE_BASE | 1      | 约束源自系统设置   |
| CONSTRAINT_TYPE_DEVICE_OWNER  | 2   | 约束源自设备所有者设置   |
| CONSTRAINT_TYPE_PROFILE_OWNER  | 3  | 约束源自资料所有者设置   |