js-apis-appAccount.md 173.5 KB
Newer Older
1
# @ohos.account.appAccount (应用帐号管理)
Z
zhaoyuan17 已提交
2

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

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


## 导入模块

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


## account_appAccount.createAppAccountManager

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

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

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

**返回值:**
26

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

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

## AppAccountManager

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

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

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

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

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

**参数:**

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

**错误码:**

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

**示例:**

  ```js
  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
  let options = {
    customData: {
      "age": "10"
    }
  }
109
  try {
J
jidong 已提交
110 111 112 113 114
    appAccountManager.createAccount("LiSi", options, (err) => {
      if (err) {
        console.log("createAccount failed, error: " + JSON.stringify(err));
      } else {
        console.log("createAccount successfully");
L
libing23 已提交
115
      }
J
jidong 已提交
116 117 118
    });
  } catch(err) {
    console.log("createAccount exception: " + JSON.stringify(err));
119 120 121 122 123
  }
  ```

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

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

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

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

**参数:**

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

**返回值:**

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

**错误码:**

J
jidong 已提交
145 146 147 148 149 150 151
| 错误码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. |
152 153 154 155

**示例:**

  ```js
J
jidong 已提交
156 157 158 159 160
  let options = {
    customData: {
      "age": "10"
    }
  }
161
  try {
J
jidong 已提交
162 163 164 165 166 167 168
    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));
169 170 171 172 173 174 175
  }
  ```

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

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

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

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

**参数:**

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

L
libing23 已提交
187 188
**错误码:**

J
jidong 已提交
189 190 191 192 193 194 195 196
| 错误码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 已提交
197

198 199 200 201 202 203
**示例:**

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

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

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

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

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

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

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

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

**参数:**

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

L
libing23 已提交
241 242
**错误码:**

J
jidong 已提交
243 244 245 246 247 248 249 250
| 错误码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 已提交
251

252 253 254 255 256 257
**示例:**

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

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

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

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

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

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

J
jidong 已提交
287
删除应用帐号。使用callback异步回调。
288 289 290 291 292 293 294

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

**参数:**

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

**错误码:**

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

**示例:**

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

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

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

J
jidong 已提交
326
删除应用帐号。使用Promise异步回调。
327 328 329 330 331 332 333

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

**参数:**

| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
J
jidong 已提交
334
| name | string | 是    | 应用帐号的名称。 |
335 336 337 338 339

**返回值:**

| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
340
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
341 342 343

**错误码:**

J
jidong 已提交
344 345 346 347 348
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
349 350 351 352 353

**示例:**

  ```js
  try {
J
jidong 已提交
354 355 356 357 358
    appAccountManager.removeAccount("Lisi").then(() => {
      console.log("removeAccount successfully");
    }).catch((err) => {
      console.log("removeAccount failed, error: " + JSON.stringify(err));
    });
359
  } catch (err) {
J
jidong 已提交
360
    console.log("removeAccount exception: " + JSON.stringify(err));
361 362 363 364 365 366 367
  }
  ```

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

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

J
jidong 已提交
368
设置指定应用对特定帐号的访问权限。使用callback异步回调。
369 370 371 372 373

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

**参数:**

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

L
libing23 已提交
381 382
**错误码:**

J
jidong 已提交
383 384 385 386 387 388
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. |
| 12400001 | Application not found. |
L
libing23 已提交
389

390 391 392 393
**示例:**

  ```js
  try {
J
jidong 已提交
394 395 396 397 398 399 400
    appAccountManager.setAppAccess("ZhangSan", "com.example.accountjsdemo", true, (err) => {
      if (err) {
        console.log("setAppAccess failed: " + JSON.stringify(err));
      } else {
        console.log("setAppAccess successfully");
      }
    });
401
  } catch (err) {
J
jidong 已提交
402
    console.log("setAppAccess exception: " + JSON.stringify(err));
403 404 405 406 407 408 409
  }
  ```

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

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

J
jidong 已提交
410
设置指定应用对特定帐号的数据访问权限。使用Promise异步回调。
411 412 413 414 415 416 417

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

**参数:**

| 参数名        | 类型     | 必填   | 说明        |
| ---------- | ------ | ---- | --------- |
J
jidong 已提交
418
| name       | string | 是    | 应用帐号的名称。   |
419
| bundleName | string | 是    | 第三方应用的包名。 |
J
jidong 已提交
420
| isAccessible | boolean | 是    | 是否可访问。true表示允许访问,false表示禁止访问。 |
421 422 423 424 425

**返回值:**

| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
426
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
427 428 429

**错误码:**

J
jidong 已提交
430 431 432 433 434 435
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. |
| 12400001 | Application not found. |
436 437 438 439 440

**示例:**

  ```js
  try {
J
jidong 已提交
441 442 443 444 445
    appAccountManager.setAppAccess("ZhangSan", "com.example.accountjsdemo", true).then(() => {
      console.log("setAppAccess successfully");
    }).catch((err) => {
      console.log("setAppAccess failed: " + JSON.stringify(err));
    });
446
  } catch (err) {
J
jidong 已提交
447
    console.log("setAppAccess exception: " + JSON.stringify(err));
448 449 450
  }
  ```

L
libing23 已提交
451
### checkAppAccess<sup>9+</sup>
Z
zhaoyuan17 已提交
452

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

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

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

Z
zengyawen 已提交
459
**参数:**
Z
zhaoyuan17 已提交
460

H
HelloCrease 已提交
461 462
| 参数名        | 类型                        | 必填   | 说明                                |
| ---------- | ------------------------- | ---- | --------------------------------- |
J
jidong 已提交
463
| name       | string                    | 是    | 应用帐号的名称。                           |
H
HelloCrease 已提交
464
| bundleName | string                    | 是    | 第三方应用的包名。                         |
465
| callback   | AsyncCallback&lt;boolean&gt; | 是    | 回调函数。返回true表示指定应用可访问特定帐号的数据;返回false表示不可访问。 |
L
libing23 已提交
466 467 468

**错误码:**

J
jidong 已提交
469 470 471 472 473 474
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. |
| 12400001 | Application not found. |
Z
zengyawen 已提交
475 476

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

Z
zhangalong 已提交
478
  ```js
L
libing23 已提交
479
  try {
J
jidong 已提交
480 481 482 483 484 485 486
    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 已提交
487
  } catch (err) {
J
jidong 已提交
488
    console.log("checkAppAccess exception: " + JSON.stringify(err));
L
libing23 已提交
489 490
  }
  ```
Z
zhaoyuan17 已提交
491

L
libing23 已提交
492
### checkAppAccess<sup>9+</sup>
Z
zhaoyuan17 已提交
493

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

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

Z
zengyawen 已提交
498 499 500
**系统能力:** SystemCapability.Account.AppAccount

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

L
libing23 已提交
502 503
| 参数名        | 类型     | 必填   | 说明        |
| ---------- | ------ | ---- | --------- |
J
jidong 已提交
504
| name       | string | 是    | 应用帐号的名称。   |
L
libing23 已提交
505
| bundleName | string | 是    | 第三方应用的包名。 |
Z
zhaoyuan17 已提交
506

Z
zengyawen 已提交
507
**返回值:**
Z
zhaoyuan17 已提交
508

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

L
libing23 已提交
513
**错误码:**
Z
zhaoyuan17 已提交
514

J
jidong 已提交
515 516 517 518 519 520
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or bundleName. |
| 12300003 | Account not found. |
| 12400001 | Application not found. |
521 522 523 524 525

**示例:**

  ```js
  try {
J
jidong 已提交
526 527 528 529 530
    appAccountManager.checkAppAccess("ZhangSan", "com.example.accountjsdemo").then((isAccessible) => {
      console.log("checkAppAccess successfully, isAccessible: " + isAccessible);
    }).catch((err) => {
      console.log("checkAppAccess failed, error: " + JSON.stringify(err));
    });
531
  } catch (err) {
J
jidong 已提交
532
    console.log("checkAppAccess exception: " + JSON.stringify(err));
533 534 535
  }
  ```

J
jidong 已提交
536
### setDataSyncEnabled<sup>9+</sup>
537

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

J
jidong 已提交
540
开启或禁止指定应用帐号的数据同步功能。使用callback异步回调。
541 542 543 544 545 546 547

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

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

**参数:**

J
jidong 已提交
548 549 550 551 552
| 参数名      | 类型                        | 必填   | 说明                        |
| -------- | ------------------------- | ---- | ------------------------- |
| name     | string                    | 是    | 应用帐号的名称。                   |
| isEnabled | boolean                   | 是    | 是否开启数据同步。               |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当开启或禁止成功时,err为null,否则为错误对象。 |
L
libing23 已提交
553 554 555

**错误码:**

J
jidong 已提交
556 557 558 559 560
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
561 562 563 564 565

**示例:**

  ```js
  try {
J
jidong 已提交
566 567
      appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => { 
          console.log("setDataSyncEnabled err: " + JSON.stringify(err));
568 569
      });
  } catch (err) {
J
jidong 已提交
570
      console.log("setDataSyncEnabled err: " + JSON.stringify(err));
571 572 573
  }
  ```

J
jidong 已提交
574
### setDataSyncEnabled<sup>9+</sup>
575

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

J
jidong 已提交
578
开启或禁止指定应用帐号的数据同步功能。使用Promise异步回调。
579 580 581 582 583 584 585

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

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

**参数:**

J
jidong 已提交
586 587 588 589
| 参数名      | 类型      | 必填   | 说明          |
| -------- | ------- | ---- | ----------- |
| name     | string  | 是    | 应用帐号的名称。     |
| isEnabled | boolean | 是    | 是否开启数据同步。 |
590 591 592

**返回值:**

J
jidong 已提交
593 594
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
595
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
596 597 598

**错误码:**

J
jidong 已提交
599 600 601 602 603
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
604 605 606 607 608

**示例:**

  ```js
  try {
J
jidong 已提交
609 610
      appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => { 
          console.log('setDataSyncEnabled Success');
611
      }).catch((err) => {
J
jidong 已提交
612
          console.log("setDataSyncEnabled err: "  + JSON.stringify(err));
613 614
      });
  } catch (err) {
J
jidong 已提交
615
      console.log("setDataSyncEnabled err: "  + JSON.stringify(err));
616 617 618
  }
  ```

J
jidong 已提交
619
### checkDataSyncEnabled<sup>9+</sup>
620

J
jidong 已提交
621 622 623
checkDataSyncEnabled(name: string, callback: AsyncCallback&lt;boolean&gt;): void

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

J
jidong 已提交
625
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
626 627 628 629 630

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

**参数:**

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

**错误码:**

J
jidong 已提交
638 639 640 641 642
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
643 644 645 646 647

**示例:**

  ```js
  try {
J
jidong 已提交
648 649 650 651 652 653 654
    appAccountManager.checkDataSyncEnabled("ZhangSan", (err, isEnabled) => {
      if (err) {
        console.log("checkDataSyncEnabled failed, err: " + JSON.stringify(err));
      } else {
        console.log('checkDataSyncEnabled successfully, isEnabled: ' + isEnabled);
      }
    });
655
  } catch (err) {
J
jidong 已提交
656
    console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
657 658 659
  }
  ```

J
jidong 已提交
660
### checkDataSyncEnabled<sup>9+</sup>
661

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

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

J
jidong 已提交
666
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
667 668 669 670 671

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

**参数:**

J
jidong 已提交
672 673 674
| 参数名  | 类型     | 必填   | 说明      |
| ---- | ------ | ---- | ------- |
| name | string | 是    | 应用帐号的名称。 |
675 676 677

**返回值:**

J
jidong 已提交
678 679
| 类型                     | 说明                    |
| :--------------------- | :-------------------- |
A
Annie_wang 已提交
680
| Promise&lt;boolean&gt; | Promise对象。返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。 |
L
libing23 已提交
681 682 683

**错误码:**

J
jidong 已提交
684 685 686 687 688
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name. |
| 12300003 | Account not found. |
689 690 691 692 693

**示例:**

  ```js
  try {
J
jidong 已提交
694 695 696 697 698
    appAccountManager.checkDataSyncEnabled("ZhangSan").then((isEnabled) => {
        console.log("checkDataSyncEnabled successfully, isEnabled: " + isEnabled);
    }).catch((err) => {
      console.log("checkDataSyncEnabled failed, err: " + JSON.stringify(err));
    });
699
  } catch (err) {
J
jidong 已提交
700
    console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
701 702 703
  }
  ```

J
jidong 已提交
704
### setCredential<sup>9+</sup>
Z
zhaoyuan17 已提交
705

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

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

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

Z
zengyawen 已提交
712
**参数:**
Z
zhaoyuan17 已提交
713

J
jidong 已提交
714 715 716 717 718 719
| 参数名            | 类型                        | 必填   | 说明            |
| -------------- | ------------------------- | ---- | ------------- |
| name           | string                    | 是    | 应用帐号的名称。     |
| credentialType | string                    | 是    | 凭据类型。     |
| credential     | string                    | 是    | 凭据取值。       |
| callback       | AsyncCallback&lt;void&gt; | 是    | 回调函数。当凭据设置成功时,err为null,否则为错误对象。 |
L
libing23 已提交
720 721 722

**错误码:**

J
jidong 已提交
723 724 725 726 727
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType or credential. |
| 12300003 | Account not found. |
Z
zengyawen 已提交
728 729

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

Z
zhangalong 已提交
731
  ```js
L
libing23 已提交
732
  try {
J
jidong 已提交
733 734 735 736 737 738 739
    appAccountManager.setCredential("ZhangSan", "PIN_SIX", "xxxxxx", (err) => {
      if (err) {
        console.log("setCredential failed, error: " + JSON.stringify(err));
      } else {
        console.log("setCredential successfully");
      }
    });
L
libing23 已提交
740
  } catch (err) {
J
jidong 已提交
741
    console.log("setCredential exception: " + JSON.stringify(err));
L
libing23 已提交
742
  }
Z
zhaoyuan17 已提交
743 744
  ```

J
jidong 已提交
745
### setCredential<sup>9+</sup>
Z
zhaoyuan17 已提交
746

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

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

Z
zengyawen 已提交
751 752 753
**系统能力:** SystemCapability.Account.AppAccount

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

J
jidong 已提交
755 756 757 758 759
| 参数名            | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
| name           | string | 是    | 应用帐号的名称。   |
| credentialType | string | 是    | 凭据类型。 |
| credential     | string | 是    | 凭据取值。    |
Z
zhaoyuan17 已提交
760

Z
zengyawen 已提交
761
**返回值:**
Z
zhaoyuan17 已提交
762

J
jidong 已提交
763
| 类型                 | 说明                    |
H
HelloCrease 已提交
764
| :------------------ | :-------------------- |
A
Annie_wang 已提交
765
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
766 767 768

**错误码:**

J
jidong 已提交
769 770 771 772 773
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType or credential. |
| 12300003 | Account not found. |
Z
zhaoyuan17 已提交
774

Z
zengyawen 已提交
775
**示例:**
Z
zhaoyuan17 已提交
776

Z
zhangalong 已提交
777
  ```js
L
libing23 已提交
778
  try {
J
jidong 已提交
779 780 781 782 783
    appAccountManager.setCredential("ZhangSan", "PIN_SIX", "xxxxxx").then(() => {
      console.log("setCredential successfully");
    }).catch((err) => {
      console.log("setCredential failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
784
  } catch (err) {
J
jidong 已提交
785
    console.log("setCredential exception: " + JSON.stringify(err));
L
libing23 已提交
786
  }
Z
zhaoyuan17 已提交
787 788
  ```

J
jidong 已提交
789
### getCredential<sup>9+</sup>
Z
zhaoyuan17 已提交
790

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

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

Z
zengyawen 已提交
795 796 797
**系统能力:** SystemCapability.Account.AppAccount

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

J
jidong 已提交
799 800 801 802 803
| 参数名            | 类型                          | 必填   | 说明             |
| -------------- | --------------------------- | ---- | -------------- |
| name           | string                      | 是    | 应用帐号的名称。        |
| credentialType | string                      | 是    | 凭据类型。 |
| callback       | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取凭据成功时,err为null,data为指定应用帐号的凭据;否则为错误对象。 |
L
libing23 已提交
804 805 806

**错误码:**

J
jidong 已提交
807 808 809 810 811 812
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType. |
| 12300003 | Account not found. |
| 12300102 | Credential not found. |
Z
zhaoyuan17 已提交
813

Z
zengyawen 已提交
814
**示例:**
Z
zhaoyuan17 已提交
815

Z
zhangalong 已提交
816
  ```js
L
libing23 已提交
817
  try {
J
jidong 已提交
818 819 820 821 822 823 824
      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 已提交
825
  } catch (err) {
J
jidong 已提交
826
      console.log("getCredential err: " + JSON.stringify(err));
L
libing23 已提交
827
  }
Z
zhaoyuan17 已提交
828 829
  ```

J
jidong 已提交
830
### getCredential<sup>9+</sup>
Z
zhaoyuan17 已提交
831

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

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

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

Z
zengyawen 已提交
838
**参数:**
Z
zhaoyuan17 已提交
839

J
jidong 已提交
840 841 842 843
| 参数名          | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
| name           | string | 是    | 应用帐号的名称。 |
| credentialType | string | 是    | 凭据类型。 |
Z
zhaoyuan17 已提交
844

Z
zengyawen 已提交
845
**返回值:**
Z
zhaoyuan17 已提交
846

J
jidong 已提交
847 848 849
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise对象,返回指定应用帐号的凭据。 |
L
libing23 已提交
850 851 852

**错误码:**

J
jidong 已提交
853 854 855 856 857 858
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType. |
| 12300003 | Account not found. |
| 12300102 | Credential not found. |
Z
zengyawen 已提交
859 860

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

Z
zhangalong 已提交
862
  ```js
L
libing23 已提交
863
  try {
J
jidong 已提交
864 865 866 867 868
    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 已提交
869
  } catch (err) {
J
jidong 已提交
870
    console.log("getCredential exception: "  + JSON.stringify(err));
L
libing23 已提交
871
  }
Z
zhaoyuan17 已提交
872
  ```
873

J
jidong 已提交
874
### setCustomData<sup>9+</sup>
875

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

J
jidong 已提交
878
设置指定应用帐号的自定义数据。使用callback异步回调。
879 880 881 882 883

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

**参数:**

J
jidong 已提交
884 885 886 887 888 889
| 参数名      | 类型                        | 必填   | 说明                |
| -------- | ------------------------- | ---- | ----------------- |
| name     | string                    | 是    | 应用帐号的名称。 |
| key      | string                    | 是    | 自定义数据的键名。 |
| value    | string                    | 是    | 自定义数据的取值。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置自定义数据成功时,err为null,否则为错误对象。 |
L
libing23 已提交
890 891 892

**错误码:**

J
jidong 已提交
893 894 895 896 897 898
| 错误码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. |
899 900 901 902 903

**示例:**

  ```js
  try {
J
jidong 已提交
904 905 906 907 908 909 910
    appAccountManager.setCustomData("ZhangSan", "age", "12", (err) => {
      if (err) {
        console.log("setCustomData failed, error: " + JSON.stringify(err));
      } else {
        console.log("setCustomData successfully");
      }
    });
911
  } catch (err) {
J
jidong 已提交
912
    console.log("setCustomData exception: " + JSON.stringify(err));
913 914 915
  }
  ```

J
jidong 已提交
916
### setCustomData<sup>9+</sup>
917

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

J
jidong 已提交
920
设置指定应用帐号的自定义数据。使用Promise异步回调。
921 922 923

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

J
jidong 已提交
924 925 926 927 928 929 930 931
**参数:**

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

L
libing23 已提交
932
**返回值:**
933

J
jidong 已提交
934 935
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
936
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
937

L
libing23 已提交
938
**错误码:**
939

J
jidong 已提交
940 941 942 943 944 945
| 错误码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. |
946 947 948 949 950

**示例:**

  ```js
  try {
J
jidong 已提交
951 952 953 954 955
    appAccountManager.setCustomData("ZhangSan", "age", "12").then(() => {
      console.log("setCustomData successfully");
    }).catch((err) => {
      console.log("setCustomData failed, error: " + JSON.stringify(err));
    });
956
  } catch (err) {
J
jidong 已提交
957
    console.log("setCustomData exception: " + JSON.stringify(err));
958 959
  }
  ```
Z
zhaoyuan17 已提交
960

J
jidong 已提交
961
### getCustomData<sup>9+</sup>
Z
zhaoyuan17 已提交
962

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

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

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

Z
zengyawen 已提交
969
**参数:**
Z
zhaoyuan17 已提交
970

J
jidong 已提交
971 972 973 974 975
| 参数名    | 类型                        | 必填  | 说明                     |
| -------- | --------------------------- | ----- | ------------------------ |
| name     | string                      | 是    | 应用帐号的名称。           |
| key      | string                      | 是    | 自定义数据的键名。         |
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取成功时,err为null,data为自定义数据的取值;否则为错误对象。 |
L
libing23 已提交
976 977 978

**错误码:**

J
jidong 已提交
979 980 981 982 983 984
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or key. |
| 12300003 | Account not found. |
| 12400002 | Custom data not found. |
Z
zhaoyuan17 已提交
985

Z
zengyawen 已提交
986
**示例:**
Z
zhaoyuan17 已提交
987

Z
zhangalong 已提交
988
  ```js
L
libing23 已提交
989
  try {
J
jidong 已提交
990 991 992 993 994 995 996
    appAccountManager.getCustomData("ZhangSan", "age", (err, data) => {
      if (err) {
        console.log('getCustomData failed, error: ' + err);
      } else {
        console.log("getCustomData successfully, data: " + data);
      }
    });
L
libing23 已提交
997
  } catch (err) {
J
jidong 已提交
998
    console.log("getCustomData exception: " + JSON.stringify(err));
L
libing23 已提交
999
  }
Z
zhaoyuan17 已提交
1000 1001
  ```

J
jidong 已提交
1002
### getCustomData<sup>9+</sup>
Z
zhaoyuan17 已提交
1003

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

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

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

Z
zengyawen 已提交
1010
**参数:**
Z
zhaoyuan17 已提交
1011

J
jidong 已提交
1012 1013 1014 1015
| 参数名  | 类型     | 必填   | 说明        |
| ---- | ------ | ---- | --------- |
| name | string | 是    | 应用帐号的名称。   |
| key  | string | 是    | 自定义数据的键名。 |
Z
zhaoyuan17 已提交
1016

Z
zengyawen 已提交
1017
**返回值:**
Z
zhaoyuan17 已提交
1018

J
jidong 已提交
1019 1020 1021
| 类型                   | 说明                    |
| --------------------- | --------------------- |
| Promise&lt;string&gt; | Promise对象,返回自定义数据的取值。 |
L
libing23 已提交
1022 1023 1024

**错误码:**

J
jidong 已提交
1025 1026 1027 1028 1029 1030
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or key. |
| 12300003 | Account not found. |
| 12400002 | Custom data not found. |
Z
zengyawen 已提交
1031 1032

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

Z
zhangalong 已提交
1034
  ```js
L
libing23 已提交
1035
  try {
J
jidong 已提交
1036 1037 1038 1039 1040
    appAccountManager.getCustomData("ZhangSan", "age").then((data) => {
      console.log("getCustomData successfully, data: " + data);
    }).catch((err) => {
      console.log("getCustomData failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
1041
  } catch (err) {
J
jidong 已提交
1042
    console.log("getCustomData exception: " + JSON.stringify(err));
L
libing23 已提交
1043
  }
Z
zhaoyuan17 已提交
1044 1045
  ```

J
jidong 已提交
1046
### getCustomDataSync<sup>9+</sup>
Z
zhaoyuan17 已提交
1047

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

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

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

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

J
jidong 已提交
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
| 参数名  | 类型     | 必填   | 说明        |
| ---- | ------ | ---- | --------- |
| name | string | 是    | 应用帐号的名称。   |
| key  | string | 是    | 自定义数据的键名。 |

**返回值:**

| 类型                    | 说明                    |
| --------------------- | --------------------- |
| string | 自定义数据的取值。 |
L
libing23 已提交
1066 1067 1068

**错误码:**

J
jidong 已提交
1069 1070 1071 1072 1073 1074
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or key. |
| 12300003 | Account not found. |
| 12400002 | Custom data not found. |
Z
zhaoyuan17 已提交
1075

Z
zengyawen 已提交
1076
**示例:**
Z
zhaoyuan17 已提交
1077

Z
zhangalong 已提交
1078
  ```js
1079
  try {
J
jidong 已提交
1080 1081
      let value = appAccountManager.getCustomDataSync("ZhangSan", "age");
      console.info("getCustomDataSync successfully, vaue:" + value);
1082
  } catch (err) {
J
jidong 已提交
1083
    console.error("getCustomDataSync failed, error: " + JSON.stringify(err));
1084
  }
Z
zhaoyuan17 已提交
1085 1086
  ```

J
jidong 已提交
1087
### getAllAccounts<sup>9+</sup>
Z
zhaoyuan17 已提交
1088

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

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

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

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

Z
zengyawen 已提交
1097
**参数:**
Z
zhaoyuan17 已提交
1098

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

**错误码:**

J
jidong 已提交
1105 1106 1107
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
Z
zengyawen 已提交
1108 1109

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

Z
zhangalong 已提交
1111
  ```js
1112
  try {
J
jidong 已提交
1113 1114 1115 1116 1117 1118 1119
    appAccountManager.getAllAccounts((err, data) => {
      if (err) {
        console.debug("getAllAccounts failed, error:" + JSON.stringify(err));
      } else {
        console.debug("getAllAccounts successfully");
      }
    });
1120
  } catch (err) {
J
jidong 已提交
1121
      console.debug("getAllAccounts exception: " + JSON.stringify(err));
1122
  }
Z
zhaoyuan17 已提交
1123 1124
  ```

J
jidong 已提交
1125
### getAllAccounts<sup>9+</sup>
Z
zhaoyuan17 已提交
1126

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

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

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

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

J
jidong 已提交
1135
**返回值:**
1136

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

**错误码:**

J
jidong 已提交
1143 1144 1145
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
1146 1147

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

Z
zhangalong 已提交
1149
  ```js
L
libing23 已提交
1150
  try {
J
jidong 已提交
1151 1152 1153 1154 1155
    appAccountManager.getAllAccounts().then((data) => {
      console.debug("getAllAccounts successfully");
    }).catch((err) => {
      console.debug("getAllAccounts failed, error:" + JSON.stringify(err));
    });
L
libing23 已提交
1156
  } catch (err) {
J
jidong 已提交
1157
    console.debug("getAllAccounts exception: " + JSON.stringify(err));
L
libing23 已提交
1158
  }
Z
zhaoyuan17 已提交
1159 1160
  ```

J
jidong 已提交
1161
### getAccountsByOwner<sup>9+</sup>
1162

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

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

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

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

Z
zengyawen 已提交
1171
**参数:**
Z
zhaoyuan17 已提交
1172

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

L
libing23 已提交
1178
**错误码:**
Z
zhaoyuan17 已提交
1179

J
jidong 已提交
1180 1181 1182 1183 1184
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12400001 | Application not found. |
Z
zhaoyuan17 已提交
1185

Z
zengyawen 已提交
1186
**示例:**
Z
zhaoyuan17 已提交
1187

Z
zhangalong 已提交
1188
  ```js
1189
  try {
J
jidong 已提交
1190 1191 1192 1193 1194 1195 1196
    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));
      }
    });
1197
  } catch (err) {
J
jidong 已提交
1198
    console.debug("getAccountsByOwner exception:" + JSON.stringify(err));
1199
  }
Z
zhaoyuan17 已提交
1200 1201
  ```

J
jidong 已提交
1202 1203 1204
### getAccountsByOwner<sup>9+</sup>

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

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

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

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

L
libing23 已提交
1212 1213
**参数:**

J
jidong 已提交
1214 1215 1216
| 参数名   | 类型     | 必填   | 说明     |
| ----- | ------ | ---- | ------ |
| owner | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
1217

Z
zengyawen 已提交
1218
**返回值:**
Z
zhaoyuan17 已提交
1219

J
jidong 已提交
1220 1221 1222
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise对象,返回获取到的应用帐号列表。 |
L
libing23 已提交
1223 1224 1225

**错误码:**

J
jidong 已提交
1226 1227 1228 1229 1230
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12400001 | Application not found. |
Z
zengyawen 已提交
1231 1232

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

Z
zhangalong 已提交
1234
  ```js
1235
  try {
J
jidong 已提交
1236 1237 1238 1239 1240
    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));
    });
1241
  } catch (err) {
J
jidong 已提交
1242
    console.debug("getAccountsByOwner exception:" + JSON.stringify(err));
1243
  }
Z
zhaoyuan17 已提交
1244 1245
  ```

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

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

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

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

Z
zengyawen 已提交
1254
**参数:**
Z
zhaoyuan17 已提交
1255

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

**错误码:**

J
jidong 已提交
1264 1265 1266 1267 1268 1269
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or owners. |
| 12300011 | Callback has been registered. |
| 12400001 | Application not found. |
Z
zengyawen 已提交
1270 1271

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

Z
zhangalong 已提交
1273
  ```js
L
libing23 已提交
1274
  function changeOnCallback(data){
J
jidong 已提交
1275
  	console.log("receive change data:" + JSON.stringify(data));
L
libing23 已提交
1276 1277
  }
  try{
J
jidong 已提交
1278 1279 1280
  	appAccountManager.on("accountChange", ["com.example.actsaccounttest"], changeOnCallback);
  } catch(err) {
  	console.error("on accountChange failed, error:" + JSON.stringify(err));
L
libing23 已提交
1281
  }
Z
zhaoyuan17 已提交
1282 1283
  ```

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

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

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

L
libing23 已提交
1290
**系统能力:** SystemCapability.Account.AppAccount
1291

L
libing23 已提交
1292
**参数:**
1293

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

L
libing23 已提交
1299
**错误码:**
1300

J
jidong 已提交
1301 1302 1303 1304 1305
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid type. |
| 12300012 | Callback has not been registered. |
1306 1307 1308 1309

**示例:**

  ```js
L
libing23 已提交
1310
  function changeOnCallback(data){
J
jidong 已提交
1311 1312 1313 1314 1315 1316
  	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 已提交
1317 1318
  }
  try{
J
jidong 已提交
1319
  	appAccountManager.off('accountChange', changeOnCallback);
L
libing23 已提交
1320 1321
  }
  catch(err){
J
jidong 已提交
1322
  	console.error("off accountChange failed, error:" + JSON.stringify(err));
L
libing23 已提交
1323
  }
1324 1325
  ```

L
libing23 已提交
1326
### auth<sup>9+</sup>
Z
zhaoyuan17 已提交
1327

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

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

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

Z
zengyawen 已提交
1334
**参数:**
Z
zhaoyuan17 已提交
1335

L
libing23 已提交
1336 1337
| 参数名      | 类型                    | 必填   | 说明              |
| -------- | --------------------- | ---- | --------------- |
J
jidong 已提交
1338 1339
| name     | string                | 是    | 应用帐号的名称。     |
| owner    | string                | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
1340
| authType | string                | 是    | 鉴权类型。           |
J
jidong 已提交
1341
| callback | [AuthCallback](#authcallback9) | 是    | 回调对象,返回鉴权结果。 |
L
libing23 已提交
1342 1343 1344

**错误码:**

J
jidong 已提交
1345 1346 1347 1348 1349 1350 1351 1352
| 错误码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 已提交
1353

Z
zengyawen 已提交
1354
**示例:**
Z
zhaoyuan17 已提交
1355

Z
zhangalong 已提交
1356
  ```js
L
libing23 已提交
1357 1358
  import featureAbility from '@ohos.ability.featureAbility';

J
jidong 已提交
1359 1360 1361
  function onResultCallback(code, authResult) {
    console.log("resultCode: "  + code);
    console.log("authResult: "  + JSON.stringify(authResult));
L
libing23 已提交
1362 1363 1364
  }

  function onRequestRedirectedCallback(request) {
J
jidong 已提交
1365 1366 1367 1368
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err) => {
        console.log("startAbility err: " + JSON.stringify(err));
    });
L
libing23 已提交
1369 1370
  }

1371
  try {
J
jidong 已提交
1372 1373 1374 1375
    appAccountManager.auth("LiSi", "com.example.accountjsdemo", "getSocialData", {
        onResult: onResultCallback,
        onRequestRedirected: onRequestRedirectedCallback
    });
1376
  } catch (err) {
J
jidong 已提交
1377
    console.log("auth exception: "  + JSON.stringify(err));
1378
  }
Z
zhaoyuan17 已提交
1379 1380
  ```

L
libing23 已提交
1381
### auth<sup>9+</sup>
Z
zhaoyuan17 已提交
1382

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

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

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

Z
zengyawen 已提交
1389
**参数:**
Z
zhaoyuan17 已提交
1390

L
libing23 已提交
1391 1392
| 参数名      | 类型                    | 必填   | 说明              |
| -------- | --------------------- | ---- | --------------- |
J
jidong 已提交
1393 1394
| name     | string                | 是    | 应用帐号的名称。     |
| owner    | string                | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
1395 1396
| authType | string                | 是    | 鉴权类型。           |
| options  | {[key: string]: Object}  | 是    | 鉴权所需的可选项。       |
J
jidong 已提交
1397
| callback | [AuthCallback](#authcallback9) | 是    | 回调对象,返回鉴权结果。 |
1398

L
libing23 已提交
1399
**错误码:**
1400

J
jidong 已提交
1401 1402 1403 1404 1405 1406 1407 1408
| 错误码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 已提交
1409 1410

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

Z
zhangalong 已提交
1412
  ```js
L
libing23 已提交
1413 1414
  import featureAbility from '@ohos.ability.featureAbility';

J
jidong 已提交
1415 1416 1417
  function onResultCallback(code, authResult) {
    console.log("resultCode: "  + code);
    console.log("authResult: "  + JSON.stringify(authResult));
L
libing23 已提交
1418 1419 1420
  }

  function onRequestRedirectedCallback(request) {
J
jidong 已提交
1421 1422 1423 1424
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err) => {
        console.log("startAbility err: " + JSON.stringify(err));
    });
L
libing23 已提交
1425 1426
  }

J
jidong 已提交
1427 1428 1429
  let options = {
    "password": "xxxx",
  };
1430
  try {
J
jidong 已提交
1431 1432 1433 1434
    appAccountManager.auth("LiSi", "com.example.accountjsdemo", "getSocialData", options, {
        onResult: onResultCallback,
        onRequestRedirected: onRequestRedirectedCallback
    });
1435
  } catch (err) {
J
jidong 已提交
1436
    console.log("auth exception: "  + JSON.stringify(err));
1437
  }
Z
zhaoyuan17 已提交
1438 1439
  ```

L
libing23 已提交
1440
### getAuthToken<sup>9+</sup>
Z
zhaoyuan17 已提交
1441

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

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

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

Z
zengyawen 已提交
1448
**参数:**
Z
zhaoyuan17 已提交
1449

L
libing23 已提交
1450 1451 1452
| 参数名      | 类型                          | 必填   | 说明          |
| -------- | --------------------------- | ---- | ----------- |
| name     | string                      | 是    | 应用帐号的名称。    |
J
jidong 已提交
1453
| owner    | string                      | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
1454
| authType | string                      | 是    | 鉴权类型。       |
J
jidong 已提交
1455
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取成功时,err为null,data为授权令牌值;否则为错误对象。    |
L
libing23 已提交
1456 1457 1458

**错误码:**

J
jidong 已提交
1459 1460 1461 1462 1463 1464
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name, owner or authType. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
Z
zhaoyuan17 已提交
1465

Z
zengyawen 已提交
1466
**示例:**
Z
zhaoyuan17 已提交
1467

Z
zhangalong 已提交
1468
  ```js
L
libing23 已提交
1469
  try {
J
jidong 已提交
1470 1471 1472 1473 1474 1475 1476
    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 已提交
1477
  } catch (err) {
J
jidong 已提交
1478
      console.log("getAuthToken exception: " + JSON.stringify(err));
L
libing23 已提交
1479
  }
Z
zhaoyuan17 已提交
1480 1481
  ```

L
libing23 已提交
1482
### getAuthToken<sup>9+</sup>
Z
zhaoyuan17 已提交
1483

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

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

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

Z
zengyawen 已提交
1490
**参数:**
Z
zhaoyuan17 已提交
1491

L
libing23 已提交
1492 1493 1494
| 参数名      | 类型     | 必填   | 说明          |
| -------- | ------ | ---- | ----------- |
| name     | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
1495
| owner    | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
1496
| authType | string | 是    | 鉴权类型。       |
Z
zhaoyuan17 已提交
1497

1498
**返回值:**
Z
zhaoyuan17 已提交
1499

J
jidong 已提交
1500
| 类型                    | 说明                 |
L
libing23 已提交
1501
| --------------------- | --------------------- |
J
jidong 已提交
1502
| Promise&lt;string&gt; | Promise对象,返回授权令牌。 |
L
libing23 已提交
1503 1504 1505

**错误码:**

J
jidong 已提交
1506 1507 1508 1509 1510 1511
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
Z
zhaoyuan17 已提交
1512

Z
zengyawen 已提交
1513
**示例:**
Z
zhaoyuan17 已提交
1514

Z
zhangalong 已提交
1515
  ```js
L
libing23 已提交
1516
  try {
J
jidong 已提交
1517 1518 1519 1520 1521
    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 已提交
1522
  } catch (err) {
J
jidong 已提交
1523
      console.log("getAuthToken exception: " + JSON.stringify(err));
L
libing23 已提交
1524
  }
Z
zhaoyuan17 已提交
1525 1526
  ```

L
libing23 已提交
1527
### setAuthToken<sup>9+</sup>
Z
zhaoyuan17 已提交
1528

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

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

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

Z
zengyawen 已提交
1535
**参数:**
Z
zhaoyuan17 已提交
1536

L
libing23 已提交
1537 1538 1539 1540
| 参数名      | 类型                        | 必填   | 说明       |
| -------- | ------------------------- | ---- | -------- |
| name     | string                    | 是    | 应用帐号的名称。 |
| authType | string                    | 是    | 鉴权类型。    |
J
jidong 已提交
1541 1542
| token    | string                    | 是    | 授权令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null;否则为错误对象。 |
L
libing23 已提交
1543 1544 1545

**错误码:**

J
jidong 已提交
1546 1547 1548 1549 1550 1551
| 错误码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 已提交
1552 1553

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

Z
zhangalong 已提交
1555
  ```js
1556
  try {
J
jidong 已提交
1557 1558 1559 1560 1561 1562 1563
    appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => {
      if (err) {
        console.log("setAuthToken failed, error: " + JSON.stringify(err));
      } else {
        console.log("setAuthToken successfully");
      }
    });
1564
  } catch (err) {
J
jidong 已提交
1565
      console.log('setAuthToken exception: ' + JSON.stringify(err));
Z
zhaoyuan17 已提交
1566 1567 1568
  }
  ```

L
libing23 已提交
1569
### setAuthToken<sup>9+</sup>
Z
zhaoyuan17 已提交
1570

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

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

Z
zengyawen 已提交
1575 1576 1577
**系统能力:** SystemCapability.Account.AppAccount

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

L
libing23 已提交
1579 1580 1581 1582
| 参数名      | 类型     | 必填   | 说明       |
| -------- | ------ | ---- | -------- |
| name     | string | 是    | 应用帐号的名称。 |
| authType | string | 是    | 鉴权类型。    |
J
jidong 已提交
1583
| token    | string | 是    | 授权令牌。 |
1584 1585 1586

**返回值:**

L
libing23 已提交
1587 1588
| 类型                  | 说明                    |
| ------------------- | --------------------- |
A
Annie_wang 已提交
1589
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
1590 1591 1592

**错误码:**

J
jidong 已提交
1593 1594 1595 1596 1597 1598
| 错误码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 已提交
1599

Z
zengyawen 已提交
1600
**示例:**
Z
zhaoyuan17 已提交
1601

Z
zhangalong 已提交
1602
  ```js
1603
  try {
J
jidong 已提交
1604 1605 1606 1607 1608
    appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => {
        console.log("setAuthToken successfully");
    }).catch((err) => {
        console.log("setAuthToken failed, error: " + JSON.stringify(err));
    });
1609
  } catch (err) {
J
jidong 已提交
1610
    console.log("setAuthToken exception: " + JSON.stringify(err));
Z
zhaoyuan17 已提交
1611 1612 1613
  }
  ```

L
libing23 已提交
1614
### deleteAuthToken<sup>9+</sup>
J
jidong 已提交
1615

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

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

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

Z
zengyawen 已提交
1622
**参数:**
J
jidong 已提交
1623

L
libing23 已提交
1624 1625 1626
| 参数名      | 类型                        | 必填   | 说明           |
| -------- | ------------------------- | ---- | ------------ |
| name     | string                    | 是    | 应用帐号的名称。     |
J
jidong 已提交
1627
| owner    | string                    | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
1628
| authType | string                    | 是    | 鉴权类型。        |
J
jidong 已提交
1629 1630
| token    | string                    | 是    | 授权令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当删除成功时,err为null;否则为错误对象。     |
L
libing23 已提交
1631 1632 1633

**错误码:**

J
jidong 已提交
1634 1635 1636 1637 1638 1639
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType or token. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
1640 1641 1642 1643

**示例:**

  ```js
L
libing23 已提交
1644
  try {
J
jidong 已提交
1645 1646 1647 1648 1649 1650
      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 已提交
1651 1652
      });
  } catch (err) {
J
jidong 已提交
1653
      console.log('deleteAuthToken exception: ' + JSON.stringify(err));
L
libing23 已提交
1654
  }
1655 1656
  ```

L
libing23 已提交
1657
### deleteAuthToken<sup>9+</sup>
1658

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

J
jidong 已提交
1661
删除指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。
1662 1663 1664 1665 1666

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

**参数:**

L
libing23 已提交
1667 1668 1669
| 参数名      | 类型     | 必填   | 说明           |
| -------- | ------ | ---- | ------------ |
| name     | string | 是    | 应用帐号的名称。     |
J
jidong 已提交
1670
| owner    | string | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
1671
| authType | string | 是    | 鉴权类型。        |
J
jidong 已提交
1672
| token    | string | 是    | 授权令牌。 |
1673 1674 1675

**返回值:**

L
libing23 已提交
1676 1677
| 类型                  | 说明                    |
| ------------------- | --------------------- |
A
Annie_wang 已提交
1678
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
1679 1680 1681

**错误码:**

J
jidong 已提交
1682 1683 1684 1685 1686 1687
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner or authType or token. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
1688 1689 1690 1691

**示例:**

  ```js
L
libing23 已提交
1692
  try {
J
jidong 已提交
1693 1694 1695 1696 1697
    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 已提交
1698
  } catch (err) {
J
jidong 已提交
1699
    console.log('deleteAuthToken exception: ' + JSON.stringify(err));
L
libing23 已提交
1700
  }
1701 1702
  ```

L
libing23 已提交
1703
### setAuthTokenVisibility<sup>9+</sup>
1704

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

J
jidong 已提交
1707
设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。
1708 1709 1710 1711 1712

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

**参数:**

L
libing23 已提交
1713 1714 1715 1716 1717
| 参数名        | 类型                        | 必填   | 说明                        |
| ---------- | ------------------------- | ---- | ------------------------- |
| name       | string                    | 是    | 应用帐号的名称。                  |
| authType   | string                    | 是    | 鉴权类型。                     |
| bundleName | string                    | 是    | 被设置可见性的应用包名。              |
J
jidong 已提交
1718 1719
| isVisible  | boolean                   | 是    | 是否可见。true表示可见,false表示不可见。 |
| callback   | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null;否则为错误对象。|
L
libing23 已提交
1720 1721 1722

**错误码:**

J
jidong 已提交
1723 1724 1725 1726 1727 1728 1729 1730
| 错误码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. |
1731 1732 1733 1734

**示例:**

  ```js
L
libing23 已提交
1735
  try {
J
jidong 已提交
1736 1737 1738 1739 1740 1741
      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 已提交
1742 1743
      });
  } catch (err) {
J
jidong 已提交
1744
      console.log("setAuthTokenVisibility exception: " + JSON.stringify(err));
L
libing23 已提交
1745
  }
1746 1747
  ```

L
libing23 已提交
1748
### setAuthTokenVisibility<sup>9+</sup>
1749

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

J
jidong 已提交
1752
设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。
1753 1754 1755 1756 1757

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

**参数:**

J
jidong 已提交
1758 1759 1760 1761 1762 1763
| 参数名      | 类型                        | 必填   | 说明                        |
| ---------- | ------------------------- | ---- | ------------------------- |
| name       | string                    | 是    | 应用帐号的名称。                  |
| authType   | string                    | 是    | 鉴权类型。                     |
| bundleName | string                    | 是    | 被设置可见性的应用包名。              |
| isVisible  | boolean                   | 是    | 是否可见。true表示可见,false表示不可见。 |
1764 1765 1766

**返回值:**

L
libing23 已提交
1767 1768
| 类型                  | 说明                    |
| ------------------- | --------------------- |
A
Annie_wang 已提交
1769
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
1770 1771 1772

**错误码:**

J
jidong 已提交
1773 1774 1775 1776 1777 1778 1779 1780
| 错误码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. |
1781 1782 1783 1784

**示例:**

  ```js
L
libing23 已提交
1785
  try {
J
jidong 已提交
1786 1787 1788 1789 1790
    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 已提交
1791
  } catch (err) {
J
jidong 已提交
1792
    console.log("setAuthTokenVisibility exception: " + JSON.stringify(err));
L
libing23 已提交
1793
  }
1794 1795
  ```

L
libing23 已提交
1796
### checkAuthTokenVisibility<sup>9+</sup>
1797

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

J
jidong 已提交
1800
检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。
1801 1802 1803 1804 1805

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

**参数:**

L
libing23 已提交
1806 1807 1808 1809 1810
| 参数名        | 类型                           | 必填   | 说明          |
| ---------- | ---------------------------- | ---- | ----------- |
| name       | string                       | 是    | 应用帐号的名称。    |
| authType   | string                       | 是    | 鉴权类型。       |
| bundleName | string                       | 是    | 检查可见性的应用包名。 |
J
jidong 已提交
1811
| callback   | AsyncCallback&lt;boolean&gt; | 是    | 回调函数。当检查成功时,err为null,data为true表示可见,data为false表示不可见;否则为错误对象。    |
L
libing23 已提交
1812 1813 1814

**错误码:**

J
jidong 已提交
1815 1816 1817 1818 1819 1820 1821
| 错误码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 已提交
1822

1823 1824 1825 1826
**示例:**

  ```js
  try {
J
jidong 已提交
1827 1828 1829 1830 1831 1832 1833
    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);
      }
    });
1834
  } catch (err) {
J
jidong 已提交
1835
    console.log("checkAuthTokenVisibility exception: " + JSON.stringify(err));
1836 1837 1838
  }
  ```

L
libing23 已提交
1839
### checkAuthTokenVisibility<sup>9+</sup>
1840

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

J
jidong 已提交
1843
检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。
1844 1845 1846 1847 1848

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

**参数:**

L
libing23 已提交
1849 1850 1851 1852 1853
| 参数名        | 类型     | 必填   | 说明            |
| ---------- | ------ | ---- | ------------- |
| name       | string | 是    | 应用帐号的名称。      |
| authType   | string | 是    | 鉴权类型。         |
| bundleName | string | 是    | 用于检查可见性的应用包名。 |
1854 1855 1856

**返回值:**

L
libing23 已提交
1857 1858
| 类型                     | 说明                    |
| ---------------------- | --------------------- |
A
Annie_wang 已提交
1859
| Promise&lt;boolean&gt; | Promise对象。返回true表示授权令牌对指定应用的可见,返回false表示不可见。 |
L
libing23 已提交
1860 1861 1862

**错误码:**

J
jidong 已提交
1863 1864 1865 1866 1867 1868 1869
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType or bundleName. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
| 12400001 | Application not found. |
1870 1871 1872 1873 1874

**示例:**

  ```js
  try {
J
jidong 已提交
1875 1876 1877 1878 1879
    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));
    });
1880
  } catch (err) {
J
jidong 已提交
1881
    console.log("checkAuthTokenVisibility exception: " + JSON.stringify(err));
1882 1883 1884
  }
  ```

L
libing23 已提交
1885
### getAllAuthTokens<sup>9+</sup>
1886

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

J
jidong 已提交
1889
获取指定帐号对调用方可见的所有授权令牌。使用callback异步回调。
1890 1891 1892 1893 1894

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

**参数:**

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

L
libing23 已提交
1901 1902
**错误码:**

J
jidong 已提交
1903 1904 1905 1906 1907
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner. |
| 12300003 | Account not found. |
L
libing23 已提交
1908 1909

**示例:** 
1910 1911

  ```js
L
libing23 已提交
1912
  try {
J
jidong 已提交
1913 1914 1915 1916 1917 1918 1919
    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 已提交
1920
  } catch (err) {
J
jidong 已提交
1921
    console.log("getAllAuthTokens exception: "  + JSON.stringify(err));
L
libing23 已提交
1922
  }
1923 1924
  ```

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

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

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

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

**参数:**

L
libing23 已提交
1935 1936 1937
| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
| name  | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
1938
| owner | string | 是    | 应用帐号所有者的包名。 |
1939 1940 1941

**返回值:**

L
libing23 已提交
1942 1943
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
J
jidong 已提交
1944
| Promise&lt;Array&lt;[AuthTokenInfo](#authtokeninfo9)&gt;&gt; | Promise对象,返回授权令牌数组。 |
L
libing23 已提交
1945 1946 1947

**错误码:**

J
jidong 已提交
1948 1949 1950 1951 1952
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or owner. |
| 12300003 | Account not found. |
1953 1954 1955 1956

**示例:**

  ```js
L
libing23 已提交
1957
  try {
J
jidong 已提交
1958 1959 1960 1961 1962
    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 已提交
1963
  } catch (err) {
J
jidong 已提交
1964
    console.log("getAllAuthTokens exception: "  + JSON.stringify(err));
L
libing23 已提交
1965
  }
1966 1967
  ```

L
libing23 已提交
1968
### getAuthList<sup>9+</sup>
1969

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

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

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

**参数:**

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

L
libing23 已提交
1984
**错误码:**
1985

J
jidong 已提交
1986 1987 1988 1989 1990 1991
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid name or authType. |
| 12300003 | Account not found. |
| 12300107 | AuthType not found. |
1992 1993 1994 1995 1996

**示例:**

  ```js
  try {
J
jidong 已提交
1997 1998 1999 2000 2001 2002 2003
    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);
      }
    });
2004
  } catch (err) {
J
jidong 已提交
2005
    console.log('getAuthList exception: ' + JSON.stringify(err));
2006 2007 2008
  }
  ```

L
libing23 已提交
2009
### getAuthList<sup>9+</sup>
2010

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

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

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

**参数:**

L
libing23 已提交
2019
| 参数名      | 类型     | 必填   | 说明                      |
J
jidong 已提交
2020
| -------- | ------ | ---- | ------------------------------ |
L
libing23 已提交
2021
| name     | string | 是    | 应用帐号的名称。                |
J
jidong 已提交
2022
| authType | string | 是    | 鉴权类型。 |
2023

L
libing23 已提交
2024
**返回值:**
2025

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

L
libing23 已提交
2030
**错误码:**
2031

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

**示例:**

  ```js
L
libing23 已提交
2042
  try {
J
jidong 已提交
2043 2044 2045 2046 2047
    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 已提交
2048
  } catch (err) {
J
jidong 已提交
2049
    console.log("getAuthList exception: "  + JSON.stringify(err));
2050 2051 2052
  }
  ```

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

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

J
jidong 已提交
2057
获取鉴权会话的认证器回调对象。使用callback异步回调。
2058 2059 2060 2061 2062

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

**参数:**

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

**错误码:**

J
jidong 已提交
2070 2071 2072 2073 2074
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid sessionId. |
| 12300108 | Session not found. |
2075 2076 2077 2078

**示例:**

  ```js
L
libing23 已提交
2079 2080
  import featureAbility from '@ohos.ability.featureAbility';
  featureAbility.getWant((err, want) => {
J
jidong 已提交
2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102
    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 已提交
2103
  });
2104 2105
  ```

L
libing23 已提交
2106
### getAuthCallback<sup>9+</sup>
2107

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

J
jidong 已提交
2110
获取鉴权会话的认证器回调对象。使用Promise异步回调。
2111 2112 2113 2114 2115

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

**参数:**

L
libing23 已提交
2116 2117 2118 2119 2120 2121 2122 2123
| 参数名       | 类型     | 必填   | 说明       |
| --------- | ------ | ---- | -------- |
| sessionId | string | 是    | 鉴权会话的标识。 |

**返回值:**

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

**错误码:**

J
jidong 已提交
2128 2129 2130 2131 2132
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid sessionId. |
| 12300108 | Session not found. |
2133 2134 2135 2136

**示例:**

  ```js
L
libing23 已提交
2137 2138 2139 2140 2141
  import featureAbility from '@ohos.ability.featureAbility';

  featureAbility.getWant().then((want) => {
      var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
      try {
J
jidong 已提交
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
        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 已提交
2159 2160 2161 2162
      }
  }).catch((err) => {
      console.log("getWant err: "  + JSON.stringify(err));
  });
2163 2164
  ```

L
libing23 已提交
2165
### queryAuthenticatorInfo<sup>9+</sup>
2166

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

J
jidong 已提交
2169
获取指定应用的认证器信息。使用callback异步回调。
2170 2171 2172 2173 2174

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

**参数:**

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

L
libing23 已提交
2180
**错误码:**
2181

J
jidong 已提交
2182 2183 2184 2185 2186
| 错误码ID | 错误信息|
| ------- | -------|
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12300113 | Authenticator service not found. |
2187

L
libing23 已提交
2188
**示例:**
2189

L
libing23 已提交
2190
  ```js
2191
  try {
J
jidong 已提交
2192 2193 2194 2195 2196 2197 2198
    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));
      }
    });
2199
  } catch (err) {
J
jidong 已提交
2200
    console.log("queryAuthenticatorInfo exception: "  + JSON.stringify(err));
2201 2202 2203
  }
  ```

L
libing23 已提交
2204
### queryAuthenticatorInfo<sup>9+</sup>
2205

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

J
jidong 已提交
2208
获取指定应用的认证器信息。使用Promise异步回调。
2209 2210 2211 2212 2213

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

**参数:**

L
libing23 已提交
2214 2215
| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
J
jidong 已提交
2216
| owner | string | 是    | 应用包名。 |
2217

L
libing23 已提交
2218
**返回值:**
2219

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

L
libing23 已提交
2224
**错误码:**
2225

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

**示例:**
2233

L
libing23 已提交
2234
  ```js
2235
  try {
J
jidong 已提交
2236 2237 2238 2239 2240
    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));
    });
2241
  } catch (err) {
J
jidong 已提交
2242
    console.log("queryAuthenticatorInfo exception: "  + JSON.stringify(err));
2243 2244 2245
  }
  ```

L
libing23 已提交
2246
### checkAccountLabels<sup>9+</sup>
2247

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

J
jidong 已提交
2250
检查指定应用帐号是否满足特定的标签集合。使用callback异步回调。该方法依赖目标应用的认证器提供标签检查的能力。
2251 2252 2253 2254 2255

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

**参数:**

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

L
libing23 已提交
2263
**错误码:**
J
jidong 已提交
2264

J
jidong 已提交
2265 2266 2267 2268 2269 2270 2271 2272
| 错误码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 已提交
2273

L
libing23 已提交
2274
**示例:**
J
jidong 已提交
2275

L
libing23 已提交
2276
  ```js
J
jidong 已提交
2277
  let labels = ["student"];
L
libing23 已提交
2278
  try {
J
jidong 已提交
2279 2280 2281 2282 2283 2284 2285
    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 已提交
2286
  } catch (err) {
J
jidong 已提交
2287
    console.log("checkAccountLabels exception: "  + JSON.stringify(err));
2288 2289 2290
  }
  ```

L
libing23 已提交
2291
### checkAccountLabels<sup>9+</sup>
2292

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

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

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

**参数:**

L
libing23 已提交
2301 2302
| 参数名         | 类型                       | 必填  | 说明             |
| -------------- | ------------------------- | ----- | --------------- |
J
jidong 已提交
2303 2304
| name           | string                    | 是    | 应用帐号的名称。  |
| owner          | string                    | 是    | 应用帐号的所有者。|
L
libing23 已提交
2305 2306 2307 2308 2309 2310
| labels         | Array&lt;string&gt;       | 是    | 标签数组。       |

**返回值:**

| 类型                | 说明                              |
| ------------------- | -------------------------------- |
A
Annie_wang 已提交
2311
| Promise&lt;boolean&gt; | Promise对象。返回true表示指定帐号满足特定的标签集合,返回false表示不满足。 |
L
libing23 已提交
2312 2313 2314

**错误码:**

J
jidong 已提交
2315 2316 2317 2318 2319 2320 2321 2322
| 错误码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. |
2323 2324 2325 2326

**示例:**

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

L
libing23 已提交
2339
### deleteCredential<sup>9+</sup>
2340

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

J
jidong 已提交
2343
删除指定应用帐号的特定类型的凭据信息。使用callback异步回调。
2344 2345 2346 2347 2348

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

**参数:**

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

L
libing23 已提交
2355
**错误码:**
2356

J
jidong 已提交
2357 2358 2359 2360 2361 2362
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType. |
| 12300003 | Account not found. |
| 12300102 | Credential not found. |
2363 2364

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

2366 2367
  ```js
  try {
J
jidong 已提交
2368 2369 2370 2371 2372 2373 2374
    appAccountManager.deleteCredential("zhangsan", "PIN_SIX", (err) => {
      if (err) {
        console.log("deleteCredential failed, error: "  + JSON.stringify(err));
      } else {
        console.log("deleteCredential successfully");
      }
    });
2375
  } catch (err) {
J
jidong 已提交
2376
    console.log("deleteCredential exception: "  + JSON.stringify(err));
2377
  }
J
jidong 已提交
2378 2379
  ```

L
libing23 已提交
2380
### deleteCredential<sup>9+</sup>
J
jidong 已提交
2381

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

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

Z
zengyawen 已提交
2386 2387 2388
**系统能力:** SystemCapability.Account.AppAccount

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

L
libing23 已提交
2390 2391
| 参数名         | 类型   | 必填   | 说明            |
| -------------- | ------ | ----- | --------------- |
J
jidong 已提交
2392
| name           | string | 是    | 应用帐号的名称。 |
L
libing23 已提交
2393 2394 2395 2396 2397 2398
| credentialType | string | 是    | 凭据类型。       |

**返回值:**

| 类型                | 说明                              |
| ------------------- | -------------------------------- |
A
Annie_wang 已提交
2399
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
2400 2401 2402

**错误码:**

J
jidong 已提交
2403 2404 2405 2406 2407 2408
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid name or credentialType. |
| 12300003 | Account not found. |
| 12300102 | Credential not found. |
J
jidong 已提交
2409

Z
zengyawen 已提交
2410
**示例:**
J
jidong 已提交
2411

Z
zhangalong 已提交
2412
  ```js
L
libing23 已提交
2413
  try {
J
jidong 已提交
2414 2415 2416 2417 2418
    appAccountManager.deleteCredential("zhangsan", "PIN_SIX").then(() => {
      console.log("deleteCredential successfully");
    }).catch((err) => {
      console.log("deleteCredential failed, error: " + JSON.stringify(err));
    });
L
libing23 已提交
2419
  } catch (err) {
J
jidong 已提交
2420
    console.log("deleteCredential exception: "  + JSON.stringify(err));
L
libing23 已提交
2421
  }
J
jidong 已提交
2422 2423
  ```

L
libing23 已提交
2424
### selectAccountsByOptions<sup>9+</sup>
J
jidong 已提交
2425

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

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

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

Z
zengyawen 已提交
2432
**参数:**
J
jidong 已提交
2433

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

L
libing23 已提交
2439
**错误码:**
J
jidong 已提交
2440

J
jidong 已提交
2441 2442 2443 2444 2445 2446
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid options. |
| 12300010 | Account service busy. |
| 12300114 | Authenticator service exception. |
2447 2448 2449 2450

**示例:**

  ```js
J
jidong 已提交
2451 2452 2453
  let options = {
    allowedOwners: [ "com.example.accountjsdemo" ],
    requiredLabels: [ "student" ]
L
libing23 已提交
2454
  };
2455
  try {
J
jidong 已提交
2456 2457 2458 2459 2460 2461 2462
    appAccountManager.selectAccountsByOptions(options, (err, accountArr) => {
      if (err) {
        console.log("selectAccountsByOptions failed, error: "  + JSON.stringify(err));
      } else {
        console.log("selectAccountsByOptions successfully, accountArr: " + JSON.stringify(accountArr));
      }
    });
2463
  } catch (err) {
J
jidong 已提交
2464
    console.log("selectAccountsByOptions exception: "  + JSON.stringify(err));
2465 2466 2467
  }
  ```

L
libing23 已提交
2468
### selectAccountsByOptions<sup>9+</sup>
2469

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

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

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

**参数:**

L
libing23 已提交
2478 2479
| 参数名         | 类型                       | 必填  | 说明             |
| -------------- | ------------------------- | ----- | --------------- |
J
jidong 已提交
2480
| options        | [SelectAccountsOptions](#selectaccountsoptions9)     | 是    | 选择帐号的选项。  |
2481 2482 2483

**返回值:**

L
libing23 已提交
2484 2485
| 类型                | 说明                              |
| ------------------- | -------------------------------- |
J
jidong 已提交
2486
| Promise&lt;[AppAccountInfo](#appaccountinfo)&gt; | Promise对象,返回调用方可访问的帐号列表。 |
L
libing23 已提交
2487 2488 2489

**错误码:**

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

**示例:**

  ```js
J
jidong 已提交
2500 2501
  let options = {
    allowedOwners: ["com.example.accountjsdemo"]
L
libing23 已提交
2502
  };
2503
  try {
J
jidong 已提交
2504 2505 2506 2507 2508
    appAccountManager.selectAccountsByOptions(options).then((accountArr) => {
      console.log("selectAccountsByOptions successfully, accountArr: " + JSON.stringify(accountArr));
    }).catch((err) => {
      console.log("selectAccountsByOptions failed, error: "  + JSON.stringify(err));
    });
2509
  } catch (err) {
J
jidong 已提交
2510
    console.log("selectAccountsByOptions exception: "  + JSON.stringify(err));
2511 2512 2513
  }
  ```

L
libing23 已提交
2514
### verifyCredential<sup>9+</sup>
J
jidong 已提交
2515

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

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

Z
zengyawen 已提交
2520 2521 2522
**系统能力:** SystemCapability.Account.AppAccount

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

L
libing23 已提交
2524 2525
| 参数名    | 类型                  | 必填  | 说明                     |
| -------- | --------------------- | ----- | ----------------------- |
J
jidong 已提交
2526 2527 2528
| name     | string                | 是    | 应用帐号的名称。          |
| owner    | string                | 是    | 应用帐号所有者的包名。        |
| callback | [AuthCallback](#authcallback9) | 是    | 回调函数,返回验证结果。 |
L
libing23 已提交
2529 2530 2531

**错误码:**

J
jidong 已提交
2532 2533 2534 2535 2536 2537 2538 2539
| 错误码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 已提交
2540

Z
zengyawen 已提交
2541
**示例:**
J
jidong 已提交
2542

Z
zhangalong 已提交
2543
  ```js
L
libing23 已提交
2544
  try {
J
jidong 已提交
2545
      appAccountManager.verifyCredential("zhangsan", "com.example.accountjsdemo", {
L
libing23 已提交
2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
          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 已提交
2557 2558
  ```

L
libing23 已提交
2559
### verifyCredential<sup>9+</sup>
J
jidong 已提交
2560

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

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

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

Z
zengyawen 已提交
2567
**参数:**
J
jidong 已提交
2568

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

L
libing23 已提交
2576
**错误码:**
J
jidong 已提交
2577

J
jidong 已提交
2578 2579 2580 2581 2582 2583 2584 2585
| 错误码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 已提交
2586 2587

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

Z
zhangalong 已提交
2589
  ```js
J
jidong 已提交
2590
  let options = {
L
libing23 已提交
2591 2592 2593 2594
    credentialType: "pin",
    credential: "123456"
  };
  try {
J
jidong 已提交
2595 2596 2597 2598 2599 2600 2601 2602 2603
    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 已提交
2604 2605 2606
  } catch (err) {
    console.log("verifyCredential err: "  + JSON.stringify(err));
  }
J
jidong 已提交
2607 2608
  ```

L
libing23 已提交
2609
### setAuthenticatorProperties<sup>9+</sup>
2610

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

J
jidong 已提交
2613
设置指定应用的认证器属性。使用callback异步回调。
2614 2615 2616 2617 2618

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

**参数:**

L
libing23 已提交
2619 2620 2621
| 参数名    | 类型                  | 必填  | 说明                     |
| -------- | --------------------- | ----- | ----------------------- |
| owner    | string                | 是    | 认证器的所有者。          |
J
jidong 已提交
2622
| callback | [AuthCallback](#authcallback9) | 是    | 回调函数,返回设置属性的结果。 |
L
libing23 已提交
2623 2624 2625

**错误码:**

J
jidong 已提交
2626 2627 2628 2629 2630 2631 2632
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid owner. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
2633 2634 2635 2636 2637

**示例:**

  ```js
  try {
J
jidong 已提交
2638 2639 2640 2641 2642 2643 2644 2645 2646
    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));
      }
    });
2647
  } catch (err) {
J
jidong 已提交
2648
    console.log("setAuthenticatorProperties err: "  + JSON.stringify(err));
2649 2650 2651
  }
  ```

L
libing23 已提交
2652
### setAuthenticatorProperties<sup>9+</sup>
2653

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

L
libing23 已提交
2656
设置认证器属性。使用callback异步回调。
2657 2658 2659 2660 2661

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

**参数:**

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

L
libing23 已提交
2668
**错误码:**
2669

J
jidong 已提交
2670 2671 2672 2673 2674 2675 2676
| 错误码ID | 错误信息 |
| ------- | ------- |
| 12300001 | System service exception. |
| 12300002 | Invalid owner or options. |
| 12300010 | Account service busy. |
| 12300113 | Authenticator service not found. |
| 12300114 | Authenticator service exception. |
2677 2678 2679 2680

**示例:**

  ```js
J
jidong 已提交
2681
  let options = {
L
libing23 已提交
2682 2683
    properties: {"prop1": "value1"}
  };
2684
  try {
J
jidong 已提交
2685 2686 2687 2688 2689 2690 2691 2692 2693
    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));
      }
    });
2694
  } catch (err) {
J
jidong 已提交
2695
    console.log("setAuthenticatorProperties err: "  + JSON.stringify(err));
L
libing23 已提交
2696 2697
  } 

2698 2699
  ```

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

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

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

L
libing23 已提交
2706
> **说明:** 
A
Annie_wang 已提交
2707 2708 2709
> 
>从 API version 7开始支持,从API version 9开始废弃。建议使用[createAccount](#createaccount9)替代。

2710

Z
zengyawen 已提交
2711 2712 2713
**系统能力:** SystemCapability.Account.AppAccount

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

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

Z
zengyawen 已提交
2720
**示例:**
J
jidong 已提交
2721

Z
zhangalong 已提交
2722
  ```js
L
libing23 已提交
2723 2724
  appAccountManager.addAccount("WangWu", (err) => { 
      console.log("addAccount err: " + JSON.stringify(err));
J
jidong 已提交
2725 2726 2727
  });
  ```

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

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

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

A
Annie_wang 已提交
2734 2735
> **说明:** 
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[createAccount](#createaccount9-1)替代。
2736

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

Z
zengyawen 已提交
2739
**参数:**
J
jidong 已提交
2740

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

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

Z
zhangalong 已提交
2749
  ```js
L
libing23 已提交
2750
  appAccountManager.addAccount("LiSi", "token101", (err) => { 
J
jidong 已提交
2751
    console.log("addAccount err: " + JSON.stringify(err));
J
jidong 已提交
2752 2753 2754
  });
  ```

L
libing23 已提交
2755
### addAccount<sup>(deprecated)</sup>
2756

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

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

A
Annie_wang 已提交
2761 2762
> **说明:**  
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[createAccount](#createaccount9-2)替代。
2763 2764 2765 2766 2767

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

**参数:**

L
libing23 已提交
2768 2769
| 参数名       | 类型     | 必填   | 说明                                       |
| --------- | ------ | ---- | ---------------------------------------- |
J
jidong 已提交
2770
| name      | string | 是    | 应用帐号的名称。                            |
Z
zengyawen 已提交
2771
| extraInfo | string | 否    | 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用帐号密码、token等)。 |
L
libing23 已提交
2772 2773 2774 2775 2776

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
A
Annie_wang 已提交
2777
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
2778 2779 2780 2781

**示例:**

  ```js
L
libing23 已提交
2782
  appAccountManager.addAccount("LiSi", "token101").then(()=> { 
J
jidong 已提交
2783
    console.log('addAccount Success');
L
libing23 已提交
2784
  }).catch((err) => {
J
jidong 已提交
2785
    console.log("addAccount err: "  + JSON.stringify(err));
L
libing23 已提交
2786
  });
2787 2788
  ```

L
libing23 已提交
2789
### addAccountImplicitly<sup>(deprecated)</sup>
2790

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

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

A
Annie_wang 已提交
2795
> **说明:**  
L
libing23 已提交
2796
>
A
Annie_wang 已提交
2797
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[createAccountImplicitly](#createaccountimplicitly9)替代。
2798 2799 2800 2801 2802

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

**参数:**

L
libing23 已提交
2803 2804
| 参数名      | 类型                    | 必填   | 说明                      |
| -------- | --------------------- | ---- | ----------------------- |
J
jidong 已提交
2805 2806
| owner    | string                | 是    | 应用帐号所有者的包名。          |
| authType | string                | 是    | 鉴权类型。鉴权类型为自定义。  |
L
libing23 已提交
2807
| options  | {[key: string]: any}  | 是    | 鉴权所需要的可选项。可选项可根据自己需要设置。 |
J
jidong 已提交
2808
| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是    | 认证器回调对象,返回添加结果。         |
2809 2810 2811 2812

**示例:**

  ```js
L
libing23 已提交
2813 2814 2815
  import featureAbility from '@ohos.ability.featureAbility';

  function onResultCallback(code, result) {
J
jidong 已提交
2816 2817
    console.log("resultCode: "  + code);
    console.log("result: "  + JSON.stringify(result));
L
libing23 已提交
2818 2819 2820
  }

  function onRequestRedirectedCallback(request) {
J
jidong 已提交
2821 2822 2823 2824
    let abilityStartSetting = {want: request};
    featureAbility.startAbility(abilityStartSetting, (err)=>{
      console.log("startAbility err: " + JSON.stringify(err));
    });
2825
  }
L
libing23 已提交
2826

J
jidong 已提交
2827 2828 2829
  appAccountManager.addAccountImplicitly("com.example.accountjsdemo", "getSocialData", {}, {
    onResult: onResultCallback,
    onRequestRedirected: onRequestRedirectedCallback
L
libing23 已提交
2830
  });
2831 2832
  ```

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

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

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

A
Annie_wang 已提交
2839
> **说明:** 
2840
>
A
Annie_wang 已提交
2841
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[removeAccount](#removeaccount9)替代。
J
jidong 已提交
2842

Z
zengyawen 已提交
2843 2844 2845
**系统能力:** SystemCapability.Account.AppAccount

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

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

Z
zengyawen 已提交
2852
**示例:**
J
jidong 已提交
2853

Z
zhangalong 已提交
2854
  ```js
L
libing23 已提交
2855 2856 2857
  appAccountManager.deleteAccount("ZhaoLiu", (err) => { 
      console.log("deleteAccount err: " + JSON.stringify(err));
   });
2858 2859
  ```

L
libing23 已提交
2860
### deleteAccount<sup>(deprecated)</sup>
2861

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

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

A
Annie_wang 已提交
2866
> **说明:** 
2867
>
A
Annie_wang 已提交
2868
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[removeAccount](#removeaccount9)替代。
2869 2870 2871 2872 2873

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

**参数:**

L
libing23 已提交
2874 2875
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
J
jidong 已提交
2876
| name | string | 是    | 应用帐号的名称。 |
2877 2878 2879 2880

**返回值:**

| 类型                  | 说明                    |
L
libing23 已提交
2881
| :------------------ | :-------------------- |
A
Annie_wang 已提交
2882
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
2883 2884 2885 2886

**示例:**

  ```js
L
libing23 已提交
2887 2888 2889 2890
  appAccountManager.deleteAccount("ZhaoLiu").then(() => { 
        console.log('deleteAccount Success');
   }).catch((err) => {
      console.log("deleteAccount err: "  + JSON.stringify(err));
2891 2892
  });
  ```
L
libing23 已提交
2893
### disableAppAccess<sup>(deprecated)</sup>
2894

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

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

A
Annie_wang 已提交
2899
> **说明:** 
L
libing23 已提交
2900
>
A
Annie_wang 已提交
2901
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。
2902 2903 2904 2905 2906

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

**参数:**

L
libing23 已提交
2907 2908
| 参数名        | 类型                        | 必填   | 说明                                |
| ---------- | ------------------------- | ---- | --------------------------------- |
J
jidong 已提交
2909
| name       | string                    | 是    | 应用帐号的名称。                  |
L
libing23 已提交
2910
| bundleName | string                    | 是    | 第三方应用的包名。                         |
J
jidong 已提交
2911
| callback   | AsyncCallback&lt;void&gt; | 是    | 回调函数。当禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时,err为null,否则为错误对象。 |
2912 2913 2914 2915

**示例:**

  ```js
J
jidong 已提交
2916
  appAccountManager.disableAppAccess("ZhangSan", "com.example.accountjsdemo", (err) => { 
L
libing23 已提交
2917 2918
      console.log("disableAppAccess err: " + JSON.stringify(err));
  });
J
jidong 已提交
2919 2920
  ```

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

L
libing23 已提交
2923 2924 2925
disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;

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

A
Annie_wang 已提交
2927
> **说明:** 
L
libing23 已提交
2928
>
A
Annie_wang 已提交
2929
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。
J
jidong 已提交
2930

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

Z
zengyawen 已提交
2933
**参数:**
J
jidong 已提交
2934

L
libing23 已提交
2935 2936
| 参数名        | 类型     | 必填   | 说明               |
| ---------- | ------ | ---- | ---------------- |
J
jidong 已提交
2937
| name       | string | 是    | 要禁用访问的第三方应用帐号的名称。 |
L
libing23 已提交
2938
| bundleName | string | 是    | 第三方应用的包名。        |
J
jidong 已提交
2939

2940
**返回值:**
J
jidong 已提交
2941

L
libing23 已提交
2942 2943
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
2944
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
Z
zengyawen 已提交
2945 2946

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

Z
zhangalong 已提交
2948
  ```js
J
jidong 已提交
2949
  appAccountManager.disableAppAccess("ZhangSan", "com.example.accountjsdemo").then(() => { 
L
libing23 已提交
2950 2951 2952 2953
      console.log('disableAppAccess Success');
  }).catch((err) => {
      console.log("disableAppAccess err: "  + JSON.stringify(err));
  });
J
jidong 已提交
2954 2955
  ```

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

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

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

A
Annie_wang 已提交
2962
> **说明:** 
2963
>
A
Annie_wang 已提交
2964
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。
2965

Z
zengyawen 已提交
2966 2967 2968
**系统能力:** SystemCapability.Account.AppAccount

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

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

Z
zengyawen 已提交
2976
**示例:**
J
jidong 已提交
2977

Z
zhangalong 已提交
2978
  ```js
J
jidong 已提交
2979
  appAccountManager.enableAppAccess("ZhangSan", "com.example.accountjsdemo", (err) => { 
L
libing23 已提交
2980 2981
      console.log("enableAppAccess: " + JSON.stringify(err));
   });
J
jidong 已提交
2982 2983
  ```

L
libing23 已提交
2984
### enableAppAccess<sup>(deprecated)</sup>
2985

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

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

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

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

Z
zengyawen 已提交
2996
**参数:**
J
jidong 已提交
2997

L
libing23 已提交
2998 2999
| 参数名        | 类型     | 必填   | 说明        |
| ---------- | ------ | ---- | --------- |
J
jidong 已提交
3000
| name       | string | 是    | 应用帐号的名称。   |
L
libing23 已提交
3001
| bundleName | string | 是    | 第三方应用的包名。 |
J
jidong 已提交
3002

3003
**返回值:**
J
jidong 已提交
3004

L
libing23 已提交
3005 3006
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
3007
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
Z
zengyawen 已提交
3008 3009

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

Z
zhangalong 已提交
3011
  ```js
J
jidong 已提交
3012
  appAccountManager.enableAppAccess("ZhangSan", "com.example.accountjsdemo").then(() => { 
L
libing23 已提交
3013
       console.log('enableAppAccess Success');
J
jidong 已提交
3014
  }).catch((err) => {
L
libing23 已提交
3015
      console.log("enableAppAccess err: "  + JSON.stringify(err));
J
jidong 已提交
3016 3017 3018
  });
  ```

L
libing23 已提交
3019
### checkAppAccountSyncEnable<sup>(deprecated)</sup>
3020

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

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

A
Annie_wang 已提交
3025
> **说明:** 
L
libing23 已提交
3026
>
A
Annie_wang 已提交
3027
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9)替代。
3028

L
libing23 已提交
3029
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
3030 3031 3032 3033 3034

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

**参数:**

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

L
libing23 已提交
3040
**示例:**
3041 3042

  ```js
L
libing23 已提交
3043 3044 3045 3046
  appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { 
      console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err));
      console.log('checkAppAccountSyncEnable result: ' + result);
  });
3047 3048
  ```

L
libing23 已提交
3049
### checkAppAccountSyncEnable<sup>(deprecated)</sup>
3050

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

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

A
Annie_wang 已提交
3055
> **说明:** 
L
libing23 已提交
3056
>
A
Annie_wang 已提交
3057
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9-1)替代。
3058

L
libing23 已提交
3059
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC
3060 3061 3062 3063 3064

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

**参数:**

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

**返回值:**

L
libing23 已提交
3071
| 类型                     | 说明                    |
J
jidong 已提交
3072
| ---------------------- | --------------------- |
A
Annie_wang 已提交
3073
| Promise&lt;boolean&gt; | Promise对象。返回true表示指定应用帐号已开启数据同步功能;返回false表示未开启。 |
3074 3075 3076 3077

**示例:**

  ```js
L
libing23 已提交
3078 3079 3080 3081 3082
  appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { 
      console.log('checkAppAccountSyncEnable, result: ' + data);
  }).catch((err) => {
      console.log("checkAppAccountSyncEnable err: "  + JSON.stringify(err));
  });
3083 3084
  ```

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

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

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

A
Annie_wang 已提交
3091
> **说明:** 
3092
>
A
Annie_wang 已提交
3093
> 从 API version 7开始支持,从API version 9开始废弃,建议使用[setCredential](#setcredential9)替代。
3094

Z
zengyawen 已提交
3095 3096 3097
**系统能力:** SystemCapability.Account.AppAccount

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

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

L
libing23 已提交
3106
**示例:**
J
jidong 已提交
3107

Z
zhangalong 已提交
3108
  ```js
L
libing23 已提交
3109 3110
  appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { 
      console.log("setAccountCredential err: " + JSON.stringify(err));
J
jidong 已提交
3111 3112 3113
  });
  ```

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

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

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

A
Annie_wang 已提交
3120
> **说明:** 
3121
>
A
Annie_wang 已提交
3122
> 从 API version 7开始支持,从API version 9开始废弃,建议使用[setCredential](#setcredential9-1)替代。
3123

Z
zengyawen 已提交
3124 3125 3126
**系统能力:** SystemCapability.Account.AppAccount

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

L
libing23 已提交
3128 3129 3130
| 参数名            | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
| name           | string | 是    | 应用帐号的名称。   |
J
jidong 已提交
3131 3132
| credentialType | string | 是    | 凭据类型。 |
| credential     | string | 是    | 凭据取值。 |
J
jidong 已提交
3133

3134
**返回值:**
J
jidong 已提交
3135

L
libing23 已提交
3136 3137
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
3138
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
J
jidong 已提交
3139

Z
zengyawen 已提交
3140
**示例:**
J
jidong 已提交
3141

Z
zhangalong 已提交
3142
  ```js
L
libing23 已提交
3143 3144
  appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001").then(() => { 
      console.log('setAccountCredential Success');
J
jidong 已提交
3145
  }).catch((err) => {
L
libing23 已提交
3146
      console.log("setAccountCredential err: "  + JSON.stringify(err));
J
jidong 已提交
3147 3148 3149
  });
  ```

L
libing23 已提交
3150
### setAccountExtraInfo<sup>(deprecated)</sup>
3151

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

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

A
Annie_wang 已提交
3156
> **说明:** 
L
libing23 已提交
3157
>
A
Annie_wang 已提交
3158
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setCustomData](#setcustomdata9)替代。
3159 3160 3161 3162 3163 3164


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

**参数:**

L
libing23 已提交
3165 3166
| 参数名       | 类型                        | 必填   | 说明              |
| --------- | ------------------------- | ---- | --------------- |
J
jidong 已提交
3167
| name      | string                    | 是    | 应用帐号的名称。         |
Z
zengyawen 已提交
3168
| extraInfo | string                    | 是    | 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用帐号密码、token等)。       |
J
jidong 已提交
3169
| callback  | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null,否则为错误对象。 |
3170 3171 3172 3173

**示例:**

  ```js
L
libing23 已提交
3174 3175 3176
  appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { 
      console.log("setAccountExtraInfo err: " + JSON.stringify(err));
  });
3177 3178
  ```

L
libing23 已提交
3179
### setAccountExtraInfo<sup>(deprecated)</sup>
3180

L
libing23 已提交
3181 3182 3183 3184
setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;

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

A
Annie_wang 已提交
3185
> **说明:** 
L
libing23 已提交
3186
>
A
Annie_wang 已提交
3187
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setCustomData](#setcustomdata9-1)替代。
3188 3189 3190 3191 3192 3193


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

**参数:**

L
libing23 已提交
3194 3195
| 参数名       | 类型     | 必填   | 说明        |
| --------- | ------ | ---- | --------- |
J
jidong 已提交
3196
| name      | string | 是    | 应用帐号的名称。   |
Z
zengyawen 已提交
3197
| extraInfo | string | 是    | 额外信息(能转换string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用帐号密码、token等)。 |
3198 3199 3200

**返回值:**

L
libing23 已提交
3201 3202
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
3203
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
3204 3205 3206 3207

**示例:**

  ```js
L
libing23 已提交
3208 3209 3210 3211 3212
  appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { 
      console.log('setAccountExtraInfo Success');
  }).catch((err) => {
      console.log("setAccountExtraInfo err: "  + JSON.stringify(err));
  });
3213 3214
  ```

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

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

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

A
Annie_wang 已提交
3221
> **说明:** 
3222
>
A
Annie_wang 已提交
3223
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setDataSyncEnabled](#setdatasyncenabled9)替代。
L
libing23 已提交
3224 3225

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

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

Z
zengyawen 已提交
3229
**参数:**
J
jidong 已提交
3230

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

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

Z
zhangalong 已提交
3239
  ```js
L
libing23 已提交
3240 3241
  appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { 
      console.log("setAppAccountSyncEnable err: " + JSON.stringify(err));
J
jidong 已提交
3242 3243 3244
  });
  ```

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

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

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

A
Annie_wang 已提交
3251
> **说明:** 
3252
>
A
Annie_wang 已提交
3253
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setDataSyncEnabled](#setdatasyncenabled9-1)替代。
L
libing23 已提交
3254 3255

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

Z
zengyawen 已提交
3257 3258 3259
**系统能力:** SystemCapability.Account.AppAccount

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

L
libing23 已提交
3261 3262
| 参数名      | 类型      | 必填   | 说明          |
| -------- | ------- | ---- | ----------- |
J
jidong 已提交
3263 3264
| name     | string  | 是    | 应用帐号的名称。     |
| isEnable | boolean | 是    | 是否开启数据同步。 |
J
jidong 已提交
3265

3266
**返回值:**
J
jidong 已提交
3267

L
libing23 已提交
3268 3269
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
3270
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
J
jidong 已提交
3271

Z
zengyawen 已提交
3272
**示例:**
J
jidong 已提交
3273

Z
zhangalong 已提交
3274
  ```js
L
libing23 已提交
3275 3276
  appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { 
      console.log('setAppAccountSyncEnable Success');
J
jidong 已提交
3277
  }).catch((err) => {
L
libing23 已提交
3278
      console.log("setAppAccountSyncEnable err: "  + JSON.stringify(err));
J
jidong 已提交
3279 3280 3281
  });
  ```

L
libing23 已提交
3282
### setAssociatedData<sup>(deprecated)</sup>
3283

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

J
jidong 已提交
3286
设置指定应用帐号的关联数据。使用callback异步回调。
L
libing23 已提交
3287

A
Annie_wang 已提交
3288
> **说明:** 
L
libing23 已提交
3289
>
A
Annie_wang 已提交
3290
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setCustomData](#setcustomdata9)替代。
3291 3292 3293 3294 3295 3296


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

**参数:**

L
libing23 已提交
3297 3298
| 参数名      | 类型                        | 必填   | 说明                |
| -------- | ------------------------- | ---- | ----------------- |
J
jidong 已提交
3299 3300 3301 3302
| name     | string                    | 是    | 应用帐号的名称。           |
| key      | string                    | 是    | 关联数据的键名。 |
| value    | string                    | 是    | 关联数据的取值。         |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置与此应用帐号关联的数据成功时,err为null,否则为错误对象。 |
3303 3304 3305 3306

**示例:**

  ```js
L
libing23 已提交
3307 3308
  appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { 
      console.log("setAssociatedData err: " + JSON.stringify(err));
3309 3310 3311
  });
  ```

L
libing23 已提交
3312
### setAssociatedData<sup>(deprecated)</sup>
3313

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

J
jidong 已提交
3316
设置指定应用帐号的关联数据。使用Promise异步回调。
L
libing23 已提交
3317

A
Annie_wang 已提交
3318
> **说明:** 
L
libing23 已提交
3319
>
A
Annie_wang 已提交
3320
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[setCustomData](#setcustomdata9-1)替代。
3321 3322 3323 3324 3325 3326


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

**参数:**

L
libing23 已提交
3327 3328
| 参数名   | 类型     | 必填   | 说明                |
| ----- | ------ | ---- | ----------------- |
J
jidong 已提交
3329 3330 3331
| name  | string | 是    | 应用帐号的名称。           |
| key      | string | 是    | 关联数据的键名。 |
| value    | string | 是    | 关联数据的取值。 |
3332 3333 3334

**返回值:**

L
libing23 已提交
3335 3336
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
A
Annie_wang 已提交
3337
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
3338 3339 3340 3341

**示例:**

  ```js
L
libing23 已提交
3342 3343
  appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { 
      console.log('setAssociatedData Success');
3344
  }).catch((err) => {
L
libing23 已提交
3345
      console.log("setAssociatedData err: "  + JSON.stringify(err));
3346 3347 3348
  });
  ```

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

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

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

A
Annie_wang 已提交
3355
> **说明:** 
3356
>
A
Annie_wang 已提交
3357
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getAllAccounts](#getallaccounts9)替代。
L
libing23 已提交
3358

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

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

Z
zengyawen 已提交
3363
**参数:**
J
jidong 已提交
3364

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

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

Z
zhangalong 已提交
3371
  ```js
L
libing23 已提交
3372 3373 3374
  appAccountManager.getAllAccessibleAccounts((err, data)=>{
  	console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err));
  	console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data));
J
jidong 已提交
3375 3376 3377
  });
  ```

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

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

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

A
Annie_wang 已提交
3384
> **说明:** 
3385
>
A
Annie_wang 已提交
3386
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getAllAccounts](#getallaccounts9-1)替代。
Z
zengyawen 已提交
3387

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

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

3392
**返回值:**
J
jidong 已提交
3393

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

Z
zengyawen 已提交
3398
**示例:**
J
jidong 已提交
3399

Z
zhangalong 已提交
3400
  ```js
L
libing23 已提交
3401 3402
  appAccountManager.getAllAccessibleAccounts().then((data) => { 
       console.log('getAllAccessibleAccounts: ' + data);
3403
  }).catch((err) => {
L
libing23 已提交
3404
      console.log("getAllAccessibleAccounts err: "  + JSON.stringify(err));
3405 3406 3407
  });
  ```

L
libing23 已提交
3408
### getAllAccounts<sup>(deprecated)</sup>
3409

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

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

A
Annie_wang 已提交
3414
> **说明:** 
L
libing23 已提交
3415
>
A
Annie_wang 已提交
3416
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getAccountsByOwner](#getaccountsbyowner9)替代。
L
libing23 已提交
3417

J
jidong 已提交
3418
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS。
3419 3420 3421 3422 3423

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

**参数:**

L
libing23 已提交
3424 3425
| 参数名      | 类型                                       | 必填   | 说明        |
| -------- | ---------------------------------------- | ---- | --------- |
J
jidong 已提交
3426
| owner    | string                                   | 是    | 应用帐号所有者的包名。    |
L
libing23 已提交
3427
| callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 应用帐号信息列表。 |
3428 3429 3430 3431

**示例:**

  ```js
L
libing23 已提交
3432 3433 3434 3435 3436
  const selfBundle = "com.example.actsgetallaaccounts";
  appAccountManager.getAllAccounts(selfBundle, (err, data)=>{
  	console.debug("getAllAccounts err:" + JSON.stringify(err));
  	console.debug("getAllAccounts data:" + JSON.stringify(data));
  });
3437 3438
  ```

L
libing23 已提交
3439
### getAllAccounts<sup>(deprecated)</sup>
3440

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

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

A
Annie_wang 已提交
3445
> **说明:** 
L
libing23 已提交
3446
>
A
Annie_wang 已提交
3447
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getAccountsByOwner](#getaccountsbyowner9-1)替代。
3448

L
libing23 已提交
3449
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS,仅系统应用可用。
3450 3451 3452 3453 3454

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

**参数:**

L
libing23 已提交
3455 3456 3457
| 参数名   | 类型     | 必填   | 说明     |
| ----- | ------ | ---- | ------ |
| owner | string | 是    | 应用包名称。 |
3458 3459 3460

**返回值:**

L
libing23 已提交
3461 3462
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
J
jidong 已提交
3463
| Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise对象,返回指定应用全部帐号信息对象。 |
3464 3465 3466 3467

**示例:**

  ```js
L
libing23 已提交
3468 3469 3470 3471 3472 3473
  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 已提交
3474 3475
  ```

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

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

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

A
Annie_wang 已提交
3482
> **说明:** 
3483
>
A
Annie_wang 已提交
3484
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCredential](#getcredential9)替代。
3485

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

Z
zengyawen 已提交
3488
**参数:**
J
jidong 已提交
3489

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

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

Z
zhangalong 已提交
3498
  ```js
L
libing23 已提交
3499 3500 3501
  appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { 
      console.log("getAccountCredential err: " + JSON.stringify(err));
      console.log('getAccountCredential result: ' + result);
J
jidong 已提交
3502 3503 3504
  });
  ```

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

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

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

A
Annie_wang 已提交
3511
> **说明:** 
3512
>
A
Annie_wang 已提交
3513
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCredential](#getcredential9-1)替代。
3514

Z
zengyawen 已提交
3515 3516 3517
**系统能力:** SystemCapability.Account.AppAccount

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

L
libing23 已提交
3519 3520
| 参数名            | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
J
jidong 已提交
3521 3522
| name           | string | 是    | 应用帐号的名称。    |
| credentialType | string | 是    | 凭据类型。 |
J
jidong 已提交
3523

3524
**返回值:**
J
jidong 已提交
3525

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

Z
zengyawen 已提交
3530
**示例:**
J
jidong 已提交
3531

Z
zhangalong 已提交
3532
  ```js
L
libing23 已提交
3533 3534
  appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { 
      console.log('getAccountCredential, result: ' + data);
J
jidong 已提交
3535
  }).catch((err) => {
L
libing23 已提交
3536
      console.log("getAccountCredential err: "  + JSON.stringify(err));
J
jidong 已提交
3537 3538 3539
  });
  ```

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

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

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

A
Annie_wang 已提交
3546
> **说明:** 
L
libing23 已提交
3547
>
A
Annie_wang 已提交
3548
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCustomData](#getcustomdata9)替代。
J
jidong 已提交
3549 3550 3551 3552 3553

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

**参数:**

L
libing23 已提交
3554 3555
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
J
jidong 已提交
3556 3557
| name     | string                      | 是    | 应用帐号的名称。         |
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取此应用帐号的额外信息成功时,err为null,data返回此应用帐号的额外信息对象;否则为错误对象。 |
J
jidong 已提交
3558 3559 3560 3561

**示例:**

  ```js
L
libing23 已提交
3562 3563 3564 3565
  appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { 
      console.log("getAccountExtraInfo err: " + JSON.stringify(err));
      console.log('getAccountExtraInfo result: ' + result);
  });
J
jidong 已提交
3566 3567
  ```

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

L
libing23 已提交
3570
getAccountExtraInfo(name: string): Promise&lt;string&gt;
J
jidong 已提交
3571

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

A
Annie_wang 已提交
3574
> **说明:** 
L
libing23 已提交
3575
>
A
Annie_wang 已提交
3576
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCustomData](#getcustomdata9-1)替代。
J
jidong 已提交
3577 3578 3579 3580 3581

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

**参数:**

L
libing23 已提交
3582 3583
| 参数名  | 类型     | 必填   | 说明      |
| ---- | ------ | ---- | ------- |
J
jidong 已提交
3584
| name | string | 是    | 应用帐号的名称。 |
J
jidong 已提交
3585

3586
**返回值:**
J
jidong 已提交
3587

L
libing23 已提交
3588 3589
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
J
jidong 已提交
3590
| Promise&lt;string&gt; | Promise对象,返回此应用程序帐号的额外信息对象。 |
J
jidong 已提交
3591 3592 3593 3594

**示例:**

  ```js
L
libing23 已提交
3595 3596 3597 3598 3599
  appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { 
      console.log('getAccountExtraInfo, result: ' + data);
  }).catch((err) => {
      console.log("getAccountExtraInfo err: "  + JSON.stringify(err));
  });
J
jidong 已提交
3600 3601
  ```

L
libing23 已提交
3602 3603 3604
### getAssociatedData<sup>(deprecated)</sup>

getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void
J
jidong 已提交
3605

J
jidong 已提交
3606
根据指定键名获取特定应用帐号的关联数据。使用callback异步回调。
J
jidong 已提交
3607

A
Annie_wang 已提交
3608
> **说明:** 
L
libing23 已提交
3609
>
A
Annie_wang 已提交
3610
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCustomData](#getcustomdata9)替代。
J
jidong 已提交
3611 3612 3613 3614 3615

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

**参数:**

L
libing23 已提交
3616 3617
| 参数名      | 类型                          | 必填   | 说明                |
| -------- | --------------------------- | ---- | ----------------- |
J
jidong 已提交
3618 3619 3620
| name     | string                      | 是    | 应用帐号的名称。           |
| key      | string                      | 是    | 关联数据的键名。         |
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取成功时,err为null,data为关联数据的取值;否则为错误对象。 |
J
jidong 已提交
3621 3622 3623 3624

**示例:**

  ```js
L
libing23 已提交
3625 3626 3627 3628
  appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { 
      console.log("getAssociatedData err: " + JSON.stringify(err));
      console.log('getAssociatedData result: ' + result);
  });
J
jidong 已提交
3629 3630
  ```

L
libing23 已提交
3631 3632 3633
### getAssociatedData<sup>(deprecated)</sup>

getAssociatedData(name: string, key: string): Promise&lt;string&gt;
J
jidong 已提交
3634

L
libing23 已提交
3635
获取与此应用程序帐号关联的数据。使用Promise异步回调。
J
jidong 已提交
3636

A
Annie_wang 已提交
3637
> **说明:** 
L
libing23 已提交
3638
>
A
Annie_wang 已提交
3639
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[getCustomData](#getcustomdata9-1)替代。
J
jidong 已提交
3640 3641 3642 3643 3644

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

**参数:**

L
libing23 已提交
3645 3646
| 参数名  | 类型     | 必填   | 说明        |
| ---- | ------ | ---- | --------- |
J
jidong 已提交
3647 3648
| name | string | 是    | 应用帐号的名称。   |
| key  | string | 是    | 关联数据的键名。 |
J
jidong 已提交
3649

3650
**返回值:**
J
jidong 已提交
3651

L
libing23 已提交
3652 3653
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
J
jidong 已提交
3654
| Promise&lt;string&gt; | Promise对象,返回关联数据的取值。 |
J
jidong 已提交
3655 3656 3657 3658

**示例:**

  ```js
L
libing23 已提交
3659 3660 3661 3662 3663
  appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { 
       console.log('getAssociatedData: ' + data);
  }).catch((err) => {
      console.log("getAssociatedData err: "  + JSON.stringify(err));
  });
J
jidong 已提交
3664 3665
  ```

L
libing23 已提交
3666
### on('change')<sup>(deprecated)</sup>
J
jidong 已提交
3667

L
libing23 已提交
3668 3669
on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void

J
jidong 已提交
3670
订阅指定应用的帐号信息变更事件。
J
jidong 已提交
3671

A
Annie_wang 已提交
3672
> **说明:** 
L
libing23 已提交
3673
>
A
Annie_wang 已提交
3674
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[on('accountChange')](#onaccountchange9)替代。
J
jidong 已提交
3675 3676 3677 3678 3679

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

**参数:**

L
libing23 已提交
3680 3681
| 参数名      | 类型                                       | 必填   | 说明                             |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
J
jidong 已提交
3682 3683 3684
| type     | 'change'                                 | 是    | 事件回调类型,支持的事件为'change',当帐号所有者更新帐号信息时,触发该事件。 |
| owners   | Array&lt;string&gt;                      | 是    | 应用帐号所有者的包名列表。                      |
| callback | Callback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是    | 回调函数,返回信息发生变更的应用帐号列表。           |
J
jidong 已提交
3685 3686 3687 3688

**示例:**

  ```js
L
libing23 已提交
3689 3690 3691 3692 3693 3694 3695 3696
  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));
3697
  }
J
jidong 已提交
3698 3699
  ```

L
libing23 已提交
3700
### off('change')<sup>(deprecated)</sup>
J
jidong 已提交
3701

L
libing23 已提交
3702 3703
off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void

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

A
Annie_wang 已提交
3706
> **说明:** 
L
libing23 已提交
3707
>
A
Annie_wang 已提交
3708
> 从 API version 7开始支持,从API version 9开始废弃。建议使用[off('accountChange')](#offaccountchange9)替代。
J
jidong 已提交
3709 3710 3711 3712 3713

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

**参数:**

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

**示例:**

  ```js
L
libing23 已提交
3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732
  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));
3733
  }
J
jidong 已提交
3734 3735
  ```

L
libing23 已提交
3736
### authenticate<sup>(deprecated)</sup>
J
jidong 已提交
3737

L
libing23 已提交
3738 3739
authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void

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

A
Annie_wang 已提交
3742
> **说明:** 
L
libing23 已提交
3743
>
A
Annie_wang 已提交
3744
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[auth](#auth9)替代。
J
jidong 已提交
3745 3746 3747 3748 3749

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

**参数:**

L
libing23 已提交
3750 3751
| 参数名      | 类型                    | 必填   | 说明              |
| -------- | --------------------- | ---- | --------------- |
J
jidong 已提交
3752 3753
| name     | string                | 是    | 应用帐号的名称。     |
| owner    | string                | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
3754 3755
| authType | string                | 是    | 鉴权类型。           |
| options  | {[key: string]: any}  | 是    | 鉴权所需的可选项。       |
J
jidong 已提交
3756
| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是    | 回调对象,返回鉴权结果。 |
J
jidong 已提交
3757 3758 3759 3760

**示例:**

  ```js
L
libing23 已提交
3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771
  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));
3772 3773
      });
  }
L
libing23 已提交
3774

J
jidong 已提交
3775
  appAccountManager.authenticate("LiSi", "com.example.accountjsdemo", "getSocialData", {}, {
L
libing23 已提交
3776 3777 3778
    onResult: onResultCallback,
    onRequestRedirected: onRequestRedirectedCallback
  });
J
jidong 已提交
3779 3780
  ```

L
libing23 已提交
3781
### getOAuthToken<sup>(deprecated)</sup>
J
jidong 已提交
3782

L
libing23 已提交
3783
getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback&lt;string&gt;): void
J
jidong 已提交
3784

J
jidong 已提交
3785
获取指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。
L
libing23 已提交
3786

A
Annie_wang 已提交
3787
> **说明:** 
L
libing23 已提交
3788
>
A
Annie_wang 已提交
3789
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getAuthToken](#getauthtoken9)替代。
J
jidong 已提交
3790 3791 3792 3793 3794

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

**参数:**

L
libing23 已提交
3795 3796 3797
| 参数名      | 类型                          | 必填   | 说明          |
| -------- | --------------------------- | ---- | ----------- |
| name     | string                      | 是    | 应用帐号的名称。    |
J
jidong 已提交
3798
| owner    | string                      | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
3799
| authType | string                      | 是    | 鉴权类型。       |
J
jidong 已提交
3800
| callback | AsyncCallback&lt;string&gt; | 是    | 回调函数。当获取成功时,err为null,data为授权令牌值;否则为错误对象。   |
J
jidong 已提交
3801 3802 3803 3804

**示例:**

  ```js
J
jidong 已提交
3805
  appAccountManager.getOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", (err, data) => {
L
libing23 已提交
3806 3807 3808
       console.log('getOAuthToken err: ' + JSON.stringify(err));
       console.log('getOAuthToken token: ' + data);
  });
J
jidong 已提交
3809 3810
  ```

L
libing23 已提交
3811
### getOAuthToken<sup>(deprecated)</sup>
J
jidong 已提交
3812

L
libing23 已提交
3813 3814
getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&gt;

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

A
Annie_wang 已提交
3817
> **说明:** 
L
libing23 已提交
3818
>
A
Annie_wang 已提交
3819
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getAuthToken](#getauthtoken9-1)替代。
J
jidong 已提交
3820 3821 3822 3823 3824

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

**参数:**

L
libing23 已提交
3825 3826 3827
| 参数名      | 类型     | 必填   | 说明          |
| -------- | ------ | ---- | ----------- |
| name     | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
3828
| owner    | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
3829 3830 3831 3832 3833 3834
| authType | string | 是    | 鉴权类型。       |

**返回值:**

| 类型                    | 说明                    |
| --------------------- | --------------------- |
J
jidong 已提交
3835
| Promise&lt;string&gt; | Promise对象,返回授权令牌。 |
L
libing23 已提交
3836 3837 3838 3839

**示例:**

  ```js
J
jidong 已提交
3840
  appAccountManager.getOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData").then((data) => {
L
libing23 已提交
3841 3842 3843 3844 3845 3846 3847 3848 3849 3850
       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 已提交
3851
为指定应用帐号设置特定鉴权类型的授权令牌。使用callback异步回调。
L
libing23 已提交
3852

A
Annie_wang 已提交
3853
> **说明:** 
L
libing23 已提交
3854
>
A
Annie_wang 已提交
3855
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[setAuthToken](#setauthtoken9)替代。
L
libing23 已提交
3856 3857 3858 3859 3860 3861 3862 3863 3864

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

**参数:**

| 参数名      | 类型                        | 必填   | 说明       |
| -------- | ------------------------- | ---- | -------- |
| name     | string                    | 是    | 应用帐号的名称。 |
| authType | string                    | 是    | 鉴权类型。    |
J
jidong 已提交
3865 3866
| token    | string                    | 是    | 授权令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当设置成功时,err为null;否则为错误对象。 |
L
libing23 已提交
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879

**示例:**

  ```js
  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 已提交
3880
为指定应用帐号设置特定鉴权类型的授权令牌。使用Promise异步回调。
L
libing23 已提交
3881

A
Annie_wang 已提交
3882
> **说明:** 
L
libing23 已提交
3883
>
A
Annie_wang 已提交
3884
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[setAuthToken](#setauthtoken9-1)替代。
L
libing23 已提交
3885 3886 3887 3888 3889 3890 3891 3892 3893

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

**参数:**

| 参数名      | 类型     | 必填   | 说明       |
| -------- | ------ | ---- | -------- |
| name     | string | 是    | 应用帐号的名称。 |
| authType | string | 是    | 鉴权类型。    |
J
jidong 已提交
3894
| token    | string | 是    | 授权令牌。 |
L
libing23 已提交
3895 3896 3897 3898 3899

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
A
Annie_wang 已提交
3900
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915

**示例:**

  ```js
  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 已提交
3916
删除指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。
L
libing23 已提交
3917

A
Annie_wang 已提交
3918
> **说明:** 
L
libing23 已提交
3919
>
A
Annie_wang 已提交
3920
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[deleteAuthToken](#deleteauthtoken9)替代。
L
libing23 已提交
3921 3922 3923 3924 3925 3926 3927 3928

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

**参数:**

| 参数名      | 类型                        | 必填   | 说明           |
| -------- | ------------------------- | ---- | ------------ |
| name     | string                    | 是    | 应用帐号的名称。     |
J
jidong 已提交
3929
| owner    | string                    | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
3930
| authType | string                    | 是    | 鉴权类型。        |
J
jidong 已提交
3931 3932
| token    | string                    | 是    | 授权令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。当删除成功时,err为null;否则为错误对象。     |
L
libing23 已提交
3933 3934 3935 3936

**示例:**

  ```js
J
jidong 已提交
3937
  appAccountManager.deleteOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx", (err) => {
L
libing23 已提交
3938 3939 3940 3941 3942 3943 3944 3945
       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 已提交
3946
删除指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。
L
libing23 已提交
3947

A
Annie_wang 已提交
3948
> **说明:** 
L
libing23 已提交
3949
>
A
Annie_wang 已提交
3950
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[deleteAuthToken](#deleteauthtoken9-1)替代。
L
libing23 已提交
3951 3952 3953 3954 3955 3956 3957 3958

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

**参数:**

| 参数名      | 类型     | 必填   | 说明           |
| -------- | ------ | ---- | ------------ |
| name     | string | 是    | 应用帐号的名称。     |
J
jidong 已提交
3959
| owner    | string | 是    | 应用帐号所有者的包名。  |
L
libing23 已提交
3960
| authType | string | 是    | 鉴权类型。        |
J
jidong 已提交
3961
| token    | string | 是    | 授权令牌。 |
L
libing23 已提交
3962 3963 3964 3965 3966

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
A
Annie_wang 已提交
3967
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
3968 3969 3970 3971

**示例:**

  ```js
J
jidong 已提交
3972
  appAccountManager.deleteOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx").then(() => {
L
libing23 已提交
3973 3974 3975 3976 3977 3978 3979 3980 3981 3982
       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 已提交
3983
设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。
L
libing23 已提交
3984

A
Annie_wang 已提交
3985
> **说明:** 
L
libing23 已提交
3986
>
A
Annie_wang 已提交
3987
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[setAuthTokenVisibility](#setauthtokenvisibility9)替代。
L
libing23 已提交
3988 3989 3990 3991 3992 3993 3994 3995 3996 3997

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

**参数:**

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

**示例:**

  ```js
J
jidong 已提交
4004
  appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true, (err) => {
L
libing23 已提交
4005 4006 4007 4008 4009 4010 4011 4012
       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 已提交
4013
设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。
L
libing23 已提交
4014

A
Annie_wang 已提交
4015
> **说明:** 
L
libing23 已提交
4016
>
A
Annie_wang 已提交
4017
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[setAuthTokenVisibility](#setauthtokenvisibility9-1)替代。
L
libing23 已提交
4018 4019 4020 4021 4022 4023 4024 4025 4026 4027

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

**参数:**

| 参数名        | 类型      | 必填   | 说明           |
| ---------- | ------- | ---- | ------------ |
| name       | string  | 是    | 应用帐号的名称。     |
| authType   | string  | 是    | 鉴权类型。        |
| bundleName | string  | 是    | 被设置可见性的应用包名。 |
J
jidong 已提交
4028
| isVisible  | boolean | 是    | 是否可见。true表示可见,false表示不可见。        |
L
libing23 已提交
4029 4030 4031 4032 4033

**返回值:**

| 类型                  | 说明                    |
| ------------------- | --------------------- |
A
Annie_wang 已提交
4034
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
L
libing23 已提交
4035 4036 4037 4038

**示例:**

  ```js
J
jidong 已提交
4039
  appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true).then(() => {
L
libing23 已提交
4040 4041 4042 4043 4044 4045 4046 4047 4048 4049
      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 已提交
4050
检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。
L
libing23 已提交
4051

A
Annie_wang 已提交
4052
> **说明:** 
L
libing23 已提交
4053
>
A
Annie_wang 已提交
4054
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9)替代。
L
libing23 已提交
4055 4056 4057 4058 4059 4060 4061 4062 4063 4064

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

**参数:**

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

**示例:**

  ```js
J
jidong 已提交
4070
  appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", (err, data) => {
L
libing23 已提交
4071 4072 4073 4074 4075 4076 4077 4078 4079
      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 已提交
4080
检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。
L
libing23 已提交
4081

A
Annie_wang 已提交
4082
> **说明:** 
L
libing23 已提交
4083
>
A
Annie_wang 已提交
4084
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9-1)替代。
L
libing23 已提交
4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099

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

**参数:**

| 参数名        | 类型     | 必填   | 说明            |
| ---------- | ------ | ---- | ------------- |
| name       | string | 是    | 应用帐号的名称。      |
| authType   | string | 是    | 鉴权类型。         |
| bundleName | string | 是    | 用于检查可见性的应用包名。 |

**返回值:**

| 类型                     | 说明                    |
| ---------------------- | --------------------- |
A
Annie_wang 已提交
4100
| Promise&lt;boolean&gt; | Promise对象。返回true表示指定鉴权类型的OAuth令牌对特定应用的可见,返回false表示不可见。 |
L
libing23 已提交
4101 4102 4103 4104

**示例:**

  ```js
J
jidong 已提交
4105
  appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo").then((data) => {
L
libing23 已提交
4106 4107 4108 4109 4110 4111 4112 4113 4114 4115
      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 已提交
4116
获取指定帐号对调用方可见的所有授权令牌。使用callback异步回调。
L
libing23 已提交
4117

A
Annie_wang 已提交
4118
> **说明:** 
L
libing23 已提交
4119
>
A
Annie_wang 已提交
4120
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getAllAuthTokens](#getallauthtokens9)替代。
L
libing23 已提交
4121 4122 4123 4124 4125 4126 4127 4128

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

**参数:**

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

**示例:** 

  ```js
J
jidong 已提交
4135
  appAccountManager.getAllOAuthTokens("LiSi", "com.example.accountjsdemo", (err, data) => {
L
libing23 已提交
4136 4137 4138 4139 4140 4141 4142 4143 4144
      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 已提交
4145
获取指定帐号对调用方可见的所有授权令牌。使用Promise异步回调。
L
libing23 已提交
4146

A
Annie_wang 已提交
4147
> **说明:** 
L
libing23 已提交
4148
>
A
Annie_wang 已提交
4149
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getAllAuthTokens](#getallauthtokens9-1)替代。
L
libing23 已提交
4150 4151 4152 4153 4154 4155 4156 4157

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

**参数:**

| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
| name  | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
4158
| owner | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
4159 4160 4161 4162 4163

**返回值:**

| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
J
jidong 已提交
4164
| Promise&lt;Array&lt; [OAuthTokenInfo](#oauthtokeninfodeprecated)&gt;&gt; | Promise对象,返回授权令牌数组。 |
L
libing23 已提交
4165 4166

**示例:**
J
jidong 已提交
4167 4168

  ```js
J
jidong 已提交
4169
  appAccountManager.getAllOAuthTokens("LiSi", "com.example.accountjsdemo").then((data) => {
L
libing23 已提交
4170 4171 4172 4173 4174 4175 4176 4177 4178 4179
      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 已提交
4180
获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过setOAuthTokenVisibility(#setoauthtokenvisibilitydeprecated)来设置)。使用callback异步回调。
L
libing23 已提交
4181

A
Annie_wang 已提交
4182
> **说明:** 
L
libing23 已提交
4183
>
A
Annie_wang 已提交
4184
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getAuthList](#getauthlist9)替代。
L
libing23 已提交
4185 4186 4187 4188 4189 4190 4191 4192

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

**参数:**

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

**示例:**

  ```js
J
jidong 已提交
4199 4200 4201
  appAccountManager.getOAuthList("com.example.accountjsdemo", "getSocialData", (err, data) => {
    console.log('getOAuthList err: ' + JSON.stringify(err));
    console.log('getOAuthList data: ' + JSON.stringify(data));
L
libing23 已提交
4202 4203 4204 4205 4206 4207 4208
  });
  ```

### getOAuthList<sup>(deprecated)</sup>

getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;

J
jidong 已提交
4209
获取指定应用帐号的特定鉴权类型的授权列表,即被授权的包名数组(令牌的授权列表通过setOAuthTokenVisibility(#setoauthtokenvisibilitydeprecated)来设置)。使用Promise异步回调。
L
libing23 已提交
4210

A
Annie_wang 已提交
4211
> **说明:** 
L
libing23 已提交
4212
>
A
Annie_wang 已提交
4213
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getAuthList](#getauthlist9-1)替代。
L
libing23 已提交
4214 4215 4216 4217 4218 4219 4220 4221

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

**参数:**

| 参数名      | 类型     | 必填   | 说明                      |
| -------- | ------ | ---- | ----------------------- |
| name     | string | 是    | 应用帐号的名称。                |
J
jidong 已提交
4222
| authType | string | 是    | 鉴权类型。 |
L
libing23 已提交
4223 4224 4225 4226 4227

**返回值:**

| 类型                                 | 说明                    |
| ---------------------------------- | --------------------- |
J
jidong 已提交
4228
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象,返回被授权的包名数组。 |
L
libing23 已提交
4229 4230 4231 4232

**示例:**

  ```js
J
jidong 已提交
4233
  appAccountManager.getOAuthList("com.example.accountjsdemo", "getSocialData").then((data) => {
L
libing23 已提交
4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245
       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异步回调。

A
Annie_wang 已提交
4246
> **说明:** 
L
libing23 已提交
4247
>
A
Annie_wang 已提交
4248
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getAuthCallback](#getauthcallback9)替代。
L
libing23 已提交
4249 4250 4251 4252 4253 4254 4255 4256

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

**参数:**

| 参数名       | 类型                                       | 必填   | 说明       |
| --------- | ---------------------------------------- | ---- | -------- |
| sessionId | string                                   | 是    | 鉴权会话的标识。 |
J
jidong 已提交
4257
| callback  | AsyncCallback&lt;[AuthenticatorCallback](#authenticatorcallbackdeprecated)&gt; | 是    | 回调函数。当获取鉴权会话的认证器回调函数成功时,err为null,data为认证器回调函数;否则为错误对象。 |
L
libing23 已提交
4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270

**示例:**

  ```js
  import featureAbility from '@ohos.ability.featureAbility';
  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 已提交
4271
                      [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
L
libing23 已提交
4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284
                      [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异步回调。

A
Annie_wang 已提交
4285
> **说明:** 
L
libing23 已提交
4286
>
A
Annie_wang 已提交
4287
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[getAuthCallback](#getauthcallback9-1)替代。
L
libing23 已提交
4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300

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

**参数:**

| 参数名       | 类型     | 必填   | 说明       |
| --------- | ------ | ---- | -------- |
| sessionId | string | 是    | 鉴权会话的标识。 |

**返回值:**

| 类型                                   | 说明                    |
| ------------------------------------ | --------------------- |
J
jidong 已提交
4301
| Promise&lt;[AuthenticatorCallback](#authenticatorcallbackdeprecated)&gt; | Promise对象,返回鉴权会话的认证器回调对象。 |
L
libing23 已提交
4302 4303 4304 4305 4306 4307 4308 4309 4310 4311

**示例:**

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

  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 已提交
4312
                        [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
L
libing23 已提交
4313 4314 4315 4316 4317
                        [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));
4318
      });
L
libing23 已提交
4319 4320 4321
  }).catch((err) => {
      console.log("getWant err: "  + JSON.stringify(err));
  });
J
jidong 已提交
4322 4323
  ```

L
libing23 已提交
4324
### getAuthenticatorInfo<sup>(deprecated)</sup>
J
jidong 已提交
4325

L
libing23 已提交
4326 4327
getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void

J
jidong 已提交
4328
获取指定应用的认证器信息。使用callback异步回调。
J
jidong 已提交
4329

A
Annie_wang 已提交
4330
> **说明:** 
L
libing23 已提交
4331
>
A
Annie_wang 已提交
4332
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9)替代。
J
jidong 已提交
4333 4334 4335 4336 4337

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

**参数:**

L
libing23 已提交
4338 4339
| 参数名      | 类型                                     | 必填   | 说明          |
| -------- | -------------------------------------- | ---- | ----------- |
J
jidong 已提交
4340 4341
| owner    | string                                 | 是    | 应用帐号所有者的包名。 |
| callback | AsyncCallback&lt;[AuthenticatorInfo](#authenticatorinfo8)&gt; | 是    | 回调函数。当获取成功时,err为null,data为认证器信息对象;否则为错误对象。    |
J
jidong 已提交
4342 4343 4344 4345

**示例:**

  ```js
J
jidong 已提交
4346
  appAccountManager.getAuthenticatorInfo("com.example.accountjsdemo", (err, data) => {
L
libing23 已提交
4347 4348 4349 4350 4351 4352 4353 4354 4355
      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 已提交
4356
获取指定应用的认证器信息。使用Promise异步回调。
L
libing23 已提交
4357

A
Annie_wang 已提交
4358
> **说明:** 
L
libing23 已提交
4359
>
A
Annie_wang 已提交
4360
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9-1)替代。
L
libing23 已提交
4361 4362 4363 4364 4365 4366 4367

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

**参数:**

| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
J
jidong 已提交
4368
| owner | string | 是    | 应用帐号所有者的包名。 |
L
libing23 已提交
4369 4370 4371 4372 4373

**返回值:**

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

**示例:**
4377

L
libing23 已提交
4378
  ```js
J
jidong 已提交
4379
  appAccountManager.getAuthenticatorInfo("com.example.accountjsdemo").then((data) => { 
L
libing23 已提交
4380 4381 4382 4383
       console.log('getAuthenticatorInfo: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getAuthenticatorInfo err: "  + JSON.stringify(err));
  });
J
jidong 已提交
4384 4385
  ```

Z
zhaoyuan17 已提交
4386 4387
## AppAccountInfo

J
jidong 已提交
4388 4389
表示应用帐号信息。

Z
zengyawen 已提交
4390 4391
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4392
| 名称   | 类型     | 必填   | 说明          |
H
HelloCrease 已提交
4393
| ----- | ------ | ---- | ----------- |
J
jidong 已提交
4394
| owner | string | 是    | 应用帐号所有者的包名。 |
H
HelloCrease 已提交
4395
| name  | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
4396

4397 4398 4399 4400 4401 4402
## AuthTokenInfo<sup>9+</sup>

表示Auth令牌信息。

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

4403
| 名称               | 类型            | 必填  | 说明              |
4404 4405 4406 4407 4408 4409
| -------------------- | -------------- | ----- | ---------------- |
| authType<sup>9+</sup>             | string         | 是    | 令牌的鉴权类型。   |
| token<sup>9+</sup>                | string         | 是    | 令牌的取值。       |
| account<sup>9+</sup> | [AppAccountInfo](#appaccountinfo) | 否    | 令牌所属的帐号信息。|

## OAuthTokenInfo<sup>(deprecated)</sup>
J
jidong 已提交
4410 4411 4412

表示OAuth令牌信息。

A
Annie_wang 已提交
4413
> **说明:** 
4414
>
A
Annie_wang 已提交
4415
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[AuthTokenInfo](#authtokeninfo9)替代。
4416

Z
zengyawen 已提交
4417 4418
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4419
| 名称               | 类型            | 必填  | 说明              |
J
jidong 已提交
4420 4421 4422
| -------------------- | -------------- | ----- | ---------------- |
| authType             | string         | 是    | 令牌的鉴权类型。   |
| token                | string         | 是    | 令牌的取值。       |
4423
| account<sup>9+</sup> | [AppAccountInfo](#appaccountinfo) | 否    | 令牌所属的帐号信息。|
J
jidong 已提交
4424 4425 4426 4427 4428

## AuthenticatorInfo<sup>8+</sup>

表示OAuth认证器信息。

Z
zengyawen 已提交
4429 4430
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4431
| 名称     | 类型     | 必填   | 说明         |
H
HelloCrease 已提交
4432 4433
| ------- | ------ | ---- | ---------- |
| owner   | string | 是    | 认证器的所有者包名。 |
4434 4435
| iconId  | number | 是    | 认证器的图标标识。  |
| labelId | number | 是    | 认证器的标签标识。  |
J
jidong 已提交
4436

4437 4438 4439 4440 4441 4442
## AuthResult<sup>9+</sup>

表示认证结果信息。

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

4443
| 名称     | 类型     | 必填   | 说明         |
4444 4445 4446 4447 4448 4449
| ------- | ------ | ---- | ---------- |
| account   | [AppAccountInfo](#appaccountinfo) | 否    | 令牌所属的帐号信息。 |
| tokenInfo  | [AuthTokenInfo](#authtokeninfo9) | 否    | 令牌信息。  |

## CreateAccountOptions<sup>9+</sup>

Z
zengyawen 已提交
4450
表示创建帐号的选项。
4451 4452 4453

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

4454
| 名称     | 类型     | 必填   | 说明         |
4455
| ------- | ------ | ---- | ---------- |
4456
| customData   | {[key: string]: string} | 否    | 自定义数据。 |
4457 4458 4459

## CreateAccountImplicitlyOptions<sup>9+</sup>

Z
zengyawen 已提交
4460
表示隐式创建帐号的选项。
4461 4462 4463

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

4464
| 名称     | 类型     | 必填   | 说明         |
4465
| ------- | ------ | ---- | ---------- |
4466
| requiredLabels   | Array&lt;string&gt; | 否    | 必须的标签。 |
4467
| authType   | string | 否    | 鉴权类型。 |
4468
| parameters   | {[key: string]: Object} | 否    | 自定义参数对象。 |
J
jidong 已提交
4469 4470 4471 4472 4473 4474
## SelectAccountsOptions<sup>9+</sup>

表示用于选择帐号的选项。

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

4475
| 名称          | 类型                         | 必填  | 说明                |
J
jidong 已提交
4476
| --------------- | --------------------------- | ----- | ------------------- |
4477
| allowedAccounts | Array&lt;[AppAccountInfo](#appaccountinfo)&gt; | 否    | 允许的帐号数组。      |
J
jidong 已提交
4478 4479 4480 4481 4482 4483 4484 4485 4486
| allowedOwners   | Array&lt;string&gt;         | 否    | 允许的帐号所有者数组。 |
| requiredLabels  | Array&lt;string&gt;         | 否    | 认证器的标签标识。    |

## VerifyCredentialOptions<sup>9+</sup>

表示用于验证凭据的选项。

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

4487
| 名称          | 类型                   | 必填  | 说明           |
J
jidong 已提交
4488 4489 4490
| -------------- | ---------------------- | ----- | -------------- |
| credentialType | string                 | 否    | 凭据类型。      |
| credential     | string                 | 否    | 凭据取值。      |
4491
| parameters     | {[key: string]: Object} | 否    | 自定义参数对象。 |
J
jidong 已提交
4492 4493 4494 4495 4496 4497 4498 4499


## SetPropertiesOptions<sup>9+</sup>

表示用于设置属性的选项。

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

4500
| 名称     | 类型                    | 必填  | 说明           |
J
jidong 已提交
4501
| ---------- | ---------------------- | ----- | -------------- |
4502 4503
| properties | {[key: string]: Object} | 否    | 属性对象。      |
| parameters | {[key: string]: Object} | 否    | 自定义参数对象。 |
J
jidong 已提交
4504

J
jidong 已提交
4505 4506 4507 4508
## Constants<sup>8+</sup>

表示常量的枚举。

Z
zengyawen 已提交
4509 4510
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4511
| 名称                            | 值                    | 说明                   |
J
jidong 已提交
4512
| -------------------------------- | ---------------------- | ----------------------- |
4513 4514 4515 4516
| 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 已提交
4517 4518 4519
| ACTION_VERIFY_CREDENTIAL<sup>9+</sup>    | "verifyCredential" | 表示操作,验证凭据。  |
| ACTION_SET_AUTHENTICATOR_PROPERTIES<sup>9+</sup> | "setAuthenticatorProperties" | 表示操作,设置认证器属性。      |
| KEY_NAME                         | "name"                 | 表示键名,应用帐号的名称。  |
J
jidong 已提交
4520 4521 4522 4523 4524 4525 4526 4527 4528 4529
| 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 已提交
4530

4531
## ResultCode<sup>(deprecated)</sup>
Z
zhaoyuan17 已提交
4532

J
jidong 已提交
4533
表示返回码的枚举。
Z
zhaoyuan17 已提交
4534

4535 4536 4537
> **说明:**<br/>
> 从API version 8开始支持,从API version 9开始废弃。建议查看[错误码文档](../errorcodes/errorcode-app-account.md)替代。

Z
zengyawen 已提交
4538 4539
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

4540
| 名称                                  | 值   | 说明           |
H
HelloCrease 已提交
4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560
| ----------------------------------- | ----- | ------------ |
| 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 已提交
4561

4562 4563
## AuthCallback<sup>9+</sup>

J
jidong 已提交
4564
认证器回调类。
4565 4566 4567

### onResult<sup>9+</sup>

J
jidong 已提交
4568
onResult: (code: number, result?: AuthResult) =&gt; void
4569 4570 4571 4572 4573 4574 4575 4576 4577 4578

通知请求结果。

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

**参数:**

| 参数名    | 类型                   | 必填   | 说明     |
| ------ | -------------------- | ---- | ------ |
| code   | number               | 是    | 鉴权结果码。 |
J
jidong 已提交
4579
| result | [AuthResult](#authresult9) | 否    | 鉴权结果。  |
4580 4581 4582 4583

**示例:**

  ```js
J
jidong 已提交
4584
  let appAccountManager = account_appAccount.createAppAccountManager();
4585 4586
  var sessionId = "1234";
  appAccountManager.getAuthCallback(sessionId).then((callback) => {
L
lichenchen 已提交
4587 4588 4589 4590 4591 4592 4593 4594 4595 4596
      var result = {
          accountInfo: {
            name: "Lisi",
            owner: "com.example.accountjsdemo",
          },
          tokenInfo: {
            token: "xxxxxx",
            authType: "getSocialData"
          }
      };
4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622
      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 已提交
4623 4624
              bundleName: "com.example.accountjsdemo",
              abilityName: "com.example.accountjsdemo.LoginAbility",
4625 4626 4627 4628
          });
      }

      auth(name, authType, options, callback) {
L
lichenchen 已提交
4629 4630 4631 4632 4633 4634 4635 4636 4637 4638
          var result = {
            accountInfo: {
              name: "Lisi",
              owner: "com.example.accountjsdemo",
            },
            tokenInfo: {
              token: "xxxxxx",
              authType: "getSocialData"
            }
          };
4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654
          callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
      }
  }
  ```

### onRequestContinued<sup>9+</sup>

onRequestContinued?: () =&gt; void

通知请求被继续处理。

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

**示例:**

  ```js
J
jidong 已提交
4655
  let appAccountManager = account_appAccount.createAppAccountManager();
4656 4657 4658 4659 4660 4661 4662 4663 4664
  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 已提交
4665 4666 4667

OAuth认证器回调接口。

A
Annie_wang 已提交
4668
> **说明:** 
4669
>
A
Annie_wang 已提交
4670
> 从 API version 8开始支持,从API version 9开始废弃。建议使用[AuthCallback](#authcallback9)替代。
4671

J
jidong 已提交
4672 4673
### onResult<sup>8+</sup>

Z
zengyawen 已提交
4674
onResult: (code: number, result: {[key: string]: any}) =&gt; void
J
jidong 已提交
4675

J
jidong 已提交
4676
通知请求结果。
J
jidong 已提交
4677

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

Z
zengyawen 已提交
4680
**参数:**
4681

H
HelloCrease 已提交
4682 4683 4684 4685
| 参数名    | 类型                   | 必填   | 说明     |
| ------ | -------------------- | ---- | ------ |
| code   | number               | 是    | 鉴权结果码。 |
| result | {[key: string]: any} | 是    | 鉴权结果。  |
Z
zengyawen 已提交
4686 4687

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

Z
zhangalong 已提交
4689
  ```js
J
jidong 已提交
4690
  let appAccountManager = account_appAccount.createAppAccountManager();
J
jidong 已提交
4691 4692
  var sessionId = "1234";
  appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
J
jidong 已提交
4693
      var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
J
jidong 已提交
4694
                    [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo",
4695
                    [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
J
jidong 已提交
4696
                    [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
J
jidong 已提交
4697
      callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
J
jidong 已提交
4698 4699 4700 4701 4702 4703 4704
  }).catch((err) => {
      console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
  });
  ```

### onRequestRedirected<sup>8+</sup>

Z
zengyawen 已提交
4705
onRequestRedirected: (request: Want) =&gt; void
J
jidong 已提交
4706

J
jidong 已提交
4707
通知请求被跳转。
J
jidong 已提交
4708

Z
zengyawen 已提交
4709 4710 4711
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
4712

H
HelloCrease 已提交
4713 4714 4715
| 参数名     | 类型   | 必填   | 说明         |
| ------- | ---- | ---- | ---------- |
| request | Want | 是    | 用于跳转的请求信息。 |
J
jidong 已提交
4716

Z
zengyawen 已提交
4717
**示例:**
J
jidong 已提交
4718

Z
zhangalong 已提交
4719
  ```js
J
jidong 已提交
4720 4721 4722
  class MyAuthenticator extends account_appAccount.Authenticator {
      addAccountImplicitly(authType, callerBundleName, options, callback) {
          callback.onRequestRedirected({
J
jidong 已提交
4723 4724
              bundleName: "com.example.accountjsdemo",
              abilityName: "com.example.accountjsdemo.LoginAbility",
J
jidong 已提交
4725 4726 4727 4728
          });
      }

      authenticate(name, authType, callerBundleName, options, callback) {
J
jidong 已提交
4729 4730 4731 4732
          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 已提交
4733 4734 4735 4736
      }
  }
  ```

J
jidong 已提交
4737 4738
### onRequestContinued<sup>9+</sup>

J
jidong 已提交
4739
onRequestContinued?: () =&gt; void
J
jidong 已提交
4740 4741 4742 4743 4744 4745 4746 4747

通知请求被继续处理。

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

**示例:**

  ```js
J
jidong 已提交
4748
  let appAccountManager = account_appAccount.createAppAccountManager();
J
jidong 已提交
4749 4750
  var sessionId = "1234";
  appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
J
jidong 已提交
4751
      callback.onRequestContinued();
J
jidong 已提交
4752 4753 4754 4755 4756
  }).catch((err) => {
      console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
  });
  ```

J
jidong 已提交
4757 4758
## Authenticator<sup>8+</sup>

J
jidong 已提交
4759
认证器基类。
J
jidong 已提交
4760

J
jidong 已提交
4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772
### createAccountImplicitly<sup>9+</sup>

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

根据指定的帐号所有者隐式地创建应用帐号,并使用callback异步回调返回结果。

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

**参数:**

| 参数名              | 类型                    | 必填   | 说明              |
| ---------------- | --------------------- | ---- | --------------- |
Z
zengyawen 已提交
4773
| options          | [CreateAccountImplicitlyOptions](#createaccountimplicitlyoptions9)  | 是    | 隐式创建帐号的选项。      |
J
jidong 已提交
4774 4775
| callback         | [AuthCallback](#authcallback9) | 是    | 认证器回调对象,用于返回创建结果。 |

4776
### addAccountImplicitly<sup>(deprecated)</sup>
J
jidong 已提交
4777

Z
zengyawen 已提交
4778
addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
J
jidong 已提交
4779

J
jidong 已提交
4780 4781
根据指定的鉴权类型和可选项,隐式地添加应用帐号,并使用callback异步回调返回结果。

A
Annie_wang 已提交
4782
> **说明:** 
J
jidong 已提交
4783
>
A
Annie_wang 已提交
4784
> 从 API version 8开始支持, 从API version 9开始废弃。建议使用[createAccountImplicitly](#createaccountimplicitly9-2)替代。
J
jidong 已提交
4785

Z
zengyawen 已提交
4786 4787 4788
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
4789

H
HelloCrease 已提交
4790 4791 4792 4793 4794
| 参数名              | 类型                    | 必填   | 说明              |
| ---------------- | --------------------- | ---- | --------------- |
| authType         | string                | 是    | 应用帐号的鉴权类型。      |
| callerBundleName | string                | 是    | 鉴权请求方的包名。       |
| options          | {[key: string]: any}  | 是    | 鉴权所需要的可选项。      |
4795
| callback         | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是    | 认证器回调,用于返回鉴权结果。 |
J
jidong 已提交
4796

J
jidong 已提交
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806
### auth<sup>9+</sup>

auth(name: string, authType: string, options: {[key:string]: Object}, callback: AuthCallback): void

对应用帐号进行鉴权以获取授权令牌,并使用callback异步回调返回结果。

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

**参数:**

4807
| 参数名              | 类型                    | 必填   | 说明              |
J
jidong 已提交
4808 4809 4810 4811
| ---------------- | --------------------- | ---- | --------------- |
| name             | string                | 是    | 应用帐号的名称。        |
| authType         | string                | 是    | 应用帐号的鉴权类型。      |
| callerBundleName | string                | 是    | 鉴权类型。       |
4812
| options          | {[key: string]: Object}  | 是    | 鉴权所需要的可选项。      |
J
jidong 已提交
4813 4814
| callback         | [AuthCallback](#authcallback9) | 是    | 回调对象,用于返回鉴权结果。 |

4815
### authenticate<sup>(deprecated)</sup>
J
jidong 已提交
4816

Z
zengyawen 已提交
4817
authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
J
jidong 已提交
4818

J
jidong 已提交
4819 4820
对应用帐号进行鉴权,获取OAuth令牌,并使用callback异步回调返回结果。

A
Annie_wang 已提交
4821
> **说明:** 
J
jidong 已提交
4822
>
A
Annie_wang 已提交
4823
> 从 API version 8开始支持, 从API version 9开始废弃。建议使用[auth](#auth9-2)替代。
J
jidong 已提交
4824

Z
zengyawen 已提交
4825 4826 4827
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
4828

4829
| 参数名              | 类型                    | 必填   | 说明              |
H
HelloCrease 已提交
4830 4831 4832 4833 4834
| ---------------- | --------------------- | ---- | --------------- |
| name             | string                | 是    | 应用帐号的名称。        |
| authType         | string                | 是    | 应用帐号的鉴权类型。      |
| callerBundleName | string                | 是    | 鉴权请求方的包名。       |
| options          | {[key: string]: any}  | 是    | 鉴权所需要的可选项。      |
4835
| callback         | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是    | 认证器回调,用于返回鉴权结果。 |
J
jidong 已提交
4836

J
jidong 已提交
4837 4838
### verifyCredential<sup>9+</sup>

J
jidong 已提交
4839
verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthCallback): void;
J
jidong 已提交
4840

J
jidong 已提交
4841
验证应用帐号的凭据,并使用callback异步回调返回结果。
J
jidong 已提交
4842 4843 4844 4845

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

**参数:**
4846

4847
| 参数名              | 类型                    | 必填   | 说明              |
4848
| ---------------- | --------------------- | ---- | --------------- |
J
jidong 已提交
4849
| name      | string                   | 是    | 应用帐号的名称。              |
4850
| options   | [VerifyCredentialOptions](#verifycredentialoptions9)  | 是    | 验证凭据的可选项。            |
J
jidong 已提交
4851
| callback  | [AuthCallback](#authcallback9)    | 是    | 认证器回调,用于返回验证结果。 |
J
jidong 已提交
4852 4853 4854

### setProperties<sup>9+</sup>

J
jidong 已提交
4855
setProperties(options: SetPropertiesOptions, callback: AuthCallback): void;
J
jidong 已提交
4856

J
jidong 已提交
4857
设置认证器属性,并使用callback异步回调返回结果。
J
jidong 已提交
4858 4859 4860 4861

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

**参数:**
4862

4863
| 参数名              | 类型                    | 必填   | 说明              |
4864 4865
| ---------------- | --------------------- | ---- | --------------- |
| options   | [SetPropertiesOptions](#setpropertiesoptions9)  | 是    | 设置属性的可选项。            |
J
jidong 已提交
4866
| callback  | [AuthCallback](#authcallback9) | 是    | 认证器回调,用于返回设置结果。 |
J
jidong 已提交
4867 4868 4869

### checkAccountLabels<sup>9+</sup>

J
jidong 已提交
4870
checkAccountLabels(name: string, labels: Array&lt;string&gt;, callback: AuthCallback): void;
J
jidong 已提交
4871

J
jidong 已提交
4872
检查帐号标签,并使用callback异步回调返回结果。
J
jidong 已提交
4873 4874 4875 4876

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

**参数:**
4877

4878
| 参数名              | 类型                    | 必填   | 说明              |
4879
| ---------------- | --------------------- | ---- | --------------- |
J
jidong 已提交
4880
| name      | string                | 是    | 应用帐号的名称。              |
4881
| labels    | Array&lt;string&gt;          | 是    | 标签数组。                   |
J
jidong 已提交
4882
| callback  | [AuthCallback](#authcallback9) | 是    | 认证器回调,用于返回检查结果。 |
J
jidong 已提交
4883 4884 4885

### isAccountRemovable<sup>9+</sup>

J
jidong 已提交
4886
isAccountRemovable(name: string, callback: AuthCallback): void;
J
jidong 已提交
4887

J
jidong 已提交
4888
判断帐号是否可以删除,并使用callback异步回调返回结果。
J
jidong 已提交
4889 4890 4891 4892

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

**参数:**
4893

4894
| 参数名              | 类型                    | 必填   | 说明              |
4895
| ---------------- | --------------------- | ---- | --------------- |
J
jidong 已提交
4896
| name      | string                | 是    | 应用帐号的名称。              |
J
jidong 已提交
4897
| callback  | [AuthCallback](#authcallback9) | 是    | 认证器回调,用于返回判断结果。 |
J
jidong 已提交
4898 4899 4900 4901 4902 4903 4904 4905 4906

### getRemoteObject<sup>9+</sup>

getRemoteObject(): rpc.RemoteObject;

获取认证器的远程对象,不可以重载实现。

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

Z
zengyawen 已提交
4907
**示例:**
J
jidong 已提交
4908

Z
zhangalong 已提交
4909
  ```js
J
jidong 已提交
4910
  class MyAuthenticator extends account_appAccount.Authenticator {
J
jidong 已提交
4911 4912 4913 4914 4915 4916
    addAccountImplicitly(authType, callerBundleName, options, callback) {
      callback.onRequestRedirected({
        bundleName: "com.example.accountjsdemo",
        abilityName: "com.example.accountjsdemo.LoginAbility",
      });
    }
J
jidong 已提交
4917

J
jidong 已提交
4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933
    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 已提交
4934

J
jidong 已提交
4935 4936 4937
    setProperties(options, callback) {
      callback.onResult(account_appAccount.ResultCode.SUCCESS, {});
    }
J
jidong 已提交
4938

J
jidong 已提交
4939 4940 4941 4942 4943 4944 4945 4946 4947
    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 已提交
4948
  }
4949
  var authenticator = null;
J
jidong 已提交
4950
  export default {
J
jidong 已提交
4951 4952 4953 4954
    onConnect(want) {
      authenticator = new MyAuthenticator();
      return authenticator.getRemoteObject();
    }
J
jidong 已提交
4955
  }
Z
zengyawen 已提交
4956
  ```