js-apis-appAccount.md 31.3 KB
Newer Older
Z
zhaoyuan17 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
#  	应用帐号管理

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


## 导入模块

```
import account_appAccount from '@ohos.account.appAccount';
```


## account_appAccount.createAppAccountManager

createAppAccountManager(): AppAccountManager;

应用帐号管理:获取应用帐号模块对象。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | AppAccountManager | 获取应用帐号模块的实例。 |

- 示例:
  ```
  var appAccountManager = account.createAppAccountManager();
  ```

## AppAccountManager

管理应用帐号模块的实例。

### addAccount

addAccount(name: string, callback: AsyncCallback<void>): void;

将此应用的帐号名添加到帐号管理服务中,使用callback回调异步返回结果。

需要权限:无。

- 参数:

  | 参数名   | 类型                | 必填 | 说明                                       |
  | -------- | ------------------- | ---- | ------------------------------------------ |
  | name     | string              | 是   | 要添加的应用帐户的名称。                   |
  | callback | AsyncCallback<void> | 是   | 将此应用的帐号名添加到帐号管理服务的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.addAccount("WangWu", (err) => { 
      console.log("addAccount err: " + JSON.stringify(err));
  });
  ```

### addAccount

addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void

将此应用程序的帐号名和额外信息添加到帐号管理服务中,使用callback回调异步返回结果。

需要权限:无。

- 参数:

  | 参数名    | 类型                | 必填 | 说明                                                         |
  | --------- | ------------------- | ---- | ------------------------------------------------------------ |
  | name      | string              | 是   | 要添加的应用帐户的名称。                                     |
  | extraInfo | string              | 是   | 要添加的应用帐户的额外信息(例如token等),额外的信息不能是应用帐号的敏感信息。 |
  | callback  | AsyncCallback<void> | 是   | 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。   |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.addAccount("LiSi", "token101", (err) => { 
      console.log("addAccount err: " + JSON.stringify(err));
  });
  ```



### addAccount

addAccount(name: string, extraInfo?: string): Promise<void>

将此应用的帐号名或额外信息添加到帐号管理服务中,使用Promise方式异步返回结果。

需要权限:无。

- 参数:

  | 参数名    | 类型   | 必填 | 说明                                                         |
  | --------- | ------ | ---- | ------------------------------------------------------------ |
  | name      | string | 是   | 要添加的应用帐户的名称。                                     |
  | extraInfo | string | 是   | 要添加的应用帐户的额外信息,额外的信息不能是应用帐号的敏感信息。 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.addAccount("LiSi", "token101").then(()=> { 
      console.log('addAccount Success');
  }).catch((err) => {
      console.log("addAccount err: "  + JSON.stringify(err));
  });
  ```

### deleteAccount

deleteAccount(name: string, callback: AsyncCallback<void>): void

从帐号管理服务中删除应用帐号,使用callback回调异步返回结果。

- 参数:

  | 参数名   | 类型                | 必填 | 说明                               |
  | -------- | ------------------- | ---- | ---------------------------------- |
  | name     | string              | 是   | 要删除的应用帐户的名称。           |
  | callback | AsyncCallback<void> | 是   | 帐号管理服务中删除应用帐号的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteAccount("ZhaoLiu", (err) => { 
      console.log("deleteAccount err: " + JSON.stringify(err));
   });
  ```

### deleteAccount

deleteAccount(name: string): Promise<void>

从帐号管理服务中删除应用帐号,使用Promise方式异步返回结果。

- 参数:

  | 参数名 | 类型   | 必填 | 说明                     |
  | ------ | ------ | ---- | ------------------------ |
  | name   | string | 是   | 要删除的应用帐户的名称。 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteAccount("ZhaoLiu").then(() => { 
        console.log('deleteAccount Success');
   }).catch((err) => {
      console.log("deleteAccount err: "  + JSON.stringify(err));
  });
  ```

### disableAppAccess

disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void

禁止指定第三方应用帐户的名称访问指定包名称的第三方应用,使用callback回调异步返回结果。

- 参数:

  | 参数名     | 类型                | 必填 | 说明                                                         |
  | ---------- | ------------------- | ---- | ------------------------------------------------------------ |
  | name       | string              | 是   | 要禁用访问的第三方应用帐户的名称。                           |
  | bundleName | string              | 是   | 第三方应用的包名。                                           |
  | callback   | AsyncCallback<void> | 是   | 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.disableAppAccess("ZhangSan", "com.huawei.ohos.accountjsdemo", (err) => { 
      console.log("disableAppAccess err: " + JSON.stringify(err));
  });
  ```

### disableAppAccess

disableAppAccess(name: string, bundleName: string): Promise<void>

禁止指定第三方应用帐户的名称访问指定包名称的第三方应用,使用Promise方式异步返回结果。

- 参数:

  | 参数名     | 类型   | 必填 | 说明                               |
  | ---------- | ------ | ---- | ---------------------------------- |
  | name       | string | 是   | 要禁用访问的第三方应用帐户的名称。 |
  | bundleName | string | 是   | 第三方应用的包名。                 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.disableAppAccess("ZhangSan", "com.huawei.ohos.accountjsdemo").then(() => { 
      console.log('disableAppAccess Success');
  }).catch((err) => {
      console.log("disableAppAccess err: "  + JSON.stringify(err));
  });
  ```

### enableAppAccess

enableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void

允许指定第三方应用帐户的名称访问指定包名称的第三方应用,使用callback回调异步返回结果。

- 参数:

  | 参数名     | 类型                | 必填 | 说明                                                         |
  | ---------- | ------------------- | ---- | ------------------------------------------------------------ |
  | name       | string              | 是   | 应用帐号名称。                                               |
  | bundleName | string              | 是   | 第三方应用的包名。                                           |
  | callback   | AsyncCallback<void> | 是   | 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.enableAppAccess("ZhangSan", "com.huawei.ohos.accountjsdemo", (err) => { 
      console.log("enableAppAccess: " + JSON.stringify(err));
   });
  ```

### enableAppAccess

enableAppAccess(name: string, bundleName: string): Promise<void>

允许指定第三方应用帐户的名称访问指定包名称的第三方应用,使用Promise方式异步返回结果。

- 参数:

  | 参数名     | 类型   | 必填 | 说明               |
  | ---------- | ------ | ---- | ------------------ |
  | name       | string | 是   | 应用帐号名称。     |
  | bundleName | string | 是   | 第三方应用的包名。 |

- 返回值:

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

- 示例:

  ```
  app_account_instance.enableAppAccess("ZhangSan", "com.huawei.ohos.accountjsdemo").then(() => { 
       console.log('enableAppAccess Success');
  }).catch((err) => {
      console.log("enableAppAccess err: "  + JSON.stringify(err));
  });
  ```

### checkAppAccountSyncEnable

checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): void

检查指定应用帐号是否允许应用数据同步,使用callback回调异步返回结果。

- 参数:

  | 参数名   | 类型                   | 必填 | 说明                                         |
  | -------- | ---------------------- | ---- | -------------------------------------------- |
  | name     | string                 | 是   | 应用帐号名称。                               |
  | callback | AsyncCallback<boolean> | 是   | 检查指定应用帐号是否允许应用数据同步的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { 
      console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err));
      console.log('checkAppAccountSyncEnable result: ' + result);
  });
  ```

### checkAppAccountSyncEnable

checkAppAccountSyncEnable(name: string): Promise<boolean>

检查指定应用帐号是否允许应用数据同步,使用Promise方式异步返回结果。

- 参数:

  | 参数名 | 类型   | 必填 | 说明           |
  | ------ | ------ | ---- | -------------- |
  | name   | string | 是   | 应用帐号名称。 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { 
      console.log('checkAppAccountSyncEnable, result: ' + data);
  }).catch((err) => {
      console.log("checkAppAccountSyncEnable err: "  + JSON.stringify(err));
  });
  ```

### setAccountCredential

setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void

设置此应用程序帐号的凭据,使用callback回调异步返回结果。

- 参数:

  | 参数名         | 类型                | 必填 | 说明                         |
  | -------------- | ------------------- | ---- | ---------------------------- |
  | name           | string              | 是   | 应用程序帐户的名称。         |
  | credentialType | string              | 是   | 要设置的凭据的类型。         |
  | credential     | string              | 是   | 要设置的凭据。               |
  | callback       | AsyncCallback<void> | 是   | 设置此应用帐号的凭据的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { 
      console.log("setAccountCredential err: " + JSON.stringify(err));
  });
  ```

### setAccountCredential

setAccountCredential(name: string, credentialType: string, credential: string): Promise<void>

设置此应用程序帐号的凭据,使用Promise方式异步返回结果。

- 参数:

  | 参数名         | 类型   | 必填 | 说明                 |
  | -------------- | ------ | ---- | -------------------- |
  | name           | string | 是   | 应用帐户的名称。     |
  | credentialType | string | 是   | 要设置的凭据的类型。 |
  | credential     | string | 是   | 要设置的凭据。       |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001").then(() => { 
      console.log('setAccountCredential Success');
  }).catch((err) => {
      console.log("setAccountCredential err: "  + JSON.stringify(err));
  });
  ```

### setAccountExtraInfo

setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<void>): void

设置此应用程序帐号的额外信息,使用callback回调异步返回结果。

- 参数:

  | 参数名    | 类型                | 必填 | 说明                             |
  | --------- | ------------------- | ---- | -------------------------------- |
  | name      | string              | 是   | 应用帐户的名称。                 |
  | extraInfo | string              | 是   | 要设置的额外信息。               |
  | callback  | AsyncCallback<void> | 是   | 设置此应用帐号的额外信息的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { 
      console.log("setAccountExtraInfo err: " + JSON.stringify(err));
  });
  ```

### setAccountExtraInfo

setAccountExtraInfo(name: string, extraInfo: string): Promise<void>

设置此应用程序帐号的额外信息,使用Promise方式异步返回结果。

- 参数:

  | 参数名    | 类型   | 必填 | 说明               |
  | --------- | ------ | ---- | ------------------ |
  | name      | string | 是   | 应用帐户的名称。   |
  | extraInfo | string | 是   | 要设置的额外信息。 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { 
      console.log('setAccountExtraInfo Success');
  }).catch((err) => {
      console.log("setAccountExtraInfo err: "  + JSON.stringify(err));
  });
  ```

### setAppAccountSyncEnable

setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback<void>): void

设置指定的应用程序帐号是否允许应用程序数据同步,使用callback回调异步返回结果。

- 参数:

  | 参数名   | 类型                | 必填 | 说明                                               |
  | -------- | ------------------- | ---- | -------------------------------------------------- |
  | name     | string              | 是   | 应用帐户的名称。                                   |
  | isEnable | boolean             | 是   | 是否允许应用数据同步。                             |
  | callback | AsyncCallback<void> | 是   | 设置指定的应用帐号是否允许应用程序数据同步的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { 
      console.log("setAppAccountSyncEnable err: " + JSON.stringify(err));
  });
  ```

### setAppAccountSyncEnable

setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void>

设置指定的应用程序帐号是否允许应用程序数据同步,使用Promise方式异步返回结果。

- 参数:

  | 参数名   | 类型    | 必填 | 说明                   |
  | -------- | ------- | ---- | ---------------------- |
  | name     | string  | 是   | 应用帐户的名称。       |
  | isEnable | boolean | 是   | 是否允许应用数据同步。 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { 
      console.log('setAppAccountSyncEnable Success');
  }).catch((err) => {
      console.log("setAppAccountSyncEnable err: "  + JSON.stringify(err));
  });
  ```

### setAssociatedData

setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void

设置与此应用程序帐号关联的数据,使用callback回调异步返回结果。

- 参数:

  | 参数名   | 类型                | 必填 | 说明                               |
  | -------- | ------------------- | ---- | ---------------------------------- |
  | name     | string              | 是   | 应用帐户的名称。                   |
  | key      | string              | 是   | 要设置的数据的键,密钥可以自定义。 |
  | value    | string              | 是   | 要设置的数据的值。                 |
  | callback | AsyncCallback<void> | 是   | 设置与此应用帐号关联的数据的回调。 |

- 示例:

  ```
  app_account_instance.setAssociatedData("ZhangSan", "k001", "v001", (err) => { 
      console.log("setAssociatedData err: " + JSON.stringify(err));
  });
  ```

### setAssociatedData

setAssociatedData(name: string, key: string, value: string): Promise<void>

设置与此应用程序帐号关联的数据,使用Promise方式异步返回结果。

- 参数:

  | 参数名 | 类型   | 必填 | 说明                               |
  | ------ | ------ | ---- | ---------------------------------- |
  | name   | string | 是   | 应用帐户的名称。                   |
  | key    | string | 是   | 要设置的数据的键,密钥可以自定义。 |
  | value  | string | 是   | 要设置的数据的值。                 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { 
      console.log('setAssociatedData Success');
  }).catch((err) => {
      console.log("setAssociatedData err: "  + JSON.stringify(err));
  });
  ```

### getAccountCredential

getAccountCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void

获取此应用帐号的凭据,使用callback回调异步返回结果。

- 参数:

  | 参数名         | 类型                  | 必填 | 说明                         |
  | -------------- | --------------------- | ---- | ---------------------------- |
  | name           | string                | 是   | 应用帐号名称。               |
  | credentialType | string                | 是   | 要获取的凭据的类型。         |
  | callback       | AsyncCallback<string> | 是   | 获取此应用帐号的凭据的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { 
      console.log("getAccountCredential err: " + JSON.stringify(err));
      console.log('getAccountCredential result: ' + result);
  });
  ```

### getAccountCredential

getAccountCredential(name: string, credentialType: string): Promise<string>

获取此应用程序帐号的凭据,使用Promise方式异步返回结果。

- 参数:

  | 参数名         | 类型   | 必填 | 说明                 |
  | -------------- | ------ | ---- | -------------------- |
  | name           | string | 是   | 应用帐号名称。       |
  | credentialType | string | 是   | 要获取的凭据的类型。 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { 
      console.log('getAccountCredential, result: ' + data);
  }).catch((err) => {
      console.log("getAccountCredential err: "  + JSON.stringify(err));
  });
  ```

### getAccountExtraInfo

getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void

获取此应用帐号的额外信息,使用callback回调异步返回结果。

- 参数:

  | 参数名   | 类型                  | 必填 | 说明                             |
  | -------- | --------------------- | ---- | -------------------------------- |
  | name     | string                | 是   | 应用帐号名称。                   |
  | callback | AsyncCallback<string> | 是   | 获取此应用帐号的额外信息的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { 
      console.log("getAccountExtraInfo err: " + JSON.stringify(err));
      console.log('getAccountExtraInfo result: ' + result);
  });
  ```

### getAccountExtraInfo

getAccountExtraInfo(name: string): Promise<string>

获取此应用程序帐号的额外信息,使用Promise方式异步返回结果。

- 参数:

  | 参数名 | 类型   | 必填 | 说明           |
  | ------ | ------ | ---- | -------------- |
  | name   | string | 是   | 应用帐号名称。 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { 
      console.log('getAccountExtraInfo, result: ' + data);
  }).catch((err) => {
      console.log("getAccountExtraInfo err: "  + JSON.stringify(err));
  });
  ```

### getAssociatedData

getAssociatedData(name: string, key: string, callback: AsyncCallback<string>): void

获取与此应用程序帐号关联的数据,使用callback回调异步返回结果。

- 参数:

  | 参数名   | 类型                  | 必填 | 说明                               |
  | -------- | --------------------- | ---- | ---------------------------------- |
  | name     | string                | 是   | 应用帐号名称。                     |
  | key      | string                | 是   | 要获取的数据的key。                |
  | callback | AsyncCallback<string> | 是   | 获取与此应用帐号关联的数据的回调。 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { 
      console.log("getAssociatedData err: " + JSON.stringify(err));
      console.log('getAssociatedData result: ' + result);
  });
  ```

### getAssociatedData

getAssociatedData(name: string, key: string): Promise<string>

获取与此应用程序帐号关联的数据,使用Promise方式异步返回结果。

- 参数:

  | 参数名 | 类型   | 必填 | 说明                |
  | ------ | ------ | ---- | ------------------- |
  | name   | string | 是   | 应用帐号名称。      |
  | key    | string | 是   | 要获取的数据的key。 |

- 返回值:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { 
       console.log('getAssociatedData: ' + data);
  }).catch((err) => {
      console.log("getAssociatedData err: "  + JSON.stringify(err));
  });
  ```

### getAllAccessibleAccounts

getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void;

获取全部应用已授权帐号信息。

需要权限:ohos.permission.GET_ACCOUNTS_PRIVILEGED,系统应用可用。

- 参数:

  | 参数名   | 类型                                 | 必填 | 说明             |
  | -------- | ------------------------------------ | ---- | ---------------- |
  | callback | AsyncCallback<Array<AppAccountInfo>> | 是   | 应用帐号信息列表 |

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAllAccessibleAccounts((err, data)=>{
  	console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err));
  	console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data));
  });
  ```

### getAllAccessibleAccounts

getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>>;

获取全部应用已授权帐号信息。

需要权限:ohos.permission.GET_ACCOUNTS_PRIVILEGED,系统应用可用。

- 参数:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAllAccessibleAccounts().then((data) => { 
       console.log('getAllAccessibleAccounts: ' + data);
  }).catch((err) => {
      console.log("getAllAccessibleAccounts err: "  + JSON.stringify(err));
  });
  ```

### getAllAccounts

getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void;

获取指定应用全部帐号信息。

需要权限:ohos.permission.GET_ACCOUNTS_PRIVILEGED,系统应用可用。

- 参数:

  | 参数名   | 类型                                 | 必填 | 说明             |
  | -------- | ------------------------------------ | ---- | ---------------- |
  | owner    | string                               | 是   | 应用包名称       |
  | callback | AsyncCallback<Array<AppAccountInfo>> | 是   | 应用帐号信息列表 |

- 示例:

  ```
  const appAccountManager = account.createAppAccountManager();
  const selfBundle = "com.example.actsgetallaaccounts";
  appAccountManager.getAllAccounts(selfBundle, (err, data)=>{
  	console.debug("getAllAccounts err:" + JSON.stringify(err));
  	console.debug("getAllAccounts data:" + JSON.stringify(data));
  });
  ```

### getAllAccounts

getAllAccounts(owner: string): Promise<Array<AppAccountInfo>>;

获取指定应用全部帐号信息。

需要权限:ohos.permission.GET_ACCOUNTS_PRIVILEGED,系统应用可用。

- 参数:

  | 参数名 | 类型   | 必填 | 说明       |
  | ------ | ------ | ---- | ---------- |
  | owner  | string | 是   | 应用包名称 |

- 参数:

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

- 示例:

  ```
  const appAccountManager = account_appAccount.createAppAccountManager();
  const selfBundle = "com.example.actsgetallaaccounts";
  appAccountManager.getAllAccounts(selfBundle).then((data) => { 
       console.log('getAllAccounts: ' + data);
  }).catch((err) => {
      console.log("getAllAccounts err: "  + JSON.stringify(err));
  });
  ```

### on('change')

on(type: 'change', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void;

订阅指定帐号所有者的帐户变更事件,使用callback回调异步返回结果。

- 参数:

  | 参数名   | 类型                            | 必填 | 说明                                                         |
  | -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
  | type     | 'change'                        | 是   | 关于帐户更改事件,当帐户所有者更新帐户时,订阅者将收到通知。 |
  | owners   | Array<string>                   | 是   | 指示帐户的所有者。                                           |
  | callback | Callback<Array<AppAccountInfo>> | 是   | 订阅指定帐号所有者的帐户变更事件的回调。                     |

- 示例:

  ```
  const appAccountManager = account.createAppAccountManager();
  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));
  }
  ```

### off('change')

off(type: 'change', callback?: Callback<void>): void;

取消订阅帐号事件,使用callback回调异步返回结果。

- 参数:

  | 参数名   | 类型                 | 必填 | 说明                     |
  | -------- | -------------------- | ---- | ------------------------ |
  | type     | 'change'             | 是   | 关于帐户更改事件。       |
  | callback | Callback<void> | 否   | 取消订阅帐号事件的回调。 |

- 示例:

  ```
  const appAccountManager = account.createAppAccountManager();
  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));
  }
  ```

## AppAccountInfo



| 参数名 | 类型   | 必填 | 说明               |
| ------ | ------ | ---- | ------------------ |
| owner  | string | 是   | 所有者是应用帐户。 |
| name   | string | 是   | 应用帐户的名称。   |