js-apis-appAccount.md 181.4 KB
Newer Older
1
# 应用帐号管理
Z
zhaoyuan17 已提交
2

J
jidong 已提交
3
本模块提供应用帐号信息的添加、删除、修改和查询基础能力,并支持应用间鉴权和分布式数据同步功能。
4

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


## 导入模块

Z
zhangalong 已提交
11
```js
Z
zhaoyuan17 已提交
12 13 14 15 16 17
import account_appAccount from '@ohos.account.appAccount';
```


## account_appAccount.createAppAccountManager

Z
zengyawen 已提交
18
createAppAccountManager(): AppAccountManager
Z
zhaoyuan17 已提交
19

J
jidong 已提交
20
创建应用帐号管理器对象。
Z
zhaoyuan17 已提交
21

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

**返回值:**
25

H
HelloCrease 已提交
26 27
| 类型                | 说明           |
| ----------------- | ------------ |
J
jidong 已提交
28
| AppAccountManager | 应用帐号管理器对象。 |
Z
zhaoyuan17 已提交
29

Z
zengyawen 已提交
30
**示例:**
Z
zhangalong 已提交
31
  ```js
J
jidong 已提交
32
  let appAccountManager = account_appAccount.createAppAccountManager();
Z
zhaoyuan17 已提交
33 34 35 36
  ```

## AppAccountManager

J
jidong 已提交
37
应用帐号管理器类。
Z
zhaoyuan17 已提交
38

39 40 41 42
### createAccount<sup>9+</sup>

createAccount(name: string, callback: AsyncCallback&lt;void&gt;): void;

J
jidong 已提交
43
根据帐号名创建应用帐号。使用callback异步回调。
44 45 46 47 48

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

**参数:**

J
jidong 已提交
49 50 51 52
| 参数名      | 类型                    | 必填  | 说明               |
| -------- | ------------------------- | ----- | -------------------- |
| name     | string                    | 是    | 应用帐号的名称。          |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当创建成功时,err为null,否则为错误对象。 |
L
libing23 已提交
53 54 55

**错误码:**

J
jidong 已提交
56 57 58 59 60 61
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300004 | Account already exists. |
| 12300007 | The number of accounts reaches the upper limit. |
62 63 64 65

**示例:**

  ```js
J
jidong 已提交
66
  let appAccountManager = account_appAccount.createAppAccountManager();
67
  try {
J
jidong 已提交
68 69 70
    appAccountManager.createAccount("WangWu", (err) => { 
        console.log("createAccount err: " + JSON.stringify(err));
    });
71
  } catch (err) {
J
jidong 已提交
72
    console.log("createAccount err: " + JSON.stringify(err));
73 74 75 76 77
  }
  ```

### createAccount<sup>9+</sup>

L
libing23 已提交
78
createAccount(name: string, options: CreateAccountOptions, callback: AsyncCallback&lt;void&gt;): void
79

J
jidong 已提交
80
根据帐号名和可选项创建应用帐号。使用callback异步回调。
81 82 83 84 85 86 87

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

**参数:**

| 参数名       | 类型                        | 必填   | 说明                                       |
| --------- | ------------------------- | ---- | ---------------------------------------- |
J
jidong 已提交
88 89 90
| name      | string                    | 是    | 应用帐号的名称。                              |
| options | [CreateAccountOptions](#createaccountoptions9) | 是    | 创建应用帐号的选项,可提供自定义数据,但不建议包含敏感数据(如密码、Token等)。 |
| callback  | AsyncCallback&lt;void&gt; | 是    | 回调函数。当创建成功时,err为null,否则为错误对象。             |
L
libing23 已提交
91 92 93

**错误码:**

J
jidong 已提交
94 95 96 97 98 99
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or options. |
| 12300004 | Account already exists. |
| 12300007 | The number of accounts reaches the upper limit. |
100 101 102 103

**示例:**

  ```js
J
jidong 已提交
104 105 106 107 108 109
  let appAccountManager = account_appAccount.createAppAccountManager();
  let options = {
    customData: {
      "age": "10"
    }
  }
110
  try {
J
jidong 已提交
111 112 113 114 115
    appAccountManager.createAccount("LiSi", options, (err) => {
      if (err) {
        console.log("createAccount failed, error: " + JSON.stringify(err));
      } else {
        console.log("createAccount successfully");
L
libing23 已提交
116
      }
J
jidong 已提交
117 118 119
    });
  } catch(err) {
    console.log("createAccount exception: " + JSON.stringify(err));
120 121 122 123 124
  }
  ```

### createAccount<sup>9+</sup>

J
jidong 已提交
125
createAccount(name: string, options?: CreateAccountOptions): Promise&lt;void&gt;
126

J
jidong 已提交
127
根据帐号名和可选项创建应用帐号。使用Promise异步回调。
128 129 130 131 132 133 134

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

**参数:**

| 参数名       | 类型     | 必填   | 说明                                       |
| --------- | ------ | ---- | ---------------------------------------- |
J
jidong 已提交
135 136
| name      | string | 是    | 应用帐号的名称。                              |
| options | [CreateAccountOptions](#createaccountoptions9) | 否    | 创建应用帐号的选项,可提供自定义数据,但不建议包含敏感数据(如密码、Token等)。不填无影响。 |
137 138 139 140 141

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
L
libing23 已提交
142 143 144 145
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**错误码:**

J
jidong 已提交
146 147 148 149 150 151 152
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or options. |
| 12300004 | Account already exists. |
| 12300007 | The number of accounts reaches the upper limit. |
| 12400003 | The number of custom data reaches the upper limit. |
153 154 155 156

**示例:**

  ```js
J
jidong 已提交
157 158 159 160 161 162
  let appAccountManager = account_appAccount.createAppAccountManager();
  let options = {
    customData: {
      "age": "10"
    }
  }
163
  try {
J
jidong 已提交
164 165 166 167 168 169 170
    appAccountManager.createAccount("LiSi", options).then(() => {
      console.log("createAccount successfully");
    }).catch((err) => {
      console.log("createAccount failed, error: " + JSON.stringify(err));
    });
  } catch(err) {
    console.log("createAccount exception: " + JSON.stringify(err));
171 172 173 174 175 176 177
  }
  ```

### createAccountImplicitly<sup>9+</sup>

createAccountImplicitly(owner: string, callback: AuthCallback): void

J
jidong 已提交
178
根据指定的帐号所有者隐式地创建应用帐号。使用callback异步回调。
179 180 181 182 183

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

**参数:**

J
jidong 已提交
184
| 参数名      | 类型                | 必填   | 说明                      |
185
| -------- | --------------------- | ---- | ----------------------- |
J
jidong 已提交
186 187
| owner    | string                | 是    | 应用帐号所有者的包名。          |
| callback | [AuthCallback](#authcallback9) | 是    | 认证器回调对象,返回创建结果。 |
188

L
libing23 已提交
189 190
**错误码:**

J
jidong 已提交
191 192 193 194 195 196 197 198
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12300007 | The number of accounts reaches the upper limit. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
L
libing23 已提交
199

200 201 202 203 204 205
**示例:**

  ```js
  import featureAbility from '@ohos.ability.featureAbility';

  function onResultCallback(code, result) {
J
jidong 已提交
206 207
    console.log("resultCode: "  + code);
    console.log("result: "  + JSON.stringify(result));
208 209 210
  }

  function onRequestRedirectedCallback(request) {
J
jidong 已提交
211 212 213 214
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err) => {
      console.log("startAbility err: " + JSON.stringify(err));
    });
215 216
  }

J
jidong 已提交
217
  let appAccountManager = account_appAccount.createAppAccountManager();
218
  try {  
J
jidong 已提交
219 220 221 222
    appAccountManager.createAccountImplicitly("com.example.accountjsdemo", {
      onResult: onResultCallback,
      onRequestRedirected: onRequestRedirectedCallback
    });
223
  } catch (err) {
J
jidong 已提交
224
    console.log("createAccountImplicitly exception: " + JSON.stringify(err));
225 226 227 228 229 230 231
  }
  ```

### createAccountImplicitly<sup>9+</sup>

createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, callback: AuthCallback): void

J
jidong 已提交
232
根据指定的帐号所有者和可选项隐式地创建应用帐号。使用callback异步回调。
233 234 235 236 237 238 239

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

**参数:**

| 参数名      | 类型                    | 必填   | 说明                      |
| -------- | --------------------- | ---- | ----------------------- |
J
jidong 已提交
240 241 242
| owner    | string                | 是    | 应用帐号所有者的包名。          |
| options    | [CreateAccountImplicitlyOptions](#createaccountimplicitlyoptions9)   | 是    | 隐式创建账号的选项。          |
| callback | [AuthCallback](#authcallback9) | 是    | 认证器回调对象,返回创建结果。         |
243

L
libing23 已提交
244 245
**错误码:**

J
jidong 已提交
246 247 248 249 250 251 252 253
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or options. |
| 12300007 | The number of accounts reaches the upper limit. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
L
libing23 已提交
254

255 256 257 258 259 260
**示例:**

  ```js
  import featureAbility from '@ohos.ability.featureAbility';

  function onResultCallback(code, result) {
J
jidong 已提交
261 262
    console.log("resultCode: "  + code);
    console.log("result: "  + JSON.stringify(result));
263 264 265
  }

  function onRequestRedirectedCallback(request) {
J
jidong 已提交
266 267 268 269
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err) => {
      console.log("startAbility err: " + JSON.stringify(err));
    });
270 271
  }

J
jidong 已提交
272 273 274 275 276
  let appAccountManager = account_appAccount.createAppAccountManager();
  let options = {
    authType: "getSocialData",
    requiredLabels: [ "student" ]
  };
277
  try {
J
jidong 已提交
278 279 280
    appAccountManager.createAccountImplicitly("com.example.accountjsdemo", options, {
      onResult: onResultCallback,
      onRequestRedirected: onRequestRedirectedCallback
281 282
    });
  } catch (err) {
J
jidong 已提交
283
    console.log("createAccountImplicitly exception: " + JSON.stringify(err));
284 285 286 287 288 289 290
  }
  ```

### removeAccount<sup>9+</sup>

removeAccount(name: string, callback: AsyncCallback&lt;void&gt;): void

J
jidong 已提交
291
删除应用帐号。使用callback异步回调。
292 293 294 295 296 297 298

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

**参数:**

| 参数名      | 类型                        | 必填   | 说明               |
| -------- | ------------------------- | ---- | ---------------- |
J
jidong 已提交
299 300
| name     | string                    | 是    | 应用帐号的名称。      |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当删除成功时,err为null,否则为错误对象。 |
L
libing23 已提交
301 302 303

**错误码:**

J
jidong 已提交
304 305 306 307 308
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
309 310 311 312

**示例:**

  ```js
J
jidong 已提交
313
  let appAccountManager = account_appAccount.createAppAccountManager();
314
  try {
J
jidong 已提交
315 316 317 318 319 320
    appAccountManager.removeAccount("ZhaoLiu", (err) => {
      if (err) {
        console.log("removeAccount failed, error: " + JSON.stringify(err));
      } else {
        console.log("removeAccount successfully");
      }
321
   });
J
jidong 已提交
322 323
  } catch(err) {
    console.log("removeAccount exception: " + JSON.stringify(err));
324 325 326 327 328
  }
  ```

### removeAccount<sup>9+</sup>

J
jidong 已提交
329
removeAccount(name: string): Promise&lt;void&gt;
330

J
jidong 已提交
331
删除应用帐号。使用Promise异步回调。
332 333 334 335 336 337 338

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

**参数:**

| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
J
jidong 已提交
339
| name | string | 是    | 应用帐号的名称。 |
340 341 342 343 344

**返回值:**

| 类型                  | 说明                    |
| :------------------ | :-------------------- |
L
libing23 已提交
345 346 347 348
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**错误码:**

J
jidong 已提交
349 350 351 352 353
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
354 355 356 357

**示例:**

  ```js
J
jidong 已提交
358
  let appAccountManager = account_appAccount.createAppAccountManager();
359
  try {
J
jidong 已提交
360 361 362 363 364
    appAccountManager.removeAccount("Lisi").then(() => {
      console.log("removeAccount successfully");
    }).catch((err) => {
      console.log("removeAccount failed, error: " + JSON.stringify(err));
    });
365
  } catch (err) {
J
jidong 已提交
366
    console.log("removeAccount exception: " + JSON.stringify(err));
367 368 369 370 371 372 373
  }
  ```

### setAppAccess<sup>9+</sup>

setAppAccess(name: string, bundleName: string, isAccessible: boolean, callback: AsyncCallback&lt;void&gt;): void

J
jidong 已提交
374
设置指定应用对特定帐号的访问权限。使用callback异步回调。
375 376 377 378 379

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

**参数:**

J
jidong 已提交
380 381 382 383 384 385
| 参数名        | 类型                      | 必填   | 说明                                |
| ------------ | ------------------------- | ---- | --------------------------------- |
| name         | string                    | 是    | 应用帐号的名称。                           |
| bundleName   | string                    | 是    | 第三方应用的包名。                         |
| isAccessible | boolean                   | 是    | 是否可访问。true表示允许访问,false表示禁止访问。 |
| callback     | AsyncCallback&lt;void&gt; | 是    | 回调函数,如果设置成功,err为null,否则为错误对象。 |
386

L
libing23 已提交
387 388
**错误码:**

J
jidong 已提交
389 390 391 392 393 394
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. |
| 12400001 | Application not found. |
L
libing23 已提交
395

396 397 398
**示例:**

  ```js
J
jidong 已提交
399
  let appAccountManager = account_appAccount.createAppAccountManager();
400
  try {
J
jidong 已提交
401 402 403 404 405 406 407
    appAccountManager.setAppAccess("ZhangSan", "com.example.accountjsdemo", true, (err) => {
      if (err) {
        console.log("setAppAccess failed: " + JSON.stringify(err));
      } else {
        console.log("setAppAccess successfully");
      }
    });
408
  } catch (err) {
J
jidong 已提交
409
    console.log("setAppAccess exception: " + JSON.stringify(err));
410 411 412 413 414 415 416
  }
  ```

### setAppAccess<sup>9+</sup>

setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise&lt;void&gt;

J
jidong 已提交
417
设置指定应用对特定帐号的数据访问权限。使用Promise异步回调。
418 419 420 421 422 423 424

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

**参数:**

| 参数名        | 类型     | 必填   | 说明        |
| ---------- | ------ | ---- | --------- |
J
jidong 已提交
425
| name       | string | 是    | 应用帐号的名称。   |
426
| bundleName | string | 是    | 第三方应用的包名。 |
J
jidong 已提交
427
| isAccessible | boolean | 是    | 是否可访问。true表示允许访问,false表示禁止访问。 |
428 429 430 431 432

**返回值:**

| 类型                  | 说明                    |
| :------------------ | :-------------------- |
L
libing23 已提交
433 434 435 436
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**错误码:**

J
jidong 已提交
437 438 439 440 441 442
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. |
| 12400001 | Application not found. |
443 444 445 446

**示例:**

  ```js
J
jidong 已提交
447
  let appAccountManager = account_appAccount.createAppAccountManager();
448
  try {
J
jidong 已提交
449 450 451 452 453
    appAccountManager.setAppAccess("ZhangSan", "com.example.accountjsdemo", true).then(() => {
      console.log("setAppAccess successfully");
    }).catch((err) => {
      console.log("setAppAccess failed: " + JSON.stringify(err));
    });
454
  } catch (err) {
J
jidong 已提交
455
    console.log("setAppAccess exception: " + JSON.stringify(err));
456 457 458
  }
  ```

L
libing23 已提交
459
### checkAppAccess<sup>9+</sup>
Z
zhaoyuan17 已提交
460

L
libing23 已提交
461
checkAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
Z
zhaoyuan17 已提交
462

J
jidong 已提交
463
检查指定应用对特定帐号的数据是否可访问。使用callback异步回调。
464

Z
zengyawen 已提交
465
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
466

Z
zengyawen 已提交
467
**参数:**
Z
zhaoyuan17 已提交
468

H
HelloCrease 已提交
469 470
| 参数名        | 类型                        | 必填   | 说明                                |
| ---------- | ------------------------- | ---- | --------------------------------- |
J
jidong 已提交
471
| name       | string                    | 是    | 应用帐号的名称。                           |
H
HelloCrease 已提交
472
| bundleName | string                    | 是    | 第三方应用的包名。                         |
473
| callback   | AsyncCallback&lt;boolean&gt; | 是    | 回调函数。返回true表示指定应用可访问特定帐号的数据;返回false表示不可访问。 |
L
libing23 已提交
474 475 476

**错误码:**

J
jidong 已提交
477 478 479 480 481 482
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. |
| 12400001 | Application not found. |
Z
zengyawen 已提交
483 484

**示例:**
Z
zhaoyuan17 已提交
485

Z
zhangalong 已提交
486
  ```js
J
jidong 已提交
487
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
488
  try {
J
jidong 已提交
489 490 491 492 493 494 495
    appAccountManager.checkAppAccess("ZhangSan", "com.example.accountjsdemo", (err, isAccessible) => {
      if (err) {
        console.log("checkAppAccess failed, error: " + JSON.stringify(err));
      } else {
        console.log("checkAppAccess successfully");
      }
    });
L
libing23 已提交
496
  } catch (err) {
J
jidong 已提交
497
    console.log("checkAppAccess exception: " + JSON.stringify(err));
L
libing23 已提交
498 499
  }
  ```
Z
zhaoyuan17 已提交
500

L
libing23 已提交
501
### checkAppAccess<sup>9+</sup>
Z
zhaoyuan17 已提交
502

J
jidong 已提交
503
checkAppAccess(name: string, bundleName: string): Promise&lt;boolean&gt;
Z
zhaoyuan17 已提交
504

J
jidong 已提交
505
检查指定应用对特定帐号的数据是否可访问。使用Promise异步回调。
506

Z
zengyawen 已提交
507 508 509
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
Z
zhaoyuan17 已提交
510

L
libing23 已提交
511 512
| 参数名        | 类型     | 必填   | 说明        |
| ---------- | ------ | ---- | --------- |
J
jidong 已提交
513
| name       | string | 是    | 应用帐号的名称。   |
L
libing23 已提交
514
| bundleName | string | 是    | 第三方应用的包名。 |
Z
zhaoyuan17 已提交
515

Z
zengyawen 已提交
516
**返回值:**
Z
zhaoyuan17 已提交
517

H
HelloCrease 已提交
518
| 类型                  | 说明                    |
J
jidong 已提交
519 520
| ------------------- | --------------------- |
| Promise&lt;boolean&gt; | Promise对象,返回true表示指定应用可访问特定帐号的数据;返回false表示不可访问。 |
Z
zhaoyuan17 已提交
521

L
libing23 已提交
522
**错误码:**
Z
zhaoyuan17 已提交
523

J
jidong 已提交
524 525 526 527 528 529
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. |
| 12400001 | Application not found. |
530 531 532 533

**示例:**

  ```js
J
jidong 已提交
534
  let appAccountManager = account_appAccount.createAppAccountManager();
535
  try {
J
jidong 已提交
536 537 538 539 540
    appAccountManager.checkAppAccess("ZhangSan", "com.example.accountjsdemo").then((isAccessible) => {
      console.log("checkAppAccess successfully, isAccessible: " + isAccessible);
    }).catch((err) => {
      console.log("checkAppAccess failed, error: " + JSON.stringify(err));
    });
541
  } catch (err) {
J
jidong 已提交
542
    console.log("checkAppAccess exception: " + JSON.stringify(err));
543 544 545
  }
  ```

J
jidong 已提交
546
### setDataSyncEnabled<sup>9+</sup>
547

J
jidong 已提交
548
setDataSyncEnabled(name: string, isEnabled: boolean, callback: AsyncCallback&lt;void&gt;): void
549

J
jidong 已提交
550
开启或禁止指定应用帐号的数据同步功能。使用callback异步回调。
551 552 553 554 555 556 557

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

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

**参数:**

J
jidong 已提交
558 559 560 561 562
| 参数名      | 类型                        | 必填   | 说明                        |
| -------- | ------------------------- | ---- | ------------------------- |
| name     | string                    | 是    | 应用帐号的名称。                   |
| isEnabled | boolean                   | 是    | 是否开启数据同步。               |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当开启或禁止成功时,err为null,否则为错误对象。 |
L
libing23 已提交
563 564 565

**错误码:**

J
jidong 已提交
566 567 568 569 570
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
571 572 573 574

**示例:**

  ```js
J
jidong 已提交
575
  let appAccountManager = account_appAccount.createAppAccountManager();
576
  try {
J
jidong 已提交
577 578
      appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => { 
          console.log("setDataSyncEnabled err: " + JSON.stringify(err));
579 580
      });
  } catch (err) {
J
jidong 已提交
581
      console.log("setDataSyncEnabled err: " + JSON.stringify(err));
582 583 584
  }
  ```

J
jidong 已提交
585
### setDataSyncEnabled<sup>9+</sup>
586

J
jidong 已提交
587
setDataSyncEnabled(name: string, isEnabled: boolean): Promise&lt;void&gt;
588

J
jidong 已提交
589
开启或禁止指定应用帐号的数据同步功能。使用Promise异步回调。
590 591 592 593 594 595 596

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

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

**参数:**

J
jidong 已提交
597 598 599 600
| 参数名      | 类型      | 必填   | 说明          |
| -------- | ------- | ---- | ----------- |
| name     | string  | 是    | 应用帐号的名称。     |
| isEnabled | boolean | 是    | 是否开启数据同步。 |
601 602 603

**返回值:**

J
jidong 已提交
604 605 606
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
L
libing23 已提交
607 608 609

**错误码:**

J
jidong 已提交
610 611 612 613 614
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
615 616 617 618

**示例:**

  ```js
J
jidong 已提交
619
  let appAccountManager = account_appAccount.createAppAccountManager();
620
  try {
J
jidong 已提交
621 622
      appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => { 
          console.log('setDataSyncEnabled Success');
623
      }).catch((err) => {
J
jidong 已提交
624
          console.log("setDataSyncEnabled err: "  + JSON.stringify(err));
625 626
      });
  } catch (err) {
J
jidong 已提交
627
      console.log("setDataSyncEnabled err: "  + JSON.stringify(err));
628 629 630
  }
  ```

J
jidong 已提交
631
### checkDataSyncEnabled<sup>9+</sup>
632

J
jidong 已提交
633 634 635
checkDataSyncEnabled(name: string, callback: AsyncCallback&lt;boolean&gt;): void

检查指定应用帐号是否开启数据同步功能。使用callback异步回调。
636

J
jidong 已提交
637
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
638 639 640 641 642

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

**参数:**

J
jidong 已提交
643 644 645 646
| 参数名      | 类型                           | 必填   | 说明                    |
| -------- | ---------------------------- | ---- | --------------------- |
| name     | string                       | 是    | 应用帐号的名称。               |
| callback | AsyncCallback&lt;boolean&gt; | 是    | 回调函数。返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。 |
L
libing23 已提交
647 648 649

**错误码:**

J
jidong 已提交
650 651 652 653 654
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
655 656 657 658

**示例:**

  ```js
J
jidong 已提交
659
  let appAccountManager = account_appAccount.createAppAccountManager();
660
  try {
J
jidong 已提交
661 662 663 664 665 666 667
    appAccountManager.checkDataSyncEnabled("ZhangSan", (err, isEnabled) => {
      if (err) {
        console.log("checkDataSyncEnabled failed, err: " + JSON.stringify(err));
      } else {
        console.log('checkDataSyncEnabled successfully, isEnabled: ' + isEnabled);
      }
    });
668
  } catch (err) {
J
jidong 已提交
669
    console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
670 671 672
  }
  ```

J
jidong 已提交
673
### checkDataSyncEnabled<sup>9+</sup>
674

J
jidong 已提交
675
checkDataSyncEnabled(name: string): Promise&lt;boolean&gt;
676

J
jidong 已提交
677
检查指定应用帐号是否开启数据同步功能。使用Promise异步回调。
678

J
jidong 已提交
679
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
680 681 682 683 684

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

**参数:**

J
jidong 已提交
685 686 687
| 参数名  | 类型     | 必填   | 说明      |
| ---- | ------ | ---- | ------- |
| name | string | 是    | 应用帐号的名称。 |
688 689 690

**返回值:**

J
jidong 已提交
691 692 693
| 类型                     | 说明                    |
| :--------------------- | :-------------------- |
| Promise&lt;boolean&gt; | Promise对象,返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。 |
L
libing23 已提交
694 695 696

**错误码:**

J
jidong 已提交
697 698 699 700 701
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
702 703 704 705

**示例:**

  ```js
J
jidong 已提交
706
  let appAccountManager = account_appAccount.createAppAccountManager();
707
  try {
J
jidong 已提交
708 709 710 711 712
    appAccountManager.checkDataSyncEnabled("ZhangSan").then((isEnabled) => {
        console.log("checkDataSyncEnabled successfully, isEnabled: " + isEnabled);
    }).catch((err) => {
      console.log("checkDataSyncEnabled failed, err: " + JSON.stringify(err));
    });
713
  } catch (err) {
J
jidong 已提交
714
    console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
715 716 717
  }
  ```

J
jidong 已提交
718
### setCredential<sup>9+</sup>
Z
zhaoyuan17 已提交
719

J
jidong 已提交
720
setCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
721

J
jidong 已提交
722
设置指定应用帐号的凭据。使用callback异步回调。
723

Z
zengyawen 已提交
724
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
725

Z
zengyawen 已提交
726
**参数:**
Z
zhaoyuan17 已提交
727

J
jidong 已提交
728 729 730 731 732 733
| 参数名            | 类型                        | 必填   | 说明            |
| -------------- | ------------------------- | ---- | ------------- |
| name           | string                    | 是    | 应用帐号的名称。     |
| credentialType | string                    | 是    | 凭据类型。     |
| credential     | string                    | 是    | 凭据取值。       |
| callback       | AsyncCallback&lt;void&gt; | 是    | 回调函数。当凭据设置成功时,err为null,否则为错误对象。 |
L
libing23 已提交
734 735 736

**错误码:**

J
jidong 已提交
737 738 739 740 741
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType or credential. |
| 12300003 | Account not found. |
Z
zengyawen 已提交
742 743

**示例:**
Z
zhaoyuan17 已提交
744

Z
zhangalong 已提交
745
  ```js
J
jidong 已提交
746
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
747
  try {
J
jidong 已提交
748 749 750 751 752 753 754
    appAccountManager.setCredential("ZhangSan", "PIN_SIX", "xxxxxx", (err) => {
      if (err) {
        console.log("setCredential failed, error: " + JSON.stringify(err));
      } else {
        console.log("setCredential successfully");
      }
    });
L
libing23 已提交
755
  } catch (err) {
J
jidong 已提交
756
    console.log("setCredential exception: " + JSON.stringify(err));
L
libing23 已提交
757
  }
Z
zhaoyuan17 已提交
758 759
  ```

J
jidong 已提交
760
### setCredential<sup>9+</sup>
Z
zhaoyuan17 已提交
761

J
jidong 已提交
762
setCredential(name: string, credentialType: string, credential: string): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
763

J
jidong 已提交
764
设置指定应用帐号的凭据。使用Promise异步回调。
765

Z
zengyawen 已提交
766 767 768
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
Z
zhaoyuan17 已提交
769

J
jidong 已提交
770 771 772 773 774
| 参数名            | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
| name           | string | 是    | 应用帐号的名称。   |
| credentialType | string | 是    | 凭据类型。 |
| credential     | string | 是    | 凭据取值。    |
Z
zhaoyuan17 已提交
775

Z
zengyawen 已提交
776
**返回值:**
Z
zhaoyuan17 已提交
777

J
jidong 已提交
778
| 类型                 | 说明                    |
H
HelloCrease 已提交
779
| :------------------ | :-------------------- |
L
libing23 已提交
780 781 782 783
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**错误码:**

J
jidong 已提交
784 785 786 787 788
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType or credential. |
| 12300003 | Account not found. |
Z
zhaoyuan17 已提交
789

Z
zengyawen 已提交
790
**示例:**
Z
zhaoyuan17 已提交
791

Z
zhangalong 已提交
792
  ```js
J
jidong 已提交
793
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
794
  try {
J
jidong 已提交
795 796 797 798 799
    appAccountManager.setCredential("ZhangSan", "PIN_SIX", "xxxxxx").then(() => {
      console.log("setCredential successfully");
    }).catch((err) => {
      console.log("setCredential failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
800
  } catch (err) {
J
jidong 已提交
801
    console.log("setCredential exception: " + JSON.stringify(err));
L
libing23 已提交
802
  }
Z
zhaoyuan17 已提交
803 804
  ```

J
jidong 已提交
805
### getCredential<sup>9+</sup>
Z
zhaoyuan17 已提交
806

J
jidong 已提交
807
getCredential(name: string, credentialType: string, callback: AsyncCallback&lt;string&gt;): void
808

J
jidong 已提交
809
获取指定应用帐号的凭据。使用callback异步回调。
810

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

**参数:**
Z
zhaoyuan17 已提交
814

J
jidong 已提交
815 816 817 818 819
| 参数名            | 类型                          | 必填   | 说明             |
| -------------- | --------------------------- | ---- | -------------- |
| name           | string                      | 是    | 应用帐号的名称。        |
| credentialType | string                      | 是    | 凭据类型。 |
| callback       | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取凭据成功时,err为null,data为指定应用帐号的凭据;否则为错误对象。 |
L
libing23 已提交
820 821 822

**错误码:**

J
jidong 已提交
823 824 825 826 827 828
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType. |
| 12300003 | Account not found. |
| 12300102 | Credential not found. |
Z
zhaoyuan17 已提交
829

Z
zengyawen 已提交
830
**示例:**
Z
zhaoyuan17 已提交
831

Z
zhangalong 已提交
832
  ```js
J
jidong 已提交
833
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
834
  try {
J
jidong 已提交
835 836 837 838 839 840 841
      appAccountManager.getCredential("ZhangSan", "PIN_SIX", (err, result) => { 
        if (err) {
          console.log("getCredential failed, error: " + JSON.stringify(err));
        } else {
          console.log('getCredential successfully, result: ' + result);
        }
      });
L
libing23 已提交
842
  } catch (err) {
J
jidong 已提交
843
      console.log("getCredential err: " + JSON.stringify(err));
L
libing23 已提交
844
  }
Z
zhaoyuan17 已提交
845 846
  ```

J
jidong 已提交
847
### getCredential<sup>9+</sup>
Z
zhaoyuan17 已提交
848

J
jidong 已提交
849
getCredential(name: string, credentialType: string): Promise&lt;string&gt;
850

J
jidong 已提交
851
获取指定应用帐号的凭据。使用Promise异步回调。
852

Z
zengyawen 已提交
853
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
854

Z
zengyawen 已提交
855
**参数:**
Z
zhaoyuan17 已提交
856

J
jidong 已提交
857 858 859 860
| 参数名          | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
| name           | string | 是    | 应用帐号的名称。 |
| credentialType | string | 是    | 凭据类型。 |
Z
zhaoyuan17 已提交
861

Z
zengyawen 已提交
862
**返回值:**
Z
zhaoyuan17 已提交
863

J
jidong 已提交
864 865 866
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise对象,返回指定应用帐号的凭据。 |
L
libing23 已提交
867 868 869

**错误码:**

J
jidong 已提交
870 871 872 873 874 875
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType. |
| 12300003 | Account not found. |
| 12300102 | Credential not found. |
Z
zengyawen 已提交
876 877

**示例:**
Z
zhaoyuan17 已提交
878

Z
zhangalong 已提交
879
  ```js
J
jidong 已提交
880
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
881
  try {
J
jidong 已提交
882 883 884 885 886
    appAccountManager.getCredential("ZhangSan", "PIN_SIX").then((credential) => {
        console.log("getCredential successfully, credential: " + credential);
    }).catch((err) => {
        console.log("getCredential failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
887
  } catch (err) {
J
jidong 已提交
888
    console.log("getCredential exception: "  + JSON.stringify(err));
L
libing23 已提交
889
  }
Z
zhaoyuan17 已提交
890
  ```
891

J
jidong 已提交
892
### setCustomData<sup>9+</sup>
893

J
jidong 已提交
894
setCustomData(name: string, key: string, value: string, callback: AsyncCallback&lt;void&gt;): void
L
libing23 已提交
895

J
jidong 已提交
896
设置指定应用帐号的自定义数据。使用callback异步回调。
897 898 899 900 901

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

**参数:**

J
jidong 已提交
902 903 904 905 906 907
| 参数名      | 类型                        | 必填   | 说明                |
| -------- | ------------------------- | ---- | ----------------- |
| name     | string                    | 是    | 应用帐号的名称。 |
| key      | string                    | 是    | 自定义数据的键名。 |
| value    | string                    | 是    | 自定义数据的取值。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置自定义数据成功时,err为null,否则为错误对象。 |
L
libing23 已提交
908 909 910

**错误码:**

J
jidong 已提交
911 912 913 914 915 916
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or key or value. |
| 12300003 | Account not found. |
| 12400003 | The number of custom data reaches the upper limit. |
917 918 919 920

**示例:**

  ```js
J
jidong 已提交
921
  let appAccountManager = account_appAccount.createAppAccountManager();
922
  try {
J
jidong 已提交
923 924 925 926 927 928 929
    appAccountManager.setCustomData("ZhangSan", "age", "12", (err) => {
      if (err) {
        console.log("setCustomData failed, error: " + JSON.stringify(err));
      } else {
        console.log("setCustomData successfully");
      }
    });
930
  } catch (err) {
J
jidong 已提交
931
    console.log("setCustomData exception: " + JSON.stringify(err));
932 933 934
  }
  ```

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

J
jidong 已提交
937
setCustomData(name: string, key: string, value: string): Promise&lt;void&gt;
938

J
jidong 已提交
939
设置指定应用帐号的自定义数据。使用Promise异步回调。
940 941 942

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

J
jidong 已提交
943 944 945 946 947 948 949 950
**参数:**

| 参数名   | 类型 | 必填  | 说明              |
| ----- | ------ | ---- | ----------------- |
| name  | string | 是    | 应用帐号的名称。   |
| key   | string | 是    | 自定义数据的键名。 |
| value | string | 是    | 自定义数据的取值。 |

L
libing23 已提交
951
**返回值:**
952

J
jidong 已提交
953 954 955
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
956

L
libing23 已提交
957
**错误码:**
958

J
jidong 已提交
959 960 961 962 963 964
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or key or value. |
| 12300003 | Account not found. |
| 12400003 | The number of custom data reaches the upper limit. |
965 966 967 968

**示例:**

  ```js
J
jidong 已提交
969
  let appAccountManager = account_appAccount.createAppAccountManager();
970
  try {
J
jidong 已提交
971 972 973 974 975
    appAccountManager.setCustomData("ZhangSan", "age", "12").then(() => {
      console.log("setCustomData successfully");
    }).catch((err) => {
      console.log("setCustomData failed, error: " + JSON.stringify(err));
    });
976
  } catch (err) {
J
jidong 已提交
977
    console.log("setCustomData exception: " + JSON.stringify(err));
978 979
  }
  ```
Z
zhaoyuan17 已提交
980

J
jidong 已提交
981
### getCustomData<sup>9+</sup>
Z
zhaoyuan17 已提交
982

J
jidong 已提交
983
getCustomData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void
984

J
jidong 已提交
985
根据指定键名获取特定应用帐号的自定义数据。使用callback异步回调。
Z
zengyawen 已提交
986 987

**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
988

Z
zengyawen 已提交
989
**参数:**
Z
zhaoyuan17 已提交
990

J
jidong 已提交
991 992 993 994 995
| 参数名    | 类型                        | 必填  | 说明                     |
| -------- | --------------------------- | ----- | ------------------------ |
| name     | string                      | 是    | 应用帐号的名称。           |
| key      | string                      | 是    | 自定义数据的键名。         |
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取成功时,err为null,data为自定义数据的取值;否则为错误对象。 |
L
libing23 已提交
996 997 998

**错误码:**

J
jidong 已提交
999 1000 1001 1002 1003 1004
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or key. |
| 12300003 | Account not found. |
| 12400002 | Custom data not found. |
Z
zhaoyuan17 已提交
1005

Z
zengyawen 已提交
1006
**示例:**
Z
zhaoyuan17 已提交
1007

Z
zhangalong 已提交
1008
  ```js
J
jidong 已提交
1009
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1010
  try {
J
jidong 已提交
1011 1012 1013 1014 1015 1016 1017
    appAccountManager.getCustomData("ZhangSan", "age", (err, data) => {
      if (err) {
        console.log('getCustomData failed, error: ' + err);
      } else {
        console.log("getCustomData successfully, data: " + data);
      }
    });
L
libing23 已提交
1018
  } catch (err) {
J
jidong 已提交
1019
    console.log("getCustomData exception: " + JSON.stringify(err));
L
libing23 已提交
1020
  }
Z
zhaoyuan17 已提交
1021 1022
  ```

J
jidong 已提交
1023
### getCustomData<sup>9+</sup>
Z
zhaoyuan17 已提交
1024

J
jidong 已提交
1025
getCustomData(name: string, key: string): Promise&lt;string&gt;
1026

J
jidong 已提交
1027
根据指定键名获取特定应用帐号的自定义数据。使用Promise异步回调。
Z
zhaoyuan17 已提交
1028

Z
zengyawen 已提交
1029
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1030

Z
zengyawen 已提交
1031
**参数:**
Z
zhaoyuan17 已提交
1032

J
jidong 已提交
1033 1034 1035 1036
| 参数名  | 类型     | 必填   | 说明        |
| ---- | ------ | ---- | --------- |
| name | string | 是    | 应用帐号的名称。   |
| key  | string | 是    | 自定义数据的键名。 |
Z
zhaoyuan17 已提交
1037

Z
zengyawen 已提交
1038
**返回值:**
Z
zhaoyuan17 已提交
1039

J
jidong 已提交
1040 1041 1042
| 类型                   | 说明                    |
| --------------------- | --------------------- |
| Promise&lt;string&gt; | Promise对象,返回自定义数据的取值。 |
L
libing23 已提交
1043 1044 1045

**错误码:**

J
jidong 已提交
1046 1047 1048 1049 1050 1051
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or key. |
| 12300003 | Account not found. |
| 12400002 | Custom data not found. |
Z
zengyawen 已提交
1052 1053

**示例:**
Z
zhaoyuan17 已提交
1054

Z
zhangalong 已提交
1055
  ```js
J
jidong 已提交
1056
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1057
  try {
J
jidong 已提交
1058 1059 1060 1061 1062
    appAccountManager.getCustomData("ZhangSan", "age").then((data) => {
      console.log("getCustomData successfully, data: " + data);
    }).catch((err) => {
      console.log("getCustomData failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
1063
  } catch (err) {
J
jidong 已提交
1064
    console.log("getCustomData exception: " + JSON.stringify(err));
L
libing23 已提交
1065
  }
Z
zhaoyuan17 已提交
1066 1067
  ```

J
jidong 已提交
1068
### getCustomDataSync<sup>9+</sup>
Z
zhaoyuan17 已提交
1069

J
jidong 已提交
1070
getCustomDataSync(name: string, key: string): string;
Z
zhaoyuan17 已提交
1071

J
jidong 已提交
1072
根据指定键名获取特定应用帐号的自定义数据。使用同步方式返回结果。
Z
zhaoyuan17 已提交
1073

Z
zengyawen 已提交
1074 1075 1076
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
Z
zhaoyuan17 已提交
1077

J
jidong 已提交
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
| 参数名  | 类型     | 必填   | 说明        |
| ---- | ------ | ---- | --------- |
| name | string | 是    | 应用帐号的名称。   |
| key  | string | 是    | 自定义数据的键名。 |

**返回值:**

| 类型                    | 说明                    |
| --------------------- | --------------------- |
| string | 自定义数据的取值。 |
L
libing23 已提交
1088 1089 1090

**错误码:**

J
jidong 已提交
1091 1092 1093 1094 1095 1096
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or key. |
| 12300003 | Account not found. |
| 12400002 | Custom data not found. |
Z
zhaoyuan17 已提交
1097

Z
zengyawen 已提交
1098
**示例:**
Z
zhaoyuan17 已提交
1099

Z
zhangalong 已提交
1100
  ```js
J
jidong 已提交
1101
  let appAccountManager = account_appAccount.createAppAccountManager();
1102
  try {
J
jidong 已提交
1103 1104
      let value = appAccountManager.getCustomDataSync("ZhangSan", "age");
      console.info("getCustomDataSync successfully, vaue:" + value);
1105
  } catch (err) {
J
jidong 已提交
1106
    console.error("getCustomDataSync failed, error: " + JSON.stringify(err));
1107
  }
Z
zhaoyuan17 已提交
1108 1109
  ```

J
jidong 已提交
1110
### getAllAccounts<sup>9+</sup>
Z
zhaoyuan17 已提交
1111

J
jidong 已提交
1112
getAllAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
Z
zhaoyuan17 已提交
1113

J
jidong 已提交
1114 1115 1116
获取所有可访问的应用帐号信息。使用callback异步回调。

**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS。
Z
zhaoyuan17 已提交
1117

Z
zengyawen 已提交
1118
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1119

Z
zengyawen 已提交
1120
**参数:**
Z
zhaoyuan17 已提交
1121

J
jidong 已提交
1122 1123 1124
| 参数名      | 类型                                       | 必填   | 说明        |
| -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 回调函数。当查询成功时,err为null,data为获取到的应用帐号信息列表;否则为错误对象。 |
L
libing23 已提交
1125 1126 1127

**错误码:**

J
jidong 已提交
1128 1129 1130
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
Z
zengyawen 已提交
1131 1132

**示例:**
Z
zhaoyuan17 已提交
1133

Z
zhangalong 已提交
1134
  ```js
J
jidong 已提交
1135
  let appAccountManager = account_appAccount.createAppAccountManager();
1136
  try {
J
jidong 已提交
1137 1138 1139 1140 1141 1142 1143
    appAccountManager.getAllAccounts((err, data) => {
      if (err) {
        console.debug("getAllAccounts failed, error:" + JSON.stringify(err));
      } else {
        console.debug("getAllAccounts successfully");
      }
    });
1144
  } catch (err) {
J
jidong 已提交
1145
      console.debug("getAllAccounts exception: " + JSON.stringify(err));
1146
  }
Z
zhaoyuan17 已提交
1147 1148
  ```

J
jidong 已提交
1149
### getAllAccounts<sup>9+</sup>
Z
zhaoyuan17 已提交
1150

J
jidong 已提交
1151
getAllAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
Z
zengyawen 已提交
1152

J
jidong 已提交
1153 1154 1155
获取所有可访问的应用帐号信息。使用Promise异步回调。

**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS。
Z
zhaoyuan17 已提交
1156

1157
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1158

J
jidong 已提交
1159
**返回值:**
1160

J
jidong 已提交
1161 1162 1163
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise对象,返回全部应用已授权帐号信息对象。 |
L
libing23 已提交
1164 1165 1166

**错误码:**

J
jidong 已提交
1167 1168 1169
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
1170 1171

**示例:**
Z
zhaoyuan17 已提交
1172

Z
zhangalong 已提交
1173
  ```js
J
jidong 已提交
1174
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1175
  try {
J
jidong 已提交
1176 1177 1178 1179 1180
    appAccountManager.getAllAccounts().then((data) => {
      console.debug("getAllAccounts successfully");
    }).catch((err) => {
      console.debug("getAllAccounts failed, error:" + JSON.stringify(err));
    });
L
libing23 已提交
1181
  } catch (err) {
J
jidong 已提交
1182
    console.debug("getAllAccounts exception: " + JSON.stringify(err));
L
libing23 已提交
1183
  }
Z
zhaoyuan17 已提交
1184 1185
  ```

J
jidong 已提交
1186
### getAccountsByOwner<sup>9+</sup>
1187

J
jidong 已提交
1188
getAccountsByOwner(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
Z
zhaoyuan17 已提交
1189

J
jidong 已提交
1190 1191 1192
根据应用帐号所有者获取调用方可访问的应用帐号列表。使用callback异步回调。

**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS。
Z
zhaoyuan17 已提交
1193

Z
zengyawen 已提交
1194
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1195

Z
zengyawen 已提交
1196
**参数:**
Z
zhaoyuan17 已提交
1197

J
jidong 已提交
1198 1199 1200 1201
| 参数名      | 类型                                       | 必填   | 说明        |
| -------- | ---------------------------------------- | ---- | --------- |
| owner    | string                                   | 是    | 应用帐号所有者的包名。    |
| callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 回调函数。如果获取成功,err为null,data为获取到的应用帐号列表;否则为错误对象。 |
Z
zengyawen 已提交
1202

L
libing23 已提交
1203
**错误码:**
Z
zhaoyuan17 已提交
1204

J
jidong 已提交
1205 1206 1207 1208 1209
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12400001 | Application not found. |
Z
zhaoyuan17 已提交
1210

Z
zengyawen 已提交
1211
**示例:**
Z
zhaoyuan17 已提交
1212

Z
zhangalong 已提交
1213
  ```js
J
jidong 已提交
1214
  let appAccountManager = account_appAccount.createAppAccountManager();
1215
  try {
J
jidong 已提交
1216 1217 1218 1219 1220 1221 1222
    appAccountManager.getAccountsByOwner("com.example.accountjsdemo2", (err, data) => {
      if (err) {
        console.debug("getAccountsByOwner failed, error:" + JSON.stringify(err));
      } else {
        console.debug("getAccountsByOwner successfully, data:" + JSON.stringify(data));
      }
    });
1223
  } catch (err) {
J
jidong 已提交
1224
    console.debug("getAccountsByOwner exception:" + JSON.stringify(err));
1225
  }
Z
zhaoyuan17 已提交
1226 1227
  ```

J
jidong 已提交
1228 1229 1230
### getAccountsByOwner<sup>9+</sup>

getAccountsByOwner(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
Z
zhaoyuan17 已提交
1231

J
jidong 已提交
1232
根据应用帐号所有者获取调用方可访问的应用帐号列表。使用Promise异步回调。
Z
zhaoyuan17 已提交
1233

J
jidong 已提交
1234
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS。
Z
zhaoyuan17 已提交
1235

1236
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1237

L
libing23 已提交
1238 1239
**参数:**

J
jidong 已提交
1240 1241 1242
| 参数名   | 类型     | 必填   | 说明     |
| ----- | ------ | ---- | ------ |
| owner | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
1243

Z
zengyawen 已提交
1244
**返回值:**
Z
zhaoyuan17 已提交
1245

J
jidong 已提交
1246 1247 1248
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise对象,返回获取到的应用帐号列表。 |
L
libing23 已提交
1249 1250 1251

**错误码:**

J
jidong 已提交
1252 1253 1254 1255 1256
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12400001 | Application not found. |
Z
zengyawen 已提交
1257 1258

**示例:**
Z
zhaoyuan17 已提交
1259

Z
zhangalong 已提交
1260
  ```js
J
jidong 已提交
1261
  let appAccountManager = account_appAccount.createAppAccountManager();
1262
  try {
J
jidong 已提交
1263 1264 1265 1266 1267
    appAccountManager.getAccountsByOwner("com.example.accountjsdemo2").then((data) => {
      console.debug("getAccountsByOwner successfully, data:" + JSON.stringify(data));
    }).catch((err) => {
      console.debug("getAccountsByOwner failed, error:" + JSON.stringify(err));
    });
1268
  } catch (err) {
J
jidong 已提交
1269
    console.debug("getAccountsByOwner exception:" + JSON.stringify(err));
1270
  }
Z
zhaoyuan17 已提交
1271 1272
  ```

L
libing23 已提交
1273
### on('accountChange')<sup>9+</sup>
Z
zhaoyuan17 已提交
1274

L
libing23 已提交
1275
on(type: 'accountChange', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
Z
zhaoyuan17 已提交
1276

J
jidong 已提交
1277
订阅指定应用的帐号信息变更事件。
Z
zhaoyuan17 已提交
1278

Z
zengyawen 已提交
1279
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1280

Z
zengyawen 已提交
1281
**参数:**
Z
zhaoyuan17 已提交
1282

L
libing23 已提交
1283 1284
| 参数名      | 类型                                       | 必填   | 说明                             |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
J
jidong 已提交
1285 1286 1287
| type     | 'accountChange'                          | 是    | 事件回调类型,支持的事件为'accountChange',当目标应用更新帐号信息时,触发该事件。 |
| owners   | Array&lt;string&gt;                      | 是    | 应用帐号所有者的包名列表。                      |
| callback | Callback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 回调函数,返回信息发生变更的应用帐号列表。           |
L
libing23 已提交
1288 1289 1290

**错误码:**

J
jidong 已提交
1291 1292 1293 1294 1295 1296
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or owners. |
| 12300011 | Callback has been registered. |
| 12400001 | Application not found. |
Z
zengyawen 已提交
1297 1298

**示例:**
Z
zhaoyuan17 已提交
1299

Z
zhangalong 已提交
1300
  ```js
J
jidong 已提交
1301
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1302
  function changeOnCallback(data){
J
jidong 已提交
1303
  	console.log("receive change data:" + JSON.stringify(data));
L
libing23 已提交
1304 1305
  }
  try{
J
jidong 已提交
1306 1307 1308
  	appAccountManager.on("accountChange", ["com.example.actsaccounttest"], changeOnCallback);
  } catch(err) {
  	console.error("on accountChange failed, error:" + JSON.stringify(err));
L
libing23 已提交
1309
  }
Z
zhaoyuan17 已提交
1310 1311
  ```

L
libing23 已提交
1312
### off('accountChange')<sup>9+</sup>
1313

L
libing23 已提交
1314
off(type: 'accountChange', callback?: Callback<Array\<AppAccountInfo>>): void
1315

J
jidong 已提交
1316
取消订阅帐号信息变更事件。
1317

L
libing23 已提交
1318
**系统能力:** SystemCapability.Account.AppAccount
1319

L
libing23 已提交
1320
**参数:**
1321

L
libing23 已提交
1322 1323
| 参数名      | 类型                               | 必填   | 说明           |
| -------- | -------------------------------- | ---- | ------------ |
J
jidong 已提交
1324 1325
| type     | 'accountChange'                         | 是    | 事件回调类型,支持的事件为'accountChange',当帐号所有者更新帐号信息时,触发该事件。    |
| callback | Callback<Array\<[AppAccountInfo](#appaccountinfo)>> | 否    | 回调函数,返回信息发生变更的应用帐号列表。 |
1326

L
libing23 已提交
1327
**错误码:**
1328

J
jidong 已提交
1329 1330 1331 1332 1333
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid type. |
| 12300012 | Callback has not been registered. |
1334 1335 1336 1337

**示例:**

  ```js
J
jidong 已提交
1338
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1339
  function changeOnCallback(data){
J
jidong 已提交
1340 1341 1342 1343 1344 1345
  	console.log("receive change data:" + JSON.stringify(data));
  }
  try{
  	appAccountManager.on("accountChange", ["com.example.actsaccounttest"], changeOnCallback);
  } catch(err) {
  	console.error("on accountChange failed, error:" + JSON.stringify(err));
L
libing23 已提交
1346 1347
  }
  try{
J
jidong 已提交
1348
  	appAccountManager.off('accountChange', changeOnCallback);
L
libing23 已提交
1349 1350
  }
  catch(err){
J
jidong 已提交
1351
  	console.error("off accountChange failed, error:" + JSON.stringify(err));
L
libing23 已提交
1352
  }
1353 1354
  ```

L
libing23 已提交
1355
### auth<sup>9+</sup>
Z
zhaoyuan17 已提交
1356

L
libing23 已提交
1357
auth(name: string, owner: string, authType: string, callback: AuthCallback): void
Z
zhaoyuan17 已提交
1358

J
jidong 已提交
1359
对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。
Z
zengyawen 已提交
1360 1361

**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1362

Z
zengyawen 已提交
1363
**参数:**
Z
zhaoyuan17 已提交
1364

L
libing23 已提交
1365 1366
| 参数名      | 类型                    | 必填   | 说明              |
| -------- | --------------------- | ---- | --------------- |
J
jidong 已提交
1367 1368
| name     | string                | 是    | 应用帐号的名称。     |
| owner    | string                | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
1369
| authType | string                | 是    | 鉴权类型。           |
J
jidong 已提交
1370
| callback | [AuthCallback](#authcallback9) | 是    | 回调对象,返回鉴权结果。 |
L
libing23 已提交
1371 1372 1373

**错误码:**

J
jidong 已提交
1374 1375 1376 1377 1378 1379 1380 1381
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType. |
| 12300003 | Account not found. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
Z
zhaoyuan17 已提交
1382

Z
zengyawen 已提交
1383
**示例:**
Z
zhaoyuan17 已提交
1384

Z
zhangalong 已提交
1385
  ```js
L
libing23 已提交
1386 1387
  import featureAbility from '@ohos.ability.featureAbility';

J
jidong 已提交
1388 1389 1390
  function onResultCallback(code, authResult) {
    console.log("resultCode: "  + code);
    console.log("authResult: "  + JSON.stringify(authResult));
L
libing23 已提交
1391 1392 1393
  }

  function onRequestRedirectedCallback(request) {
J
jidong 已提交
1394 1395 1396 1397
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err) => {
        console.log("startAbility err: " + JSON.stringify(err));
    });
L
libing23 已提交
1398 1399
  }

J
jidong 已提交
1400
  let appAccountManager = account_appAccount.createAppAccountManager();
1401
  try {
J
jidong 已提交
1402 1403 1404 1405
    appAccountManager.auth("LiSi", "com.example.accountjsdemo", "getSocialData", {
        onResult: onResultCallback,
        onRequestRedirected: onRequestRedirectedCallback
    });
1406
  } catch (err) {
J
jidong 已提交
1407
    console.log("auth exception: "  + JSON.stringify(err));
1408
  }
Z
zhaoyuan17 已提交
1409 1410
  ```

L
libing23 已提交
1411
### auth<sup>9+</sup>
Z
zhaoyuan17 已提交
1412

L
libing23 已提交
1413
auth(name: string, owner: string, authType: string, options: {[key: string]: Object}, callback: AuthCallback): void
Z
zhaoyuan17 已提交
1414

J
jidong 已提交
1415
对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。
Z
zhaoyuan17 已提交
1416

Z
zengyawen 已提交
1417
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1418

Z
zengyawen 已提交
1419
**参数:**
Z
zhaoyuan17 已提交
1420

L
libing23 已提交
1421 1422
| 参数名      | 类型                    | 必填   | 说明              |
| -------- | --------------------- | ---- | --------------- |
J
jidong 已提交
1423 1424
| name     | string                | 是    | 应用帐号的名称。     |
| owner    | string                | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
1425 1426
| authType | string                | 是    | 鉴权类型。           |
| options  | {[key: string]: Object}  | 是    | 鉴权所需的可选项。       |
J
jidong 已提交
1427
| callback | [AuthCallback](#authcallback9) | 是    | 回调对象,返回鉴权结果。 |
1428

L
libing23 已提交
1429
**错误码:**
1430

J
jidong 已提交
1431 1432 1433 1434 1435 1436 1437 1438
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType. |
| 12300003 | Account not exist. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
Z
zengyawen 已提交
1439 1440

**示例:**
Z
zhaoyuan17 已提交
1441

Z
zhangalong 已提交
1442
  ```js
L
libing23 已提交
1443 1444
  import featureAbility from '@ohos.ability.featureAbility';

J
jidong 已提交
1445 1446 1447
  function onResultCallback(code, authResult) {
    console.log("resultCode: "  + code);
    console.log("authResult: "  + JSON.stringify(authResult));
L
libing23 已提交
1448 1449 1450
  }

  function onRequestRedirectedCallback(request) {
J
jidong 已提交
1451 1452 1453 1454
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err) => {
        console.log("startAbility err: " + JSON.stringify(err));
    });
L
libing23 已提交
1455 1456
  }

J
jidong 已提交
1457 1458 1459 1460
  let options = {
    "password": "xxxx",
  };
  let appAccountManager = account_appAccount.createAppAccountManager();
1461
  try {
J
jidong 已提交
1462 1463 1464 1465
    appAccountManager.auth("LiSi", "com.example.accountjsdemo", "getSocialData", options, {
        onResult: onResultCallback,
        onRequestRedirected: onRequestRedirectedCallback
    });
1466
  } catch (err) {
J
jidong 已提交
1467
    console.log("auth exception: "  + JSON.stringify(err));
1468
  }
Z
zhaoyuan17 已提交
1469 1470
  ```

L
libing23 已提交
1471
### getAuthToken<sup>9+</sup>
Z
zhaoyuan17 已提交
1472

L
libing23 已提交
1473
getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback&lt;string&gt;): void
1474

J
jidong 已提交
1475
获取指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。
Z
zengyawen 已提交
1476 1477

**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1478

Z
zengyawen 已提交
1479
**参数:**
Z
zhaoyuan17 已提交
1480

L
libing23 已提交
1481 1482 1483
| 参数名      | 类型                          | 必填   | 说明          |
| -------- | --------------------------- | ---- | ----------- |
| name     | string                      | 是    | 应用帐号的名称。    |
J
jidong 已提交
1484
| owner    | string                      | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
1485
| authType | string                      | 是    | 鉴权类型。       |
J
jidong 已提交
1486
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取成功时,err为null,data为授权令牌值;否则为错误对象。    |
L
libing23 已提交
1487 1488 1489

**错误码:**

J
jidong 已提交
1490 1491 1492 1493 1494 1495
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name, owner or authType. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
Z
zhaoyuan17 已提交
1496

Z
zengyawen 已提交
1497
**示例:**
Z
zhaoyuan17 已提交
1498

Z
zhangalong 已提交
1499
  ```js
J
jidong 已提交
1500
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1501
  try {
J
jidong 已提交
1502 1503 1504 1505 1506 1507 1508
    appAccountManager.getAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", (err, token) => {
      if (err) {
        console.log("getAuthToken failed, error: " + JSON.stringify(err));
      } else {
        console.log("getAuthToken successfully, token: " + token);
      }
    });
L
libing23 已提交
1509
  } catch (err) {
J
jidong 已提交
1510
      console.log("getAuthToken exception: " + JSON.stringify(err));
L
libing23 已提交
1511
  }
Z
zhaoyuan17 已提交
1512 1513
  ```

L
libing23 已提交
1514
### getAuthToken<sup>9+</sup>
Z
zhaoyuan17 已提交
1515

L
libing23 已提交
1516
getAuthToken(name: string, owner: string, authType: string): Promise&lt;string&gt;
1517

J
jidong 已提交
1518
获取指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。
Z
zengyawen 已提交
1519 1520

**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1521

Z
zengyawen 已提交
1522
**参数:**
Z
zhaoyuan17 已提交
1523

L
libing23 已提交
1524 1525 1526
| 参数名      | 类型     | 必填   | 说明          |
| -------- | ------ | ---- | ----------- |
| name     | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
1527
| owner    | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
1528
| authType | string | 是    | 鉴权类型。       |
Z
zhaoyuan17 已提交
1529

1530
**返回值:**
Z
zhaoyuan17 已提交
1531

J
jidong 已提交
1532
| 类型                    | 说明                 |
L
libing23 已提交
1533
| --------------------- | --------------------- |
J
jidong 已提交
1534
| Promise&lt;string&gt; | Promise对象,返回授权令牌。 |
L
libing23 已提交
1535 1536 1537

**错误码:**

J
jidong 已提交
1538 1539 1540 1541 1542 1543
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
Z
zhaoyuan17 已提交
1544

Z
zengyawen 已提交
1545
**示例:**
Z
zhaoyuan17 已提交
1546

Z
zhangalong 已提交
1547
  ```js
J
jidong 已提交
1548
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1549
  try {
J
jidong 已提交
1550 1551 1552 1553 1554
    appAccountManager.getAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData").then((token) => {
      console.log("getAuthToken successfully, token: " + token);
    }).catch((err) => {
      console.log("getAuthToken failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
1555
  } catch (err) {
J
jidong 已提交
1556
      console.log("getAuthToken exception: " + JSON.stringify(err));
L
libing23 已提交
1557
  }
Z
zhaoyuan17 已提交
1558 1559
  ```

L
libing23 已提交
1560
### setAuthToken<sup>9+</sup>
Z
zhaoyuan17 已提交
1561

L
libing23 已提交
1562
setAuthToken(name: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
1563

J
jidong 已提交
1564
为指定应用帐号设置特定鉴权类型的授权令牌。使用callback异步回调。
Z
zhaoyuan17 已提交
1565

Z
zengyawen 已提交
1566
**系统能力:** SystemCapability.Account.AppAccount
Z
zhaoyuan17 已提交
1567

Z
zengyawen 已提交
1568
**参数:**
Z
zhaoyuan17 已提交
1569

L
libing23 已提交
1570 1571 1572 1573
| 参数名      | 类型                        | 必填   | 说明       |
| -------- | ------------------------- | ---- | -------- |
| name     | string                    | 是    | 应用帐号的名称。 |
| authType | string                    | 是    | 鉴权类型。    |
J
jidong 已提交
1574 1575
| token    | string                    | 是    | 授权令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null;否则为错误对象。 |
L
libing23 已提交
1576 1577 1578

**错误码:**

J
jidong 已提交
1579 1580 1581 1582 1583 1584
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType or token. |
| 12300003 | Account not found. |
| 12400004 | The number of token reaches the upper limit. |
Z
zengyawen 已提交
1585 1586

**示例:**
Z
zhaoyuan17 已提交
1587

Z
zhangalong 已提交
1588
  ```js
J
jidong 已提交
1589
  let appAccountManager = account_appAccount.createAppAccountManager();
1590
  try {
J
jidong 已提交
1591 1592 1593 1594 1595 1596 1597
    appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => {
      if (err) {
        console.log("setAuthToken failed, error: " + JSON.stringify(err));
      } else {
        console.log("setAuthToken successfully");
      }
    });
1598
  } catch (err) {
J
jidong 已提交
1599
      console.log('setAuthToken exception: ' + JSON.stringify(err));
Z
zhaoyuan17 已提交
1600 1601 1602
  }
  ```

L
libing23 已提交
1603
### setAuthToken<sup>9+</sup>
Z
zhaoyuan17 已提交
1604

L
libing23 已提交
1605
setAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
1606

J
jidong 已提交
1607
为指定应用帐号设置特定鉴权类型的授权令牌。使用Promise异步回调。
Z
zhaoyuan17 已提交
1608

Z
zengyawen 已提交
1609 1610 1611
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
Z
zhaoyuan17 已提交
1612

L
libing23 已提交
1613 1614 1615 1616
| 参数名      | 类型     | 必填   | 说明       |
| -------- | ------ | ---- | -------- |
| name     | string | 是    | 应用帐号的名称。 |
| authType | string | 是    | 鉴权类型。    |
J
jidong 已提交
1617
| token    | string | 是    | 授权令牌。 |
1618 1619 1620

**返回值:**

L
libing23 已提交
1621 1622 1623 1624 1625 1626
| 类型                  | 说明                    |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**错误码:**

J
jidong 已提交
1627 1628 1629 1630 1631 1632
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType or token. |
| 12300003 | Account not found. |
| 12400004 | The number of token reaches the upper limit. |
Z
zhaoyuan17 已提交
1633

Z
zengyawen 已提交
1634
**示例:**
Z
zhaoyuan17 已提交
1635

Z
zhangalong 已提交
1636
  ```js
J
jidong 已提交
1637
  let appAccountManager = account_appAccount.createAppAccountManager();
1638
  try {
J
jidong 已提交
1639 1640 1641 1642 1643
    appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => {
        console.log("setAuthToken successfully");
    }).catch((err) => {
        console.log("setAuthToken failed, error: " + JSON.stringify(err));
    });
1644
  } catch (err) {
J
jidong 已提交
1645
    console.log("setAuthToken exception: " + JSON.stringify(err));
Z
zhaoyuan17 已提交
1646 1647 1648
  }
  ```

L
libing23 已提交
1649
### deleteAuthToken<sup>9+</sup>
J
jidong 已提交
1650

L
libing23 已提交
1651
deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void
1652

J
jidong 已提交
1653
删除指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。
J
jidong 已提交
1654

Z
zengyawen 已提交
1655
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
1656

Z
zengyawen 已提交
1657
**参数:**
J
jidong 已提交
1658

L
libing23 已提交
1659 1660 1661
| 参数名      | 类型                        | 必填   | 说明           |
| -------- | ------------------------- | ---- | ------------ |
| name     | string                    | 是    | 应用帐号的名称。     |
J
jidong 已提交
1662
| owner    | string                    | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
1663
| authType | string                    | 是    | 鉴权类型。        |
J
jidong 已提交
1664 1665
| token    | string                    | 是    | 授权令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当删除成功时,err为null;否则为错误对象。     |
L
libing23 已提交
1666 1667 1668

**错误码:**

J
jidong 已提交
1669 1670 1671 1672 1673 1674
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType or token. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
1675 1676 1677 1678

**示例:**

  ```js
J
jidong 已提交
1679
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1680
  try {
J
jidong 已提交
1681 1682 1683 1684 1685 1686
      appAccountManager.deleteAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx", (err) => {
        if (err) {
          console.log('deleteAuthToken failed, error: ' + JSON.stringify(err));
        } else {
          console.log("deleteAuthToken successfully");
        }
L
libing23 已提交
1687 1688
      });
  } catch (err) {
J
jidong 已提交
1689
      console.log('deleteAuthToken exception: ' + JSON.stringify(err));
L
libing23 已提交
1690
  }
1691 1692
  ```

L
libing23 已提交
1693
### deleteAuthToken<sup>9+</sup>
1694

L
libing23 已提交
1695
deleteAuthToken(name: string, owner: string, authType: string, token: string): Promise&lt;void&gt;
1696

J
jidong 已提交
1697
删除指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。
1698 1699 1700 1701 1702

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

**参数:**

L
libing23 已提交
1703 1704 1705
| 参数名      | 类型     | 必填   | 说明           |
| -------- | ------ | ---- | ------------ |
| name     | string | 是    | 应用帐号的名称。     |
J
jidong 已提交
1706
| owner    | string | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
1707
| authType | string | 是    | 鉴权类型。        |
J
jidong 已提交
1708
| token    | string | 是    | 授权令牌。 |
1709 1710 1711

**返回值:**

L
libing23 已提交
1712 1713 1714 1715 1716 1717
| 类型                  | 说明                    |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**错误码:**

J
jidong 已提交
1718 1719 1720 1721 1722 1723
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType or token. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
1724 1725 1726 1727

**示例:**

  ```js
J
jidong 已提交
1728
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1729
  try {
J
jidong 已提交
1730 1731 1732 1733 1734
    appAccountManager.deleteAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx").then(() => {
      console.log("deleteAuthToken successfully");
    }).catch((err) => {
      console.log('deleteAuthToken failed, error: ' + JSON.stringify(err));
    });
L
libing23 已提交
1735
  } catch (err) {
J
jidong 已提交
1736
    console.log('deleteAuthToken exception: ' + JSON.stringify(err));
L
libing23 已提交
1737
  }
1738 1739
  ```

L
libing23 已提交
1740
### setAuthTokenVisibility<sup>9+</sup>
1741

L
libing23 已提交
1742
setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback&lt;void&gt;): void
1743

J
jidong 已提交
1744
设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。
1745 1746 1747 1748 1749

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

**参数:**

L
libing23 已提交
1750 1751 1752 1753 1754
| 参数名        | 类型                        | 必填   | 说明                        |
| ---------- | ------------------------- | ---- | ------------------------- |
| name       | string                    | 是    | 应用帐号的名称。                  |
| authType   | string                    | 是    | 鉴权类型。                     |
| bundleName | string                    | 是    | 被设置可见性的应用包名。              |
J
jidong 已提交
1755 1756
| isVisible  | boolean                   | 是    | 是否可见。true表示可见,false表示不可见。 |
| callback   | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null;否则为错误对象。|
L
libing23 已提交
1757 1758 1759

**错误码:**

J
jidong 已提交
1760 1761 1762 1763 1764 1765 1766 1767
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
| 12400001 | Application not found. |
| 12400005 | The size of authorization list reaches the upper limit. |
1768 1769 1770 1771

**示例:**

  ```js
J
jidong 已提交
1772
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1773
  try {
J
jidong 已提交
1774 1775 1776 1777 1778 1779
      appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true, (err) => {
        if (err) {
          console.log("setAuthTokenVisibility failed, error: " + JSON.stringify(err));
        } else {
          console.log("setAuthTokenVisibility successfully");
        }
L
libing23 已提交
1780 1781
      });
  } catch (err) {
J
jidong 已提交
1782
      console.log("setAuthTokenVisibility exception: " + JSON.stringify(err));
L
libing23 已提交
1783
  }
1784 1785
  ```

L
libing23 已提交
1786
### setAuthTokenVisibility<sup>9+</sup>
1787

L
libing23 已提交
1788
setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise&lt;void&gt;
1789

J
jidong 已提交
1790
设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。
1791 1792 1793 1794 1795

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

**参数:**

J
jidong 已提交
1796 1797 1798 1799 1800 1801
| 参数名      | 类型                        | 必填   | 说明                        |
| ---------- | ------------------------- | ---- | ------------------------- |
| name       | string                    | 是    | 应用帐号的名称。                  |
| authType   | string                    | 是    | 鉴权类型。                     |
| bundleName | string                    | 是    | 被设置可见性的应用包名。              |
| isVisible  | boolean                   | 是    | 是否可见。true表示可见,false表示不可见。 |
1802 1803 1804

**返回值:**

L
libing23 已提交
1805 1806 1807 1808 1809 1810
| 类型                  | 说明                    |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**错误码:**

J
jidong 已提交
1811 1812 1813 1814 1815 1816 1817 1818
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
| 12400001 | Application not found. |
| 12400005 | The size of authorization list reaches the upper limit. |
1819 1820 1821 1822

**示例:**

  ```js
J
jidong 已提交
1823
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1824
  try {
J
jidong 已提交
1825 1826 1827 1828 1829
    appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true).then(() => {
      console.log("setAuthTokenVisibility successfully");
    }).catch((err) => {
      console.log("setAuthTokenVisibility failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
1830
  } catch (err) {
J
jidong 已提交
1831
    console.log("setAuthTokenVisibility exception: " + JSON.stringify(err));
L
libing23 已提交
1832
  }
1833 1834
  ```

L
libing23 已提交
1835
### checkAuthTokenVisibility<sup>9+</sup>
1836

L
libing23 已提交
1837
checkAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
1838

J
jidong 已提交
1839
检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。
1840 1841 1842 1843 1844

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

**参数:**

L
libing23 已提交
1845 1846 1847 1848 1849
| 参数名        | 类型                           | 必填   | 说明          |
| ---------- | ---------------------------- | ---- | ----------- |
| name       | string                       | 是    | 应用帐号的名称。    |
| authType   | string                       | 是    | 鉴权类型。       |
| bundleName | string                       | 是    | 检查可见性的应用包名。 |
J
jidong 已提交
1850
| callback   | AsyncCallback&lt;boolean&gt; | 是    | 回调函数。当检查成功时,err为null,data为true表示可见,data为false表示不可见;否则为错误对象。    |
L
libing23 已提交
1851 1852 1853

**错误码:**

J
jidong 已提交
1854 1855 1856 1857 1858 1859 1860
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
| 12400001 | Application not found. |
L
libing23 已提交
1861

1862 1863 1864
**示例:**

  ```js
J
jidong 已提交
1865
  let appAccountManager = account_appAccount.createAppAccountManager();
1866
  try {
J
jidong 已提交
1867 1868 1869 1870 1871 1872 1873
    appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", (err, isVisible) => {
      if (err) {
        console.log("checkAuthTokenVisibility failed, error: " + JSON.stringify(err));
      } else {
        console.log("checkAuthTokenVisibility successfully, isVisible: " + isVisible);
      }
    });
1874
  } catch (err) {
J
jidong 已提交
1875
    console.log("checkAuthTokenVisibility exception: " + JSON.stringify(err));
1876 1877 1878
  }
  ```

L
libing23 已提交
1879
### checkAuthTokenVisibility<sup>9+</sup>
1880

L
libing23 已提交
1881
checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise&lt;boolean&gt;
1882

J
jidong 已提交
1883
检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。
1884 1885 1886 1887 1888

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

**参数:**

L
libing23 已提交
1889 1890 1891 1892 1893
| 参数名        | 类型     | 必填   | 说明            |
| ---------- | ------ | ---- | ------------- |
| name       | string | 是    | 应用帐号的名称。      |
| authType   | string | 是    | 鉴权类型。         |
| bundleName | string | 是    | 用于检查可见性的应用包名。 |
1894 1895 1896

**返回值:**

L
libing23 已提交
1897 1898
| 类型                     | 说明                    |
| ---------------------- | --------------------- |
J
jidong 已提交
1899
| Promise&lt;boolean&gt; | Promise对象,返回true表示授权令牌对指定应用的可见,返回false表示不可见。 |
L
libing23 已提交
1900 1901 1902

**错误码:**

J
jidong 已提交
1903 1904 1905 1906 1907 1908 1909
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
| 12400001 | Application not found. |
1910 1911 1912 1913

**示例:**

  ```js
J
jidong 已提交
1914
  let appAccountManager = account_appAccount.createAppAccountManager();
1915
  try {
J
jidong 已提交
1916 1917 1918 1919 1920
    appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo").then((isVisible) => {
      console.log("checkAuthTokenVisibility successfully, isVisible: " + isVisible);
    }).catch((err) => {
      console.log("checkAuthTokenVisibility failed, error: " + JSON.stringify(err));
    });
1921
  } catch (err) {
J
jidong 已提交
1922
    console.log("checkAuthTokenVisibility exception: " + JSON.stringify(err));
1923 1924 1925
  }
  ```

L
libing23 已提交
1926
### getAllAuthTokens<sup>9+</sup>
1927

J
jidong 已提交
1928
getAllAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&lt;AuthTokenInfo&gt;&gt;): void
1929

J
jidong 已提交
1930
获取指定帐号对调用方可见的所有授权令牌。使用callback异步回调。
1931 1932 1933 1934 1935

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

**参数:**

L
libing23 已提交
1936 1937 1938
| 参数名      | 类型                                       | 必填   | 说明          |
| -------- | ---------------------------------------- | ---- | ----------- |
| name     | string                                   | 是    | 应用帐号的名称。    |
J
jidong 已提交
1939 1940
| owner    | string                                   | 是    | 应用帐号所有者的包名。 |
| callback | AsyncCallback&lt;Array&lt;[AuthTokenInfo](#authtokeninfo9)&gt;&gt; | 是    | 回调函数。当获取成功时,err为null,data为授权令牌数组;否则为错误对象。    |
1941

L
libing23 已提交
1942 1943
**错误码:**

J
jidong 已提交
1944 1945 1946 1947 1948
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner. |
| 12300003 | Account not found. |
L
libing23 已提交
1949 1950

**示例:** 
1951 1952

  ```js
J
jidong 已提交
1953
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
1954
  try {
J
jidong 已提交
1955 1956 1957 1958 1959 1960 1961
    appAccountManager.getAllAuthTokens("LiSi", "com.example.accountjsdemo", (err, tokenArr) => {
      if (err) {
        console.log("getAllAuthTokens failed, error: "  + JSON.stringify(err));
      } else {
        console.log('getAllAuthTokens successfully, tokenArr: ' + tokenArr);
      }
    });
L
libing23 已提交
1962
  } catch (err) {
J
jidong 已提交
1963
    console.log("getAllAuthTokens exception: "  + JSON.stringify(err));
L
libing23 已提交
1964
  }
1965 1966
  ```

L
libing23 已提交
1967
### getAllAuthTokens<sup>9+</sup>
1968

L
libing23 已提交
1969
getAllAuthTokens(name: string, owner: string): Promise&lt;Array&lt;AuthTokenInfo&gt;&gt;
1970

J
jidong 已提交
1971
获取指定帐号对调用方可见的所有授权令牌。使用Promise异步回调。
1972 1973 1974 1975 1976

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

**参数:**

L
libing23 已提交
1977 1978 1979
| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
| name  | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
1980
| owner | string | 是    | 应用帐号所有者的包名。 |
1981 1982 1983

**返回值:**

L
libing23 已提交
1984 1985
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
J
jidong 已提交
1986
| Promise&lt;Array&lt;[AuthTokenInfo](#authtokeninfo9)&gt;&gt; | Promise对象,返回授权令牌数组。 |
L
libing23 已提交
1987 1988 1989

**错误码:**

J
jidong 已提交
1990 1991 1992 1993 1994
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner. |
| 12300003 | Account not found. |
1995 1996 1997 1998

**示例:**

  ```js
J
jidong 已提交
1999
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2000
  try {
J
jidong 已提交
2001 2002 2003 2004 2005
    appAccountManager.getAllAuthTokens("LiSi", "com.example.accountjsdemo").then((tokenArr) => {
        console.log('getAllAuthTokens successfully, tokenArr: ' + JSON.stringify(tokenArr));
    }).catch((err) => {
        console.log("getAllAuthTokens failed, error: "  + JSON.stringify(err));
    });
L
libing23 已提交
2006
  } catch (err) {
J
jidong 已提交
2007
    console.log("getAllAuthTokens exception: "  + JSON.stringify(err));
L
libing23 已提交
2008
  }
2009 2010
  ```

L
libing23 已提交
2011
### getAuthList<sup>9+</sup>
2012

L
libing23 已提交
2013
getAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
2014

J
jidong 已提交
2015
获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过[setAuthTokenVisibility](#setauthtokenvisibility9)来设置)。使用callback异步回调。
2016 2017 2018 2019 2020

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

**参数:**

L
libing23 已提交
2021 2022 2023
| 参数名      | 类型                                       | 必填   | 说明                      |
| -------- | ---------------------------------------- | ---- | ----------------------- |
| name     | string                                   | 是    | 应用帐号的名称。                |
J
jidong 已提交
2024 2025
| authType | string                                   | 是    | 鉴权类型。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 回调函数。当获取成功时,err为null,data为被授权的包名数组;否则为错误对象。 |
2026

L
libing23 已提交
2027
**错误码:**
2028

J
jidong 已提交
2029 2030 2031 2032 2033 2034
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
2035 2036 2037 2038

**示例:**

  ```js
J
jidong 已提交
2039
  let appAccountManager = account_appAccount.createAppAccountManager();
2040
  try {
J
jidong 已提交
2041 2042 2043 2044 2045 2046 2047
    appAccountManager.getAuthList("com.example.accountjsdemo", "getSocialData", (err, authList) => {
      if (err) {
        console.log("getAuthList failed, error: " + JSON.stringify(err));
      } else {
        console.log("getAuthList successfully, authList: " + authList);
      }
    });
2048
  } catch (err) {
J
jidong 已提交
2049
    console.log('getAuthList exception: ' + JSON.stringify(err));
2050 2051 2052
  }
  ```

L
libing23 已提交
2053
### getAuthList<sup>9+</sup>
2054

L
libing23 已提交
2055
getAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;
2056

J
jidong 已提交
2057
获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过[setAuthTokenVisibility](#setauthtokenvisibility9)来设置)。使用Promise异步回调。
2058 2059 2060 2061 2062

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

**参数:**

L
libing23 已提交
2063
| 参数名      | 类型     | 必填   | 说明                      |
J
jidong 已提交
2064
| -------- | ------ | ---- | ------------------------------ |
L
libing23 已提交
2065
| name     | string | 是    | 应用帐号的名称。                |
J
jidong 已提交
2066
| authType | string | 是    | 鉴权类型。 |
2067

L
libing23 已提交
2068
**返回值:**
2069

L
libing23 已提交
2070 2071
| 类型                                 | 说明                    |
| ---------------------------------- | --------------------- |
J
jidong 已提交
2072
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象,返回被授权的包名数组。 |
2073

L
libing23 已提交
2074
**错误码:**
2075

J
jidong 已提交
2076 2077 2078 2079 2080 2081
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
2082 2083 2084 2085

**示例:**

  ```js
J
jidong 已提交
2086
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2087
  try {
J
jidong 已提交
2088 2089 2090 2091 2092
    appAccountManager.getAuthList("com.example.accountjsdemo", "getSocialData").then((authList) => {
        console.log("getAuthList successfully, authList: " + authList);
    }).catch((err) => {
        console.log("getAuthList failed, error: "  + JSON.stringify(err));
    });
L
libing23 已提交
2093
  } catch (err) {
J
jidong 已提交
2094
    console.log("getAuthList exception: "  + JSON.stringify(err));
2095 2096 2097
  }
  ```

L
libing23 已提交
2098
### getAuthCallback<sup>9+</sup>
2099

L
libing23 已提交
2100
getAuthCallback(sessionId: string, callback: AsyncCallback&lt;AuthCallback&gt;): void
2101

J
jidong 已提交
2102
获取鉴权会话的认证器回调对象。使用callback异步回调。
2103 2104 2105 2106 2107

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

**参数:**

L
libing23 已提交
2108 2109 2110
| 参数名       | 类型                                       | 必填   | 说明       |
| --------- | ---------------------------------------- | ---- | -------- |
| sessionId | string                                   | 是    | 鉴权会话的标识。 |
J
jidong 已提交
2111
| callback  | AsyncCallback&lt;[AuthCallback](#authcallback9)&gt; | 是    | 回调函数。当获取成功时,err为null,data为鉴权会话的认证器回调对象;否则为错误对象。 |
L
libing23 已提交
2112 2113 2114

**错误码:**

J
jidong 已提交
2115 2116 2117 2118 2119
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid sessionId. |
| 12300108 | Session not found. |
2120 2121 2122 2123

**示例:**

  ```js
L
libing23 已提交
2124
  import featureAbility from '@ohos.ability.featureAbility';
J
jidong 已提交
2125
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2126
  featureAbility.getWant((err, want) => {
J
jidong 已提交
2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148
    var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
    try {
      appAccountManager.getAuthCallback(sessionId, (err, callback) => {
        if (err.code != account_appAccount.ResultCode.SUCCESS) {
            console.log("getAuthCallback err: "  + JSON.stringify(err));
            return;
        }
        var result = {
          accountInfo: {
            name: "Lisi",
            owner: "com.example.accountjsdemo",
          },
          tokenInfo: {
            token: "xxxxxx",
            authType: "getSocialData"
          }
        }; 
        callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
      });
    } catch (err) {
        console.log("getAuthCallback exception: "  + JSON.stringify(err));
    }
L
libing23 已提交
2149
  });
2150 2151
  ```

L
libing23 已提交
2152
### getAuthCallback<sup>9+</sup>
2153

L
libing23 已提交
2154
getAuthCallback(sessionId: string): Promise&lt;AuthCallback&gt;
2155

J
jidong 已提交
2156
获取鉴权会话的认证器回调对象。使用Promise异步回调。
2157 2158 2159 2160 2161

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

**参数:**

L
libing23 已提交
2162 2163 2164 2165 2166 2167 2168 2169
| 参数名       | 类型     | 必填   | 说明       |
| --------- | ------ | ---- | -------- |
| sessionId | string | 是    | 鉴权会话的标识。 |

**返回值:**

| 类型                                   | 说明                    |
| ------------------------------------ | --------------------- |
J
jidong 已提交
2170
| Promise&lt;[AuthCallback](#authcallback9)&gt; | Promise对象,返回鉴权会话的认证器回调对象。 |
L
libing23 已提交
2171 2172 2173

**错误码:**

J
jidong 已提交
2174 2175 2176 2177 2178
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid sessionId. |
| 12300108 | Session not found. |
2179 2180 2181 2182

**示例:**

  ```js
L
libing23 已提交
2183 2184
  import featureAbility from '@ohos.ability.featureAbility';

J
jidong 已提交
2185
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2186 2187 2188
  featureAbility.getWant().then((want) => {
      var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
      try {
J
jidong 已提交
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
        appAccountManager.getAuthCallback(sessionId).then((callback) => {
        var result = {
          accountInfo: {
            name: "Lisi",
            owner: "com.example.accountjsdemo",
          },
          tokenInfo: {
            token: "xxxxxx",
            authType: "getSocialData"
          }
        };
        callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
        }).catch((err) => {
            console.log("getAuthCallback err: "  + JSON.stringify(err));
        });
      } catch (err) {
        console.log("getAuthCallback exception: "  + JSON.stringify(err));
L
libing23 已提交
2206 2207 2208 2209
      }
  }).catch((err) => {
      console.log("getWant err: "  + JSON.stringify(err));
  });
2210 2211
  ```

L
libing23 已提交
2212
### queryAuthenticatorInfo<sup>9+</sup>
2213

L
libing23 已提交
2214
queryAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void
2215

J
jidong 已提交
2216
获取指定应用的认证器信息。使用callback异步回调。
2217 2218 2219 2220 2221

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

**参数:**

L
libing23 已提交
2222 2223
| 参数名      | 类型                                     | 必填   | 说明          |
| -------- | -------------------------------------- | ---- | ----------- |
J
jidong 已提交
2224 2225
| owner    | string                                 | 是    | 应用包名。 |
| callback | AsyncCallback&lt;[AuthenticatorInfo](#authenticatorinfo8)&gt; | 是    | 回调函数。当获取成功时,err为null,data为认证器信息对象;否则为错误对象。    |
2226

L
libing23 已提交
2227
**错误码:**
2228

J
jidong 已提交
2229 2230 2231 2232 2233
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12300113 | Authenticator service not found. |
2234

L
libing23 已提交
2235
**示例:**
2236

L
libing23 已提交
2237
  ```js
J
jidong 已提交
2238
  let appAccountManager = account_appAccount.createAppAccountManager();
2239
  try {
J
jidong 已提交
2240 2241 2242 2243 2244 2245 2246
    appAccountManager.queryAuthenticatorInfo("com.example.accountjsdemo", (err, info) => {
      if (err) {
        console.log("queryAuthenticatorInfo failed, error: "  + JSON.stringify(err));
      } else {
        console.log('queryAuthenticatorInfo successfully, info: ' + JSON.stringify(info));
      }
    });
2247
  } catch (err) {
J
jidong 已提交
2248
    console.log("queryAuthenticatorInfo exception: "  + JSON.stringify(err));
2249 2250 2251
  }
  ```

L
libing23 已提交
2252
### queryAuthenticatorInfo<sup>9+</sup>
2253

L
libing23 已提交
2254
queryAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
2255

J
jidong 已提交
2256
获取指定应用的认证器信息。使用Promise异步回调。
2257 2258 2259 2260 2261

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

**参数:**

L
libing23 已提交
2262 2263
| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
J
jidong 已提交
2264
| owner | string | 是    | 应用包名。 |
2265

L
libing23 已提交
2266
**返回值:**
2267

L
libing23 已提交
2268 2269
| 类型                               | 说明                    |
| -------------------------------- | --------------------- |
J
jidong 已提交
2270
| Promise&lt;[AuthenticatorInfo](#authenticatorinfo8)&gt; | Promise对象,返回指定应用的认证器信息对象。 |
2271

L
libing23 已提交
2272
**错误码:**
2273

J
jidong 已提交
2274 2275 2276 2277 2278
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12300113 | Authenticator service not found. |
L
libing23 已提交
2279 2280

**示例:**
2281

L
libing23 已提交
2282
  ```js
J
jidong 已提交
2283
  let appAccountManager = account_appAccount.createAppAccountManager();
2284
  try {
J
jidong 已提交
2285 2286 2287 2288 2289
    appAccountManager.queryAuthenticatorInfo("com.example.accountjsdemo").then((info) => { 
        console.log("queryAuthenticatorInfo successfully, info: " + JSON.stringify(info));
    }).catch((err) => {
        console.log("queryAuthenticatorInfo failed, error: "  + JSON.stringify(err));
    });
2290
  } catch (err) {
J
jidong 已提交
2291
    console.log("queryAuthenticatorInfo exception: "  + JSON.stringify(err));
2292 2293 2294
  }
  ```

L
libing23 已提交
2295
### checkAccountLabels<sup>9+</sup>
2296

L
libing23 已提交
2297
checkAccountLabels(name: string, owner: string, labels: Array&lt;string&gt;, callback: AsyncCallback&lt;boolean&gt;): void;
2298

J
jidong 已提交
2299
检查指定应用帐号是否满足特定的标签集合。使用callback异步回调。该方法依赖目标应用的认证器提供标签检查的能力。
2300 2301 2302 2303 2304

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

**参数:**

L
libing23 已提交
2305 2306
| 参数名         | 类型                       | 必填  | 说明             |
| -------------- | ------------------------- | ----- | --------------- |
J
jidong 已提交
2307 2308
| name           | string                    | 是    | 应用帐号的名称。  |
| owner          | string                    | 是    | 应用帐号的所有者。|
L
libing23 已提交
2309
| labels         | Array&lt;string&gt;       | 是    | 标签数组。       |
J
jidong 已提交
2310
| callback       | AsyncCallback&lt;boolean&gt; | 是    | 回调函数。当检查成功时,err为null,data为true表示满足特定的标签集合,data为false表示不满足;否则为错误对象。  |
2311

L
libing23 已提交
2312
**错误码:**
J
jidong 已提交
2313

J
jidong 已提交
2314 2315 2316 2317 2318 2319 2320 2321
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or labels. |
| 12300003 | Account not found. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
J
jidong 已提交
2322

L
libing23 已提交
2323
**示例:**
J
jidong 已提交
2324

L
libing23 已提交
2325
  ```js
J
jidong 已提交
2326 2327
  let appAccountManager = account_appAccount.createAppAccountManager();
  let labels = ["student"];
L
libing23 已提交
2328
  try {
J
jidong 已提交
2329 2330 2331 2332 2333 2334 2335
    appAccountManager.checkAccountLabels("zhangsan", "com.example.accountjsdemo", labels, (err, hasAllLabels) => {
      if (err) {
        console.log("checkAccountLabels failed, error: "  + JSON.stringify(err));
      } else {
        console.log("checkAccountLabels successfully, hasAllLabels: " + hasAllLabels);
      }
    });
L
libing23 已提交
2336
  } catch (err) {
J
jidong 已提交
2337
    console.log("checkAccountLabels exception: "  + JSON.stringify(err));
2338 2339 2340
  }
  ```

L
libing23 已提交
2341
### checkAccountLabels<sup>9+</sup>
2342

L
libing23 已提交
2343
checkAccountLabels(name: string, owner: string, labels: Array&lt;string&gt;): Promise&lt;boolean&gt;
2344

J
jidong 已提交
2345
检查指定应用帐号是否满足特定的标签集合。使用Promise异步回调。该方法依赖目标应用的认证器提供标签检查的能力。
2346 2347 2348 2349 2350

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

**参数:**

L
libing23 已提交
2351 2352
| 参数名         | 类型                       | 必填  | 说明             |
| -------------- | ------------------------- | ----- | --------------- |
J
jidong 已提交
2353 2354
| name           | string                    | 是    | 应用帐号的名称。  |
| owner          | string                    | 是    | 应用帐号的所有者。|
L
libing23 已提交
2355 2356 2357 2358 2359 2360
| labels         | Array&lt;string&gt;       | 是    | 标签数组。       |

**返回值:**

| 类型                | 说明                              |
| ------------------- | -------------------------------- |
J
jidong 已提交
2361
| Promise&lt;boolean&gt; | Promise对象,返回true表示指定帐号满足特定的标签集合,返回false表示不满足。 |
L
libing23 已提交
2362 2363 2364

**错误码:**

J
jidong 已提交
2365 2366 2367 2368 2369 2370 2371 2372
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or labels. |
| 12300003 | Account not found. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
2373 2374 2375 2376

**示例:**

  ```js
J
jidong 已提交
2377 2378
  let appAccountManager = account_appAccount.createAppAccountManager();
  let labels = ["student"];
2379
  try {
J
jidong 已提交
2380 2381 2382 2383 2384
    appAccountManager.checkAccountLabels("zhangsan", "com.example.accountjsdemo", labels).then((hasAllLabels) => {
      console.log('checkAccountLabels successfully: ' + hasAllLabels);
    }).catch((err) => {
      console.log("checkAccountLabels failed, error: "  + JSON.stringify(err));
    });
2385
  } catch (err) {
J
jidong 已提交
2386
    console.log("checkAccountLabels exception: "  + JSON.stringify(err));
J
jidong 已提交
2387
  }
2388 2389
  ```

L
libing23 已提交
2390
### deleteCredential<sup>9+</sup>
2391

L
libing23 已提交
2392
deleteCredential(name: string, credentialType: string, callback: AsyncCallback&lt;void&gt;): void
2393

J
jidong 已提交
2394
删除指定应用帐号的特定类型的凭据信息。使用callback异步回调。
2395 2396 2397 2398 2399

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

**参数:**

L
libing23 已提交
2400 2401
| 参数名         | 类型                       | 必填  | 说明            |
| -------------- | ------------------------- | ----- | -------------- |
J
jidong 已提交
2402
| name           | string                    | 是    | 应用帐号的名称。 |
L
libing23 已提交
2403
| credentialType | string                    | 是    | 凭据类型。      |
J
jidong 已提交
2404
| callback       | AsyncCallback&lt;void&gt; | 是    | 回调函数。当删除成功时,err为null;否则为错误对象。 |
2405

L
libing23 已提交
2406
**错误码:**
2407

J
jidong 已提交
2408 2409 2410 2411 2412 2413
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType. |
| 12300003 | Account not found. |
| 12300102 | Credential not found. |
2414 2415

**示例:**
J
jidong 已提交
2416

2417
  ```js
J
jidong 已提交
2418
  let appAccountManager = account_appAccount.createAppAccountManager();
2419
  try {
J
jidong 已提交
2420 2421 2422 2423 2424 2425 2426
    appAccountManager.deleteCredential("zhangsan", "PIN_SIX", (err) => {
      if (err) {
        console.log("deleteCredential failed, error: "  + JSON.stringify(err));
      } else {
        console.log("deleteCredential successfully");
      }
    });
2427
  } catch (err) {
J
jidong 已提交
2428
    console.log("deleteCredential exception: "  + JSON.stringify(err));
2429
  }
J
jidong 已提交
2430 2431
  ```

L
libing23 已提交
2432
### deleteCredential<sup>9+</sup>
J
jidong 已提交
2433

L
libing23 已提交
2434
deleteCredential(name: string, credentialType: string): Promise&lt;void&gt;
J
jidong 已提交
2435

J
jidong 已提交
2436
删除指定应用帐号的特定类型的凭据信息。使用Promise异步回调。
2437

Z
zengyawen 已提交
2438 2439 2440
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
2441

L
libing23 已提交
2442 2443
| 参数名         | 类型   | 必填   | 说明            |
| -------------- | ------ | ----- | --------------- |
J
jidong 已提交
2444
| name           | string | 是    | 应用帐号的名称。 |
L
libing23 已提交
2445 2446 2447 2448 2449 2450 2451 2452 2453 2454
| credentialType | string | 是    | 凭据类型。       |

**返回值:**

| 类型                | 说明                              |
| ------------------- | -------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**错误码:**

J
jidong 已提交
2455 2456 2457 2458 2459 2460
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType. |
| 12300003 | Account not found. |
| 12300102 | Credential not found. |
J
jidong 已提交
2461

Z
zengyawen 已提交
2462
**示例:**
J
jidong 已提交
2463

Z
zhangalong 已提交
2464
  ```js
J
jidong 已提交
2465
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2466
  try {
J
jidong 已提交
2467 2468 2469 2470 2471
    appAccountManager.deleteCredential("zhangsan", "PIN_SIX").then(() => {
      console.log("deleteCredential successfully");
    }).catch((err) => {
      console.log("deleteCredential failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
2472
  } catch (err) {
J
jidong 已提交
2473
    console.log("deleteCredential exception: "  + JSON.stringify(err));
L
libing23 已提交
2474
  }
J
jidong 已提交
2475 2476
  ```

L
libing23 已提交
2477
### selectAccountsByOptions<sup>9+</sup>
J
jidong 已提交
2478

J
jidong 已提交
2479
selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
J
jidong 已提交
2480

J
jidong 已提交
2481
根据选项选择调用方可访问的帐号列表。使用callback异步回调。如果选项中包含标签约束,则该方法依赖目标应用的认证器提供标签检查的能力。
2482

Z
zengyawen 已提交
2483
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
2484

Z
zengyawen 已提交
2485
**参数:**
J
jidong 已提交
2486

L
libing23 已提交
2487 2488
| 参数名         | 类型                                 | 必填  | 说明             |
| -------------- | ----------------------------------- | ----- | --------------- |
J
jidong 已提交
2489
| options        | SelectAccountsOptions               | 是    | 选择帐号的选项。  |
2490
| callback       | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 回调函数。当根据选项选择请求方可访问的帐号列表时,err为null,data为可访问的帐号信息对象;否则为错误对象。  |
J
jidong 已提交
2491

L
libing23 已提交
2492
**错误码:**
J
jidong 已提交
2493

J
jidong 已提交
2494 2495 2496 2497 2498 2499
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid options. |
| 12300010 | Account service busy. |
| 12300114 | Authenticator service exception. |
2500 2501 2502 2503

**示例:**

  ```js
J
jidong 已提交
2504 2505 2506 2507
  let appAccountManager = account_appAccount.createAppAccountManager();
  let options = {
    allowedOwners: [ "com.example.accountjsdemo" ],
    requiredLabels: [ "student" ]
L
libing23 已提交
2508
  };
2509
  try {
J
jidong 已提交
2510 2511 2512 2513 2514 2515 2516
    appAccountManager.selectAccountsByOptions(options, (err, accountArr) => {
      if (err) {
        console.log("selectAccountsByOptions failed, error: "  + JSON.stringify(err));
      } else {
        console.log("selectAccountsByOptions successfully, accountArr: " + JSON.stringify(accountArr));
      }
    });
2517
  } catch (err) {
J
jidong 已提交
2518
    console.log("selectAccountsByOptions exception: "  + JSON.stringify(err));
2519 2520 2521
  }
  ```

L
libing23 已提交
2522
### selectAccountsByOptions<sup>9+</sup>
2523

L
libing23 已提交
2524
selectAccountsByOptions(options: SelectAccountsOptions): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
2525

J
jidong 已提交
2526
根据选项选择调用方可访问的帐号列表。使用Promise异步回调。如果选项中包含标签约束,则该方法依赖目标应用的认证器提供标签检查的能力。
2527 2528 2529 2530 2531

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

**参数:**

L
libing23 已提交
2532 2533
| 参数名         | 类型                       | 必填  | 说明             |
| -------------- | ------------------------- | ----- | --------------- |
J
jidong 已提交
2534
| options        | [SelectAccountsOptions](#selectaccountsoptions9)     | 是    | 选择帐号的选项。  |
2535 2536 2537

**返回值:**

L
libing23 已提交
2538 2539
| 类型                | 说明                              |
| ------------------- | -------------------------------- |
J
jidong 已提交
2540
| Promise&lt;[AppAccountInfo](#appaccountinfo)&gt; | Promise对象,返回调用方可访问的帐号列表。 |
L
libing23 已提交
2541 2542 2543

**错误码:**

J
jidong 已提交
2544 2545 2546 2547 2548 2549
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid options. |
| 12300010 | Account service busy. |
| 12300114 | Authenticator service exception. |
2550 2551 2552 2553

**示例:**

  ```js
J
jidong 已提交
2554 2555 2556
  let appAccountManager = account_appAccount.createAppAccountManager();
  let options = {
    allowedOwners: ["com.example.accountjsdemo"]
L
libing23 已提交
2557
  };
2558
  try {
J
jidong 已提交
2559 2560 2561 2562 2563
    appAccountManager.selectAccountsByOptions(options).then((accountArr) => {
      console.log("selectAccountsByOptions successfully, accountArr: " + JSON.stringify(accountArr));
    }).catch((err) => {
      console.log("selectAccountsByOptions failed, error: "  + JSON.stringify(err));
    });
2564
  } catch (err) {
J
jidong 已提交
2565
    console.log("selectAccountsByOptions exception: "  + JSON.stringify(err));
2566 2567 2568
  }
  ```

L
libing23 已提交
2569
### verifyCredential<sup>9+</sup>
J
jidong 已提交
2570

J
jidong 已提交
2571
verifyCredential(name: string, owner: string, callback: AuthCallback): void;
J
jidong 已提交
2572

J
jidong 已提交
2573
验证指定帐号的凭据。使用callback异步回调。
2574

Z
zengyawen 已提交
2575 2576 2577
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
2578

L
libing23 已提交
2579 2580
| 参数名    | 类型                  | 必填  | 说明                     |
| -------- | --------------------- | ----- | ----------------------- |
J
jidong 已提交
2581 2582 2583
| name     | string                | 是    | 应用帐号的名称。          |
| owner    | string                | 是    | 应用帐号所有者的包名。        |
| callback | [AuthCallback](#authcallback9) | 是    | 回调函数,返回验证结果。 |
L
libing23 已提交
2584 2585 2586

**错误码:**

J
jidong 已提交
2587 2588 2589 2590 2591 2592 2593 2594
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner. |
| 12300003 | Account not found. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
J
jidong 已提交
2595

Z
zengyawen 已提交
2596
**示例:**
J
jidong 已提交
2597

Z
zhangalong 已提交
2598
  ```js
J
jidong 已提交
2599
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2600
  try {
J
jidong 已提交
2601
      appAccountManager.verifyCredential("zhangsan", "com.example.accountjsdemo", {
L
libing23 已提交
2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612
          onResult: (resultCode, result) => {
              console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode));
              console.log("verifyCredential onResult, result:" + JSON.stringify(result));
          },
          onRequestRedirected: (request) => {
              console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request));
          }
      });
  } catch (err) {
      console.log("verifyCredential err: "  + JSON.stringify(err));
  }
J
jidong 已提交
2613 2614
  ```

L
libing23 已提交
2615
### verifyCredential<sup>9+</sup>
J
jidong 已提交
2616

J
jidong 已提交
2617
verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, callback: AuthCallback): void;
J
jidong 已提交
2618

L
libing23 已提交
2619
验证用户凭据。使用callback异步回调。
2620

Z
zengyawen 已提交
2621
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
2622

Z
zengyawen 已提交
2623
**参数:**
J
jidong 已提交
2624

L
libing23 已提交
2625 2626
| 参数名    | 类型                    | 必填  | 说明                     |
| -------- | ----------------------- | ----- | ----------------------- |
J
jidong 已提交
2627 2628
| name     | string                  | 是    | 应用帐号的名称。          |
| owner    | string                  | 是    | 应用帐号所有者的包名。        |
L
libing23 已提交
2629
| options  | [VerifyCredentialOptions](#verifycredentialoptions9) | 是    | 验证凭据的选项。          |
J
jidong 已提交
2630
| callback | [AuthCallback](#authcallback9)   | 是    | 回调函数,返回验证结果。 |
J
jidong 已提交
2631

L
libing23 已提交
2632
**错误码:**
J
jidong 已提交
2633

J
jidong 已提交
2634 2635 2636 2637 2638 2639 2640 2641
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or options. |
| 12300003 | Account not found. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
Z
zengyawen 已提交
2642 2643

**示例:**
J
jidong 已提交
2644

Z
zhangalong 已提交
2645
  ```js
J
jidong 已提交
2646 2647
  let appAccountManager = account_appAccount.createAppAccountManager();
  let options = {
L
libing23 已提交
2648 2649 2650 2651
    credentialType: "pin",
    credential: "123456"
  };
  try {
J
jidong 已提交
2652 2653 2654 2655 2656 2657 2658 2659 2660
    appAccountManager.verifyCredential("zhangsan", "com.example.accountjsdemo", options, {
      onResult: (resultCode, result) => {
        console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode));
        console.log("verifyCredential onResult, result:" + JSON.stringify(result));
      },
      onRequestRedirected: (request) => {
        console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request));
      }
    });
L
libing23 已提交
2661 2662 2663
  } catch (err) {
    console.log("verifyCredential err: "  + JSON.stringify(err));
  }
J
jidong 已提交
2664 2665
  ```

L
libing23 已提交
2666
### setAuthenticatorProperties<sup>9+</sup>
2667

L
libing23 已提交
2668
setAuthenticatorProperties(owner: string, callback: AuthCallback): void;
2669

J
jidong 已提交
2670
设置指定应用的认证器属性。使用callback异步回调。
2671 2672 2673 2674 2675

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

**参数:**

L
libing23 已提交
2676 2677 2678
| 参数名    | 类型                  | 必填  | 说明                     |
| -------- | --------------------- | ----- | ----------------------- |
| owner    | string                | 是    | 认证器的所有者。          |
J
jidong 已提交
2679
| callback | [AuthCallback](#authcallback9) | 是    | 回调函数,返回设置属性的结果。 |
L
libing23 已提交
2680 2681 2682

**错误码:**

J
jidong 已提交
2683 2684 2685 2686 2687 2688 2689
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
2690 2691 2692 2693

**示例:**

  ```js
J
jidong 已提交
2694
  let appAccountManager = account_appAccount.createAppAccountManager();
2695
  try {
J
jidong 已提交
2696 2697 2698 2699 2700 2701 2702 2703 2704
    appAccountManager.setAuthenticatorProperties("com.example.accountjsdemo", {
      onResult: (resultCode, result) => {
        console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode));
        console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(result));
      },
      onRequestRedirected: (request) => {
        console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request));
      }
    });
2705
  } catch (err) {
J
jidong 已提交
2706
    console.log("setAuthenticatorProperties err: "  + JSON.stringify(err));
2707 2708 2709
  }
  ```

L
libing23 已提交
2710
### setAuthenticatorProperties<sup>9+</sup>
2711

L
libing23 已提交
2712
setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthCallback): void;
2713

L
libing23 已提交
2714
设置认证器属性。使用callback异步回调。
2715 2716 2717 2718 2719

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

**参数:**

L
libing23 已提交
2720 2721 2722 2723
| 参数名    | 类型                  | 必填  | 说明                     |
| -------- | --------------------- | ----- | ----------------------- |
| owner    | string                | 是    | 认证器的所有者。          |
| options  | [SetPropertiesOptions](#setpropertiesoptions9)  | 是    | 设置属性的选项。          |
J
jidong 已提交
2724
| callback | [AuthCallback](#authcallback9) | 是    | 认证器回调,返回设置属性的结果。 |
2725

L
libing23 已提交
2726
**错误码:**
2727

J
jidong 已提交
2728 2729 2730 2731 2732 2733 2734
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid owner or options. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
2735 2736 2737 2738

**示例:**

  ```js
J
jidong 已提交
2739 2740
  let appAccountManager = account_appAccount.createAppAccountManager();
  let options = {
L
libing23 已提交
2741 2742
    properties: {"prop1": "value1"}
  };
2743
  try {
J
jidong 已提交
2744 2745 2746 2747 2748 2749 2750 2751 2752
    appAccountManager.setAuthenticatorProperties("com.example.accountjsdemo", options, {
      onResult: (resultCode, result) => {
        console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode));
        console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(result));
      },
      onRequestRedirected: (request) => {
        console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request));
      }
    });
2753
  } catch (err) {
J
jidong 已提交
2754
    console.log("setAuthenticatorProperties err: "  + JSON.stringify(err));
L
libing23 已提交
2755 2756
  } 

2757 2758
  ```

L
libing23 已提交
2759
### addAccount<sup>(deprecated)</sup>
J
jidong 已提交
2760

L
libing23 已提交
2761
addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
2762

J
jidong 已提交
2763
根据帐号名添加应用帐号。使用callback异步回调。
J
jidong 已提交
2764

L
libing23 已提交
2765 2766
> **说明:** 
> 从API version 9开始废弃, 建议使用[createAccount](#createaccount9)替代
2767
>
L
libing23 已提交
2768
> 从 API version 7开始支持。
2769

Z
zengyawen 已提交
2770 2771 2772
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
2773

L
libing23 已提交
2774 2775
| 参数名      | 类型                        | 必填   | 说明                   |
| -------- | ------------------------- | ---- | -------------------- |
J
jidong 已提交
2776 2777
| name     | string                    | 是    | 应用帐号的名称。          |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当创建成功时,err为null,否则为错误对象。 |
J
jidong 已提交
2778

Z
zengyawen 已提交
2779
**示例:**
J
jidong 已提交
2780

Z
zhangalong 已提交
2781
  ```js
J
jidong 已提交
2782
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2783 2784
  appAccountManager.addAccount("WangWu", (err) => { 
      console.log("addAccount err: " + JSON.stringify(err));
J
jidong 已提交
2785 2786 2787
  });
  ```

L
libing23 已提交
2788
### addAccount<sup>(deprecated)</sup>
J
jidong 已提交
2789

L
libing23 已提交
2790
addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
2791

J
jidong 已提交
2792
根据帐号名和额外信息添加应用帐号。使用callback异步回调。
J
jidong 已提交
2793

L
libing23 已提交
2794 2795
> **说明:** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-1)替代
> 从 API version 7开始支持。
2796

Z
zengyawen 已提交
2797
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
2798

Z
zengyawen 已提交
2799
**参数:**
J
jidong 已提交
2800

L
libing23 已提交
2801 2802
| 参数名       | 类型                        | 必填   | 说明                                       |
| --------- | ------------------------- | ---- | ---------------------------------------- |
J
jidong 已提交
2803 2804 2805
| name      | string                    | 是    | 应用帐号的名称。                              |
| extraInfo | string                    | 是    | 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码、token等)。 |
| callback  | AsyncCallback&lt;void&gt; | 是    | 回调函数。当创建成功时,err为null,否则为错误对象。             |
Z
zengyawen 已提交
2806 2807

**示例:**
J
jidong 已提交
2808

Z
zhangalong 已提交
2809
  ```js
J
jidong 已提交
2810
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2811
  appAccountManager.addAccount("LiSi", "token101", (err) => { 
J
jidong 已提交
2812
    console.log("addAccount err: " + JSON.stringify(err));
J
jidong 已提交
2813 2814 2815
  });
  ```

L
libing23 已提交
2816
### addAccount<sup>(deprecated)</sup>
2817

L
libing23 已提交
2818 2819
addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;

J
jidong 已提交
2820
根据帐号名和额外信息添加应用帐号。使用callback异步回调。使用Promise异步回调。
2821

L
libing23 已提交
2822 2823
> **说明:** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-2)替代
> 从 API version 7开始支持。
2824 2825 2826 2827 2828

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

**参数:**

L
libing23 已提交
2829 2830
| 参数名       | 类型     | 必填   | 说明                                       |
| --------- | ------ | ---- | ---------------------------------------- |
J
jidong 已提交
2831 2832
| name      | string | 是    | 应用帐号的名称。                            |
| extraInfo | string | 否    | 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码、token等)。 |
L
libing23 已提交
2833 2834 2835 2836 2837 2838

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
2839 2840 2841 2842

**示例:**

  ```js
J
jidong 已提交
2843
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2844
  appAccountManager.addAccount("LiSi", "token101").then(()=> { 
J
jidong 已提交
2845
    console.log('addAccount Success');
L
libing23 已提交
2846
  }).catch((err) => {
J
jidong 已提交
2847
    console.log("addAccount err: "  + JSON.stringify(err));
L
libing23 已提交
2848
  });
2849 2850
  ```

L
libing23 已提交
2851
### addAccountImplicitly<sup>(deprecated)</sup>
2852

L
libing23 已提交
2853 2854
addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void

J
jidong 已提交
2855
根据指定的帐号所有者隐式地添加应用帐号。使用callback异步回调。
2856

L
libing23 已提交
2857 2858 2859
> **说明:**  从API version 9开始废弃, 建议使用[createAccountImplicitly](#createaccountimplicitly9)替代。
>
> 从 API version 8开始支持。
2860 2861 2862 2863 2864

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

**参数:**

L
libing23 已提交
2865 2866
| 参数名      | 类型                    | 必填   | 说明                      |
| -------- | --------------------- | ---- | ----------------------- |
J
jidong 已提交
2867 2868
| owner    | string                | 是    | 应用帐号所有者的包名。          |
| authType | string                | 是    | 鉴权类型。鉴权类型为自定义。  |
L
libing23 已提交
2869
| options  | {[key: string]: any}  | 是    | 鉴权所需要的可选项。可选项可根据自己需要设置。 |
J
jidong 已提交
2870
| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是    | 认证器回调对象,返回添加结果。         |
2871 2872 2873 2874

**示例:**

  ```js
L
libing23 已提交
2875 2876 2877
  import featureAbility from '@ohos.ability.featureAbility';

  function onResultCallback(code, result) {
J
jidong 已提交
2878 2879
    console.log("resultCode: "  + code);
    console.log("result: "  + JSON.stringify(result));
L
libing23 已提交
2880 2881 2882
  }

  function onRequestRedirectedCallback(request) {
J
jidong 已提交
2883 2884 2885 2886
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err)=>{
      console.log("startAbility err: " + JSON.stringify(err));
    });
2887
  }
L
libing23 已提交
2888

J
jidong 已提交
2889 2890 2891 2892
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.addAccountImplicitly("com.example.accountjsdemo", "getSocialData", {}, {
    onResult: onResultCallback,
    onRequestRedirected: onRequestRedirectedCallback
L
libing23 已提交
2893
  });
2894 2895
  ```

L
libing23 已提交
2896
### deleteAccount<sup>(deprecated)</sup>
J
jidong 已提交
2897

L
libing23 已提交
2898
deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
2899

J
jidong 已提交
2900
删除应用帐号。使用callback异步回调。
2901

L
libing23 已提交
2902
> **说明:** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。
2903
>
L
libing23 已提交
2904
> 从 API version 7开始支持。
J
jidong 已提交
2905

Z
zengyawen 已提交
2906 2907 2908
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
2909

L
libing23 已提交
2910 2911
| 参数名      | 类型                        | 必填   | 说明               |
| -------- | ------------------------- | ---- | ---------------- |
J
jidong 已提交
2912 2913
| name     | string                    | 是    | 应用帐号的名称。      |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当删除成功时,err为null,否则为错误对象。 |
J
jidong 已提交
2914

Z
zengyawen 已提交
2915
**示例:**
J
jidong 已提交
2916

Z
zhangalong 已提交
2917
  ```js
J
jidong 已提交
2918
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2919 2920 2921
  appAccountManager.deleteAccount("ZhaoLiu", (err) => { 
      console.log("deleteAccount err: " + JSON.stringify(err));
   });
2922 2923
  ```

L
libing23 已提交
2924
### deleteAccount<sup>(deprecated)</sup>
2925

L
libing23 已提交
2926
deleteAccount(name: string): Promise&lt;void&gt;
2927

J
jidong 已提交
2928
删除应用帐号。使用Promise异步回调。
2929

L
libing23 已提交
2930
> **说明:** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。
2931
>
L
libing23 已提交
2932
> 从 API version 7开始支持。
2933 2934 2935 2936 2937

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

**参数:**

L
libing23 已提交
2938 2939
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
J
jidong 已提交
2940
| name | string | 是    | 应用帐号的名称。 |
2941 2942 2943 2944

**返回值:**

| 类型                  | 说明                    |
L
libing23 已提交
2945 2946
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
2947 2948 2949 2950

**示例:**

  ```js
J
jidong 已提交
2951
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
2952 2953 2954 2955
  appAccountManager.deleteAccount("ZhaoLiu").then(() => { 
        console.log('deleteAccount Success');
   }).catch((err) => {
      console.log("deleteAccount err: "  + JSON.stringify(err));
2956 2957
  });
  ```
L
libing23 已提交
2958
### disableAppAccess<sup>(deprecated)</sup>
2959

L
libing23 已提交
2960
disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void
2961

L
libing23 已提交
2962
禁止指定第三方应用帐号名称对指定的第三方应用进行访问。使用callback异步回调。
2963

L
libing23 已提交
2964 2965 2966
> **说明:** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。
>
> 从 API version 7开始支持。
2967 2968 2969 2970 2971

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

**参数:**

L
libing23 已提交
2972 2973
| 参数名        | 类型                        | 必填   | 说明                                |
| ---------- | ------------------------- | ---- | --------------------------------- |
J
jidong 已提交
2974
| name       | string                    | 是    | 应用帐号的名称。                  |
L
libing23 已提交
2975
| bundleName | string                    | 是    | 第三方应用的包名。                         |
J
jidong 已提交
2976
| callback   | AsyncCallback&lt;void&gt; | 是    | 回调函数。当禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时,err为null,否则为错误对象。 |
2977 2978 2979 2980

**示例:**

  ```js
J
jidong 已提交
2981 2982
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.disableAppAccess("ZhangSan", "com.example.accountjsdemo", (err) => { 
L
libing23 已提交
2983 2984
      console.log("disableAppAccess err: " + JSON.stringify(err));
  });
J
jidong 已提交
2985 2986
  ```

L
libing23 已提交
2987
### disableAppAccess<sup>(deprecated)</sup>
J
jidong 已提交
2988

L
libing23 已提交
2989 2990 2991
disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;

禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问。使用Promise异步回调。
J
jidong 已提交
2992

L
libing23 已提交
2993 2994 2995
> **说明:** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。
>
> 从 API version 7开始支持。
J
jidong 已提交
2996

Z
zengyawen 已提交
2997
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
2998

Z
zengyawen 已提交
2999
**参数:**
J
jidong 已提交
3000

L
libing23 已提交
3001 3002
| 参数名        | 类型     | 必填   | 说明               |
| ---------- | ------ | ---- | ---------------- |
J
jidong 已提交
3003
| name       | string | 是    | 要禁用访问的第三方应用帐号的名称。 |
L
libing23 已提交
3004
| bundleName | string | 是    | 第三方应用的包名。        |
J
jidong 已提交
3005

3006
**返回值:**
J
jidong 已提交
3007

L
libing23 已提交
3008 3009 3010
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
Z
zengyawen 已提交
3011 3012

**示例:**
J
jidong 已提交
3013

Z
zhangalong 已提交
3014
  ```js
J
jidong 已提交
3015 3016
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.disableAppAccess("ZhangSan", "com.example.accountjsdemo").then(() => { 
L
libing23 已提交
3017 3018 3019 3020
      console.log('disableAppAccess Success');
  }).catch((err) => {
      console.log("disableAppAccess err: "  + JSON.stringify(err));
  });
J
jidong 已提交
3021 3022
  ```

L
libing23 已提交
3023
### enableAppAccess<sup>(deprecated)</sup>
J
jidong 已提交
3024

L
libing23 已提交
3025
enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
3026

L
libing23 已提交
3027
允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问。使用callback异步回调。
J
jidong 已提交
3028

L
libing23 已提交
3029
> **说明:** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。
3030
>
L
libing23 已提交
3031
> 从 API version 7开始支持。
3032

Z
zengyawen 已提交
3033 3034 3035
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
3036

L
libing23 已提交
3037 3038
| 参数名        | 类型                        | 必填   | 说明                                |
| ---------- | ------------------------- | ---- | --------------------------------- |
J
jidong 已提交
3039
| name       | string                    | 是    | 应用帐号的名称。                           |
L
libing23 已提交
3040
| bundleName | string                    | 是    | 第三方应用的包名。                         |
J
jidong 已提交
3041
| callback   | AsyncCallback&lt;void&gt; | 是    | 回调函数。当允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时,err为null,否则为错误对象。 |
J
jidong 已提交
3042

Z
zengyawen 已提交
3043
**示例:**
J
jidong 已提交
3044

Z
zhangalong 已提交
3045
  ```js
J
jidong 已提交
3046 3047
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.enableAppAccess("ZhangSan", "com.example.accountjsdemo", (err) => { 
L
libing23 已提交
3048 3049
      console.log("enableAppAccess: " + JSON.stringify(err));
   });
J
jidong 已提交
3050 3051
  ```

L
libing23 已提交
3052
### enableAppAccess<sup>(deprecated)</sup>
3053

L
libing23 已提交
3054
enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
J
jidong 已提交
3055

L
libing23 已提交
3056
允许指定第三方应用帐号的名称对指定包名称的第三方应用进行访问。使用Promise异步回调。
J
jidong 已提交
3057

L
libing23 已提交
3058
> **说明:** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。
3059
>
L
libing23 已提交
3060
> 从 API version 7开始支持。
3061

Z
zengyawen 已提交
3062
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
3063

Z
zengyawen 已提交
3064
**参数:**
J
jidong 已提交
3065

L
libing23 已提交
3066 3067
| 参数名        | 类型     | 必填   | 说明        |
| ---------- | ------ | ---- | --------- |
J
jidong 已提交
3068
| name       | string | 是    | 应用帐号的名称。   |
L
libing23 已提交
3069
| bundleName | string | 是    | 第三方应用的包名。 |
J
jidong 已提交
3070

3071
**返回值:**
J
jidong 已提交
3072

L
libing23 已提交
3073 3074 3075
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
Z
zengyawen 已提交
3076 3077

**示例:**
J
jidong 已提交
3078

Z
zhangalong 已提交
3079
  ```js
J
jidong 已提交
3080 3081
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.enableAppAccess("ZhangSan", "com.example.accountjsdemo").then(() => { 
L
libing23 已提交
3082
       console.log('enableAppAccess Success');
J
jidong 已提交
3083
  }).catch((err) => {
L
libing23 已提交
3084
      console.log("enableAppAccess err: "  + JSON.stringify(err));
J
jidong 已提交
3085 3086 3087
  });
  ```

L
libing23 已提交
3088
### checkAppAccountSyncEnable<sup>(deprecated)</sup>
3089

L
libing23 已提交
3090 3091
checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): void

J
jidong 已提交
3092
检查指定应用帐号是否开启数据同步功能。使用callback异步回调。
L
libing23 已提交
3093 3094 3095 3096

> **说明:** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9)替代。
>
> 从 API version 7开始支持。
3097

L
libing23 已提交
3098
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
3099 3100 3101 3102 3103

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

**参数:**

L
libing23 已提交
3104 3105
| 参数名      | 类型                           | 必填   | 说明                    |
| -------- | ---------------------------- | ---- | --------------------- |
J
jidong 已提交
3106 3107
| name     | string                       | 是    | 应用帐号的名称。               |
| callback | AsyncCallback&lt;boolean&gt; | 是    | 回调函数。返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。 |
3108

L
libing23 已提交
3109
**示例:**
3110 3111

  ```js
J
jidong 已提交
3112
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3113 3114 3115 3116
  appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { 
      console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err));
      console.log('checkAppAccountSyncEnable result: ' + result);
  });
3117 3118
  ```

L
libing23 已提交
3119
### checkAppAccountSyncEnable<sup>(deprecated)</sup>
3120

L
libing23 已提交
3121 3122
checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;

J
jidong 已提交
3123
检查指定应用帐号是否开启数据同步功能。使用Promise异步回调。
L
libing23 已提交
3124 3125 3126 3127

> **说明:** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9-1)替代。
>
> 从 API version 7开始支持。
3128

L
libing23 已提交
3129
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
3130 3131 3132 3133 3134

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

**参数:**

L
libing23 已提交
3135 3136
| 参数名  | 类型     | 必填   | 说明      |
| ---- | ------ | ---- | ------- |
J
jidong 已提交
3137
| name | string | 是    | 应用帐号的名称。 |
3138 3139 3140

**返回值:**

L
libing23 已提交
3141
| 类型                     | 说明                    |
J
jidong 已提交
3142 3143
| ---------------------- | --------------------- |
| Promise&lt;boolean&gt; | Promise对象,返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。 |
3144 3145 3146 3147

**示例:**

  ```js
J
jidong 已提交
3148
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3149 3150 3151 3152 3153
  appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { 
      console.log('checkAppAccountSyncEnable, result: ' + data);
  }).catch((err) => {
      console.log("checkAppAccountSyncEnable err: "  + JSON.stringify(err));
  });
3154 3155
  ```

L
libing23 已提交
3156
### setAccountCredential<sup>(deprecated)</sup>
J
jidong 已提交
3157

L
libing23 已提交
3158
setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
3159

J
jidong 已提交
3160
设置指定应用帐号的凭据。使用callback异步回调。
J
jidong 已提交
3161

L
libing23 已提交
3162
> **说明:** 从API version 9开始废弃,建议使用[setCredential](#setcredential9)替代。
3163
>
L
libing23 已提交
3164
> 从 API version 7开始支持。
3165

Z
zengyawen 已提交
3166 3167 3168
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
3169

L
libing23 已提交
3170 3171
| 参数名            | 类型                        | 必填   | 说明            |
| -------------- | ------------------------- | ---- | ------------- |
J
jidong 已提交
3172 3173 3174 3175
| name           | string                    | 是    | 应用帐号的名称。     |
| credentialType | string                    | 是    | 凭据类型。     |
| credential     | string                    | 是    | 凭据取值。      |
| callback       | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置此应用程序帐号的凭据成功时,err为null,否则为错误对象。 |
J
jidong 已提交
3176

L
libing23 已提交
3177
**示例:**
J
jidong 已提交
3178

Z
zhangalong 已提交
3179
  ```js
J
jidong 已提交
3180
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3181 3182
  appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { 
      console.log("setAccountCredential err: " + JSON.stringify(err));
J
jidong 已提交
3183 3184 3185
  });
  ```

L
libing23 已提交
3186
### setAccountCredential<sup>(deprecated)</sup>
J
jidong 已提交
3187

L
libing23 已提交
3188
setAccountCredential(name: string, credentialType: string, credential: string): Promise&lt;void&gt;
J
jidong 已提交
3189

J
jidong 已提交
3190
设置指定应用帐号的凭据。使用Promise异步回调。
J
jidong 已提交
3191

L
libing23 已提交
3192
> **说明:** 从API version 9开始废弃,建议使用[setCredential](#setcredential9-1)替代。
3193
>
L
libing23 已提交
3194
> 从 API version 7开始支持。
3195

Z
zengyawen 已提交
3196 3197 3198
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
3199

L
libing23 已提交
3200 3201 3202
| 参数名            | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
| name           | string | 是    | 应用帐号的名称。   |
J
jidong 已提交
3203 3204
| credentialType | string | 是    | 凭据类型。 |
| credential     | string | 是    | 凭据取值。 |
J
jidong 已提交
3205

3206
**返回值:**
J
jidong 已提交
3207

L
libing23 已提交
3208 3209 3210
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
J
jidong 已提交
3211

Z
zengyawen 已提交
3212
**示例:**
J
jidong 已提交
3213

Z
zhangalong 已提交
3214
  ```js
J
jidong 已提交
3215
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3216 3217
  appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001").then(() => { 
      console.log('setAccountCredential Success');
J
jidong 已提交
3218
  }).catch((err) => {
L
libing23 已提交
3219
      console.log("setAccountCredential err: "  + JSON.stringify(err));
J
jidong 已提交
3220 3221 3222
  });
  ```

L
libing23 已提交
3223
### setAccountExtraInfo<sup>(deprecated)</sup>
3224

L
libing23 已提交
3225 3226
setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void

J
jidong 已提交
3227
设置指定应用帐号的额外信息。使用callback异步回调。
L
libing23 已提交
3228

J
jidong 已提交
3229
> **说明:** 从API version 9开始废弃,建议使用[setCustomData](#setcustomdata9)替代。
L
libing23 已提交
3230 3231
>
> 从 API version 7开始支持。
3232 3233 3234 3235 3236 3237


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

**参数:**

L
libing23 已提交
3238 3239
| 参数名       | 类型                        | 必填   | 说明              |
| --------- | ------------------------- | ---- | --------------- |
J
jidong 已提交
3240 3241 3242
| name      | string                    | 是    | 应用帐号的名称。         |
| extraInfo | string                    | 是    | 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码、token等)。       |
| callback  | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null,否则为错误对象。 |
3243 3244 3245 3246

**示例:**

  ```js
J
jidong 已提交
3247
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3248 3249 3250
  appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { 
      console.log("setAccountExtraInfo err: " + JSON.stringify(err));
  });
3251 3252
  ```

L
libing23 已提交
3253
### setAccountExtraInfo<sup>(deprecated)</sup>
3254

L
libing23 已提交
3255 3256 3257 3258
setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;

设置此应用程序帐号的额外信息。使用Promise异步回调。

J
jidong 已提交
3259
> **说明:** 从API version 9开始废弃,建议使用[setCustomData](#setcustomdata9-1)替代。
L
libing23 已提交
3260 3261
>
> 从 API version 7开始支持。
3262 3263 3264 3265 3266 3267


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

**参数:**

L
libing23 已提交
3268 3269
| 参数名       | 类型     | 必填   | 说明        |
| --------- | ------ | ---- | --------- |
J
jidong 已提交
3270 3271
| name      | string | 是    | 应用帐号的名称。   |
| extraInfo | string | 是    | 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码、token等)。 |
3272 3273 3274

**返回值:**

L
libing23 已提交
3275 3276 3277
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
3278 3279 3280 3281

**示例:**

  ```js
J
jidong 已提交
3282
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3283 3284 3285 3286 3287
  appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { 
      console.log('setAccountExtraInfo Success');
  }).catch((err) => {
      console.log("setAccountExtraInfo err: "  + JSON.stringify(err));
  });
3288 3289
  ```

L
libing23 已提交
3290
### setAppAccountSyncEnable<sup>(deprecated)</sup>
J
jidong 已提交
3291

L
libing23 已提交
3292
setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
3293

J
jidong 已提交
3294
开启或禁止指定应用帐号的数据同步功能。使用callback异步回调。
J
jidong 已提交
3295

L
libing23 已提交
3296
> **说明:** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9)替代。
3297
>
L
libing23 已提交
3298 3299 3300
> 从 API version 7开始支持。

**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
3301

Z
zengyawen 已提交
3302
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
3303

Z
zengyawen 已提交
3304
**参数:**
J
jidong 已提交
3305

L
libing23 已提交
3306 3307
| 参数名      | 类型                        | 必填   | 说明                        |
| -------- | ------------------------- | ---- | ------------------------- |
J
jidong 已提交
3308 3309 3310
| name     | string                    | 是    | 应用帐号的名称。                  |
| isEnable | boolean                   | 是    | 是否开启数据同步。               |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当开启或禁止成功时,err为null,否则为错误对象。 |
Z
zengyawen 已提交
3311 3312

**示例:**
J
jidong 已提交
3313

Z
zhangalong 已提交
3314
  ```js
J
jidong 已提交
3315
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3316 3317
  appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { 
      console.log("setAppAccountSyncEnable err: " + JSON.stringify(err));
J
jidong 已提交
3318 3319 3320
  });
  ```

L
libing23 已提交
3321
### setAppAccountSyncEnable<sup>(deprecated)</sup>
J
jidong 已提交
3322

L
libing23 已提交
3323
setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;
J
jidong 已提交
3324

J
jidong 已提交
3325
开启或禁止指定应用帐号的数据同步功能。使用Promise异步回调。
J
jidong 已提交
3326

L
libing23 已提交
3327
> **说明:** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9-1)替代。
3328
>
L
libing23 已提交
3329 3330 3331
> 从 API version 7开始支持。

**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
3332

Z
zengyawen 已提交
3333 3334 3335
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
3336

L
libing23 已提交
3337 3338
| 参数名      | 类型      | 必填   | 说明          |
| -------- | ------- | ---- | ----------- |
J
jidong 已提交
3339 3340
| name     | string  | 是    | 应用帐号的名称。     |
| isEnable | boolean | 是    | 是否开启数据同步。 |
J
jidong 已提交
3341

3342
**返回值:**
J
jidong 已提交
3343

L
libing23 已提交
3344 3345 3346
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
J
jidong 已提交
3347

Z
zengyawen 已提交
3348
**示例:**
J
jidong 已提交
3349

Z
zhangalong 已提交
3350
  ```js
J
jidong 已提交
3351
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3352 3353
  appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { 
      console.log('setAppAccountSyncEnable Success');
J
jidong 已提交
3354
  }).catch((err) => {
L
libing23 已提交
3355
      console.log("setAppAccountSyncEnable err: "  + JSON.stringify(err));
J
jidong 已提交
3356 3357 3358
  });
  ```

L
libing23 已提交
3359
### setAssociatedData<sup>(deprecated)</sup>
3360

L
libing23 已提交
3361 3362
setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback&lt;void&gt;): void

J
jidong 已提交
3363
设置指定应用帐号的关联数据。使用callback异步回调。
L
libing23 已提交
3364 3365 3366 3367

> **说明:** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9)替代。
>
> 从 API version 7开始支持。
3368 3369 3370 3371 3372 3373


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

**参数:**

L
libing23 已提交
3374 3375
| 参数名      | 类型                        | 必填   | 说明                |
| -------- | ------------------------- | ---- | ----------------- |
J
jidong 已提交
3376 3377 3378 3379
| name     | string                    | 是    | 应用帐号的名称。           |
| key      | string                    | 是    | 关联数据的键名。 |
| value    | string                    | 是    | 关联数据的取值。         |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置与此应用帐号关联的数据成功时,err为null,否则为错误对象。 |
3380 3381 3382 3383

**示例:**

  ```js
J
jidong 已提交
3384
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3385 3386
  appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { 
      console.log("setAssociatedData err: " + JSON.stringify(err));
3387 3388 3389
  });
  ```

L
libing23 已提交
3390
### setAssociatedData<sup>(deprecated)</sup>
3391

L
libing23 已提交
3392 3393
setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;

J
jidong 已提交
3394
设置指定应用帐号的关联数据。使用Promise异步回调。
L
libing23 已提交
3395 3396 3397 3398

> **说明:** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9-1)替代。
>
> 从 API version 7开始支持。
3399 3400 3401 3402 3403 3404


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

**参数:**

L
libing23 已提交
3405 3406
| 参数名   | 类型     | 必填   | 说明                |
| ----- | ------ | ---- | ----------------- |
J
jidong 已提交
3407 3408 3409
| name  | string | 是    | 应用帐号的名称。           |
| key      | string | 是    | 关联数据的键名。 |
| value    | string | 是    | 关联数据的取值。 |
3410 3411 3412

**返回值:**

L
libing23 已提交
3413 3414 3415
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
3416 3417 3418 3419

**示例:**

  ```js
J
jidong 已提交
3420
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3421 3422
  appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { 
      console.log('setAssociatedData Success');
3423
  }).catch((err) => {
L
libing23 已提交
3424
      console.log("setAssociatedData err: "  + JSON.stringify(err));
3425 3426 3427
  });
  ```

L
libing23 已提交
3428
### getAllAccessibleAccounts<sup>(deprecated)</sup>
J
jidong 已提交
3429

L
libing23 已提交
3430
getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
J
jidong 已提交
3431

J
jidong 已提交
3432
获取所有可访问的应用帐号信息。使用callback异步回调。
J
jidong 已提交
3433

L
libing23 已提交
3434
> **说明:** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9)替代。
3435
>
L
libing23 已提交
3436 3437
> 从 API version 7开始支持。

J
jidong 已提交
3438
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS。
3439

Z
zengyawen 已提交
3440
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
3441

Z
zengyawen 已提交
3442
**参数:**
J
jidong 已提交
3443

L
libing23 已提交
3444 3445
| 参数名      | 类型                                       | 必填   | 说明        |
| -------- | ---------------------------------------- | ---- | --------- |
J
jidong 已提交
3446
| callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 回调函数。当查询成功时,err为null,data为获取到的应用帐号信息列表;否则为错误对象。 |
Z
zengyawen 已提交
3447 3448

**示例:**
J
jidong 已提交
3449

Z
zhangalong 已提交
3450
  ```js
J
jidong 已提交
3451
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3452 3453 3454
  appAccountManager.getAllAccessibleAccounts((err, data)=>{
  	console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err));
  	console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data));
J
jidong 已提交
3455 3456 3457
  });
  ```

L
libing23 已提交
3458
### getAllAccessibleAccounts<sup>(deprecated)</sup>
J
jidong 已提交
3459

L
libing23 已提交
3460
getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
J
jidong 已提交
3461

J
jidong 已提交
3462
获取所有可访问的应用帐号信息。使用Promise异步回调。
J
jidong 已提交
3463

L
libing23 已提交
3464
> **说明:** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9-1)替代。
3465
>
L
libing23 已提交
3466
> 从 API version 7开始支持。
Z
zengyawen 已提交
3467

J
jidong 已提交
3468
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS。
J
jidong 已提交
3469

L
libing23 已提交
3470
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
3471

3472
**返回值:**
J
jidong 已提交
3473

L
libing23 已提交
3474 3475
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
J
jidong 已提交
3476
| Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise对象,返回全部应用已授权帐号信息对象。 |
J
jidong 已提交
3477

Z
zengyawen 已提交
3478
**示例:**
J
jidong 已提交
3479

Z
zhangalong 已提交
3480
  ```js
J
jidong 已提交
3481
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3482 3483
  appAccountManager.getAllAccessibleAccounts().then((data) => { 
       console.log('getAllAccessibleAccounts: ' + data);
3484
  }).catch((err) => {
L
libing23 已提交
3485
      console.log("getAllAccessibleAccounts err: "  + JSON.stringify(err));
3486 3487 3488
  });
  ```

L
libing23 已提交
3489
### getAllAccounts<sup>(deprecated)</sup>
3490

L
libing23 已提交
3491 3492
getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void

J
jidong 已提交
3493
根据应用帐号所有者获取调用方可访问的应用帐号列表。使用callback异步回调。
3494

J
jidong 已提交
3495
> **说明:** 从API version 9开始废弃, 建议使用[getAccountsByOwner](#getaccountsbyowner9)替代。
L
libing23 已提交
3496 3497 3498
>
> 从 API version 7开始支持。

J
jidong 已提交
3499
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS。
3500 3501 3502 3503 3504

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

**参数:**

L
libing23 已提交
3505 3506
| 参数名      | 类型                                       | 必填   | 说明        |
| -------- | ---------------------------------------- | ---- | --------- |
J
jidong 已提交
3507
| owner    | string                                   | 是    | 应用帐号所有者的包名。    |
L
libing23 已提交
3508
| callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 应用帐号信息列表。 |
3509 3510 3511 3512

**示例:**

  ```js
J
jidong 已提交
3513
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3514 3515 3516 3517 3518
  const selfBundle = "com.example.actsgetallaaccounts";
  appAccountManager.getAllAccounts(selfBundle, (err, data)=>{
  	console.debug("getAllAccounts err:" + JSON.stringify(err));
  	console.debug("getAllAccounts data:" + JSON.stringify(data));
  });
3519 3520
  ```

L
libing23 已提交
3521
### getAllAccounts<sup>(deprecated)</sup>
3522

L
libing23 已提交
3523 3524
getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;

J
jidong 已提交
3525
根据应用帐号所有者获取调用方可访问的应用帐号列表。使用Promise异步回调。
L
libing23 已提交
3526 3527 3528 3529

> **说明:** 从API version 9开始废弃, 建议使用[getAccountsByOwner](#getaccountsbyowner9-1)替代。
>
> 从 API version 7开始支持。
3530

L
libing23 已提交
3531
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS,仅系统应用可用。
3532 3533 3534 3535 3536

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

**参数:**

L
libing23 已提交
3537 3538 3539
| 参数名   | 类型     | 必填   | 说明     |
| ----- | ------ | ---- | ------ |
| owner | string | 是    | 应用包名称。 |
3540 3541 3542

**返回值:**

L
libing23 已提交
3543 3544
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
J
jidong 已提交
3545
| Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise对象,返回指定应用全部帐号信息对象。 |
3546 3547 3548 3549

**示例:**

  ```js
J
jidong 已提交
3550
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3551 3552 3553 3554 3555 3556
  const selfBundle = "com.example.actsgetallaaccounts";
  appAccountManager.getAllAccounts(selfBundle).then((data) => { 
       console.log('getAllAccounts: ' + data);
  }).catch((err) => {
      console.log("getAllAccounts err: "  + JSON.stringify(err));
  });
J
jidong 已提交
3557 3558
  ```

L
libing23 已提交
3559
### getAccountCredential<sup>(deprecated)</sup>
J
jidong 已提交
3560

L
libing23 已提交
3561
getAccountCredential(name: string, credentialType: string, callback: AsyncCallback&lt;string&gt;): void
J
jidong 已提交
3562

J
jidong 已提交
3563
获取指定应用帐号的凭据。使用callback异步回调。
J
jidong 已提交
3564

L
libing23 已提交
3565
> **说明:** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9)替代。
3566
>
L
libing23 已提交
3567
> 从 API version 7开始支持。
3568

Z
zengyawen 已提交
3569
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
3570

Z
zengyawen 已提交
3571
**参数:**
J
jidong 已提交
3572

L
libing23 已提交
3573 3574
| 参数名            | 类型                          | 必填   | 说明             |
| -------------- | --------------------------- | ---- | -------------- |
J
jidong 已提交
3575 3576 3577
| name           | string                      | 是    | 应用帐号的名称。        |
| credentialType | string                      | 是    | 凭据类型。 |
| callback       | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取凭据成功时,err为null,data为指定应用帐号的凭据;否则为错误对象。 |
Z
zengyawen 已提交
3578 3579

**示例:**
J
jidong 已提交
3580

Z
zhangalong 已提交
3581
  ```js
J
jidong 已提交
3582
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3583 3584 3585
  appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { 
      console.log("getAccountCredential err: " + JSON.stringify(err));
      console.log('getAccountCredential result: ' + result);
J
jidong 已提交
3586 3587 3588
  });
  ```

L
libing23 已提交
3589
### getAccountCredential<sup>(deprecated)</sup>
J
jidong 已提交
3590

L
libing23 已提交
3591
getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt;
J
jidong 已提交
3592

J
jidong 已提交
3593
获取指定应用帐号的凭据。使用Promise异步回调。
J
jidong 已提交
3594

L
libing23 已提交
3595
> **说明:** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9-1)替代。
3596
>
L
libing23 已提交
3597
> 从 API version 7开始支持。
3598

Z
zengyawen 已提交
3599 3600 3601
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
J
jidong 已提交
3602

L
libing23 已提交
3603 3604
| 参数名            | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
J
jidong 已提交
3605 3606
| name           | string | 是    | 应用帐号的名称。    |
| credentialType | string | 是    | 凭据类型。 |
J
jidong 已提交
3607

3608
**返回值:**
J
jidong 已提交
3609

L
libing23 已提交
3610 3611
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
J
jidong 已提交
3612
| Promise&lt;string&gt; | Promise对象,返回指定应用帐号的凭据。 |
J
jidong 已提交
3613

Z
zengyawen 已提交
3614
**示例:**
J
jidong 已提交
3615

Z
zhangalong 已提交
3616
  ```js
J
jidong 已提交
3617
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3618 3619
  appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { 
      console.log('getAccountCredential, result: ' + data);
J
jidong 已提交
3620
  }).catch((err) => {
L
libing23 已提交
3621
      console.log("getAccountCredential err: "  + JSON.stringify(err));
J
jidong 已提交
3622 3623 3624
  });
  ```

L
libing23 已提交
3625
### getAccountExtraInfo<sup>(deprecated)</sup>
J
jidong 已提交
3626

L
libing23 已提交
3627 3628
getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void

J
jidong 已提交
3629
获取指定应用帐号的额外信息(能转换成string类型的其它信息)。使用callback异步回调。
J
jidong 已提交
3630

J
jidong 已提交
3631
> **说明:** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9)替代。
L
libing23 已提交
3632 3633
>
> 从 API version 7开始支持。
J
jidong 已提交
3634 3635 3636 3637 3638

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

**参数:**

L
libing23 已提交
3639 3640
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
J
jidong 已提交
3641 3642
| name     | string                      | 是    | 应用帐号的名称。         |
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取此应用帐号的额外信息成功时,err为null,data返回此应用帐号的额外信息对象;否则为错误对象。 |
J
jidong 已提交
3643 3644 3645 3646

**示例:**

  ```js
J
jidong 已提交
3647
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3648 3649 3650 3651
  appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { 
      console.log("getAccountExtraInfo err: " + JSON.stringify(err));
      console.log('getAccountExtraInfo result: ' + result);
  });
J
jidong 已提交
3652 3653
  ```

L
libing23 已提交
3654
### getAccountExtraInfo<sup>(deprecated)</sup>
J
jidong 已提交
3655

L
libing23 已提交
3656
getAccountExtraInfo(name: string): Promise&lt;string&gt;
J
jidong 已提交
3657

J
jidong 已提交
3658
获取指定应用帐号的额外信息(能转换成string类型的其它信息)。使用Promise异步回调。
L
libing23 已提交
3659

J
jidong 已提交
3660
> **说明:** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9-1)替代。
L
libing23 已提交
3661 3662
>
> 从 API version 7开始支持。
J
jidong 已提交
3663 3664 3665 3666 3667

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

**参数:**

L
libing23 已提交
3668 3669
| 参数名  | 类型     | 必填   | 说明      |
| ---- | ------ | ---- | ------- |
J
jidong 已提交
3670
| name | string | 是    | 应用帐号的名称。 |
J
jidong 已提交
3671

3672
**返回值:**
J
jidong 已提交
3673

L
libing23 已提交
3674 3675
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
J
jidong 已提交
3676
| Promise&lt;string&gt; | Promise对象,返回此应用程序帐号的额外信息对象。 |
J
jidong 已提交
3677 3678 3679 3680

**示例:**

  ```js
J
jidong 已提交
3681
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3682 3683 3684 3685 3686
  appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { 
      console.log('getAccountExtraInfo, result: ' + data);
  }).catch((err) => {
      console.log("getAccountExtraInfo err: "  + JSON.stringify(err));
  });
J
jidong 已提交
3687 3688
  ```

L
libing23 已提交
3689 3690 3691
### getAssociatedData<sup>(deprecated)</sup>

getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void
J
jidong 已提交
3692

J
jidong 已提交
3693
根据指定键名获取特定应用帐号的关联数据。使用callback异步回调。
J
jidong 已提交
3694

L
libing23 已提交
3695 3696 3697
> **说明:** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9)替代。
>
> 从 API version 7开始支持。
J
jidong 已提交
3698 3699 3700 3701 3702

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

**参数:**

L
libing23 已提交
3703 3704
| 参数名      | 类型                          | 必填   | 说明                |
| -------- | --------------------------- | ---- | ----------------- |
J
jidong 已提交
3705 3706 3707
| name     | string                      | 是    | 应用帐号的名称。           |
| key      | string                      | 是    | 关联数据的键名。         |
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取成功时,err为null,data为关联数据的取值;否则为错误对象。 |
J
jidong 已提交
3708 3709 3710 3711

**示例:**

  ```js
J
jidong 已提交
3712
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3713 3714 3715 3716
  appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { 
      console.log("getAssociatedData err: " + JSON.stringify(err));
      console.log('getAssociatedData result: ' + result);
  });
J
jidong 已提交
3717 3718
  ```

L
libing23 已提交
3719 3720 3721
### getAssociatedData<sup>(deprecated)</sup>

getAssociatedData(name: string, key: string): Promise&lt;string&gt;
J
jidong 已提交
3722

L
libing23 已提交
3723
获取与此应用程序帐号关联的数据。使用Promise异步回调。
J
jidong 已提交
3724

L
libing23 已提交
3725 3726 3727
> **说明:** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9-1)替代。
>
> 从 API version 7开始支持。
J
jidong 已提交
3728 3729 3730 3731 3732

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

**参数:**

L
libing23 已提交
3733 3734
| 参数名  | 类型     | 必填   | 说明        |
| ---- | ------ | ---- | --------- |
J
jidong 已提交
3735 3736
| name | string | 是    | 应用帐号的名称。   |
| key  | string | 是    | 关联数据的键名。 |
J
jidong 已提交
3737

3738
**返回值:**
J
jidong 已提交
3739

L
libing23 已提交
3740 3741
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
J
jidong 已提交
3742
| Promise&lt;string&gt; | Promise对象,返回关联数据的取值。 |
J
jidong 已提交
3743 3744 3745 3746

**示例:**

  ```js
J
jidong 已提交
3747
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3748 3749 3750 3751 3752
  appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { 
       console.log('getAssociatedData: ' + data);
  }).catch((err) => {
      console.log("getAssociatedData err: "  + JSON.stringify(err));
  });
J
jidong 已提交
3753 3754
  ```

L
libing23 已提交
3755
### on('change')<sup>(deprecated)</sup>
J
jidong 已提交
3756

L
libing23 已提交
3757 3758
on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void

J
jidong 已提交
3759
订阅指定应用的帐号信息变更事件。
J
jidong 已提交
3760

L
libing23 已提交
3761 3762 3763
> **说明:** 从API version 9开始废弃, 建议使用[on('accountChange')](#onaccountchange9)替代。
>
> 从 API version 7开始支持。
J
jidong 已提交
3764 3765 3766 3767 3768

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

**参数:**

L
libing23 已提交
3769 3770
| 参数名      | 类型                                       | 必填   | 说明                             |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
J
jidong 已提交
3771 3772 3773
| type     | 'change'                                 | 是    | 事件回调类型,支持的事件为'change',当帐号所有者更新帐号信息时,触发该事件。 |
| owners   | Array&lt;string&gt;                      | 是    | 应用帐号所有者的包名列表。                      |
| callback | Callback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 回调函数,返回信息发生变更的应用帐号列表。           |
J
jidong 已提交
3774 3775 3776 3777

**示例:**

  ```js
J
jidong 已提交
3778
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3779 3780 3781 3782 3783 3784 3785 3786
  function changeOnCallback(data){
  	console.debug("receive change data:" + JSON.stringify(data));
  }
  try{
  	appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback);
  }
  catch(err){
  	console.error("on accountOnOffDemo err:" + JSON.stringify(err));
3787
  }
J
jidong 已提交
3788 3789
  ```

L
libing23 已提交
3790
### off('change')<sup>(deprecated)</sup>
J
jidong 已提交
3791

L
libing23 已提交
3792 3793
off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void

J
jidong 已提交
3794
取消订阅帐号信息变更事件。
J
jidong 已提交
3795

L
libing23 已提交
3796 3797 3798
> **说明:** 从API version 9开始废弃, 建议使用[off('accountChange')](#offaccountchange9)替代。
>
> 从 API version 7开始支持。
J
jidong 已提交
3799 3800 3801 3802 3803

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

**参数:**

L
libing23 已提交
3804 3805
| 参数名      | 类型                               | 必填   | 说明           |
| -------- | -------------------------------- | ---- | ------------ |
J
jidong 已提交
3806 3807
| type     | 'change'                         | 是    | 事件回调类型,支持的事件为'change',当帐号所有者更新帐号信息时,触发该事件。    |
| callback | Callback<Array\<[AppAccountInfo](#appaccountinfo)>> | 否    | 回调函数,返回信息发生变更的应用帐号列表。 |
J
jidong 已提交
3808 3809 3810 3811

**示例:**

  ```js
J
jidong 已提交
3812
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823
  function changeOnCallback(data){
  	console.debug("receive change data:" + JSON.stringify(data));
  	appAccountManager.off('change', function(){
  		console.debug("off finish");
  	})
  }
  try{
  	appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback);
  }
  catch(err){
  	console.error("on accountOnOffDemo err:" + JSON.stringify(err));
3824
  }
J
jidong 已提交
3825 3826
  ```

L
libing23 已提交
3827
### authenticate<sup>(deprecated)</sup>
J
jidong 已提交
3828

L
libing23 已提交
3829 3830
authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void

J
jidong 已提交
3831
对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。
J
jidong 已提交
3832

L
libing23 已提交
3833 3834 3835
> **说明:** 从API version 9开始废弃, 建议使用[auth](#auth9)替代。
>
> 从 API version 8开始支持。
J
jidong 已提交
3836 3837 3838 3839 3840

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

**参数:**

L
libing23 已提交
3841 3842
| 参数名      | 类型                    | 必填   | 说明              |
| -------- | --------------------- | ---- | --------------- |
J
jidong 已提交
3843 3844
| name     | string                | 是    | 应用帐号的名称。     |
| owner    | string                | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
3845 3846
| authType | string                | 是    | 鉴权类型。           |
| options  | {[key: string]: any}  | 是    | 鉴权所需的可选项。       |
J
jidong 已提交
3847
| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是    | 回调对象,返回鉴权结果。 |
J
jidong 已提交
3848 3849 3850 3851

**示例:**

  ```js
L
libing23 已提交
3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862
  import featureAbility from '@ohos.ability.featureAbility';

  function onResultCallback(code, result) {
      console.log("resultCode: "  + code);
      console.log("result: "  + JSON.stringify(result));
  }

  function onRequestRedirectedCallback(request) {
      let abilityStartSetting = {want: request};
      featureAbility.startAbility(abilityStartSetting, (err)=>{
          console.log("startAbility err: " + JSON.stringify(err));
3863 3864
      });
  }
L
libing23 已提交
3865

J
jidong 已提交
3866 3867
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.authenticate("LiSi", "com.example.accountjsdemo", "getSocialData", {}, {
L
libing23 已提交
3868 3869 3870
    onResult: onResultCallback,
    onRequestRedirected: onRequestRedirectedCallback
  });
J
jidong 已提交
3871 3872
  ```

L
libing23 已提交
3873
### getOAuthToken<sup>(deprecated)</sup>
J
jidong 已提交
3874

L
libing23 已提交
3875
getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback&lt;string&gt;): void
J
jidong 已提交
3876

J
jidong 已提交
3877
获取指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。
L
libing23 已提交
3878 3879 3880 3881

> **说明:** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9)替代。
>
> 从 API version 8开始支持。
J
jidong 已提交
3882 3883 3884 3885 3886

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

**参数:**

L
libing23 已提交
3887 3888 3889
| 参数名      | 类型                          | 必填   | 说明          |
| -------- | --------------------------- | ---- | ----------- |
| name     | string                      | 是    | 应用帐号的名称。    |
J
jidong 已提交
3890
| owner    | string                      | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
3891
| authType | string                      | 是    | 鉴权类型。       |
J
jidong 已提交
3892
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取成功时,err为null,data为授权令牌值;否则为错误对象。   |
J
jidong 已提交
3893 3894 3895 3896

**示例:**

  ```js
J
jidong 已提交
3897 3898
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", (err, data) => {
L
libing23 已提交
3899 3900 3901
       console.log('getOAuthToken err: ' + JSON.stringify(err));
       console.log('getOAuthToken token: ' + data);
  });
J
jidong 已提交
3902 3903
  ```

L
libing23 已提交
3904
### getOAuthToken<sup>(deprecated)</sup>
J
jidong 已提交
3905

L
libing23 已提交
3906 3907
getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&gt;

J
jidong 已提交
3908
获取指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。
J
jidong 已提交
3909

L
libing23 已提交
3910 3911 3912
> **说明:** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9-1)替代。
>
> 从 API version 8开始支持。
J
jidong 已提交
3913 3914 3915 3916 3917

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

**参数:**

L
libing23 已提交
3918 3919 3920
| 参数名      | 类型     | 必填   | 说明          |
| -------- | ------ | ---- | ----------- |
| name     | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
3921
| owner    | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
3922 3923 3924 3925 3926 3927
| authType | string | 是    | 鉴权类型。       |

**返回值:**

| 类型                    | 说明                    |
| --------------------- | --------------------- |
J
jidong 已提交
3928
| Promise&lt;string&gt; | Promise对象,返回授权令牌。 |
L
libing23 已提交
3929 3930 3931 3932

**示例:**

  ```js
J
jidong 已提交
3933 3934
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData").then((data) => {
L
libing23 已提交
3935 3936 3937 3938 3939 3940 3941 3942 3943 3944
       console.log('getOAuthToken token: ' + data);
  }).catch((err) => {
      console.log("getOAuthToken err: "  + JSON.stringify(err));
  });
  ```

### setOAuthToken<sup>(deprecated)</sup>

setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void

J
jidong 已提交
3945
为指定应用帐号设置特定鉴权类型的授权令牌。使用callback异步回调。
L
libing23 已提交
3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958

> **说明:** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名      | 类型                        | 必填   | 说明       |
| -------- | ------------------------- | ---- | -------- |
| name     | string                    | 是    | 应用帐号的名称。 |
| authType | string                    | 是    | 鉴权类型。    |
J
jidong 已提交
3959 3960
| token    | string                    | 是    | 授权令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null;否则为错误对象。 |
L
libing23 已提交
3961 3962 3963 3964

**示例:**

  ```js
J
jidong 已提交
3965
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
3966 3967 3968 3969 3970 3971 3972 3973 3974
  appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx", (err) => {
      console.log('setOAuthToken err: ' + JSON.stringify(err));
  });
  ```

### setOAuthToken<sup>(deprecated)</sup>

setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt;

J
jidong 已提交
3975
为指定应用帐号设置特定鉴权类型的授权令牌。使用Promise异步回调。
L
libing23 已提交
3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988

> **说明:** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名      | 类型     | 必填   | 说明       |
| -------- | ------ | ---- | -------- |
| name     | string | 是    | 应用帐号的名称。 |
| authType | string | 是    | 鉴权类型。    |
J
jidong 已提交
3989
| token    | string | 是    | 授权令牌。 |
L
libing23 已提交
3990 3991 3992 3993 3994 3995 3996 3997 3998 3999

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**示例:**

  ```js
J
jidong 已提交
4000
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011
  appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx").then(() => {
      console.log('setOAuthToken successfully');
  }).catch((err) => {
      console.log('setOAuthToken err: ' + JSON.stringify(err));
  });
  ```

### deleteOAuthToken<sup>(deprecated)</sup>

deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void

J
jidong 已提交
4012
删除指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。
L
libing23 已提交
4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024

> **说明:** 从API version 9开始废弃, 建议使用[deleteAuthToken](#deleteauthtoken9)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名      | 类型                        | 必填   | 说明           |
| -------- | ------------------------- | ---- | ------------ |
| name     | string                    | 是    | 应用帐号的名称。     |
J
jidong 已提交
4025
| owner    | string                    | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
4026
| authType | string                    | 是    | 鉴权类型。        |
J
jidong 已提交
4027 4028
| token    | string                    | 是    | 授权令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当删除成功时,err为null;否则为错误对象。     |
L
libing23 已提交
4029 4030 4031 4032

**示例:**

  ```js
J
jidong 已提交
4033 4034
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx", (err) => {
L
libing23 已提交
4035 4036 4037 4038 4039 4040 4041 4042
       console.log('deleteOAuthToken err: ' + JSON.stringify(err));
  });
  ```

### deleteOAuthToken<sup>(deprecated)</sup>

deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise&lt;void&gt;

J
jidong 已提交
4043
删除指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。
L
libing23 已提交
4044

J
jidong 已提交
4045
> **说明:** 从API version 9开始废弃, 建议使用[deleteAuthToken](#deleteauthtoken9-1)替代。
L
libing23 已提交
4046 4047 4048 4049 4050 4051 4052 4053 4054 4055
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名      | 类型     | 必填   | 说明           |
| -------- | ------ | ---- | ------------ |
| name     | string | 是    | 应用帐号的名称。     |
J
jidong 已提交
4056
| owner    | string | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
4057
| authType | string | 是    | 鉴权类型。        |
J
jidong 已提交
4058
| token    | string | 是    | 授权令牌。 |
L
libing23 已提交
4059 4060 4061 4062 4063 4064 4065 4066 4067 4068

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**示例:**

  ```js
J
jidong 已提交
4069 4070
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx").then(() => {
L
libing23 已提交
4071 4072 4073 4074 4075 4076 4077 4078 4079 4080
       console.log('deleteOAuthToken successfully');
  }).catch((err) => {
      console.log("deleteOAuthToken err: "  + JSON.stringify(err));
  });
  ```

### setOAuthTokenVisibility<sup>(deprecated)</sup>

setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback&lt;void&gt;): void

J
jidong 已提交
4081
设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。
L
libing23 已提交
4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095

> **说明:** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名        | 类型                        | 必填   | 说明                        |
| ---------- | ------------------------- | ---- | ------------------------- |
| name       | string                    | 是    | 应用帐号的名称。                  |
| authType   | string                    | 是    | 鉴权类型。                     |
| bundleName | string                    | 是    | 被设置可见性的应用包名。              |
J
jidong 已提交
4096 4097
| isVisible  | boolean                   | 是    | 是否可见。true表示可见,false表示不可见。 |
| callback   | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null;否则为错误对象。                  |
L
libing23 已提交
4098 4099 4100 4101

**示例:**

  ```js
J
jidong 已提交
4102 4103
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true, (err) => {
L
libing23 已提交
4104 4105 4106 4107 4108 4109 4110 4111
       console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err));
  });
  ```

### setOAuthTokenVisibility<sup>(deprecated)</sup>

setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise&lt;void&gt;

J
jidong 已提交
4112
设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。
L
libing23 已提交
4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126

> **说明:** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9-1)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名        | 类型      | 必填   | 说明           |
| ---------- | ------- | ---- | ------------ |
| name       | string  | 是    | 应用帐号的名称。     |
| authType   | string  | 是    | 鉴权类型。        |
| bundleName | string  | 是    | 被设置可见性的应用包名。 |
J
jidong 已提交
4127
| isVisible  | boolean | 是    | 是否可见。true表示可见,false表示不可见。        |
L
libing23 已提交
4128 4129 4130 4131 4132 4133 4134 4135 4136 4137

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |

**示例:**

  ```js
J
jidong 已提交
4138 4139
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true).then(() => {
L
libing23 已提交
4140 4141 4142 4143 4144 4145 4146 4147 4148 4149
      console.log('setOAuthTokenVisibility successfully');
  }).catch((err) => {
      console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err));
  });
  ```

### checkOAuthTokenVisibility<sup>(deprecated)</sup>

checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void

J
jidong 已提交
4150
检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。
L
libing23 已提交
4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164

> **说明:** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名        | 类型                           | 必填   | 说明          |
| ---------- | ---------------------------- | ---- | ----------- |
| name       | string                       | 是    | 应用帐号的名称。    |
| authType   | string                       | 是    | 鉴权类型。       |
| bundleName | string                       | 是    | 检查可见性的应用包名。 |
J
jidong 已提交
4165
| callback   | AsyncCallback&lt;boolean&gt; | 是    | 回调函数。当检查成功时,err为null,data为true表示可见,data为false表示不可见;否则为错误对象。    |
L
libing23 已提交
4166 4167 4168 4169

**示例:**

  ```js
J
jidong 已提交
4170 4171
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", (err, data) => {
L
libing23 已提交
4172 4173 4174 4175 4176 4177 4178 4179 4180
      console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err));
      console.log('checkOAuthTokenVisibility isVisible: ' + data);
  });
  ```

### checkOAuthTokenVisibility<sup>(deprecated)</sup>

checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise&lt;boolean&gt;

J
jidong 已提交
4181
检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。
L
libing23 已提交
4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200

> **说明:** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9-1)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名        | 类型     | 必填   | 说明            |
| ---------- | ------ | ---- | ------------- |
| name       | string | 是    | 应用帐号的名称。      |
| authType   | string | 是    | 鉴权类型。         |
| bundleName | string | 是    | 用于检查可见性的应用包名。 |

**返回值:**

| 类型                     | 说明                    |
| ---------------------- | --------------------- |
J
jidong 已提交
4201
| Promise&lt;boolean&gt; | Promise对象,返回true表示指定鉴权类型的OAuth令牌对特定应用的可见,返回false表示不可见。 |
L
libing23 已提交
4202 4203 4204 4205

**示例:**

  ```js
J
jidong 已提交
4206 4207
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo").then((data) => {
L
libing23 已提交
4208 4209 4210 4211 4212 4213 4214 4215 4216 4217
      console.log('checkOAuthTokenVisibility isVisible: ' + data);
  }).catch((err) => {
      console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err));
  });
  ```

### getAllOAuthTokens<sup>(deprecated)</sup>

getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt;): void

J
jidong 已提交
4218
获取指定帐号对调用方可见的所有授权令牌。使用callback异步回调。
L
libing23 已提交
4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230

> **说明:** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名      | 类型                                       | 必填   | 说明          |
| -------- | ---------------------------------------- | ---- | ----------- |
| name     | string                                   | 是    | 应用帐号的名称。    |
J
jidong 已提交
4231
| owner    | string                                   | 是    | 应用帐号所有者的包名。 |
4232
| callback | AsyncCallback&lt;Array&lt;[OAuthTokenInfo](#oauthtokeninfodeprecated)&gt;&gt; | 是    | 回调函数。当获取成功时,err为null,data为授权令牌数组;否则为错误对象。    |
L
libing23 已提交
4233 4234 4235 4236

**示例:** 

  ```js
J
jidong 已提交
4237 4238
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAllOAuthTokens("LiSi", "com.example.accountjsdemo", (err, data) => {
L
libing23 已提交
4239 4240 4241 4242 4243 4244 4245 4246 4247
      console.log("getAllOAuthTokens err: "  + JSON.stringify(err));
      console.log('getAllOAuthTokens data: ' + JSON.stringify(data));
  });
  ```

### getAllOAuthTokens<sup>(deprecated)</sup>

getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenInfo&gt;&gt;

J
jidong 已提交
4248
获取指定帐号对调用方可见的所有授权令牌。使用Promise异步回调。
L
libing23 已提交
4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260

> **说明:** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9-1)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
| name  | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
4261
| owner | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
4262 4263 4264 4265 4266

**返回值:**

| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
J
jidong 已提交
4267
| Promise&lt;Array&lt; [OAuthTokenInfo](#oauthtokeninfodeprecated)&gt;&gt; | Promise对象,返回授权令牌数组。 |
L
libing23 已提交
4268 4269

**示例:**
J
jidong 已提交
4270 4271

  ```js
J
jidong 已提交
4272 4273
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAllOAuthTokens("LiSi", "com.example.accountjsdemo").then((data) => {
L
libing23 已提交
4274 4275 4276 4277 4278 4279 4280 4281 4282 4283
      console.log('getAllOAuthTokens data: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getAllOAuthTokens err: "  + JSON.stringify(err));
  });
  ```

### getOAuthList<sup>(deprecated)</sup>

getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void

J
jidong 已提交
4284
获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过setOAuthTokenVisibility(#setoauthtokenvisibilitydeprecated)来设置)。使用callback异步回调。
L
libing23 已提交
4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296

> **说明:** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名      | 类型                                       | 必填   | 说明                      |
| -------- | ---------------------------------------- | ---- | ----------------------- |
| name     | string                                   | 是    | 应用帐号的名称。                |
J
jidong 已提交
4297 4298
| authType | string                                   | 是    | 鉴权类型。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 回调函数。当获取成功时,err为null,data为被授权的包名数组;否则为错误对象。               |
L
libing23 已提交
4299 4300 4301 4302

**示例:**

  ```js
J
jidong 已提交
4303 4304 4305 4306
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getOAuthList("com.example.accountjsdemo", "getSocialData", (err, data) => {
    console.log('getOAuthList err: ' + JSON.stringify(err));
    console.log('getOAuthList data: ' + JSON.stringify(data));
L
libing23 已提交
4307 4308 4309 4310 4311 4312 4313
  });
  ```

### getOAuthList<sup>(deprecated)</sup>

getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;

J
jidong 已提交
4314
获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过setOAuthTokenVisibility(#setoauthtokenvisibilitydeprecated)来设置)。使用Promise异步回调。
L
libing23 已提交
4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326

> **说明:** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9-1)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名      | 类型     | 必填   | 说明                      |
| -------- | ------ | ---- | ----------------------- |
| name     | string | 是    | 应用帐号的名称。                |
J
jidong 已提交
4327
| authType | string | 是    | 鉴权类型。 |
L
libing23 已提交
4328 4329 4330 4331 4332

**返回值:**

| 类型                                 | 说明                    |
| ---------------------------------- | --------------------- |
J
jidong 已提交
4333
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象,返回被授权的包名数组。 |
L
libing23 已提交
4334 4335 4336 4337

**示例:**

  ```js
J
jidong 已提交
4338 4339
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getOAuthList("com.example.accountjsdemo", "getSocialData").then((data) => {
L
libing23 已提交
4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362
       console.log('getOAuthList data: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getOAuthList err: "  + JSON.stringify(err));
  });
  ```

### getAuthenticatorCallback<sup>(deprecated)</sup>

getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;AuthenticatorCallback&gt;): void

获取鉴权会话的认证器回调。使用callback异步回调。

> **说明:** 从API version 9开始废弃, 建议使用[getAuthCallback](#getauthcallback9)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名       | 类型                                       | 必填   | 说明       |
| --------- | ---------------------------------------- | ---- | -------- |
| sessionId | string                                   | 是    | 鉴权会话的标识。 |
J
jidong 已提交
4363
| callback  | AsyncCallback&lt;[AuthenticatorCallback](#authenticatorcallbackdeprecated)&gt; | 是    | 回调函数。当获取鉴权会话的认证器回调函数成功时,err为null,data为认证器回调函数;否则为错误对象。 |
L
libing23 已提交
4364 4365 4366 4367 4368

**示例:**

  ```js
  import featureAbility from '@ohos.ability.featureAbility';
J
jidong 已提交
4369
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
4370 4371 4372 4373 4374 4375 4376 4377
  featureAbility.getWant((err, want) => {
    var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
    appAccountManager.getAuthenticatorCallback(sessionId, (err, callback) => {
        if (err.code != account_appAccount.ResultCode.SUCCESS) {
            console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
            return;
        }
        var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
J
jidong 已提交
4378
                      [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
L
libing23 已提交
4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407
                      [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
                      [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
        callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
    });
  });
  ```

### getAuthenticatorCallback<sup>(deprecated)</sup>

getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt;

获取鉴权会话的认证器回调。使用Promise异步回调。

> **说明:** 从API version 9开始废弃, 建议使用[getAuthCallback](#getauthcallback9-1)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名       | 类型     | 必填   | 说明       |
| --------- | ------ | ---- | -------- |
| sessionId | string | 是    | 鉴权会话的标识。 |

**返回值:**

| 类型                                   | 说明                    |
| ------------------------------------ | --------------------- |
J
jidong 已提交
4408
| Promise&lt;[AuthenticatorCallback](#authenticatorcallbackdeprecated)&gt; | Promise对象,返回鉴权会话的认证器回调对象。 |
L
libing23 已提交
4409 4410 4411 4412 4413 4414

**示例:**

  ```js
  import featureAbility from '@ohos.ability.featureAbility';

J
jidong 已提交
4415
  let appAccountManager = account_appAccount.createAppAccountManager();
L
libing23 已提交
4416 4417 4418 4419
  featureAbility.getWant().then((want) => {
      var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
      appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
          var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
J
jidong 已提交
4420
                        [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
L
libing23 已提交
4421 4422 4423 4424 4425
                        [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
                        [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
          callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
      }).catch((err) => {
          console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
4426
      });
L
libing23 已提交
4427 4428 4429
  }).catch((err) => {
      console.log("getWant err: "  + JSON.stringify(err));
  });
J
jidong 已提交
4430 4431
  ```

L
libing23 已提交
4432
### getAuthenticatorInfo<sup>(deprecated)</sup>
J
jidong 已提交
4433

L
libing23 已提交
4434 4435
getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void

J
jidong 已提交
4436
获取指定应用的认证器信息。使用callback异步回调。
J
jidong 已提交
4437

L
libing23 已提交
4438 4439 4440
> **说明:** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9)替代。
>
> 从 API version 8开始支持。
J
jidong 已提交
4441 4442 4443 4444 4445

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

**参数:**

L
libing23 已提交
4446 4447
| 参数名      | 类型                                     | 必填   | 说明          |
| -------- | -------------------------------------- | ---- | ----------- |
J
jidong 已提交
4448 4449
| owner    | string                                 | 是    | 应用帐号所有者的包名。 |
| callback | AsyncCallback&lt;[AuthenticatorInfo](#authenticatorinfo8)&gt; | 是    | 回调函数。当获取成功时,err为null,data为认证器信息对象;否则为错误对象。    |
J
jidong 已提交
4450 4451 4452 4453

**示例:**

  ```js
J
jidong 已提交
4454 4455
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAuthenticatorInfo("com.example.accountjsdemo", (err, data) => {
L
libing23 已提交
4456 4457 4458 4459 4460 4461 4462 4463 4464
      console.log("getAuthenticatorInfo err: "  + JSON.stringify(err));
      console.log('getAuthenticatorInfo data: ' + JSON.stringify(data));
  });
  ```

### getAuthenticatorInfo<sup>(deprecated)</sup>

getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;

J
jidong 已提交
4465
获取指定应用的认证器信息。使用Promise异步回调。
L
libing23 已提交
4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476

> **说明:** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9-1)替代。
>
> 从 API version 8开始支持。

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

**参数:**

| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
J
jidong 已提交
4477
| owner | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
4478 4479 4480 4481 4482

**返回值:**

| 类型                               | 说明                    |
| -------------------------------- | --------------------- |
J
jidong 已提交
4483
| Promise&lt;[AuthenticatorInfo](#authenticatorinfo8)&gt; | Promise对象,返回指定应用的认证器信息对象。 |
L
libing23 已提交
4484 4485

**示例:**
4486

L
libing23 已提交
4487
  ```js
J
jidong 已提交
4488 4489
  let appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAuthenticatorInfo("com.example.accountjsdemo").then((data) => { 
L
libing23 已提交
4490 4491 4492 4493
       console.log('getAuthenticatorInfo: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getAuthenticatorInfo err: "  + JSON.stringify(err));
  });
J
jidong 已提交
4494 4495
  ```

Z
zhaoyuan17 已提交
4496 4497
## AppAccountInfo

J
jidong 已提交
4498 4499
表示应用帐号信息。

Z
zengyawen 已提交
4500 4501
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4502
| 名称   | 类型     | 必填   | 说明          |
H
HelloCrease 已提交
4503
| ----- | ------ | ---- | ----------- |
J
jidong 已提交
4504
| owner | string | 是    | 应用帐号所有者的包名。 |
H
HelloCrease 已提交
4505
| name  | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
4506

4507 4508 4509 4510 4511 4512
## AuthTokenInfo<sup>9+</sup>

表示Auth令牌信息。

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

4513
| 名称               | 类型            | 必填  | 说明              |
4514 4515 4516 4517 4518 4519
| -------------------- | -------------- | ----- | ---------------- |
| authType<sup>9+</sup>             | string         | 是    | 令牌的鉴权类型。   |
| token<sup>9+</sup>                | string         | 是    | 令牌的取值。       |
| account<sup>9+</sup> | [AppAccountInfo](#appaccountinfo) | 否    | 令牌所属的帐号信息。|

## OAuthTokenInfo<sup>(deprecated)</sup>
J
jidong 已提交
4520 4521 4522

表示OAuth令牌信息。

4523 4524 4525 4526
> **说明:** 从API version 9开始废弃, 建议使用[AuthTokenInfo](#authtokeninfo9)替代。
>
> 从 API version 8开始支持。

Z
zengyawen 已提交
4527 4528
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4529
| 名称               | 类型            | 必填  | 说明              |
J
jidong 已提交
4530 4531 4532
| -------------------- | -------------- | ----- | ---------------- |
| authType             | string         | 是    | 令牌的鉴权类型。   |
| token                | string         | 是    | 令牌的取值。       |
4533
| account<sup>9+</sup> | [AppAccountInfo](#appaccountinfo) | 否    | 令牌所属的帐号信息。|
J
jidong 已提交
4534 4535 4536 4537 4538

## AuthenticatorInfo<sup>8+</sup>

表示OAuth认证器信息。

Z
zengyawen 已提交
4539 4540
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4541
| 名称     | 类型     | 必填   | 说明         |
H
HelloCrease 已提交
4542 4543
| ------- | ------ | ---- | ---------- |
| owner   | string | 是    | 认证器的所有者包名。 |
4544 4545
| iconId  | number | 是    | 认证器的图标标识。  |
| labelId | number | 是    | 认证器的标签标识。  |
J
jidong 已提交
4546

4547 4548 4549 4550 4551 4552
## AuthResult<sup>9+</sup>

表示认证结果信息。

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

4553
| 名称     | 类型     | 必填   | 说明         |
4554 4555 4556 4557 4558 4559 4560 4561 4562 4563
| ------- | ------ | ---- | ---------- |
| account   | [AppAccountInfo](#appaccountinfo) | 否    | 令牌所属的帐号信息。 |
| tokenInfo  | [AuthTokenInfo](#authtokeninfo9) | 否    | 令牌信息。  |

## CreateAccountOptions<sup>9+</sup>

表示创建账号的选项。

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

4564
| 名称     | 类型     | 必填   | 说明         |
4565 4566 4567 4568 4569 4570 4571 4572 4573
| ------- | ------ | ---- | ---------- |
| customData   | {[key:string]: Object} | 否    | 自定义数据。 |

## CreateAccountImplicitlyOptions<sup>9+</sup>

表示隐式创建账号的选项。

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

4574
| 名称     | 类型     | 必填   | 说明         |
4575 4576 4577 4578
| ------- | ------ | ---- | ---------- |
| requiredLabels   | {[key:string]: Object} | 否    | 必须的标签。 |
| authType   | string | 否    | 鉴权类型。 |
| parameters   | {[key:string]: Object} | 否    | 自定义参数对象。 |
J
jidong 已提交
4579 4580 4581 4582 4583 4584
## SelectAccountsOptions<sup>9+</sup>

表示用于选择帐号的选项。

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

4585
| 名称          | 类型                         | 必填  | 说明                |
J
jidong 已提交
4586
| --------------- | --------------------------- | ----- | ------------------- |
4587
| allowedAccounts | Array&lt;[AppAccountInfo](#appaccountinfo)&gt; | 否    | 允许的帐号数组。      |
J
jidong 已提交
4588 4589 4590 4591 4592 4593 4594 4595 4596
| allowedOwners   | Array&lt;string&gt;         | 否    | 允许的帐号所有者数组。 |
| requiredLabels  | Array&lt;string&gt;         | 否    | 认证器的标签标识。    |

## VerifyCredentialOptions<sup>9+</sup>

表示用于验证凭据的选项。

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

4597
| 名称          | 类型                   | 必填  | 说明           |
J
jidong 已提交
4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609
| -------------- | ---------------------- | ----- | -------------- |
| credentialType | string                 | 否    | 凭据类型。      |
| credential     | string                 | 否    | 凭据取值。      |
| parameters     | {[key:string]: Object} | 否    | 自定义参数对象。 |


## SetPropertiesOptions<sup>9+</sup>

表示用于设置属性的选项。

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

4610
| 名称     | 类型                    | 必填  | 说明           |
J
jidong 已提交
4611 4612 4613 4614
| ---------- | ---------------------- | ----- | -------------- |
| properties | {[key:string]: Object} | 否    | 属性对象。      |
| parameters | {[key:string]: Object} | 否    | 自定义参数对象。 |

J
jidong 已提交
4615 4616 4617 4618
## Constants<sup>8+</sup>

表示常量的枚举。

Z
zengyawen 已提交
4619 4620
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4621
| 名称                            | 值                    | 说明                   |
J
jidong 已提交
4622
| -------------------------------- | ---------------------- | ----------------------- |
4623 4624 4625 4626
| ACTION_ADD_ACCOUNT_IMPLICITLY<sup>(deprecated)</sup>    | "addAccountImplicitly" | 表示操作,隐式添加帐号。  |
| ACTION_AUTHENTICATE<sup>(deprecated)</sup>              | "authenticate"         | 表示操作,鉴权。         |
| ACTION_CREATE_ACCOUNT_IMPLICITLY<sup>9+</sup>    | "createAccountImplicitly" | 表示操作,隐式创建帐号。  |
| ACTION_AUTH<sup>9+</sup>              | "auth"         | 表示操作,鉴权。         |
J
jidong 已提交
4627 4628 4629
| ACTION_VERIFY_CREDENTIAL<sup>9+</sup>    | "verifyCredential" | 表示操作,验证凭据。  |
| ACTION_SET_AUTHENTICATOR_PROPERTIES<sup>9+</sup> | "setAuthenticatorProperties" | 表示操作,设置认证器属性。      |
| KEY_NAME                         | "name"                 | 表示键名,应用帐号的名称。  |
J
jidong 已提交
4630 4631 4632 4633 4634 4635 4636 4637 4638 4639
| KEY_OWNER                        | "owner"                | 表示键名,应用帐号所有者。|
| KEY_TOKEN                        | "token"                | 表示键名,令牌。         |
| KEY_ACTION                       | "action"               | 表示键名,操作。         |
| KEY_AUTH_TYPE                    | "authType"             | 表示键名,鉴权类型。     |
| KEY_SESSION_ID                   | "sessionId"            | 表示键名,会话标识。     |
| KEY_CALLER_PID                   | "callerPid"            | 表示键名,调用方PID。    |
| KEY_CALLER_UID                   | "callerUid"            | 表示键名,调用方UID。    |
| KEY_CALLER_BUNDLE_NAME           | "callerBundleName"     | 表示键名,调用方包名。    |
| KEY_REQUIRED_LABELS<sup>9+</sup> | "requiredLabels"       | 表示键名,必需的标签。    |
| KEY_BOOLEAN_RESULT<sup>9+</sup>  | "booleanResult"        | 表示键名,布尔返回值。    |
J
jidong 已提交
4640 4641

## ResultCode<sup>8+</sup>
Z
zhaoyuan17 已提交
4642

J
jidong 已提交
4643
表示返回码的枚举。
Z
zhaoyuan17 已提交
4644

Z
zengyawen 已提交
4645 4646
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4647
| 名称                                  | 值   | 说明           |
H
HelloCrease 已提交
4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667
| ----------------------------------- | ----- | ------------ |
| SUCCESS                             | 0     | 表示操作成功。      |
| ERROR_ACCOUNT_NOT_EXIST             | 10001 | 表示应用帐号不存在。   |
| ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002 | 表示应用帐号服务异常。  |
| ERROR_INVALID_PASSWORD              | 10003 | 表示密码无效。      |
| ERROR_INVALID_REQUEST               | 10004 | 表示请求无效。      |
| ERROR_INVALID_RESPONSE              | 10005 | 表示响应无效。      |
| ERROR_NETWORK_EXCEPTION             | 10006 | 表示网络异常。      |
| ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST | 10007 | 表示认证器不存在。    |
| ERROR_OAUTH_CANCELED                | 10008 | 表示鉴权取消。      |
| ERROR_OAUTH_LIST_TOO_LARGE          | 10009 | 表示开放授权列表过大。  |
| ERROR_OAUTH_SERVICE_BUSY            | 10010 | 表示开放授权服务忙碌。  |
| ERROR_OAUTH_SERVICE_EXCEPTION       | 10011 | 表示开放授权服务异常。  |
| ERROR_OAUTH_SESSION_NOT_EXIST       | 10012 | 表示鉴权会话不存在。   |
| ERROR_OAUTH_TIMEOUT                 | 10013 | 表示鉴权超时。      |
| ERROR_OAUTH_TOKEN_NOT_EXIST         | 10014 | 表示开放授权令牌不存在。 |
| ERROR_OAUTH_TOKEN_TOO_MANY          | 10015 | 表示开放授权令牌过多。  |
| ERROR_OAUTH_UNSUPPORT_ACTION        | 10016 | 表示不支持的鉴权操作。  |
| ERROR_OAUTH_UNSUPPORT_AUTH_TYPE     | 10017 | 表示不支持的鉴权类型。  |
| ERROR_PERMISSION_DENIED             | 10018 | 表示权限不足。      |
Z
zhaoyuan17 已提交
4668

4669 4670
## AuthCallback<sup>9+</sup>

J
jidong 已提交
4671
认证器回调类。
4672 4673 4674

### onResult<sup>9+</sup>

J
jidong 已提交
4675
onResult: (code: number, result?: AuthResult) =&gt; void
4676 4677 4678 4679 4680 4681 4682 4683 4684 4685

通知请求结果。

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

**参数:**

| 参数名    | 类型                   | 必填   | 说明     |
| ------ | -------------------- | ---- | ------ |
| code   | number               | 是    | 鉴权结果码。 |
J
jidong 已提交
4686
| result | [AuthResult](#authresult9) | 否    | 鉴权结果。  |
4687 4688 4689 4690

**示例:**

  ```js
J
jidong 已提交
4691
  let appAccountManager = account_appAccount.createAppAccountManager();
4692 4693
  var sessionId = "1234";
  appAccountManager.getAuthCallback(sessionId).then((callback) => {
L
lichenchen 已提交
4694 4695 4696 4697 4698 4699 4700 4701 4702 4703
      var result = {
          accountInfo: {
            name: "Lisi",
            owner: "com.example.accountjsdemo",
          },
          tokenInfo: {
            token: "xxxxxx",
            authType: "getSocialData"
          }
      };
4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
  }).catch((err) => {
      console.log("getAuthCallback err: "  + JSON.stringify(err));
  });
  ```

### onRequestRedirected<sup>9+</sup>

onRequestRedirected: (request: Want) =&gt; void

通知请求被跳转。

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

**参数:**

| 参数名     | 类型   | 必填   | 说明         |
| ------- | ---- | ---- | ---------- |
| request | Want | 是    | 用于跳转的请求信息。 |

**示例:**

  ```js
  class MyAuthenticator extends account_appAccount.Authenticator {
      createAccountImplicitly(options, callback) {
          callback.onRequestRedirected({
J
jidong 已提交
4730 4731
              bundleName: "com.example.accountjsdemo",
              abilityName: "com.example.accountjsdemo.LoginAbility",
4732 4733 4734 4735
          });
      }

      auth(name, authType, options, callback) {
L
lichenchen 已提交
4736 4737 4738 4739 4740 4741 4742 4743 4744 4745
          var result = {
            accountInfo: {
              name: "Lisi",
              owner: "com.example.accountjsdemo",
            },
            tokenInfo: {
              token: "xxxxxx",
              authType: "getSocialData"
            }
          };
4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761
          callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
      }
  }
  ```

### onRequestContinued<sup>9+</sup>

onRequestContinued?: () =&gt; void

通知请求被继续处理。

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

**示例:**

  ```js
J
jidong 已提交
4762
  let appAccountManager = account_appAccount.createAppAccountManager();
4763 4764 4765 4766 4767 4768 4769 4770 4771
  var sessionId = "1234";
  appAccountManager.getAuthCallback(sessionId).then((callback) => {
      callback.onRequestContinued();
  }).catch((err) => {
      console.log("getAuthCallback err: "  + JSON.stringify(err));
  });
  ```

## AuthenticatorCallback<sup>(deprecated)</sup>
J
jidong 已提交
4772 4773 4774

OAuth认证器回调接口。

4775 4776 4777 4778
> **说明:** 从API version 9开始废弃。
>
> 从 API version 8开始支持, 建议使用[AuthCallback](#authcallback9)替代。

J
jidong 已提交
4779 4780
### onResult<sup>8+</sup>

Z
zengyawen 已提交
4781
onResult: (code: number, result: {[key: string]: any}) =&gt; void
J
jidong 已提交
4782

J
jidong 已提交
4783
通知请求结果。
J
jidong 已提交
4784

Z
zengyawen 已提交
4785
**系统能力:** SystemCapability.Account.AppAccount
J
jidong 已提交
4786

Z
zengyawen 已提交
4787
**参数:**
4788

H
HelloCrease 已提交
4789 4790 4791 4792
| 参数名    | 类型                   | 必填   | 说明     |
| ------ | -------------------- | ---- | ------ |
| code   | number               | 是    | 鉴权结果码。 |
| result | {[key: string]: any} | 是    | 鉴权结果。  |
Z
zengyawen 已提交
4793 4794

**示例:**
J
jidong 已提交
4795

Z
zhangalong 已提交
4796
  ```js
J
jidong 已提交
4797
  let appAccountManager = account_appAccount.createAppAccountManager();
J
jidong 已提交
4798 4799
  var sessionId = "1234";
  appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
J
jidong 已提交
4800
      var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
J
jidong 已提交
4801
                    [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
4802
                    [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
J
jidong 已提交
4803
                    [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
J
jidong 已提交
4804
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
J
jidong 已提交
4805 4806 4807 4808 4809 4810 4811
  }).catch((err) => {
      console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
  });
  ```

### onRequestRedirected<sup>8+</sup>

Z
zengyawen 已提交
4812
onRequestRedirected: (request: Want) =&gt; void
J
jidong 已提交
4813

J
jidong 已提交
4814
通知请求被跳转。
J
jidong 已提交
4815

Z
zengyawen 已提交
4816 4817 4818
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
4819

H
HelloCrease 已提交
4820 4821 4822
| 参数名     | 类型   | 必填   | 说明         |
| ------- | ---- | ---- | ---------- |
| request | Want | 是    | 用于跳转的请求信息。 |
J
jidong 已提交
4823

Z
zengyawen 已提交
4824
**示例:**
J
jidong 已提交
4825

Z
zhangalong 已提交
4826
  ```js
J
jidong 已提交
4827 4828 4829
  class MyAuthenticator extends account_appAccount.Authenticator {
      addAccountImplicitly(authType, callerBundleName, options, callback) {
          callback.onRequestRedirected({
J
jidong 已提交
4830 4831
              bundleName: "com.example.accountjsdemo",
              abilityName: "com.example.accountjsdemo.LoginAbility",
J
jidong 已提交
4832 4833 4834 4835
          });
      }

      authenticate(name, authType, callerBundleName, options, callback) {
J
jidong 已提交
4836 4837 4838 4839
          var result = {[account_appAccount.Constants.KEY_NAME]: name,
                        [account_appAccount.Constants.KEY_AUTH_TYPE]: authType,
                        [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
          callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
J
jidong 已提交
4840 4841 4842 4843
      }
  }
  ```

J
jidong 已提交
4844 4845
### onRequestContinued<sup>9+</sup>

J
jidong 已提交
4846
onRequestContinued?: () =&gt; void
J
jidong 已提交
4847 4848 4849 4850 4851 4852 4853 4854

通知请求被继续处理。

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

**示例:**

  ```js
J
jidong 已提交
4855
  let appAccountManager = account_appAccount.createAppAccountManager();
J
jidong 已提交
4856 4857
  var sessionId = "1234";
  appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
J
jidong 已提交
4858
      callback.onRequestContinued();
J
jidong 已提交
4859 4860 4861 4862 4863
  }).catch((err) => {
      console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
  });
  ```

J
jidong 已提交
4864 4865
## Authenticator<sup>8+</sup>

J
jidong 已提交
4866
认证器基类。
J
jidong 已提交
4867

J
jidong 已提交
4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879
### createAccountImplicitly<sup>9+</sup>

createAccountImplicitly(options: CreateAccountImplicitlyOptions, callback: AuthCallback): void

根据指定的帐号所有者隐式地创建应用帐号,并使用callback异步回调返回结果。

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

**参数:**

| 参数名              | 类型                    | 必填   | 说明              |
| ---------------- | --------------------- | ---- | --------------- |
4880
| options          | [CreateAccountImplicitlyOptions](#createaccountimplicitlyoptions9)  | 是    | 隐式创建账号的选项。      |
J
jidong 已提交
4881 4882 4883
| callback         | [AuthCallback](#authcallback9) | 是    | 认证器回调对象,用于返回创建结果。 |

### addAccountImplicitly<sup>deprecated</sup>
J
jidong 已提交
4884

Z
zengyawen 已提交
4885
addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
J
jidong 已提交
4886

J
jidong 已提交
4887 4888 4889 4890 4891
根据指定的鉴权类型和可选项,隐式地添加应用帐号,并使用callback异步回调返回结果。

> **说明:** 从API version 9开始废弃。
>
> 从 API version 8开始支持, 建议使用[createAccountImplicitly](#createaccountimplicitly9-2)替代。
J
jidong 已提交
4892

Z
zengyawen 已提交
4893 4894 4895
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
4896

H
HelloCrease 已提交
4897 4898 4899 4900 4901
| 参数名              | 类型                    | 必填   | 说明              |
| ---------------- | --------------------- | ---- | --------------- |
| authType         | string                | 是    | 应用帐号的鉴权类型。      |
| callerBundleName | string                | 是    | 鉴权请求方的包名。       |
| options          | {[key: string]: any}  | 是    | 鉴权所需要的可选项。      |
4902
| callback         | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是    | 认证器回调,用于返回鉴权结果。 |
J
jidong 已提交
4903

J
jidong 已提交
4904 4905 4906 4907 4908 4909 4910 4911 4912 4913
### auth<sup>9+</sup>

auth(name: string, authType: string, options: {[key:string]: Object}, callback: AuthCallback): void

对应用帐号进行鉴权以获取授权令牌,并使用callback异步回调返回结果。

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

**参数:**

4914
| 参数名              | 类型                    | 必填   | 说明              |
J
jidong 已提交
4915 4916 4917 4918 4919 4920 4921 4922
| ---------------- | --------------------- | ---- | --------------- |
| name             | string                | 是    | 应用帐号的名称。        |
| authType         | string                | 是    | 应用帐号的鉴权类型。      |
| callerBundleName | string                | 是    | 鉴权类型。       |
| options          | {[key: string]: any}  | 是    | 鉴权所需要的可选项。      |
| callback         | [AuthCallback](#authcallback9) | 是    | 回调对象,用于返回鉴权结果。 |

### authenticate<sup>deprecated</sup>
J
jidong 已提交
4923

Z
zengyawen 已提交
4924
authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
J
jidong 已提交
4925

J
jidong 已提交
4926 4927 4928 4929 4930
对应用帐号进行鉴权,获取OAuth令牌,并使用callback异步回调返回结果。

> **说明:** 从API version 9开始废弃。
>
> 从 API version 8开始支持, 建议使用[auth](#auth9-2)替代。
J
jidong 已提交
4931

Z
zengyawen 已提交
4932 4933 4934
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
4935

4936
| 参数名              | 类型                    | 必填   | 说明              |
H
HelloCrease 已提交
4937 4938 4939 4940 4941
| ---------------- | --------------------- | ---- | --------------- |
| name             | string                | 是    | 应用帐号的名称。        |
| authType         | string                | 是    | 应用帐号的鉴权类型。      |
| callerBundleName | string                | 是    | 鉴权请求方的包名。       |
| options          | {[key: string]: any}  | 是    | 鉴权所需要的可选项。      |
4942
| callback         | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是    | 认证器回调,用于返回鉴权结果。 |
J
jidong 已提交
4943

J
jidong 已提交
4944 4945
### verifyCredential<sup>9+</sup>

J
jidong 已提交
4946
verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthCallback): void;
J
jidong 已提交
4947

J
jidong 已提交
4948
验证应用帐号的凭据,并使用callback异步回调返回结果。
J
jidong 已提交
4949 4950 4951 4952

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

**参数:**
4953

4954
| 参数名              | 类型                    | 必填   | 说明              |
4955
| ---------------- | --------------------- | ---- | --------------- |
J
jidong 已提交
4956
| name      | string                   | 是    | 应用帐号的名称。              |
4957
| options   | [VerifyCredentialOptions](#verifycredentialoptions9)  | 是    | 验证凭据的可选项。            |
J
jidong 已提交
4958
| callback  | [AuthCallback](#authcallback9)    | 是    | 认证器回调,用于返回验证结果。 |
J
jidong 已提交
4959 4960 4961

### setProperties<sup>9+</sup>

J
jidong 已提交
4962
setProperties(options: SetPropertiesOptions, callback: AuthCallback): void;
J
jidong 已提交
4963

J
jidong 已提交
4964
设置认证器属性,并使用callback异步回调返回结果。
J
jidong 已提交
4965 4966 4967 4968

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

**参数:**
4969

4970
| 参数名              | 类型                    | 必填   | 说明              |
4971 4972
| ---------------- | --------------------- | ---- | --------------- |
| options   | [SetPropertiesOptions](#setpropertiesoptions9)  | 是    | 设置属性的可选项。            |
J
jidong 已提交
4973
| callback  | [AuthCallback](#authcallback9) | 是    | 认证器回调,用于返回设置结果。 |
J
jidong 已提交
4974 4975 4976

### checkAccountLabels<sup>9+</sup>

J
jidong 已提交
4977
checkAccountLabels(name: string, labels: Array&lt;string&gt;, callback: AuthCallback): void;
J
jidong 已提交
4978

J
jidong 已提交
4979
检查帐号标签,并使用callback异步回调返回结果。
J
jidong 已提交
4980 4981 4982 4983

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

**参数:**
4984

4985
| 参数名              | 类型                    | 必填   | 说明              |
4986
| ---------------- | --------------------- | ---- | --------------- |
J
jidong 已提交
4987
| name      | string                | 是    | 应用帐号的名称。              |
4988
| labels    | Array&lt;string&gt;          | 是    | 标签数组。                   |
J
jidong 已提交
4989
| callback  | [AuthCallback](#authcallback9) | 是    | 认证器回调,用于返回检查结果。 |
J
jidong 已提交
4990 4991 4992

### isAccountRemovable<sup>9+</sup>

J
jidong 已提交
4993
isAccountRemovable(name: string, callback: AuthCallback): void;
J
jidong 已提交
4994

J
jidong 已提交
4995
判断帐号是否可以删除,并使用callback异步回调返回结果。
J
jidong 已提交
4996 4997 4998 4999

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

**参数:**
5000

5001
| 参数名              | 类型                    | 必填   | 说明              |
5002
| ---------------- | --------------------- | ---- | --------------- |
J
jidong 已提交
5003
| name      | string                | 是    | 应用帐号的名称。              |
J
jidong 已提交
5004
| callback  | [AuthCallback](#authcallback9) | 是    | 认证器回调,用于返回判断结果。 |
J
jidong 已提交
5005 5006 5007 5008 5009 5010 5011 5012 5013

### getRemoteObject<sup>9+</sup>

getRemoteObject(): rpc.RemoteObject;

获取认证器的远程对象,不可以重载实现。

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

Z
zengyawen 已提交
5014
**示例:**
J
jidong 已提交
5015

Z
zhangalong 已提交
5016
  ```js
J
jidong 已提交
5017
  class MyAuthenticator extends account_appAccount.Authenticator {
J
jidong 已提交
5018 5019 5020 5021 5022 5023
    addAccountImplicitly(authType, callerBundleName, options, callback) {
      callback.onRequestRedirected({
        bundleName: "com.example.accountjsdemo",
        abilityName: "com.example.accountjsdemo.LoginAbility",
      });
    }
J
jidong 已提交
5024

J
jidong 已提交
5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040
    authenticate(name, authType, callerBundleName, options, callback) {
      var result = {[account_appAccount.Constants.KEY_NAME]: name,
                    [account_appAccount.Constants.KEY_AUTH_TYPE]: authType,
                    [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
    }

    verifyCredential(name, options, callback) {
      callback.onRequestRedirected({
        bundleName: "com.example.accountjsdemo",
        abilityName: "com.example.accountjsdemo.VerifyAbility",
        parameters: {
          name: name
        }
      });
    }
J
jidong 已提交
5041

J
jidong 已提交
5042 5043 5044
    setProperties(options, callback) {
      callback.onResult(account_appAccount.ResultCode.SUCCESS, {});
    }
J
jidong 已提交
5045

J
jidong 已提交
5046 5047 5048 5049 5050 5051 5052 5053 5054
    checkAccountLabels(name, labels, callback) {
      var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: false};
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
    }
  
    isAccountRemovable(name, callback) {
      var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: true};
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
    }
J
jidong 已提交
5055
  }
5056
  var authenticator = null;
J
jidong 已提交
5057
  export default {
J
jidong 已提交
5058 5059 5060 5061
    onConnect(want) {
      authenticator = new MyAuthenticator();
      return authenticator.getRemoteObject();
    }
J
jidong 已提交
5062
  }
Z
zengyawen 已提交
5063
  ```