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

3 4
本模块不仅用于对应用帐号的添加、删除、查询、修改和授权,且提供帐号将数据写入磁盘和数据同步的能力。

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


## 导入模块

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


## account_appAccount.createAppAccountManager

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

20
获取应用帐号模块的对象。
Z
zhaoyuan17 已提交
21

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

**返回值:**
25

H
HelloCrease 已提交
26 27
| 类型                | 说明           |
| ----------------- | ------------ |
Z
zengyawen 已提交
28
| AppAccountManager | 获取应用帐号模块的实例。 |
Z
zhaoyuan17 已提交
29

Z
zengyawen 已提交
30
**示例:**
Z
zhangalong 已提交
31
  ```js
Z
zengyawen 已提交
32
  const appAccountManager = account_appAccount.createAppAccountManager();
Z
zhaoyuan17 已提交
33 34 35 36 37 38 39 40
  ```

## AppAccountManager

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

### addAccount

Z
zengyawen 已提交
41
addAccount(name: string, callback: AsyncCallback<void>): void
Z
zhaoyuan17 已提交
42 43 44

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

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

Z
zengyawen 已提交
47
**参数:**
Z
zhaoyuan17 已提交
48

H
HelloCrease 已提交
49 50 51 52
| 参数名      | 类型                        | 必填   | 说明                   |
| -------- | ------------------------- | ---- | -------------------- |
| name     | string                    | 是    | 要添加的应用帐号名称。          |
| callback | AsyncCallback<void> | 是    | 将此应用的帐号名添加到帐号管理服务回调。 |
Z
zhaoyuan17 已提交
53

Z
zengyawen 已提交
54
**示例:**
Z
zhaoyuan17 已提交
55

Z
zhangalong 已提交
56
  ```js
Z
zhaoyuan17 已提交
57 58 59 60 61 62 63 64
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.addAccount("WangWu", (err) => { 
      console.log("addAccount err: " + JSON.stringify(err));
  });
  ```

### addAccount

Z
zengyawen 已提交
65
addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void
Z
zhaoyuan17 已提交
66

67
将此应用程序的帐号名和额外信息(能转换string类型的其它信息,如token)添加到帐号管理服务中,使用callback回调异步返回结果。
Z
zhaoyuan17 已提交
68

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

Z
zengyawen 已提交
71
**参数:**
Z
zhaoyuan17 已提交
72

H
HelloCrease 已提交
73 74 75 76 77
| 参数名       | 类型                        | 必填   | 说明                                       |
| --------- | ------------------------- | ---- | ---------------------------------------- |
| name      | string                    | 是    | 要添加的应用帐号名称。                              |
| extraInfo | string                    | 是    | 要添加的应用帐号的额外信息(能转换string类型的其它信息,如token等),额外信息不能是应用帐号的敏感信息(如应用账号密码)。 |
| callback  | AsyncCallback<void> | 是    | 将此应用程序的帐号名和额外信息添加到帐号管理服务中回调。             |
Z
zhaoyuan17 已提交
78

Z
zengyawen 已提交
79
**示例:**
Z
zhaoyuan17 已提交
80

Z
zhangalong 已提交
81
  ```js
Z
zhaoyuan17 已提交
82 83 84 85 86 87 88 89 90 91
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.addAccount("LiSi", "token101", (err) => { 
      console.log("addAccount err: " + JSON.stringify(err));
  });
  ```



### addAccount

92
addAccount(name: string, extraInfo: string): Promise<void>
Z
zhaoyuan17 已提交
93

94
将此应用的帐号名或额外信息(能转换成string类型的其它信息)添加到帐号管理服务中,使用Promise方式异步返回结果。
Z
zhaoyuan17 已提交
95

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

Z
zengyawen 已提交
98
**参数:**
Z
zhaoyuan17 已提交
99

H
HelloCrease 已提交
100 101 102 103
| 参数名       | 类型     | 必填   | 说明                                       |
| --------- | ------ | ---- | ---------------------------------------- |
| name      | string | 是    | 要添加的应用帐号名称。                              |
| extraInfo | string | 是    | 要添加的应用帐号的额外信息(能转换成string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码)。 |
Z
zhaoyuan17 已提交
104

Z
zengyawen 已提交
105
**返回值:**
Z
zhaoyuan17 已提交
106

H
HelloCrease 已提交
107 108
| 类型                  | 说明                    |
| ------------------- | --------------------- |
Z
zengyawen 已提交
109
| Promise<void> | Promise实例,用于获取异步返回结果。 |
Z
zhaoyuan17 已提交
110

Z
zengyawen 已提交
111
**示例:**
Z
zhaoyuan17 已提交
112

Z
zhangalong 已提交
113
  ```js
Z
zhaoyuan17 已提交
114 115 116 117 118 119 120 121
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.addAccount("LiSi", "token101").then(()=> { 
      console.log('addAccount Success');
  }).catch((err) => {
      console.log("addAccount err: "  + JSON.stringify(err));
  });
  ```

J
jidong 已提交
122 123
### addAccountImplicitly<sup>8+</sup>

Z
zengyawen 已提交
124
addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
J
jidong 已提交
125

126
根据指定的帐号所有者、鉴权类型和可选项隐式地添加应用帐号,并使用callback回调异步返回结果。
J
jidong 已提交
127

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

Z
zengyawen 已提交
130
**参数:**
J
jidong 已提交
131

H
HelloCrease 已提交
132 133 134 135 136 137
| 参数名      | 类型                    | 必填   | 说明                      |
| -------- | --------------------- | ---- | ----------------------- |
| owner    | string                | 是    | 要添加的应用帐号所有者包名。          |
| authType | string                | 是    | 要添加的应用帐号鉴权类型。鉴权类型为自定义。  |
| options  | {[key: string]: any}  | 是    | 鉴权所需要的可选项。可选项可根据自己需要设置。 |
| callback | AuthenticatorCallback | 是    | 认证器回调,用于返回鉴权结果。         |
J
jidong 已提交
138

Z
zengyawen 已提交
139
**示例:**
J
jidong 已提交
140

Z
zhangalong 已提交
141
  ```js
J
jidong 已提交
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
  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));
      });
  }

  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.addAccountImplicitly("LiSi", "readAge", {}, {
      onResult: onResultCallback,
      onRequestRedirected: onRequestRedirectedCallback
  });
  ```

Z
zhaoyuan17 已提交
163 164
### deleteAccount

Z
zengyawen 已提交
165
deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
166 167 168

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

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

Z
zengyawen 已提交
171
**参数:**
Z
zhaoyuan17 已提交
172

H
HelloCrease 已提交
173 174 175 176
| 参数名      | 类型                        | 必填   | 说明               |
| -------- | ------------------------- | ---- | ---------------- |
| name     | string                    | 是    | 要删除的应用帐号名称。      |
| callback | AsyncCallback&lt;void&gt; | 是    | 帐号管理服务中删除应用帐号回调。 |
Z
zengyawen 已提交
177 178

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

Z
zhangalong 已提交
180
  ```js
Z
zhaoyuan17 已提交
181 182 183 184 185 186 187 188
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteAccount("ZhaoLiu", (err) => { 
      console.log("deleteAccount err: " + JSON.stringify(err));
   });
  ```

### deleteAccount

Z
zengyawen 已提交
189
deleteAccount(name: string): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
190 191 192

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

Z
zengyawen 已提交
193 194 195
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
197 198 199
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| name | string | 是    | 要删除的应用帐号名称。 |
Z
zhaoyuan17 已提交
200

Z
zengyawen 已提交
201
**返回值:**
Z
zhaoyuan17 已提交
202

H
HelloCrease 已提交
203 204
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
Z
zengyawen 已提交
205
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |
Z
zhaoyuan17 已提交
206

Z
zengyawen 已提交
207
**示例:**
Z
zhaoyuan17 已提交
208

Z
zhangalong 已提交
209
  ```js
Z
zhaoyuan17 已提交
210 211 212 213 214 215 216 217 218 219
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteAccount("ZhaoLiu").then(() => { 
        console.log('deleteAccount Success');
   }).catch((err) => {
      console.log("deleteAccount err: "  + JSON.stringify(err));
  });
  ```

### disableAppAccess

Z
zengyawen 已提交
220
disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
221

222
禁止指定第三方应用帐号名称对指定的第三方应用进行访问,使用callback回调异步返回结果。
Z
zhaoyuan17 已提交
223

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

Z
zengyawen 已提交
226
**参数:**
Z
zhaoyuan17 已提交
227

H
HelloCrease 已提交
228 229 230 231 232
| 参数名        | 类型                        | 必填   | 说明                                |
| ---------- | ------------------------- | ---- | --------------------------------- |
| name       | string                    | 是    | 要禁用访问的第三方应用帐号名称。                  |
| bundleName | string                    | 是    | 第三方应用的包名。                         |
| callback   | AsyncCallback&lt;void&gt; | 是    | 禁止指定第三方应用帐号名称对指定包名称的第三方应用的回调进行访问。 |
Z
zengyawen 已提交
233 234

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

Z
zhangalong 已提交
236
  ```js
Z
zhaoyuan17 已提交
237
  const appAccountManager = account_appAccount.createAppAccountManager();
Z
zengyawen 已提交
238
  appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { 
Z
zhaoyuan17 已提交
239 240 241 242 243 244
      console.log("disableAppAccess err: " + JSON.stringify(err));
  });
  ```

### disableAppAccess

Z
zengyawen 已提交
245
disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
246

247
禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问,使用Promise方式异步返回结果。
Z
zhaoyuan17 已提交
248

Z
zengyawen 已提交
249 250 251
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
253 254 255 256
| 参数名        | 类型     | 必填   | 说明               |
| ---------- | ------ | ---- | ---------------- |
| name       | string | 是    | 要禁用访问的第三方应用帐号名称。 |
| bundleName | string | 是    | 第三方应用的包名。        |
Z
zhaoyuan17 已提交
257

Z
zengyawen 已提交
258
**返回值:**
Z
zhaoyuan17 已提交
259

H
HelloCrease 已提交
260 261
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
Z
zengyawen 已提交
262
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |
Z
zhaoyuan17 已提交
263

Z
zengyawen 已提交
264
**示例:**
Z
zhaoyuan17 已提交
265

Z
zhangalong 已提交
266
  ```js
Z
zhaoyuan17 已提交
267
  const appAccountManager = account_appAccount.createAppAccountManager();
Z
zengyawen 已提交
268
  appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { 
Z
zhaoyuan17 已提交
269 270 271 272 273 274 275 276
      console.log('disableAppAccess Success');
  }).catch((err) => {
      console.log("disableAppAccess err: "  + JSON.stringify(err));
  });
  ```

### enableAppAccess

Z
zengyawen 已提交
277
enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
278

279
允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问,使用callback回调异步返回结果。
Z
zhaoyuan17 已提交
280

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

Z
zengyawen 已提交
283
**参数:**
Z
zhaoyuan17 已提交
284

H
HelloCrease 已提交
285 286 287 288 289
| 参数名        | 类型                        | 必填   | 说明                                |
| ---------- | ------------------------- | ---- | --------------------------------- |
| name       | string                    | 是    | 应用帐号名称。                           |
| bundleName | string                    | 是    | 第三方应用的包名。                         |
| callback   | AsyncCallback&lt;void&gt; | 是    | 允许指定第三方应用帐号名称对指定包名称的第三方应用的回调进行访问。 |
Z
zengyawen 已提交
290 291

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

Z
zhangalong 已提交
293
  ```js
Z
zhaoyuan17 已提交
294
  const appAccountManager = account_appAccount.createAppAccountManager();
Z
zengyawen 已提交
295
  appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { 
Z
zhaoyuan17 已提交
296 297 298 299 300 301
      console.log("enableAppAccess: " + JSON.stringify(err));
   });
  ```

### enableAppAccess

Z
zengyawen 已提交
302
enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
303

304
允许指定第三方应用帐号的名称对指定包名称的第三方应用进行访问,使用Promise方式异步返回结果。
Z
zhaoyuan17 已提交
305

Z
zengyawen 已提交
306 307 308
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
310 311 312 313
| 参数名        | 类型     | 必填   | 说明        |
| ---------- | ------ | ---- | --------- |
| name       | string | 是    | 应用帐号名称。   |
| bundleName | string | 是    | 第三方应用的包名。 |
Z
zhaoyuan17 已提交
314

Z
zengyawen 已提交
315
**返回值:**
Z
zhaoyuan17 已提交
316

H
HelloCrease 已提交
317 318
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
Z
zengyawen 已提交
319
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |
Z
zhaoyuan17 已提交
320

Z
zengyawen 已提交
321
**示例:**
Z
zhaoyuan17 已提交
322

Z
zhangalong 已提交
323
  ```js
Z
zengyawen 已提交
324
  app_account_instance.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { 
Z
zhaoyuan17 已提交
325 326 327 328 329 330 331 332
       console.log('enableAppAccess Success');
  }).catch((err) => {
      console.log("enableAppAccess err: "  + JSON.stringify(err));
  });
  ```

### checkAppAccountSyncEnable

Z
zengyawen 已提交
333
checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): void
Z
zhaoyuan17 已提交
334 335 336

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

Z
zengyawen 已提交
337
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC,仅系统应用可用。
Z
zhaoyuan17 已提交
338

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

Z
zengyawen 已提交
341
**参数:**
Z
zhaoyuan17 已提交
342

H
HelloCrease 已提交
343 344 345 346
| 参数名      | 类型                           | 必填   | 说明                    |
| -------- | ---------------------------- | ---- | --------------------- |
| name     | string                       | 是    | 应用帐号名称。               |
| callback | AsyncCallback&lt;boolean&gt; | 是    | 检查指定应用帐号是否允许应用数据同步回调。 |
Z
zengyawen 已提交
347 348

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

Z
zhangalong 已提交
350
  ```js
Z
zhaoyuan17 已提交
351 352 353 354 355 356 357 358 359
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { 
      console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err));
      console.log('checkAppAccountSyncEnable result: ' + result);
  });
  ```

### checkAppAccountSyncEnable

Z
zengyawen 已提交
360
checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;
Z
zhaoyuan17 已提交
361 362 363

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

Z
zengyawen 已提交
364 365 366
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC,仅系统应用可用。

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

Z
zengyawen 已提交
368
**参数:**
Z
zhaoyuan17 已提交
369

H
HelloCrease 已提交
370 371 372
| 参数名  | 类型     | 必填   | 说明      |
| ---- | ------ | ---- | ------- |
| name | string | 是    | 应用帐号名称。 |
Z
zhaoyuan17 已提交
373

Z
zengyawen 已提交
374
**返回值:**
Z
zhaoyuan17 已提交
375

H
HelloCrease 已提交
376 377
| 类型                     | 说明                    |
| :--------------------- | :-------------------- |
Z
zengyawen 已提交
378
| Promise&lt;boolean&gt; | Promise实例,用于获取异步返回结果。 |
Z
zhaoyuan17 已提交
379

Z
zengyawen 已提交
380
**示例:**
Z
zhaoyuan17 已提交
381

Z
zhangalong 已提交
382
  ```js
Z
zhaoyuan17 已提交
383 384 385 386 387 388 389 390 391 392
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { 
      console.log('checkAppAccountSyncEnable, result: ' + data);
  }).catch((err) => {
      console.log("checkAppAccountSyncEnable err: "  + JSON.stringify(err));
  });
  ```

### setAccountCredential

Z
zengyawen 已提交
393
setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
394 395 396

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

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

Z
zengyawen 已提交
399
**参数:**
Z
zhaoyuan17 已提交
400

H
HelloCrease 已提交
401 402 403 404 405 406
| 参数名            | 类型                        | 必填   | 说明            |
| -------------- | ------------------------- | ---- | ------------- |
| name           | string                    | 是    | 应用程序帐号名称。     |
| credentialType | string                    | 是    | 要设置的凭据类型。     |
| credential     | string                    | 是    | 要设置的凭据。       |
| callback       | AsyncCallback&lt;void&gt; | 是    | 设置此应用帐号的凭据回调。 |
Z
zengyawen 已提交
407 408

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

Z
zhangalong 已提交
410
  ```js
Z
zhaoyuan17 已提交
411 412 413 414 415 416 417 418
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { 
      console.log("setAccountCredential err: " + JSON.stringify(err));
  });
  ```

### setAccountCredential

Z
zengyawen 已提交
419
setAccountCredential(name: string, credentialType: string, credential: string): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
420 421 422

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

Z
zengyawen 已提交
423 424 425
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
427 428 429 430 431
| 参数名            | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
| name           | string | 是    | 应用帐号的名称。   |
| credentialType | string | 是    | 要设置的凭据的类型。 |
| credential     | string | 是    | 要设置的凭据。    |
Z
zhaoyuan17 已提交
432

Z
zengyawen 已提交
433
**返回值:**
Z
zhaoyuan17 已提交
434

H
HelloCrease 已提交
435 436
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
Z
zengyawen 已提交
437
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |
Z
zhaoyuan17 已提交
438

Z
zengyawen 已提交
439
**示例:**
Z
zhaoyuan17 已提交
440

Z
zhangalong 已提交
441
  ```js
Z
zhaoyuan17 已提交
442 443 444 445 446 447 448 449 450 451
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001").then(() => { 
      console.log('setAccountCredential Success');
  }).catch((err) => {
      console.log("setAccountCredential err: "  + JSON.stringify(err));
  });
  ```

### setAccountExtraInfo

Z
zengyawen 已提交
452
setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
453 454 455

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

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

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

H
HelloCrease 已提交
460 461 462 463 464
| 参数名       | 类型                        | 必填   | 说明              |
| --------- | ------------------------- | ---- | --------------- |
| name      | string                    | 是    | 应用帐号名称。         |
| extraInfo | string                    | 是    | 要设置的额外信息。       |
| callback  | AsyncCallback&lt;void&gt; | 是    | 设置此应用帐号的额外信息回调。 |
Z
zhaoyuan17 已提交
465

Z
zengyawen 已提交
466
**示例:**
Z
zhaoyuan17 已提交
467

Z
zhangalong 已提交
468
  ```js
Z
zhaoyuan17 已提交
469 470 471 472 473 474 475 476
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { 
      console.log("setAccountExtraInfo err: " + JSON.stringify(err));
  });
  ```

### setAccountExtraInfo

Z
zengyawen 已提交
477
setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
478 479 480

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

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

Z
zengyawen 已提交
483
**参数:**
Z
zhaoyuan17 已提交
484

H
HelloCrease 已提交
485 486 487 488
| 参数名       | 类型     | 必填   | 说明        |
| --------- | ------ | ---- | --------- |
| name      | string | 是    | 应用帐号名称。   |
| extraInfo | string | 是    | 要设置的额外信息。 |
Z
zhaoyuan17 已提交
489

Z
zengyawen 已提交
490
**返回值:**
Z
zhaoyuan17 已提交
491

H
HelloCrease 已提交
492 493
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
Z
zengyawen 已提交
494 495 496
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
498
  ```js
Z
zhaoyuan17 已提交
499 500 501 502 503 504 505 506 507 508
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { 
      console.log('setAccountExtraInfo Success');
  }).catch((err) => {
      console.log("setAccountExtraInfo err: "  + JSON.stringify(err));
  });
  ```

### setAppAccountSyncEnable

Z
zengyawen 已提交
509
setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
510 511 512

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

Z
zengyawen 已提交
513 514 515
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC,仅系统应用可用。

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

Z
zengyawen 已提交
517
**参数:**
Z
zhaoyuan17 已提交
518

H
HelloCrease 已提交
519 520 521 522 523
| 参数名      | 类型                        | 必填   | 说明                        |
| -------- | ------------------------- | ---- | ------------------------- |
| name     | string                    | 是    | 应用帐号名称。                   |
| isEnable | boolean                   | 是    | 是否允许应用数据同步。               |
| callback | AsyncCallback&lt;void&gt; | 是    | 设置指定的应用帐号是否允许应用程序数据同步的回调。 |
Z
zhaoyuan17 已提交
524

Z
zengyawen 已提交
525
**示例:**
Z
zhaoyuan17 已提交
526

Z
zhangalong 已提交
527
  ```js
Z
zhaoyuan17 已提交
528 529 530 531 532 533 534 535
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { 
      console.log("setAppAccountSyncEnable err: " + JSON.stringify(err));
  });
  ```

### setAppAccountSyncEnable

Z
zengyawen 已提交
536
setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
537 538 539

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

Z
zengyawen 已提交
540
**需要权限:** ohos.permission.DISTRIBUTED_DATASYNC,仅系统应用可用。
Z
zhaoyuan17 已提交
541

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

Z
zengyawen 已提交
544
**参数:**
Z
zhaoyuan17 已提交
545

H
HelloCrease 已提交
546 547 548 549
| 参数名      | 类型      | 必填   | 说明          |
| -------- | ------- | ---- | ----------- |
| name     | string  | 是    | 应用帐号名称。     |
| isEnable | boolean | 是    | 是否允许应用数据同步。 |
Z
zhaoyuan17 已提交
550

Z
zengyawen 已提交
551
**返回值:**
Z
zhaoyuan17 已提交
552

H
HelloCrease 已提交
553 554
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
Z
zengyawen 已提交
555 556 557
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
559
  ```js
Z
zhaoyuan17 已提交
560 561 562 563 564 565 566 567 568 569
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { 
      console.log('setAppAccountSyncEnable Success');
  }).catch((err) => {
      console.log("setAppAccountSyncEnable err: "  + JSON.stringify(err));
  });
  ```

### setAssociatedData

Z
zengyawen 已提交
570
setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback&lt;void&gt;): void
Z
zhaoyuan17 已提交
571 572 573

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

Z
zengyawen 已提交
574 575 576
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
578 579 580 581 582 583
| 参数名      | 类型                        | 必填   | 说明                |
| -------- | ------------------------- | ---- | ----------------- |
| name     | string                    | 是    | 应用帐号名称。           |
| key      | string                    | 是    | 要设置的数据的键,密钥可以自定义。 |
| value    | string                    | 是    | 要设置的数据的值。         |
| callback | AsyncCallback&lt;void&gt; | 是    | 设置与此应用帐号关联的数据的回调。 |
Z
zhaoyuan17 已提交
584

Z
zengyawen 已提交
585
**示例:**
Z
zhaoyuan17 已提交
586

Z
zhangalong 已提交
587
  ```js
Z
zhaoyuan17 已提交
588 589 590 591 592 593 594
  app_account_instance.setAssociatedData("ZhangSan", "k001", "v001", (err) => { 
      console.log("setAssociatedData err: " + JSON.stringify(err));
  });
  ```

### setAssociatedData

Z
zengyawen 已提交
595
setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;
Z
zhaoyuan17 已提交
596 597 598

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

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

Z
zengyawen 已提交
601
**参数:**
Z
zhaoyuan17 已提交
602

H
HelloCrease 已提交
603 604 605 606 607
| 参数名   | 类型     | 必填   | 说明                |
| ----- | ------ | ---- | ----------------- |
| name  | string | 是    | 应用帐号名称。           |
| key   | string | 是    | 要设置的数据的键,密钥可以自定义。 |
| value | string | 是    | 要设置的数据的值。         |
Z
zhaoyuan17 已提交
608

Z
zengyawen 已提交
609
**返回值:**
Z
zhaoyuan17 已提交
610

H
HelloCrease 已提交
611 612
| 类型                  | 说明                    |
| :------------------ | :-------------------- |
Z
zengyawen 已提交
613 614 615
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
617
  ```js
Z
zhaoyuan17 已提交
618 619 620 621 622 623 624 625 626 627
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { 
      console.log('setAssociatedData Success');
  }).catch((err) => {
      console.log("setAssociatedData err: "  + JSON.stringify(err));
  });
  ```

### getAccountCredential

Z
zengyawen 已提交
628
getAccountCredential(name: string, credentialType: string, callback: AsyncCallback&lt;string&gt;): void
Z
zhaoyuan17 已提交
629

630
获取此应用帐号的凭据(如数字密码、人脸和PIN码等),使用callback回调异步返回结果。
Z
zhaoyuan17 已提交
631

Z
zengyawen 已提交
632 633 634
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
636 637 638 639 640
| 参数名            | 类型                          | 必填   | 说明             |
| -------------- | --------------------------- | ---- | -------------- |
| name           | string                      | 是    | 应用帐号名称。        |
| credentialType | string                      | 是    | 获取此应用帐号的凭据的类型。 |
| callback       | AsyncCallback&lt;string&gt; | 是    | 获取此应用帐号的凭据的回调。 |
Z
zhaoyuan17 已提交
641

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

Z
zhangalong 已提交
644
  ```js
Z
zhaoyuan17 已提交
645 646 647 648 649 650 651 652 653
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { 
      console.log("getAccountCredential err: " + JSON.stringify(err));
      console.log('getAccountCredential result: ' + result);
  });
  ```

### getAccountCredential

Z
zengyawen 已提交
654
getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt;
Z
zhaoyuan17 已提交
655 656 657

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

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

Z
zengyawen 已提交
660
**参数:**
Z
zhaoyuan17 已提交
661

H
HelloCrease 已提交
662 663 664 665
| 参数名            | 类型     | 必填   | 说明         |
| -------------- | ------ | ---- | ---------- |
| name           | string | 是    | 应用帐号名称。    |
| credentialType | string | 是    | 要获取的凭据的类型。 |
Z
zhaoyuan17 已提交
666

Z
zengyawen 已提交
667
**返回值:**
Z
zhaoyuan17 已提交
668

H
HelloCrease 已提交
669 670
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
Z
zengyawen 已提交
671 672 673
| Promise&lt;string&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
675
  ```js
Z
zhaoyuan17 已提交
676 677 678 679 680 681 682 683 684 685
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { 
      console.log('getAccountCredential, result: ' + data);
  }).catch((err) => {
      console.log("getAccountCredential err: "  + JSON.stringify(err));
  });
  ```

### getAccountExtraInfo

Z
zengyawen 已提交
686
getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void
Z
zhaoyuan17 已提交
687

688
获取此应用帐号的额外信息(能转换成string类型的其它信息),使用callback回调异步返回结果。
Z
zhaoyuan17 已提交
689

Z
zengyawen 已提交
690 691 692
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
694 695 696 697
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
| name     | string                      | 是    | 应用帐号名称。         |
| callback | AsyncCallback&lt;string&gt; | 是    | 获取此应用帐号的额外信息回调。 |
Z
zhaoyuan17 已提交
698

Z
zengyawen 已提交
699
**示例:**
Z
zhaoyuan17 已提交
700

Z
zhangalong 已提交
701
  ```js
Z
zhaoyuan17 已提交
702 703 704 705 706 707 708 709 710
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { 
      console.log("getAccountExtraInfo err: " + JSON.stringify(err));
      console.log('getAccountExtraInfo result: ' + result);
  });
  ```

### getAccountExtraInfo

Z
zengyawen 已提交
711
getAccountExtraInfo(name: string): Promise&lt;string&gt;
Z
zhaoyuan17 已提交
712 713 714

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

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

Z
zengyawen 已提交
717
**参数:**
Z
zhaoyuan17 已提交
718

H
HelloCrease 已提交
719 720 721
| 参数名  | 类型     | 必填   | 说明      |
| ---- | ------ | ---- | ------- |
| name | string | 是    | 应用帐号名称。 |
Z
zhaoyuan17 已提交
722

Z
zengyawen 已提交
723
**返回值:**
Z
zhaoyuan17 已提交
724

H
HelloCrease 已提交
725 726
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
Z
zengyawen 已提交
727 728 729
| Promise&lt;string&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
731
  ```js
Z
zhaoyuan17 已提交
732 733 734 735 736 737 738 739 740 741
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { 
      console.log('getAccountExtraInfo, result: ' + data);
  }).catch((err) => {
      console.log("getAccountExtraInfo err: "  + JSON.stringify(err));
  });
  ```

### getAssociatedData

Z
zengyawen 已提交
742
getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void
Z
zhaoyuan17 已提交
743 744 745

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

Z
zengyawen 已提交
746 747 748
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
750 751 752 753 754
| 参数名      | 类型                          | 必填   | 说明                |
| -------- | --------------------------- | ---- | ----------------- |
| name     | string                      | 是    | 应用帐号名称。           |
| key      | string                      | 是    | 要获取的数据的键。         |
| callback | AsyncCallback&lt;string&gt; | 是    | 获取与此应用帐号关联的数据的回调。 |
Z
zhaoyuan17 已提交
755

Z
zengyawen 已提交
756
**示例:**
Z
zhaoyuan17 已提交
757

Z
zhangalong 已提交
758
  ```js
Z
zhaoyuan17 已提交
759 760 761 762 763 764 765 766 767
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { 
      console.log("getAssociatedData err: " + JSON.stringify(err));
      console.log('getAssociatedData result: ' + result);
  });
  ```

### getAssociatedData

Z
zengyawen 已提交
768
getAssociatedData(name: string, key: string): Promise&lt;string&gt;
Z
zhaoyuan17 已提交
769 770 771

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

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

Z
zengyawen 已提交
774
**参数:**
Z
zhaoyuan17 已提交
775

H
HelloCrease 已提交
776 777 778 779
| 参数名  | 类型     | 必填   | 说明        |
| ---- | ------ | ---- | --------- |
| name | string | 是    | 应用帐号名称。   |
| key  | string | 是    | 要获取的数据的键。 |
Z
zhaoyuan17 已提交
780

Z
zengyawen 已提交
781
**返回值:**
Z
zhaoyuan17 已提交
782

H
HelloCrease 已提交
783 784
| 类型                    | 说明                    |
| :-------------------- | :-------------------- |
Z
zengyawen 已提交
785 786 787
| Promise&lt;string&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
789
  ```js
Z
zhaoyuan17 已提交
790 791 792 793 794 795 796 797 798 799
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { 
       console.log('getAssociatedData: ' + data);
  }).catch((err) => {
      console.log("getAssociatedData err: "  + JSON.stringify(err));
  });
  ```

### getAllAccessibleAccounts

Z
zengyawen 已提交
800
getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
Z
zhaoyuan17 已提交
801 802 803

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

L
lichenchen 已提交
804
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS,仅系统应用可用。
Z
zengyawen 已提交
805 806

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

Z
zengyawen 已提交
808
**参数:**
Z
zhaoyuan17 已提交
809

H
HelloCrease 已提交
810 811 812
| 参数名      | 类型                                       | 必填   | 说明        |
| -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是    | 应用帐号信息列表。 |
Z
zhaoyuan17 已提交
813

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

Z
zhangalong 已提交
816
  ```js
Z
zhaoyuan17 已提交
817 818 819 820 821 822 823 824 825
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAllAccessibleAccounts((err, data)=>{
  	console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err));
  	console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data));
  });
  ```

### getAllAccessibleAccounts

Z
zengyawen 已提交
826
getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
Z
zhaoyuan17 已提交
827 828 829

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

L
lichenchen 已提交
830
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS,仅系统应用可用。
Z
zhaoyuan17 已提交
831

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

Z
zengyawen 已提交
834
**参数:**
Z
zhaoyuan17 已提交
835

H
HelloCrease 已提交
836 837
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
Z
zengyawen 已提交
838 839 840
| Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
842
  ```js
Z
zhaoyuan17 已提交
843 844 845 846 847 848 849 850 851 852
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAllAccessibleAccounts().then((data) => { 
       console.log('getAllAccessibleAccounts: ' + data);
  }).catch((err) => {
      console.log("getAllAccessibleAccounts err: "  + JSON.stringify(err));
  });
  ```

### getAllAccounts

Z
zengyawen 已提交
853
getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
Z
zhaoyuan17 已提交
854 855 856

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

L
lichenchen 已提交
857
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS,仅系统应用可用。
Z
zengyawen 已提交
858 859

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

Z
zengyawen 已提交
861
**参数:**
Z
zhaoyuan17 已提交
862

H
HelloCrease 已提交
863 864 865 866
| 参数名      | 类型                                       | 必填   | 说明        |
| -------- | ---------------------------------------- | ---- | --------- |
| owner    | string                                   | 是    | 应用包名称。    |
| callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是    | 应用帐号信息列表。 |
Z
zhaoyuan17 已提交
867

Z
zengyawen 已提交
868
**示例:**
Z
zhaoyuan17 已提交
869

Z
zhangalong 已提交
870
  ```js
Z
zhaoyuan17 已提交
871 872 873 874 875 876 877 878 879 880
  const appAccountManager = account.createAppAccountManager();
  const selfBundle = "com.example.actsgetallaaccounts";
  appAccountManager.getAllAccounts(selfBundle, (err, data)=>{
  	console.debug("getAllAccounts err:" + JSON.stringify(err));
  	console.debug("getAllAccounts data:" + JSON.stringify(data));
  });
  ```

### getAllAccounts

Z
zengyawen 已提交
881
getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
Z
zhaoyuan17 已提交
882 883 884

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

L
lichenchen 已提交
885
**需要权限:** ohos.permission.GET_ALL_APP_ACCOUNTS,仅系统应用可用。
Z
zengyawen 已提交
886 887

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

Z
zengyawen 已提交
889
**参数:**
Z
zhaoyuan17 已提交
890

H
HelloCrease 已提交
891 892 893
| 参数名   | 类型     | 必填   | 说明     |
| ----- | ------ | ---- | ------ |
| owner | string | 是    | 应用包名称。 |
Z
zhaoyuan17 已提交
894

Z
zengyawen 已提交
895
**参数:**
Z
zhaoyuan17 已提交
896

H
HelloCrease 已提交
897 898
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
Z
zengyawen 已提交
899
| Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例,用于获取异步返回结果。 |
Z
zhaoyuan17 已提交
900

Z
zengyawen 已提交
901
**示例:**
Z
zhaoyuan17 已提交
902

Z
zhangalong 已提交
903
  ```js
Z
zhaoyuan17 已提交
904 905 906 907 908 909 910 911 912 913 914
  const appAccountManager = account_appAccount.createAppAccountManager();
  const selfBundle = "com.example.actsgetallaaccounts";
  appAccountManager.getAllAccounts(selfBundle).then((data) => { 
       console.log('getAllAccounts: ' + data);
  }).catch((err) => {
      console.log("getAllAccounts err: "  + JSON.stringify(err));
  });
  ```

### on('change')

Z
zengyawen 已提交
915
on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
Z
zhaoyuan17 已提交
916 917 918

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

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

Z
zengyawen 已提交
921
**参数:**
Z
zhaoyuan17 已提交
922

H
HelloCrease 已提交
923 924 925 926 927
| 参数名      | 类型                                       | 必填   | 说明                             |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type     | 'change'                                 | 是    | 关于帐号更改事件,当帐号所有者更新帐号时,订阅者将收到通知。 |
| owners   | Array&lt;string&gt;                      | 是    | 指示帐号的所有者。                      |
| callback | Callback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是    | 订阅指定帐号所有者的帐号变更事件的回调。           |
Z
zengyawen 已提交
928 929

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

Z
zhangalong 已提交
931
  ```js
Z
zhaoyuan17 已提交
932 933 934 935 936 937 938 939 940 941 942 943 944 945
  const appAccountManager = account.createAppAccountManager();
  function changeOnCallback(data){
  	console.debug("receive change data:" + JSON.stringify(data));
  }
  try{
  	appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback);
  }
  catch(err){
  	console.error("on accountOnOffDemo err:" + JSON.stringify(err));
  }
  ```

### off('change')

Z
zengyawen 已提交
946
off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void
Z
zhaoyuan17 已提交
947 948 949

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

Z
zengyawen 已提交
950 951 952
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
954 955 956 957
| 参数名      | 类型                               | 必填   | 说明           |
| -------- | -------------------------------- | ---- | ------------ |
| type     | 'change'                         | 是    | 关于帐号更改事件。    |
| callback | Callback<Array\<AppAccountInfo>> | 否    | 取消订阅帐号事件的回调。 |
Z
zhaoyuan17 已提交
958

Z
zengyawen 已提交
959
**示例:**
Z
zhaoyuan17 已提交
960

Z
zhangalong 已提交
961
  ```js
Z
zhaoyuan17 已提交
962 963 964 965 966
  const appAccountManager = account.createAppAccountManager();
  function changeOnCallback(data){
  	console.debug("receive change data:" + JSON.stringify(data));
  	appAccountManager.off('change', function(){
  		console.debug("off finish");
Z
zengyawen 已提交
967
  	})
Z
zhaoyuan17 已提交
968 969 970 971 972 973 974 975 976
  }
  try{
  	appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback);
  }
  catch(err){
  	console.error("on accountOnOffDemo err:" + JSON.stringify(err));
  }
  ```

J
jidong 已提交
977 978
### authenticate<sup>8+</sup>

Z
zengyawen 已提交
979
authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
J
jidong 已提交
980

981
对应用帐户进行鉴权以获取OAuth令牌,使用callback回调异步返回结果。
J
jidong 已提交
982

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

Z
zengyawen 已提交
985
**参数:**
J
jidong 已提交
986

H
HelloCrease 已提交
987 988 989 990 991 992 993
| 参数名      | 类型                    | 必填   | 说明              |
| -------- | --------------------- | ---- | --------------- |
| name     | string                | 是    | 要鉴权的应用帐号名称。     |
| owner    | string                | 是    | 要鉴权的应用帐号所有者包名。  |
| authType | string                | 是    | 鉴权类型。           |
| options  | {[key: string]: any}  | 是    | 鉴权所需的可选项。       |
| callback | AuthenticatorCallback | 是    | 认证器回调,用于返回鉴权结果。 |
Z
zengyawen 已提交
994 995

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

Z
zhangalong 已提交
997
  ```js
J
jidong 已提交
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
  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));
      });
  }

  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.authenticate("LiSi", "com.example.ohos.accountjsdemo", "readAge", {}, {
    onResult: onResultCallback,
    onRequestRedirected: onRequestRedirectedCallback
  });
  ```

### getOAuthToken<sup>8+</sup>

Z
zengyawen 已提交
1021
getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback&lt;string&gt;): void
J
jidong 已提交
1022

1023
获取指定应用帐号和鉴权类型的OAuth令牌,使用callback回调异步返回结果。
J
jidong 已提交
1024

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

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

H
HelloCrease 已提交
1029 1030 1031 1032 1033 1034
| 参数名      | 类型                          | 必填   | 说明          |
| -------- | --------------------------- | ---- | ----------- |
| name     | string                      | 是    | 应用帐号的名称。    |
| owner    | string                      | 是    | 应用帐号的所有者包名。 |
| authType | string                      | 是    | 鉴权类型。       |
| callback | AsyncCallback&lt;string&gt; | 是    | 查询结果的回调。    |
J
jidong 已提交
1035

Z
zengyawen 已提交
1036
**示例:**
J
jidong 已提交
1037

Z
zhangalong 已提交
1038
  ```js
J
jidong 已提交
1039 1040 1041 1042 1043 1044 1045 1046 1047
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", (err, data) => {
       console.log('getOAuthToken err: ' + JSON.stringify(err));
       console.log('getOAuthToken token: ' + data);
  });
  ```

### getOAuthToken<sup>8+</sup>

Z
zengyawen 已提交
1048
getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&gt;
J
jidong 已提交
1049 1050 1051

获取指定应用帐户和鉴权类型的OAuth令牌,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
1054
**参数:**
J
jidong 已提交
1055

H
HelloCrease 已提交
1056 1057 1058 1059 1060
| 参数名      | 类型     | 必填   | 说明          |
| -------- | ------ | ---- | ----------- |
| name     | string | 是    | 应用帐号的名称。    |
| owner    | string | 是    | 应用帐号的所有者包名。 |
| authType | string | 是    | 鉴权类型。       |
J
jidong 已提交
1061

Z
zengyawen 已提交
1062
**参数:**
J
jidong 已提交
1063

H
HelloCrease 已提交
1064 1065
| 类型                    | 说明                    |
| --------------------- | --------------------- |
Z
zengyawen 已提交
1066 1067 1068
| Promise&lt;string&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
1070
  ```js
J
jidong 已提交
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge").then((data) => {
       console.log('getOAuthToken token: ' + data);
  }).catch((err) => {
      console.log("getOAuthToken err: "  + JSON.stringify(err));
  });
  ```

### setOAuthToken<sup>8+</sup>

Z
zengyawen 已提交
1081
setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
1082

1083
设置指定应用帐号和鉴权类型的OAuth令牌,使用callback回调异步返回结果。
J
jidong 已提交
1084

Z
zengyawen 已提交
1085 1086 1087
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1089 1090 1091 1092 1093 1094
| 参数名      | 类型                        | 必填   | 说明       |
| -------- | ------------------------- | ---- | -------- |
| name     | string                    | 是    | 应用帐号的名称。 |
| authType | string                    | 是    | 鉴权类型。    |
| token    | string                    | 是    | OAuth令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 设置结果的回调。 |
J
jidong 已提交
1095

Z
zengyawen 已提交
1096
**示例:**
J
jidong 已提交
1097

Z
zhangalong 已提交
1098
  ```js
J
jidong 已提交
1099 1100 1101 1102 1103 1104 1105 1106
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setOAuthToken("LiSi", "readAge", "xxxx", (err) => {
      console.log('setOAuthToken err: ' + JSON.stringify(err));
  });
  ```

### setOAuthToken<sup>8+</sup>

Z
zengyawen 已提交
1107
setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt;
J
jidong 已提交
1108 1109 1110

设置指定应用帐户和鉴权类型的OAuth令牌,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
1113
**参数:**
J
jidong 已提交
1114

H
HelloCrease 已提交
1115 1116 1117 1118 1119
| 参数名      | 类型     | 必填   | 说明       |
| -------- | ------ | ---- | -------- |
| name     | string | 是    | 应用帐号的名称。 |
| authType | string | 是    | 鉴权类型。    |
| token    | string | 是    | OAuth令牌。 |
J
jidong 已提交
1120

Z
zengyawen 已提交
1121
**参数:**
J
jidong 已提交
1122

H
HelloCrease 已提交
1123 1124
| 类型                  | 说明                    |
| ------------------- | --------------------- |
Z
zengyawen 已提交
1125 1126 1127
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
1129
  ```js
J
jidong 已提交
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setOAuthToken("LiSi", "readAge", "xxxx").then(() => {
      console.log('setOAuthToken successfully');
  }).catch((err) => {
      console.log('setOAuthToken err: ' + JSON.stringify(err));
  });
  ```

### deleteOAuthToken<sup>8+</sup>

Z
zengyawen 已提交
1140
deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
1141 1142 1143

删除指定应用帐户和鉴权类型的OAuth令牌,使用callback回调异步返回结果。

Z
zengyawen 已提交
1144 1145 1146
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1148 1149 1150 1151 1152 1153 1154
| 参数名      | 类型                        | 必填   | 说明           |
| -------- | ------------------------- | ---- | ------------ |
| name     | string                    | 是    | 应用帐号的名称。     |
| owner    | string                    | 是    | 应用帐号的所有者包名。  |
| authType | string                    | 是    | 鉴权类型。        |
| token    | string                    | 是    | 要删除的OAuth令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是    | 删除结果的回调。     |
J
jidong 已提交
1155

Z
zengyawen 已提交
1156
**示例:**
J
jidong 已提交
1157

Z
zhangalong 已提交
1158
  ```js
J
jidong 已提交
1159 1160 1161 1162 1163 1164 1165 1166
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", "xxxxx", (err) => {
       console.log('deleteOAuthToken err: ' + JSON.stringify(err));
  });
  ```

### deleteOAuthToken<sup>8+</sup>

Z
zengyawen 已提交
1167
deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise&lt;void&gt;
J
jidong 已提交
1168 1169 1170

删除指定应用帐户和鉴权类型的OAuth令牌,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
1173
**参数:**
J
jidong 已提交
1174

H
HelloCrease 已提交
1175 1176 1177 1178 1179 1180
| 参数名      | 类型     | 必填   | 说明           |
| -------- | ------ | ---- | ------------ |
| name     | string | 是    | 应用帐号的名称。     |
| owner    | string | 是    | 应用帐号的所有者包名。  |
| authType | string | 是    | 鉴权类型。        |
| token    | string | 是    | 要删除的OAuth令牌。 |
J
jidong 已提交
1181

Z
zengyawen 已提交
1182
**参数:**
J
jidong 已提交
1183

H
HelloCrease 已提交
1184 1185
| 类型                  | 说明                    |
| ------------------- | --------------------- |
Z
zengyawen 已提交
1186 1187 1188
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
1190
  ```js
J
jidong 已提交
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", "xxxxx").then(() => {
       console.log('deleteOAuthToken successfully');
  }).catch((err) => {
      console.log("deleteOAuthToken err: "  + JSON.stringify(err));
  });
  ```

### setOAuthTokenVisibility<sup>8+</sup>

Z
zengyawen 已提交
1201
setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback&lt;void&gt;): void
J
jidong 已提交
1202 1203 1204

设置指定鉴权类型的OAuth令牌对特定应用的可见性,使用callback回调异步返回结果。

Z
zengyawen 已提交
1205 1206 1207
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1209 1210 1211 1212 1213 1214 1215
| 参数名        | 类型                        | 必填   | 说明                        |
| ---------- | ------------------------- | ---- | ------------------------- |
| name       | string                    | 是    | 应用帐号的名称。                  |
| authType   | string                    | 是    | 鉴权类型。                     |
| bundleName | string                    | 是    | 被设置可见性的应用包名。              |
| isVisible  | boolean                   | 是    | 是否可见。当设置成true可见,false不可见。 |
| callback   | AsyncCallback&lt;void&gt; | 是    | 设置结果的回调。                  |
J
jidong 已提交
1216

Z
zengyawen 已提交
1217
**示例:**
J
jidong 已提交
1218

Z
zhangalong 已提交
1219
  ```js
J
jidong 已提交
1220 1221 1222 1223 1224 1225 1226 1227
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true, (err) => {
       console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err));
  });
  ```

### setOAuthTokenVisibility<sup>8+</sup>

Z
zengyawen 已提交
1228
setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise&lt;void&gt;
J
jidong 已提交
1229 1230 1231

设置指定鉴权类型的OAuth令牌对特定应用的可见性,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
1234
**参数:**
J
jidong 已提交
1235

H
HelloCrease 已提交
1236 1237 1238 1239 1240 1241
| 参数名        | 类型      | 必填   | 说明           |
| ---------- | ------- | ---- | ------------ |
| name       | string  | 是    | 应用帐号的名称。     |
| authType   | string  | 是    | 鉴权类型。        |
| bundleName | string  | 是    | 被设置可见性的应用包名。 |
| isVisible  | boolean | 是    | 是否可见。        |
J
jidong 已提交
1242

Z
zengyawen 已提交
1243
**参数:**
J
jidong 已提交
1244

H
HelloCrease 已提交
1245 1246
| 类型                  | 说明                    |
| ------------------- | --------------------- |
Z
zengyawen 已提交
1247 1248 1249
| Promise&lt;void&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
1251
  ```js
J
jidong 已提交
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then(() => {
      console.log('setOAuthTokenVisibility successfully');
  }).catch((err) => {
      console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err));
  });
  ```

### checkOAuthTokenVisibility<sup>8+</sup>

Z
zengyawen 已提交
1262
checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
J
jidong 已提交
1263 1264 1265

检查指定鉴权类型的OAuth令牌对特定应用的可见性,使用callback回调异步返回结果。

Z
zengyawen 已提交
1266 1267 1268
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1270 1271 1272 1273 1274 1275
| 参数名        | 类型                           | 必填   | 说明          |
| ---------- | ---------------------------- | ---- | ----------- |
| name       | string                       | 是    | 应用帐号的名称。    |
| authType   | string                       | 是    | 鉴权类型。       |
| bundleName | string                       | 是    | 检查可见性的应用包名。 |
| callback   | AsyncCallback&lt;boolean&gt; | 是    | 检查结果的回调。    |
J
jidong 已提交
1276

Z
zengyawen 已提交
1277
**示例:**
J
jidong 已提交
1278

Z
zhangalong 已提交
1279
  ```js
J
jidong 已提交
1280 1281 1282 1283 1284 1285 1286 1287 1288
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true, (err, data) => {
      console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err));
      console.log('checkOAuthTokenVisibility isVisible: ' + data);
  });
  ```

### checkOAuthTokenVisibility<sup>8+</sup>

Z
zengyawen 已提交
1289
checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise&lt;boolean&gt;
J
jidong 已提交
1290 1291 1292

检查指定鉴权类型的OAuth令牌对特定应用的可见性,使用Promise方式异步返回结果。

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

Z
zengyawen 已提交
1295
**参数:**
J
jidong 已提交
1296

H
HelloCrease 已提交
1297 1298 1299 1300 1301
| 参数名        | 类型     | 必填   | 说明            |
| ---------- | ------ | ---- | ------------- |
| name       | string | 是    | 应用帐号的名称。      |
| authType   | string | 是    | 鉴权类型。         |
| bundleName | string | 是    | 用于检查可见性的应用包名。 |
J
jidong 已提交
1302

Z
zengyawen 已提交
1303
**参数:**
J
jidong 已提交
1304

H
HelloCrease 已提交
1305 1306
| 类型                     | 说明                    |
| ---------------------- | --------------------- |
Z
zengyawen 已提交
1307 1308 1309
| Promise&lt;boolean&gt; | Promise实例,用于获取异步返回结果。 |

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

Z
zhangalong 已提交
1311
  ```js
J
jidong 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then((data) => {
      console.log('checkOAuthTokenVisibility isVisible: ' + data);
  }).catch((err) => {
      console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err));
  });
  ```

### getAllOAuthTokens<sup>8+</sup>

Z
zengyawen 已提交
1322
getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt;): void
J
jidong 已提交
1323 1324 1325

获取指定应用对调用方全部可见的OAuth令牌,使用callback回调异步返回结果。

Z
zengyawen 已提交
1326 1327 1328
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1330 1331 1332 1333 1334
| 参数名      | 类型                                       | 必填   | 说明          |
| -------- | ---------------------------------------- | ---- | ----------- |
| name     | string                                   | 是    | 应用帐号的名称。    |
| owner    | string                                   | 是    | 应用帐号的所有者包名。 |
| callback | AsyncCallback&lt;Array&lt; [OAuthTokenInfo](#oauthtokeninfo8)&gt;&gt; | 是    | 查询结果的回调。    |
J
jidong 已提交
1335

1336
**示例:** 
J
jidong 已提交
1337

Z
zhangalong 已提交
1338
  ```js
J
jidong 已提交
1339 1340 1341 1342 1343 1344 1345 1346 1347
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo", (err, data) => {
      console.log("getAllOAuthTokens err: "  + JSON.stringify(err));
      console.log('getAllOAuthTokens data: ' + JSON.stringify(data));
  });
  ```

### getAllOAuthTokens<sup>8+</sup>

Z
zengyawen 已提交
1348
getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenInfo&gt;&gt;
J
jidong 已提交
1349 1350 1351

获取指定应用帐户对调用方可见的全部OAuth令牌,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1352 1353 1354
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1356 1357 1358 1359
| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
| name  | string | 是    | 应用帐号的名称。    |
| owner | string | 是    | 应用帐号的所有者包名。 |
J
jidong 已提交
1360

Z
zengyawen 已提交
1361
**参数:**
J
jidong 已提交
1362

H
HelloCrease 已提交
1363 1364
| 类型                                       | 说明                    |
| ---------------------------------------- | --------------------- |
1365
| Promise&lt;Array&lt; [OAuthTokenInfo](#oauthtokeninfo8)&gt;&gt; | Promise实例,用于获取异步返回结果。 |
J
jidong 已提交
1366

Z
zengyawen 已提交
1367
**示例:**
J
jidong 已提交
1368

Z
zhangalong 已提交
1369
  ```js
J
jidong 已提交
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => {
       console.log('getAllOAuthTokens data: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getAllOAuthTokens err: "  + JSON.stringify(err));
  });
  ```

### getOAuthList<sup>8+</sup>

Z
zengyawen 已提交
1380
getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
J
jidong 已提交
1381 1382 1383

获取指定应用帐户和鉴权类型的OAuth令牌的授权列表,使用callback回调异步返回结果。

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

Z
zengyawen 已提交
1386
**参数:**
J
jidong 已提交
1387

H
HelloCrease 已提交
1388 1389 1390 1391 1392
| 参数名      | 类型                                       | 必填   | 说明                      |
| -------- | ---------------------------------------- | ---- | ----------------------- |
| name     | string                                   | 是    | 应用帐号的名称。                |
| authType | string                                   | 是    | 应用帐号的鉴权类型的OAuth令牌的授权列表。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 查询结果的回调。                |
Z
zengyawen 已提交
1393 1394

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

Z
zhangalong 已提交
1396
  ```js
J
jidong 已提交
1397 1398 1399 1400 1401 1402 1403 1404 1405
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "readAge", (err, data) => {
       console.log('getOAuthList err: ' + JSON.stringify(err));
       console.log('getOAuthList data: ' + JSON.stringify(data));
  });
  ```

### getOAuthList<sup>8+</sup>

Z
zengyawen 已提交
1406
getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;
J
jidong 已提交
1407 1408 1409

获取指定应用帐户和鉴权类型的OAuth令牌的授权列表,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1410 1411 1412
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1414 1415 1416 1417
| 参数名      | 类型     | 必填   | 说明                      |
| -------- | ------ | ---- | ----------------------- |
| name     | string | 是    | 应用帐号的名称。                |
| authType | string | 是    | 应用帐号的鉴权类型的OAuth令牌的授权列表。 |
J
jidong 已提交
1418

Z
zengyawen 已提交
1419
**参数:**
J
jidong 已提交
1420

H
HelloCrease 已提交
1421 1422
| 类型                                 | 说明                    |
| ---------------------------------- | --------------------- |
Z
zengyawen 已提交
1423
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例,用于获取异步返回结果。 |
J
jidong 已提交
1424

Z
zengyawen 已提交
1425
**示例:**
J
jidong 已提交
1426

Z
zhangalong 已提交
1427
  ```js
J
jidong 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "readAge").then((data) => {
       console.log('getOAuthList data: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getOAuthList err: "  + JSON.stringify(err));
  });
  ```

### getAuthenticatorCallback<sup>8+</sup>

Z
zengyawen 已提交
1438
getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;AuthenticatorCallback&gt;): void
J
jidong 已提交
1439 1440 1441

获取鉴权会话的认证器回调,使用callback回调异步返回结果。

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

Z
zengyawen 已提交
1444
**参数:**
J
jidong 已提交
1445

H
HelloCrease 已提交
1446 1447 1448 1449
| 参数名       | 类型                                       | 必填   | 说明       |
| --------- | ---------------------------------------- | ---- | -------- |
| sessionId | string                                   | 是    | 鉴权会话的标识。 |
| callback  | AsyncCallback&lt;AuthenticatorCallback&gt; | 是    | 查询结果的回调。 |
Z
zengyawen 已提交
1450 1451

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

Z
zhangalong 已提交
1453
  ```js
1454
  import featureAbility from '@ohos.ability.featureAbility';
J
jidong 已提交
1455 1456
  const appAccountManager = account_appAccount.createAppAccountManager();
  featureAbility.getWant((err, want) => {
J
jidong 已提交
1457
    var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
J
jidong 已提交
1458
    appAccountManager.getAuthenticatorCallback(sessionId, (err, callback) => {
J
jidong 已提交
1459
        if (err.code != account_appAccount.ResultCode.SUCCESS) {
J
jidong 已提交
1460 1461 1462
            console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
            return;
        }
J
jidong 已提交
1463 1464 1465 1466 1467
        var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
                      [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo",
                      [account_appAccount.Constants.KEY_AUTH_TYPE]: "readAge",
                      [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
        callback.OnResult(account_appAccount.ResultCode.SUCCESS, result);
J
jidong 已提交
1468 1469 1470 1471 1472 1473
    });
  });
  ```

### getAuthenticatorCallback<sup>8+</sup>

Z
zengyawen 已提交
1474
getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt;
J
jidong 已提交
1475 1476 1477

获取鉴权会话的认证器回调,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1478 1479 1480
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1482 1483 1484
| 参数名       | 类型     | 必填   | 说明       |
| --------- | ------ | ---- | -------- |
| sessionId | string | 是    | 鉴权会话的标识。 |
J
jidong 已提交
1485

Z
zengyawen 已提交
1486
**参数:**
J
jidong 已提交
1487

H
HelloCrease 已提交
1488 1489
| 类型                                   | 说明                    |
| ------------------------------------ | --------------------- |
Z
zengyawen 已提交
1490
| Promise&lt;AuthenticatorCallback&gt; | Promise实例,用于获取异步返回结果。 |
J
jidong 已提交
1491

Z
zengyawen 已提交
1492
**示例:**
J
jidong 已提交
1493

Z
zhangalong 已提交
1494
  ```js
J
jidong 已提交
1495 1496
  const appAccountManager = account_appAccount.createAppAccountManager();
  featureAbility.getWant().then((want) => {
J
jidong 已提交
1497
      var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
J
jidong 已提交
1498
      appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
J
jidong 已提交
1499 1500 1501 1502 1503
          var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
                        [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo",
                        [account_appAccount.Constants.KEY_AUTH_TYPE]: "readAge",
                        [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
          callback.OnResult(account_appAccount.ResultCode.SUCCESS, result);
J
jidong 已提交
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
      }).catch((err) => {
          console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
      });
  }).catch((err) => {
      console.log("getWant err: "  + JSON.stringify(err));
  });
  ```

### getAuthenticatorInfo<sup>8+</sup>

Z
zengyawen 已提交
1514
getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void
J
jidong 已提交
1515

1516
获取指定应用帐号的认证器信息,使用callback回调异步返回结果。
J
jidong 已提交
1517

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

Z
zengyawen 已提交
1520
**参数:**
J
jidong 已提交
1521

H
HelloCrease 已提交
1522 1523 1524 1525
| 参数名      | 类型                                     | 必填   | 说明          |
| -------- | -------------------------------------- | ---- | ----------- |
| owner    | string                                 | 是    | 应用帐号的所有者包名。 |
| callback | AsyncCallback&lt;AuthenticatorInfo&gt; | 是    | 查询结果的回调。    |
Z
zengyawen 已提交
1526 1527

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

Z
zhangalong 已提交
1529
  ```js
J
jidong 已提交
1530 1531 1532 1533 1534 1535 1536 1537 1538
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo", (err, data) => {
      console.log("getAuthenticatorInfo err: "  + JSON.stringify(err));
      console.log('getAuthenticatorInfo data: ' + JSON.stringify(data));
  });
  ```

### getAuthenticatorInfo<sup>8+</sup>

Z
zengyawen 已提交
1539
getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
J
jidong 已提交
1540 1541 1542

获取指定应用帐户的认证器信息,使用Promise方式异步返回结果。

Z
zengyawen 已提交
1543 1544 1545
**系统能力:** SystemCapability.Account.AppAccount

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

H
HelloCrease 已提交
1547 1548 1549
| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
| owner | string | 是    | 应用帐号的所有者包名。 |
J
jidong 已提交
1550

Z
zengyawen 已提交
1551
**参数:**
J
jidong 已提交
1552

H
HelloCrease 已提交
1553 1554
| 类型                               | 说明                    |
| -------------------------------- | --------------------- |
Z
zengyawen 已提交
1555
| Promise&lt;AuthenticatorInfo&gt; | Promise实例,用于获取异步返回结果。 |
J
jidong 已提交
1556

Z
zengyawen 已提交
1557
**示例:**
J
jidong 已提交
1558

Z
zhangalong 已提交
1559
  ```js
J
jidong 已提交
1560 1561 1562 1563 1564 1565 1566 1567
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => { 
       console.log('getAuthenticatorInfo: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("getAuthenticatorInfo err: "  + JSON.stringify(err));
  });
  ```

J
jidong 已提交
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937
### checkAppAccess<sup>9+</sup>

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

检查指定应用帐户对特定应用是否授权,使用callback回调异步返回结果。

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

**参数:**

| 参数名      | 类型                         | 必填  | 说明             |
| ---------- | ---------------------------- | ----- | ---------------- |
| name       | string                       | 是    | 应用帐户的名称。   |
| bundleName | string                       | 是    | 被检查的应用包名。 |
| callback   | AsyncCallback&lt;boolean&gt; | 是    | 检查结果的回调。   |

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkAppAccess("zhangsan", "com.example.ohos.accountjsdemo", (err, data) => {
      console.log('checkAppAccess: ' + JSON.stringify(data));
      console.log("checkAppAccess err: "  + JSON.stringify(err));
  });
  ```

### checkAppAccess<sup>9+</sup>

checkAppAccess(name: string, bundleName: string): Promise&lt;boolean&gt;

检查指定应用帐户对特定应用是否授权,使用Promise方式异步返回结果。

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

**参数:**

| 参数名      | 类型   | 必填   | 说明             |
| ---------- | ------ | ----- | ---------------- |
| name       | string | 是    | 应用帐户的名称。   |
| bundleName | string | 是    | 被检查的应用包名。 |

**参数:**

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

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkAppAccess("zhangsan", "com.example.ohos.accountjsdemo").then((data) => {
       console.log('checkAppAccess: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("checkAppAccess err: "  + JSON.stringify(err));
  });
  ```

### deleteAccountCredential<sup>9+</sup>

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

删除指定应用帐户的指定类型的凭据信息,使用callback回调异步返回结果。

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

**参数:**

| 参数名         | 类型                       | 必填  | 说明            |
| -------------- | ------------------------- | ----- | -------------- |
| name           | string                    | 是    | 应用帐户的名称。 |
| credentialType | string                    | 是    | 凭据类型。      |
| callback       | AsyncCallback&lt;void&gt; | 是    | 删除结果的回调。 |

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.deleteAccountCredential("zhangsan", "pin", (err, data) => {
      console.log('deleteAccountCredential: ' + JSON.stringify(data));
      console.log("deleteAccountCredential err: "  + JSON.stringify(err));
  });
  ```

### deleteAccountCredential<sup>9+</sup>

deleteAccountCredential(name: string, credentialType: string): Promise&lt;void&gt;

删除指定应用帐户的指定类型的凭据信息,使用Promise方式异步返回结果。

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

**参数:**

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

**参数:**

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

**示例:**

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

### checkAccountLabels<sup>9+</sup>

checkAccountLabels(name: string, owner: string, labels: Array&lt;string&gt;, callback: AsyncCallback&lt;boolean&gt;): void;

检查指定帐户是否具有特定的标签集合,使用callback回调异步返回结果。

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

**参数:**

| 参数名         | 类型                       | 必填  | 说明             |
| -------------- | ------------------------- | ----- | --------------- |
| name           | string                    | 是    | 应用帐户的名称。  |
| owner          | string                    | 是    | 应用帐户的所有者。|
| labels         | Array&lt;string&lt;       | 是    | 标签数组。       |
| callback       | AsyncCallback&lt;void&gt; | 是    | 检查结果的回调。  |

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", (err, data) => {
      console.log('checkAccountLabels: ' + JSON.stringify(data));
      console.log("checkAccountLabels err: "  + JSON.stringify(err));
  });
  ```

### checkAccountLabels<sup>9+</sup>

checkAccountLabels(name: string, owner: string, labels: Array&lt;string&gt;): Promise&lt;void&gt;

检查指定帐户是否具有特定的标签集合,使用Promise方式异步返回结果。

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

**参数:**

| 参数名         | 类型                       | 必填  | 说明             |
| -------------- | ------------------------- | ----- | --------------- |
| name           | string                    | 是    | 应用帐户的名称。  |
| owner          | string                    | 是    | 应用帐户的所有者。|
| labels         | Array&lt;string&lt;       | 是    | 标签数组。       |

**参数:**

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

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo").then((data) => {
       console.log('checkAccountLabels: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("checkAccountLabels err: "  + JSON.stringify(err));
  });
  ```

### selectAccountsByOptions<sup>9+</sup>

selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;);

根据选项选择请求方可访问的帐号列表,使用callback回调异步返回结果。

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

**参数:**

| 参数名         | 类型                                 | 必填  | 说明             |
| -------------- | ----------------------------------- | ----- | --------------- |
| options        | SelectAccountsOptions               | 是    | 选择帐户的选项。  |
| callback       | AsyncCallback&lt;AppAccountInfo&gt; | 是    | 选择结果的回调。  |

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  var options = {
    allowedOwners: ["com.example.ohos.accountjsdemo"]
  };
  appAccountManager.selectAccountsByOptions(options, (err, data) => {
      console.log('selectAccountsByOptions: ' + JSON.stringify(data));
      console.log("selectAccountsByOptions err: "  + JSON.stringify(err));
  });
  ```

### selectAccountsByOptions<sup>9+</sup>

selectAccountsByOptions(options: SelectAccountsOptions): Promise&lt;void&gt;

根据选项选择请求方可访问的帐户列表,使用Promise方式异步返回结果。

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

**参数:**

| 参数名         | 类型                       | 必填  | 说明             |
| -------------- | ------------------------- | ----- | --------------- |
| options        | SelectAccountsOptions     | 是    | 选择帐户的选项。  |

**参数:**

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

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  var options = {
    allowedOwners: ["com.example.ohos.accountjsdemo"]
  };
  appAccountManager.selectAccountsByOptions(options).then((data) => {
       console.log('selectAccountsByOptions: ' + JSON.stringify(data));
  }).catch((err) => {
      console.log("selectAccountsByOptions err: "  + JSON.stringify(err));
  });
  ```

### verifyCredential<sup>9+</sup>

verifyCredential(name: string, owner: string, callback: AuthenticatorCallback): void;

验证用户凭据,使用callback回调异步返回结果。

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

**参数:**

| 参数名    | 类型                  | 必填  | 说明                     |
| -------- | --------------------- | ----- | ----------------------- |
| name     | string                | 是    | 应用帐户的名称。          |
| owner    | string                | 是    | 应用帐户的所有者。        |
| callback | AuthenticatorCallback | 是    | 认证器回调,返回验证结果。 |

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", {
    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));
    }
  });
  ```

### verifyCredential<sup>9+</sup>

verifyCredential(name: string, owner: string, options, callback: AuthenticatorCallback): void;

验证用户凭据,使用callback回调异步返回结果。

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

**参数:**

| 参数名    | 类型                    | 必填  | 说明                     |
| -------- | ----------------------- | ----- | ----------------------- |
| name     | string                  | 是    | 应用帐户的名称。          |
| owner    | string                  | 是    | 应用帐户的所有者。        |
| options  | VerifyCredentialOptions | 是    | 验证凭据的选项。          |
| callback | AuthenticatorCallback   | 是    | 认证器回调,返回验证结果。 |

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  var options = {
    credentialType: "pin",
    credential: "123456"
  };
  appAccountManager.verifyCredential("zhangsan", "com.example.ohos.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));
    }
  });
  ```

### setAuthenticatorProperties<sup>9+</sup>

setAuthenticatorProperties(owner: string, callback: AuthenticatorCallback): void;

设置认证器属性,使用callback回调异步返回结果。

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

**参数:**

| 参数名    | 类型                  | 必填  | 说明                     |
| -------- | --------------------- | ----- | ----------------------- |
| owner    | string                | 是    | 认证器的所有者。          |
| options  | SetPropertiesOptions  | 是    | 设置属性的选项。          |
| callback | AuthenticatorCallback | 是    | 认证器回调,返回设置结果。 |

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  appAccountManager.setAuthenticatorProperties("com.example.ohos.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));
    }
  });
  ```

### setAuthenticatorProperties<sup>9+</sup>

setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthenticatorCallback): void;

设置认证器属性,使用callback回调异步返回结果。

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

**参数:**

| 参数名    | 类型                  | 必填  | 说明                     |
| -------- | --------------------- | ----- | ----------------------- |
| owner    | string                | 是    | 认证器的所有者。          |
| options  | SetPropertiesOptions  | 是    | 设置属性的选项。          |
| callback | AuthenticatorCallback | 是    | 认证器回调,返回设置结果。 |

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  var options = {
    properties: {"prop1": "value1"}
  };
  appAccountManager.setAuthenticatorProperties("com.example.ohos.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));
    }
  });
  ```

Z
zhaoyuan17 已提交
1938 1939
## AppAccountInfo

J
jidong 已提交
1940 1941
表示应用帐号信息。

Z
zengyawen 已提交
1942 1943
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

H
HelloCrease 已提交
1944 1945 1946 1947
| 参数名   | 类型     | 必填   | 说明          |
| ----- | ------ | ---- | ----------- |
| owner | string | 是    | 应用帐号的所有者包名。 |
| name  | string | 是    | 应用帐号的名称。    |
J
jidong 已提交
1948 1949 1950 1951 1952

## OAuthTokenInfo<sup>8+</sup>

表示OAuth令牌信息。

Z
zengyawen 已提交
1953 1954
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

H
HelloCrease 已提交
1955 1956 1957 1958
| 参数名      | 类型     | 必填   | 说明       |
| -------- | ------ | ---- | -------- |
| authType | string | 是    | 令牌的鉴权类型。 |
| token    | string | 是    | 令牌的取值。   |
J
jidong 已提交
1959 1960 1961 1962 1963

## AuthenticatorInfo<sup>8+</sup>

表示OAuth认证器信息。

Z
zengyawen 已提交
1964 1965
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

H
HelloCrease 已提交
1966 1967 1968 1969 1970
| 参数名     | 类型     | 必填   | 说明         |
| ------- | ------ | ---- | ---------- |
| owner   | string | 是    | 认证器的所有者包名。 |
| iconId  | string | 是    | 认证器的图标标识。  |
| labelId | string | 是    | 认证器的标签标识。  |
J
jidong 已提交
1971

J
jidong 已提交
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
## SelectAccountsOptions<sup>9+</sup>

表示用于选择帐号的选项。

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

| 参数名          | 类型                         | 必填  | 说明                |
| --------------- | --------------------------- | ----- | ------------------- |
| allowedAccounts | Array&lt;AppAccountInfo&gt; | 否    | 允许的帐号数组。      |
| allowedOwners   | Array&lt;string&gt;         | 否    | 允许的帐号所有者数组。 |
| requiredLabels  | Array&lt;string&gt;         | 否    | 认证器的标签标识。    |

## VerifyCredentialOptions<sup>9+</sup>

表示用于验证凭据的选项。

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

| 参数名          | 类型                   | 必填  | 说明           |
| -------------- | ---------------------- | ----- | -------------- |
| credentialType | string                 | 否    | 凭据类型。      |
| credential     | string                 | 否    | 凭据取值。      |
| parameters     | {[key:string]: Object} | 否    | 自定义参数对象。 |


## SetPropertiesOptions<sup>9+</sup>

表示用于设置属性的选项。

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

| 参数名     | 类型                    | 必填  | 说明           |
| ---------- | ---------------------- | ----- | -------------- |
| properties | {[key:string]: Object} | 否    | 属性对象。      |
| parameters | {[key:string]: Object} | 否    | 自定义参数对象。 |

J
jidong 已提交
2008 2009 2010 2011
## Constants<sup>8+</sup>

表示常量的枚举。

Z
zengyawen 已提交
2012 2013
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

H
HelloCrease 已提交
2014 2015 2016 2017 2018
| 名称                            | 默认值                    | 说明            |
| ----------------------------- | ---------------------- | ------------- |
| ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作,隐式添加帐号。  |
| ACTION_AUTHENTICATE           | "authenticate"         | 表示操作,鉴权。      |
| KEY_NAME                      | "name"                 | 表示键名,应用帐号名称。  |
2019
| KEY_OWNER                     | "owner"                | 表示键名,应用帐号所有者。 |
H
HelloCrease 已提交
2020 2021 2022 2023 2024 2025 2026
| 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"     | 表示键名,调用方包名。   |
J
jidong 已提交
2027 2028
| KEY_REQUIRED_LABELS           | "requiredLabels"       | 表示键名,必需的标签。   |
| KEY_BOOLEAN_RESULT           | "booleanResult"         | 表示键名,布尔返回值。   |
J
jidong 已提交
2029 2030

## ResultCode<sup>8+</sup>
Z
zhaoyuan17 已提交
2031

J
jidong 已提交
2032
表示返回码的枚举。
Z
zhaoyuan17 已提交
2033

Z
zengyawen 已提交
2034 2035
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。

H
HelloCrease 已提交
2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056
| 名称                                  | 默认值   | 说明           |
| ----------------------------------- | ----- | ------------ |
| 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 已提交
2057

J
jidong 已提交
2058 2059 2060 2061 2062 2063
## AuthenticatorCallback<sup>8+</sup>

OAuth认证器回调接口。

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

Z
zengyawen 已提交
2064
onResult: (code: number, result: {[key: string]: any}) =&gt; void
J
jidong 已提交
2065

J
jidong 已提交
2066
通知请求结果。
J
jidong 已提交
2067

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

Z
zengyawen 已提交
2070
**参数:**
H
HelloCrease 已提交
2071 2072 2073 2074
| 参数名    | 类型                   | 必填   | 说明     |
| ------ | -------------------- | ---- | ------ |
| code   | number               | 是    | 鉴权结果码。 |
| result | {[key: string]: any} | 是    | 鉴权结果。  |
Z
zengyawen 已提交
2075 2076

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

Z
zhangalong 已提交
2078
  ```js
J
jidong 已提交
2079 2080 2081
  const appAccountManager = account_appAccount.createAppAccountManager();
  var sessionId = "1234";
  appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
J
jidong 已提交
2082 2083 2084 2085 2086
      var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
                    [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo",
                    [account_appAccount.Constants.KEY_AUTH_TYPE]: "readAge",
                    [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
      callback.OnResult(account_appAccount.ResultCode.SUCCESS, result);
J
jidong 已提交
2087 2088 2089 2090 2091 2092 2093
  }).catch((err) => {
      console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
  });
  ```

### onRequestRedirected<sup>8+</sup>

Z
zengyawen 已提交
2094
onRequestRedirected: (request: Want) =&gt; void
J
jidong 已提交
2095

J
jidong 已提交
2096
通知请求被跳转。
J
jidong 已提交
2097

Z
zengyawen 已提交
2098 2099 2100
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
H
HelloCrease 已提交
2101 2102 2103
| 参数名     | 类型   | 必填   | 说明         |
| ------- | ---- | ---- | ---------- |
| request | Want | 是    | 用于跳转的请求信息。 |
J
jidong 已提交
2104

Z
zengyawen 已提交
2105
**示例:**
J
jidong 已提交
2106

Z
zhangalong 已提交
2107
  ```js
J
jidong 已提交
2108 2109 2110 2111 2112 2113 2114 2115 2116
  class MyAuthenticator extends account_appAccount.Authenticator {
      addAccountImplicitly(authType, callerBundleName, options, callback) {
          callback.onRequestRedirected({
              bundleName: "com.example.ohos.accountjsdemo",
              abilityName: "com.example.ohos.accountjsdemo.LoginAbility",
          });
      }

      authenticate(name, authType, callerBundleName, options, callback) {
J
jidong 已提交
2117 2118 2119 2120
          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 已提交
2121 2122 2123 2124
      }
  }
  ```

J
jidong 已提交
2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
### onRequestContinued<sup>9+</sup>

onRequestContinued: () =&gt; void

通知请求被继续处理。

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

**示例:**

  ```js
  const appAccountManager = account_appAccount.createAppAccountManager();
  var sessionId = "1234";
  appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => {
      callback.OnRequestContinued();
  }).catch((err) => {
      console.log("getAuthenticatorCallback err: "  + JSON.stringify(err));
  });
  ```

J
jidong 已提交
2145 2146
## Authenticator<sup>8+</sup>

J
jidong 已提交
2147
认证器基类。
J
jidong 已提交
2148 2149 2150

### addAccountImplicitly<sup>8+</sup>

Z
zengyawen 已提交
2151
addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
J
jidong 已提交
2152 2153 2154

根据指定的鉴权类型和可选项,隐式地添加应用帐户,并使用callback回调异步返回结果。

Z
zengyawen 已提交
2155 2156 2157
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
H
HelloCrease 已提交
2158 2159 2160 2161 2162 2163
| 参数名              | 类型                    | 必填   | 说明              |
| ---------------- | --------------------- | ---- | --------------- |
| authType         | string                | 是    | 应用帐号的鉴权类型。      |
| callerBundleName | string                | 是    | 鉴权请求方的包名。       |
| options          | {[key: string]: any}  | 是    | 鉴权所需要的可选项。      |
| callback         | AuthenticatorCallback | 是    | 认证器回调,用于返回鉴权结果。 |
J
jidong 已提交
2164 2165 2166

### authenticate<sup>8+</sup>

Z
zengyawen 已提交
2167
authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
J
jidong 已提交
2168 2169 2170

对应用帐户进行鉴权,获取OAuth令牌,并使用callback回调异步返回结果。

Z
zengyawen 已提交
2171 2172 2173
**系统能力:** SystemCapability.Account.AppAccount

**参数:**
H
HelloCrease 已提交
2174 2175 2176 2177 2178 2179 2180
| 接口名              | 类型                    | 必填   | 说明              |
| ---------------- | --------------------- | ---- | --------------- |
| name             | string                | 是    | 应用帐号的名称。        |
| authType         | string                | 是    | 应用帐号的鉴权类型。      |
| callerBundleName | string                | 是    | 鉴权请求方的包名。       |
| options          | {[key: string]: any}  | 是    | 鉴权所需要的可选项。      |
| callback         | AuthenticatorCallback | 是    | 认证器回调,用于返回鉴权结果。 |
J
jidong 已提交
2181

J
jidong 已提交
2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
### verifyCredential<sup>9+</sup>

verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback): void;

验证应用帐户的凭据,并使用callback回调异步返回结果。

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

**参数:**
| 接口名     | 类型                     | 必填   | 说明                        |
| --------- | ------------------------ | -- -- | --------------------------- |
| name      | string                   | 是    | 应用帐号的名称。              |
| options   | VerifyCredentialOptions  | 是    | 验证凭据的可选项。            |
| callback  | AuthenticatorCallback    | 是    | 认证器回调,用于返回验证结果。 |

### setProperties<sup>9+</sup>

setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback): void;

设置认证器属性,并使用callback回调异步返回结果。

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

**参数:**
| 接口名     | 类型                  | 必填   | 说明                        |
| --------- | --------------------- | -- -- | --------------------------- |
| options   | SetPropertiesOptions  | 是    | 设置属性的可选项。            |
| callback  | AuthenticatorCallback | 是    | 认证器回调,用于返回设置结果。 |

### checkAccountLabels<sup>9+</sup>

checkAccountLabels(name: string, labels: Array&lt;string&gt;, callback: AuthenticatorCallback): void;

检查帐号标签,并使用callback回调异步返回结果。

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

**参数:**
| 接口名     | 类型                  | 必填   | 说明                        |
| --------- | --------------------- | -- -- | --------------------------- |
| name      | string                | 是    | 应用帐号的名称。              |
| labels    | Array<string>         | 是    | 标签数组。                   |
| callback  | AuthenticatorCallback | 是    | 认证器回调,用于返回检查结果。 |

### isAccountRemovable<sup>9+</sup>

isAccountRemovable(name: string, callback: AuthenticatorCallback): void;

判断帐号是否可以删除,并使用callback回调异步返回结果。

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

**参数:**
| 接口名     | 类型                  | 必填   | 说明                        |
| --------- | --------------------- | -- -- | --------------------------- |
| name      | string                | 是    | 应用帐号的名称。              |
| callback  | AuthenticatorCallback | 是    | 认证器回调,用于返回判断结果。 |

### getRemoteObject<sup>9+</sup>

getRemoteObject(): rpc.RemoteObject;

获取认证器的远程对象,不可以重载实现。

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

Z
zengyawen 已提交
2248
**示例:**
J
jidong 已提交
2249

Z
zhangalong 已提交
2250
  ```js
J
jidong 已提交
2251 2252 2253 2254 2255 2256 2257 2258 2259
  class MyAuthenticator extends account_appAccount.Authenticator {
      addAccountImplicitly(authType, callerBundleName, options, callback) {
          callback.onRequestRedirected({
              bundleName: "com.example.ohos.accountjsdemo",
              abilityName: "com.example.ohos.accountjsdemo.LoginAbility",
          });
      }

      authenticate(name, authType, callerBundleName, options, callback) {
J
jidong 已提交
2260 2261 2262 2263
          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 已提交
2264
      }
J
jidong 已提交
2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288

      verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback) {
          callback.onRequestRedirected({
              bundleName: "com.example.ohos.accountjsdemo",
              abilityName: "com.example.ohos.accountjsdemo.VerifyAbility",
              parameters: {
                name: name
              }
          });
      }

      setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback) {
          callback.onResult(account_appAccount.ResultCode.SUCCESS, {});
      }

      checkAccountLabels(name: string, labels: Array&lt;string&gt;, callback: AuthenticatorCallback) {
          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 已提交
2289 2290 2291 2292 2293 2294 2295
  }

  export default {
      onConnect(want) {
          return new MyAuthenticator();
      }
  }
Z
zengyawen 已提交
2296
  ```