Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 a584612c 编写于 作者: W wangyihui
浏览文件
操作

Signed-off-by: wangyihui <wangyihui16@huawei.com> 

Change-Id: I842a55b87070e625ec8f2bffa0c34a0ba0542f7c
上级 d9e5a992
隐藏空白更改
内联 并排
Showing with 2909 addition and 437 deletion
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @ a584612c
...@@ -36,12 +36,110 @@ createAppAccountManager(): AppAccountManager ...@@ -36,12 +36,110 @@ createAppAccountManager(): AppAccountManager
管理应用帐号模块的实例。 管理应用帐号模块的实例。
### addAccount ### createAccount<sup>9+</sup>
createAccount(name: string, callback: AsyncCallback&lt;void&gt;): void;
将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------- |
| name | string | 是 | 要添加的应用帐号名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 将此应用的帐号名添加到帐号管理服务回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.createAccount("WangWu", (err) => {
console.log("createAccount err: " + JSON.stringify(err));
});
} catch (err) {
console.log("createAccount err: " + JSON.stringify(err));
}
```
### createAccount<sup>9+</sup>
createAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void
将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------------------------------- |
| name | string | 是 | 要添加的应用帐号名称。 |
| extraInfo | string | 是 | 要添加的应用帐号的额外信息(能转换string类型的其它信息，如token等)，额外信息不能是应用帐号的敏感信息（如应用账号密码）。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.createAccount("LiSi", "token101", (err) => {
console.log("createAccount err: " + JSON.stringify(err));
});
} catch (err) {
console.log("createAccount err: " + JSON.stringify(err));
}
```
### createAccount<sup>9+</sup>
createAccount(name: string, extraInfo?: string): Promise&lt;void&gt;
将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ---------------------------------------- |
| name | string | 是 | 要添加的应用帐号名称。 |
| extraInfo | string | 否 | 要添加的应用帐号的额外信息（能转换成string类型的其它信息），额外信息不能是应用帐号的敏感信息（如应用账号密码）。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.createAccount("LiSi", "token101").then(()=> {
console.log('createAccount Success');
}).catch((err) => {
console.log("createAccount err: " + JSON.stringify(err));
});
} catch (err) {
console.log("createAccount err: " + JSON.stringify(err));
}
```
### addAccount<sup>(deprecated)</sup>
addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。 将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。
> **说明：**
> 从API version 9开始废弃, 建议使用[createAccount](#createaccount9)替代
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -60,12 +158,15 @@ addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -60,12 +158,15 @@ addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
}); });
``` ```
### addAccount ### addAccount<sup>(deprecated)</sup>
addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void
将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中，使用callback回调异步返回结果。 将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中，使用callback回调异步返回结果。
> **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-1)替代
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -85,14 +186,15 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;) ...@@ -85,14 +186,15 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;)
}); });
``` ```
### addAccount<sup>(deprecated)</sup>
### addAccount
addAccount(name: string, extraInfo?: string): Promise&lt;void&gt; addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;
将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中，使用Promise方式异步返回结果。 将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中，使用Promise方式异步返回结果。
> **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-2)替代
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -119,12 +221,105 @@ addAccount(name: string, extraInfo?: string): Promise&lt;void&gt; ...@@ -119,12 +221,105 @@ addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;
}); });
``` ```
### addAccountImplicitly<sup>8+</sup> ### createAccountImplicitly<sup>9+</sup>
createAccountImplicitly(owner: string, callback: AuthCallback): void
根据指定的帐号所有者隐式地添加应用帐号，并使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ----------------------- |
| owner | string | 是 | 要添加的应用帐号所有者包名。 |
| callback | [AuthCallback](#authcallback9) | 是 | 认证回调，用于返回鉴权结果。 |
**示例：**
```js
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();
try {
appAccountManager.createAccountImplicitly("com.example.ohos.accountjsdemo", {
onResult: onResultCallback,
onRequestRedirected: onRequestRedirectedCallback
});
} catch (err) {
console.log("createAccountImplicitly err: " + JSON.stringify(err));
}
```
### createAccountImplicitly<sup>9+</sup>
createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, callback: AuthCallback): void
根据指定的帐号所有者和可选项隐式地添加应用帐号，并使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ----------------------- |
| owner | string | 是 | 要添加的应用帐号所有者包名。 |
| options | [CreateAccountImplicitlyOptions](#createaccountimplicitlyoptions9) | 是 | 隐式创建账号的选项。 |
| callback | [AuthCallback](#authcallback9) | 是 | 认证回调，用于返回鉴权结果。 |
**示例：**
```js
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();
try {
appAccountManager.createAccountImplicitly("com.example.ohos.accountjsdemo", {
requiredLabels: ["student"], authType: "getSocialData"}, {
onResult: onResultCallback,
onRequestRedirected: onRequestRedirectedCallback
});
} catch (err) {
console.log("createAccountImplicitly err: " + JSON.stringify(err));
}
```
### addAccountImplicitly<sup>(deprecated)</sup>
addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
根据指定的帐号所有者、鉴权类型和可选项隐式地添加应用帐号，并使用callback回调异步返回结果。 根据指定的帐号所有者、鉴权类型和可选项隐式地添加应用帐号，并使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[createAccountImplicitly](#createaccountimplicitly9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -134,7 +329,7 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a ...@@ -134,7 +329,7 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a
| owner | string | 是 | 要添加的应用帐号所有者包名。 | | owner | string | 是 | 要添加的应用帐号所有者包名。 |
| authType | string | 是 | 要添加的应用帐号鉴权类型。鉴权类型为自定义。 | | authType | string | 是 | 要添加的应用帐号鉴权类型。鉴权类型为自定义。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。可选项可根据自己需要设置。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。可选项可根据自己需要设置。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，用于返回鉴权结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 |
**示例：** **示例：**
...@@ -160,12 +355,81 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a ...@@ -160,12 +355,81 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a
}); });
``` ```
### deleteAccount ### removeAccount<sup>9+</sup>
removeAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
从帐号管理服务中移除应用帐号，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------- |
| name | string | 是 | 要删除的应用帐号名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 帐号管理服务中移除应用帐号的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.removeAccount("ZhaoLiu", (err) => {
console.log("removeAccount err: " + JSON.stringify(err));
});
} catch (err) {
console.log("removeAccount err: " + JSON.stringify(err));
}
```
### removeAccount<sup>9+</sup>
deleteAccount(name: string): Promise&lt;void&gt;
从帐号管理服务中移除应用帐号，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------- |
| name | string | 是 | 要移除的应用帐号名称。 |
**返回值：**
| 类型 | 说明 |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.deleteAccount("ZhaoLiu").then(() => {
console.log('removeAccount Success');
}).catch((err) => {
console.log("removeAccount err: " + JSON.stringify(err));
});
} catch (err) {
console.log("removeAccount err: " + JSON.stringify(err));
}
```
### deleteAccount<sup>(deprecated)</sup>
deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
从帐号管理服务中删除应用帐号，使用callback回调异步返回结果。 从帐号管理服务中删除应用帐号，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -184,12 +448,16 @@ deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -184,12 +448,16 @@ deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
}); });
``` ```
### deleteAccount ### deleteAccount<sup>(deprecated)</sup>
deleteAccount(name: string): Promise&lt;void&gt; deleteAccount(name: string): Promise&lt;void&gt;
从帐号管理服务中删除应用帐号，使用Promise方式异步返回结果。 从帐号管理服务中删除应用帐号，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -215,12 +483,84 @@ deleteAccount(name: string): Promise&lt;void&gt; ...@@ -215,12 +483,84 @@ deleteAccount(name: string): Promise&lt;void&gt;
}); });
``` ```
### disableAppAccess ### setAppAccess<sup>9+</sup>
setAppAccess(name: string, bundleName: string, isAccessible: boolean, callback: AsyncCallback&lt;void&gt;): void
设置指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，由isAccessible指明是允许访问还是禁止访问，callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | --------------------------------- |
| name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 |
| isAccessible | boolean | 是 | 访问控制，允许访问或禁止访问。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 访问权限设置的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", true, (err) => {
console.log("enableAppAccess: " + JSON.stringify(err));
});
} catch (err) {
console.log("enableAppAccess: " + JSON.stringify(err));
}
```
### setAppAccess<sup>9+</sup>
setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise&lt;void&gt;
设置指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，由isAccessible指明是允许访问还是禁止访问，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | --------- |
| name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 |
| isAccessible | boolean | 是 | 访问控制，允许访问或禁止访问。 |
**返回值：**
| 类型 | 说明 |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", true).then(() => {
console.log('setAppAccess Success');
}).catch((err) => {
console.log("setAppAccess err: " + JSON.stringify(err));
});
} catch (err) {
console.log("setAppAccess err: " + JSON.stringify(err));
}
```
### disableAppAccess<sup>(deprecated)</sup>
disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void
禁止指定第三方应用帐号名称对指定的第三方应用进行访问，使用callback回调异步返回结果。 禁止指定第三方应用帐号名称对指定的第三方应用进行访问，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -229,7 +569,7 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;vo ...@@ -229,7 +569,7 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;vo
| ---------- | ------------------------- | ---- | --------------------------------- | | ---------- | ------------------------- | ---- | --------------------------------- |
| name | string | 是 | 要禁用访问的第三方应用帐号名称。 | | name | string | 是 | 要禁用访问的第三方应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 | | bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 禁止指定第三方应用帐号名称对指定包名称的第三方应用的回调进行访问。 | | callback | AsyncCallback&lt;void&gt; | 是 | 禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问的回调。 |
**示例：** **示例：**
...@@ -240,12 +580,16 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;vo ...@@ -240,12 +580,16 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;vo
}); });
``` ```
### disableAppAccess ### disableAppAccess<sup>(deprecated)</sup>
disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt; disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问，使用Promise方式异步返回结果。 禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -272,12 +616,16 @@ disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt; ...@@ -272,12 +616,16 @@ disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
}); });
``` ```
### enableAppAccess ### enableAppAccess<sup>(deprecated)</sup>
enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void
允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问，使用callback回调异步返回结果。 允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -286,7 +634,7 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;voi ...@@ -286,7 +634,7 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;voi
| ---------- | ------------------------- | ---- | --------------------------------- | | ---------- | ------------------------- | ---- | --------------------------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 | | bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 允许指定第三方应用帐号名称对指定包名称的第三方应用的回调进行访问。 | | callback | AsyncCallback&lt;void&gt; | 是 | 允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问的回调。 |
**示例：** **示例：**
...@@ -297,12 +645,16 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;voi ...@@ -297,12 +645,16 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;voi
}); });
``` ```
### enableAppAccess ### enableAppAccess<sup>(deprecated)</sup>
enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt; enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
允许指定第三方应用帐号的名称对指定包名称的第三方应用进行访问，使用Promise方式异步返回结果。 允许指定第三方应用帐号的名称对指定包名称的第三方应用进行访问，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -329,22 +681,163 @@ enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt; ...@@ -329,22 +681,163 @@ enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
}); });
``` ```
### checkAppAccountSyncEnable ### checkAppAccess<sup>9+</sup>
checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): void
检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。 checkAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC 查看指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | --------------------- | | ---------- | ------------------------- | ---- | --------------------------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查指定应用帐号是否允许应用数据同步回调。 | | bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 查看访问权限的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.checkAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => {
console.log("checkAppAccess: " + JSON.stringify(err));
});
} catch (err) {
console.log("checkAppAccess: " + JSON.stringify(err));
}
```
### checkAppAccess<sup>9+</sup>
checkAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
查看指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | --------- |
| name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 |
**返回值：**
| 类型 | 说明 |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.checkAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => {
console.log('checkAppAccess Success');
}).catch((err) => {
console.log("checkAppAccess err: " + JSON.stringify(err));
});
} catch (err) {
console.log("checkAppAccess err: " + JSON.stringify(err));
}
```
### checkDataSyncEnabled<sup>9+</sup>
checkDataSyncEnabled(name: string, callback: AsyncCallback&lt;boolean&gt;): void
检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | --------------------- |
| name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查指定应用帐号是否允许应用数据同步回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.checkDataSyncEnabled("ZhangSan", (err, result) => {
console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
console.log('checkDataSyncEnabled result: ' + result);
});
} catch (err) {
console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
}
```
### checkDataSyncEnabled<sup>9+</sup>
checkDataSyncEnabled(name: string): Promise&lt;boolean&gt;
检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------- |
| name | string | 是 | 应用帐号名称。 |
**返回值：**
| 类型 | 说明 |
| :--------------------- | :-------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.checkDataSyncEnabled("ZhangSan").then((data) => {
console.log('checkDataSyncEnabled, result: ' + data);
}).catch((err) => {
console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
});
} catch (err) {
console.log("checkDataSyncEnabled err: " + JSON.stringify(err));
}
```
### checkAppAccountSyncEnable<sup>(deprecated)</sup>
checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): void
检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9)替代。
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | --------------------- |
| name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查指定应用帐号是否允许应用数据同步回调。 |
**示例：** **示例：**
...@@ -356,12 +849,16 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): ...@@ -356,12 +849,16 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;):
}); });
``` ```
### checkAppAccountSyncEnable ### checkAppAccountSyncEnable<sup>(deprecated)</sup>
checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt; checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;
检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。 检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9-1)替代。
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
...@@ -389,12 +886,88 @@ checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt; ...@@ -389,12 +886,88 @@ checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;
}); });
``` ```
### setAccountCredential ### setCredential<sup>9+</sup>
setCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback&lt;void&gt;): void
设置此应用程序帐号的凭据，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------- | ---- | ------------- |
| name | string | 是 | 应用程序帐号名称。 |
| credentialType | string | 是 | 要设置的凭据类型。 |
| credential | string | 是 | 要设置的凭据。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置此应用帐号的凭据回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setCredential("ZhangSan", "credentialType001", "credential001", (err) => {
console.log("setCredential err: " + JSON.stringify(err));
});
} catch (err) {
console.log("setCredential err: " + JSON.stringify(err));
}
```
### setCredential<sup>9+</sup>
setCredential(name: string, credentialType: string, credential: string): Promise&lt;void&gt;
设置此应用程序帐号的凭据，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ---------- |
| name | string | 是 | 应用帐号的名称。 |
| credentialType | string | 是 | 要设置的凭据的类型。 |
| credential | string | 是 | 要设置的凭据。 |
**返回值：**
| 类型 | 说明 |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setCredential("ZhangSan", "credentialType001", "credential001").then(() => {
console.log('setCredential Success');
}).catch((err) => {
console.log("setCredential err: " + JSON.stringify(err));
});
} catch (err) {
console.log("setCredential err: " + JSON.stringify(err));
}
```
### setAccountCredential<sup>(deprecated)</sup>
setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback&lt;void&gt;): void setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback&lt;void&gt;): void
设置此应用程序帐号的凭据，使用callback回调异步返回结果。 设置此应用程序帐号的凭据，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -415,12 +988,16 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca ...@@ -415,12 +988,16 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca
}); });
``` ```
### setAccountCredential ### setAccountCredential<sup>(deprecated)</sup>
setAccountCredential(name: string, credentialType: string, credential: string): Promise&lt;void&gt; setAccountCredential(name: string, credentialType: string, credential: string): Promise&lt;void&gt;
设置此应用程序帐号的凭据，使用Promise方式异步返回结果。 设置此应用程序帐号的凭据，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9-1)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -448,12 +1025,17 @@ setAccountCredential(name: string, credentialType: string, credential: string): ...@@ -448,12 +1025,17 @@ setAccountCredential(name: string, credentialType: string, credential: string):
}); });
``` ```
### setAccountExtraInfo ### setAccountExtraInfo<sup>(deprecated)</sup>
setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void
设置此应用程序帐号的额外信息，使用callback回调异步返回结果。 设置此应用程序帐号的额外信息，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -473,12 +1055,17 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt; ...@@ -473,12 +1055,17 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;
}); });
``` ```
### setAccountExtraInfo ### setAccountExtraInfo<sup>(deprecated)</sup>
setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt; setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;
设置此应用程序帐号的额外信息，使用Promise方式异步返回结果。 设置此应用程序帐号的额外信息，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -504,13 +1091,86 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt; ...@@ -504,13 +1091,86 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;
console.log("setAccountExtraInfo err: " + JSON.stringify(err)); console.log("setAccountExtraInfo err: " + JSON.stringify(err));
}); });
``` ```
### setDataSyncEnabled<sup>9+</sup>
setDataSyncEnabled(name: string, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void
设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------- |
| name | string | 是 | 应用帐号名称。 |
| isEnable | boolean | 是 | 是否允许应用数据同步。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => {
console.log("setDataSyncEnabled err: " + JSON.stringify(err));
});
} catch (err) {
console.log("setDataSyncEnabled err: " + JSON.stringify(err));
}
```
### setDataSyncEnabled<sup>9+</sup>
setDataSyncEnabled(name: string, isEnable: boolean): Promise&lt;void&gt;
设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------- | ---- | ----------- |
| name | string | 是 | 应用帐号名称。 |
| isEnable | boolean | 是 | 是否允许应用数据同步。 |
**返回值：**
| 类型 | 说明 |
| :------------------ | :-------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => {
console.log('setDataSyncEnabled Success');
}).catch((err) => {
console.log("setDataSyncEnabled err: " + JSON.stringify(err));
});
} catch (err) {
console.log("setDataSyncEnabled err: " + JSON.stringify(err));
}
```
### setAppAccountSyncEnable ### setAppAccountSyncEnable<sup>(deprecated)</sup>
setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void
设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。 设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9)替代。
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
...@@ -532,12 +1192,16 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback ...@@ -532,12 +1192,16 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback
}); });
``` ```
### setAppAccountSyncEnable ### setAppAccountSyncEnable<sup>(deprecated)</sup>
setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt; setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;
设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。 设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9-1)替代。
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
...@@ -566,7 +1230,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt; ...@@ -566,7 +1230,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;
}); });
``` ```
### setAssociatedData ### setCustomData<sup>9+</sup>
setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback&lt;void&gt;): void setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback&lt;void&gt;): void
...@@ -587,12 +1251,16 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb ...@@ -587,12 +1251,16 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { try {
console.log("setAssociatedData err: " + JSON.stringify(err)); appAccountManager.setCustomData("ZhangSan", "k001", "v001", (err) => {
}); console.log("setCustomData err: " + JSON.stringify(err));
});
} catch (err) {
console.log("setCustomData err: " + JSON.stringify(err));
}
``` ```
### setAssociatedData ### setCustomData<sup>9+</sup>
setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt; setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;
...@@ -618,219 +1286,213 @@ setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt; ...@@ -618,219 +1286,213 @@ setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { try {
console.log('setAssociatedData Success'); appAccountManager.setCustomData("ZhangSan", "k001", "v001").then(() => {
}).catch((err) => { console.log('setCustomData Success');
console.log("setAssociatedData err: " + JSON.stringify(err)); }).catch((err) => {
}); console.log("setCustomData err: " + JSON.stringify(err));
});
} catch (err) {
console.log("setCustomData err: " + JSON.stringify(err));
}
``` ```
### getAccountCredential ### setAssociatedData<sup>(deprecated)</sup>
getAccountCredential(name: string, credentialType: string, callback: AsyncCallback&lt;string&gt;): void setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback&lt;void&gt;): void
获取此应用帐号的凭据（如数字密码、人脸和PIN码等），使用callback回调异步返回结果。 设置与此应用程序帐号关联的数据，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount > **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9)替代。
>
> 从 API version 7开始支持。
**参数：**
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.AppAccount
| -------------- | --------------------------- | ---- | -------------- |
| name | string | 是 | 应用帐号名称。 |
| credentialType | string | 是 | 获取此应用帐号的凭据的类型。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的凭据的回调。 |
**示例：** **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要设置的数据的键，密钥可以自定义。 |
| value | string | 是 | 要设置的数据的值。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置与此应用帐号关联的数据的回调。 |
**示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => {
console.log("getAccountCredential err: " + JSON.stringify(err)); console.log("setAssociatedData err: " + JSON.stringify(err));
console.log('getAccountCredential result: ' + result);
}); });
``` ```
### getAccountCredential ### setAssociatedData<sup>(deprecated)</sup>
getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt; setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;
设置与此应用程序帐号关联的数据，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9-1)替代。
>
> 从 API version 7开始支持。
获取此应用程序帐号的凭据，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ---------- | | ----- | ------ | ---- | ----------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| credentialType | string | 是 | 要获取的凭据的类型。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 |
| value | string | 是 | 要设置的数据的值。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------------- | :-------------------- | | :------------------ | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => {
console.log('getAccountCredential, result: ' + data); console.log('setAssociatedData Success');
}).catch((err) => { }).catch((err) => {
console.log("getAccountCredential err: " + JSON.stringify(err)); console.log("setAssociatedData err: " + JSON.stringify(err));
}); });
``` ```
### getAccountExtraInfo ### getAllAccounts<sup>9+</sup>
getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void getAllAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
获取此应用帐号的额外信息（能转换成string类型的其它信息），使用callback回调异步返回结果。 获取全部应用已授权帐号信息。
**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- | | -------- | ---------------------------------------- | ---- | --------- |
| name | string | 是 | 应用帐号名称。 | | callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是 | 应用帐号信息列表。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的额外信息回调。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { try {
console.log("getAccountExtraInfo err: " + JSON.stringify(err)); appAccountManager.getAllAccounts((err, data)=>{
console.log('getAccountExtraInfo result: ' + result); console.debug("getAllAccounts err:" + JSON.stringify(err));
}); console.debug("getAllAccounts data:" + JSON.stringify(data));
});
} catch (err) {
console.debug("getAllAccounts err:" + JSON.stringify(err));
}
``` ```
### getAccountExtraInfo ### getAllAccounts<sup>9+</sup>
getAccountExtraInfo(name: string): Promise&lt;string&gt;
获取此应用程序帐号的额外信息，使用Promise方式异步返回结果。 getAllAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
**系统能力：** SystemCapability.Account.AppAccount 获取全部应用已授权帐号信息。
**参数：** **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.AppAccount
| ---- | ------ | ---- | ------- |
| name | string | 是 | 应用帐号名称。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------------- | :-------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { try {
console.log('getAccountExtraInfo, result: ' + data); appAccountManager.getAllAccounts().then((data) => {
}).catch((err) => { console.log('getAllAccounts: ' + data);
console.log("getAccountExtraInfo err: " + JSON.stringify(err)); }).catch((err) => {
}); console.log("getAllAccounts err: " + JSON.stringify(err));
});
} catch (err) {
console.log("getAllAccounts err: " + JSON.stringify(err));
}
``` ```
### getAssociatedData ### getAllAccessibleAccounts<sup>(deprecated)</sup>
getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void
获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ----------------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的键。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取与此应用帐号关联的数据的回调。 |
**示例：**
```js getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => {
console.log("getAssociatedData err: " + JSON.stringify(err));
console.log('getAssociatedData result: ' + result);
});
```
### getAssociatedData 获取全部应用已授权帐号信息。
getAssociatedData(name: string, key: string): Promise&lt;string&gt; > **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9)替代。
>
> 从 API version 7开始支持。
获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------- | | -------- | ---------------------------------------- | ---- | --------- |
| name | string | 是 | 应用帐号名称。 | | callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是 | 应用帐号信息列表。 |
| key | string | 是 | 要获取的数据的键。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { appAccountManager.getAllAccessibleAccounts((err, data)=>{
console.log('getAssociatedData: ' + data); console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err));
}).catch((err) => { console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data));
console.log("getAssociatedData err: " + JSON.stringify(err));
}); });
``` ```
### getAssociatedDataSync<sup>9+</sup> ### getAllAccessibleAccounts<sup>(deprecated)</sup>
getAssociatedDataSync(name: string, key: string): string; getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
获取与此应用程序帐号关联的数据，使用同步方式返回结果。 获取全部应用已授权帐号信息。
**系统能力：** SystemCapability.Account.AppAccount > **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9-1)替代。
>
> 从 API version 7开始支持。
**参数：** **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.AppAccount
| ---- | ------ | ---- | --------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的键。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------------- | :-------------------- | | ---------------------------------------- | --------------------- |
| string | 目标关联数据的取值。 | | Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
var backData = appAccountManager.getAssociatedDataSync("ZhangSan", "k001"); appAccountManager.getAllAccessibleAccounts().then((data) => {
console.info("getAssociatedDataSync backData:" + JSON.stringify(backData)); console.log('getAllAccessibleAccounts: ' + data);
}).catch((err) => {
console.log("getAllAccessibleAccounts err: " + JSON.stringify(err));
});
``` ```
### getAllAccessibleAccounts ### getAccountsByOwner<sup>9+</sup>
getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void getAccountsByOwner(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
获取全部应用已授权帐号信息。 获取指定应用全部帐号信息。
**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。
...@@ -840,23 +1502,29 @@ getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;& ...@@ -840,23 +1502,29 @@ getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- | | -------- | ---------------------------------------- | ---- | --------- |
| owner | string | 是 | 应用包名称。 |
| callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是 | 应用帐号信息列表。 | | callback | AsyncCallback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是 | 应用帐号信息列表。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAllAccessibleAccounts((err, data)=>{ const selfBundle = "com.example.actsgetallaaccounts";
console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err)); try {
console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data)); appAccountManager.getAccountsByOwner(selfBundle, (err, data)=>{
}); console.debug("getAccountsByOwner err:" + JSON.stringify(err));
console.debug("getAccountsByOwner data:" + JSON.stringify(data));
});
} catch (err) {
console.debug("getAccountsByOwner err:" + JSON.stringify(err));
}
``` ```
### getAllAccessibleAccounts ### getAccountsByOwner<sup>9+</sup>
getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt; getAccountsByOwner(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
获取全部应用已授权帐号信息。 获取指定应用全部帐号信息。
**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。
...@@ -864,6 +1532,12 @@ getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt; ...@@ -864,6 +1532,12 @@ getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------ |
| owner | string | 是 | 应用包名称。 |
**返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | Promise实例，用于获取异步返回结果。 |
...@@ -872,19 +1546,28 @@ getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt; ...@@ -872,19 +1546,28 @@ getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAllAccessibleAccounts().then((data) => { const selfBundle = "com.example.actsgetallaaccounts";
console.log('getAllAccessibleAccounts: ' + data); try {
}).catch((err) => { appAccountManager.getAccountsByOwner(selfBundle).then((data) => {
console.log("getAllAccessibleAccounts err: " + JSON.stringify(err)); console.log('getAccountsByOwner: ' + data);
}); }).catch((err) => {
console.log("getAccountsByOwner err: " + JSON.stringify(err));
});
} catch (err) {
console.log("getAccountsByOwner err: " + JSON.stringify(err));
}
``` ```
### getAllAccounts ### getAllAccounts<sup>(deprecated)</sup>
getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
获取指定应用全部帐号信息。 获取指定应用全部帐号信息。
> **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner]替代。
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
...@@ -907,12 +1590,16 @@ getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo ...@@ -907,12 +1590,16 @@ getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo
}); });
``` ```
### getAllAccounts ### getAllAccounts<sup>(deprecated)</sup>
getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt; getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
获取指定应用全部帐号信息。 获取指定应用全部帐号信息。
> **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner](#getaccountsbyowner9-1)替代。
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
...@@ -923,7 +1610,7 @@ getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt; ...@@ -923,7 +1610,7 @@ getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
| ----- | ------ | ---- | ------ | | ----- | ------ | ---- | ------ |
| owner | string | 是 | 应用包名称。 | | owner | string | 是 | 应用包名称。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------------- | | ---------------------------------------- | --------------------- |
...@@ -941,89 +1628,567 @@ getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt; ...@@ -941,89 +1628,567 @@ getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
}); });
``` ```
### on('change') ### getCredential<sup>9+</sup>
on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void getCredential(name: string, credentialType: string, callback: AsyncCallback&lt;string&gt;): void
订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。 获取此应用帐号的凭据（如数字密码、人脸和PIN码等），使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ | | -------------- | --------------------------- | ---- | -------------- |
| type | 'change' | 是 | 关于帐号更改事件，当帐号所有者更新帐号时，订阅者将收到通知。 | | name | string | 是 | 应用帐号名称。 |
| owners | Array&lt;string&gt; | 是 | 指示帐号的所有者。 | | credentialType | string | 是 | 获取此应用帐号的凭据的类型。 |
| callback | Callback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是 | 订阅指定帐号所有者的帐号变更事件的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的凭据的回调。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){ try {
console.debug("receive change data:" + JSON.stringify(data)); appAccountManager.getCredential("ZhangSan", "credentialType001", (err, result) => {
} console.log("getCredential err: " + JSON.stringify(err));
try{ console.log('getCredential result: ' + result);
appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback); });
} } catch (err) {
catch(err){ console.log("getCredential err: " + JSON.stringify(err));
console.error("on accountOnOffDemo err:" + JSON.stringify(err));
} }
``` ```
### off('change') ### getCredential<sup>9+</sup>
off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void getCredential(name: string, credentialType: string): Promise&lt;string&gt;
取消订阅帐号事件，使用callback回调异步返回结果。 获取此应用程序帐号的凭据，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | ------------ | | -------------- | ------ | ---- | ---------- |
| type | 'change' | 是 | 关于帐号更改事件。 | | name | string | 是 | 应用帐号名称。 |
| callback | Callback<Array\<[AppAccountInfo](#appaccountinfo)>> | 否 | 取消订阅帐号事件的回调。 | | credentialType | string | 是 | 要获取的凭据的类型。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){ try {
console.debug("receive change data:" + JSON.stringify(data)); appAccountManager.getCredential("ZhangSan", "credentialType001").then((data) => {
appAccountManager.off('change', function(){ console.log('getCredential, result: ' + data);
console.debug("off finish"); }).catch((err) => {
}) console.log("getCredential err: " + JSON.stringify(err));
} });
try{ } catch (err) {
appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback); console.log("getCredential err: " + JSON.stringify(err));
}
catch(err){
console.error("on accountOnOffDemo err:" + JSON.stringify(err));
} }
``` ```
### authenticate<sup>8+</sup> ### getAccountCredential<sup>(deprecated)</sup>
authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void getAccountCredential(name: string, credentialType: string, callback: AsyncCallback&lt;string&gt;): void
对应用帐户进行鉴权以获取OAuth令牌，使用callback回调异步返回结果。 获取此应用帐号的凭据（如数字密码、人脸和PIN码等），使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | --------------- | | -------------- | --------------------------- | ---- | -------------- |
| name | string | 是 | 要鉴权的应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | | credentialType | string | 是 | 获取此应用帐号的凭据的类型。 |
| authType | string | 是 | 鉴权类型。 | | callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的凭据的回调。 |
| options | {[key: string]: any} | 是 | 鉴权所需的可选项。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，用于返回鉴权结果。 | **示例：**
**示例：** ```js
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => {
console.log("getAccountCredential err: " + JSON.stringify(err));
console.log('getAccountCredential result: ' + result);
});
```
### getAccountCredential<sup>(deprecated)</sup>
getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt;
获取此应用程序帐号的凭据，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9-1)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ---------- |
| name | string | 是 | 应用帐号名称。 |
| credentialType | string | 是 | 要获取的凭据的类型。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
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<sup>(deprecated)</sup>
getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void
获取此应用帐号的额外信息（能转换成string类型的其它信息），使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的额外信息回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => {
console.log("getAccountExtraInfo err: " + JSON.stringify(err));
console.log('getAccountExtraInfo result: ' + result);
});
```
### getAccountExtraInfo<sup>(deprecated)</sup>
getAccountExtraInfo(name: string): Promise&lt;string&gt;
获取此应用程序帐号的额外信息，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------- |
| name | string | 是 | 应用帐号名称。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => {
console.log('getAccountExtraInfo, result: ' + data);
}).catch((err) => {
console.log("getAccountExtraInfo err: " + JSON.stringify(err));
});
```
### getCustomData<sup>9+</sup>
getCustomData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void
获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ----------------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的键。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取与此应用帐号关联的数据的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.getCustomData("ZhangSan", "k001", (err, result) => {
console.log("getCustomData err: " + JSON.stringify(err));
console.log('getCustomData result: ' + result);
});
} catch (err) {
console.log("getCustomData err: " + JSON.stringify(err));
}
```
### getCustomData<sup>9+</sup>
getCustomData(name: string, key: string): Promise&lt;string&gt;
获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的键。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.getCustomData("ZhangSan", "k001").then((data) => {
console.log('getCustomData: ' + data);
}).catch((err) => {
console.log("getCustomData err: " + JSON.stringify(err));
});
} catch (err) {
console.log("getCustomData err: " + JSON.stringify(err));
}
```
### getAssociatedData<sup>(deprecated)</sup>
getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void
获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ----------------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的键。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取与此应用帐号关联的数据的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => {
console.log("getAssociatedData err: " + JSON.stringify(err));
console.log('getAssociatedData result: ' + result);
});
```
### getAssociatedData<sup>(deprecated)</sup>
getAssociatedData(name: string, key: string): Promise&lt;string&gt;
获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9-1)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的键。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => {
console.log('getAssociatedData: ' + data);
}).catch((err) => {
console.log("getAssociatedData err: " + JSON.stringify(err));
});
```
### getAssociatedDataSync<sup>9+</sup>
getAssociatedDataSync(name: string, key: string): string;
获取与此应用程序帐号关联的数据，使用同步方式返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的键。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------- |
| string | 目标关联数据的取值。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
var backData = appAccountManager.getAssociatedDataSync("ZhangSan", "k001");
console.info("getAssociatedDataSync backData:" + JSON.stringify(backData));
} catch (err) {
console.error(`getAssociatedDataSync err, code is ${e.code}, message is ${e.message}`);
}
```
### on('accountChange')<sup>9+</sup>
on(type: 'accountChange', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | 'accountChange' | 是 | 关于帐号更改事件，当帐号所有者更新帐号时，订阅者将收到通知。 |
| owners | Array&lt;string&gt; | 是 | 指示帐号的所有者。 |
| callback | Callback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是 | 订阅指定帐号所有者的帐号变更事件的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){
console.debug("receive change data:" + JSON.stringify(data));
}
try{
appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback);
}
catch(err){
console.error("on accountOnOffDemo err:" + JSON.stringify(err));
}
```
### on('change')<sup>(deprecated)</sup>
on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[on('accountChange')](#onaccountchange9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | 'change' | 是 | 关于帐号更改事件，当帐号所有者更新帐号时，订阅者将收到通知。 |
| owners | Array&lt;string&gt; | 是 | 指示帐号的所有者。 |
| callback | Callback&lt;Array&lt;[AppAccountInfo](#appaccountinfo)&gt;&gt; | 是 | 订阅指定帐号所有者的帐号变更事件的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.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('accountChange')<sup>9+</sup>
off(type: 'accountChange', callback?: Callback<Array\<AppAccountInfo>>): void
取消订阅帐号事件，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | ------------ |
| type | 'accountChange' | 是 | 关于帐号更改事件。 |
| callback | Callback<Array\<[AppAccountInfo](#appaccountinfo)>> | 否 | 取消订阅帐号事件的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){
console.debug("receive change data:" + JSON.stringify(data));
appAccountManager.off('accountChange', function(){
console.debug("off finish");
})
}
try{
appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback);
}
catch(err){
console.error("on accountOnOffDemo err:" + JSON.stringify(err));
}
```
### off('change')<sup>(deprecated)</sup>
off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void
取消订阅帐号事件，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[off('accountChange')](#offaccountchange9)替代。
>
> 从 API version 7开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | ------------ |
| type | 'change' | 是 | 关于帐号更改事件。 |
| callback | Callback<Array\<[AppAccountInfo](#appaccountinfo)>> | 否 | 取消订阅帐号事件的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
function changeOnCallback(data){
console.debug("receive change data:" + JSON.stringify(data));
appAccountManager.off('change', function(){
console.debug("off finish");
})
}
try{
appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback);
}
catch(err){
console.error("on accountOnOffDemo err:" + JSON.stringify(err));
}
```
### auth<sup>9+</sup>
auth(name: string, owner: string, authType: string, callback: AuthCallback): void
对应用帐户进行鉴权以获取Auth令牌，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | --------------- |
| name | string | 是 | 要鉴权的应用帐号名称。 |
| owner | string | 是 | 要鉴权的应用帐号所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回鉴权结果。 |
**示例：**
```js
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();
try {
appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {
onResult: onResultCallback,
onRequestRedirected: onRequestRedirectedCallback
});
} catch (err) {
console.log("auth err: " + JSON.stringify(err));
}
```
### auth<sup>9+</sup>
auth(name: string, owner: string, authType: string, options: {[key: string]: Object}, callback: AuthCallback): void
对应用帐户进行鉴权以获取OAuth令牌，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | --------------- |
| name | string | 是 | 要鉴权的应用帐号名称。 |
| owner | string | 是 | 要鉴权的应用帐号所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| options | {[key: string]: Object} | 是 | 鉴权所需的可选项。 |
| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回鉴权结果。 |
**示例：**
```js ```js
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -1033,26 +2198,148 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri ...@@ -1033,26 +2198,148 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri
console.log("result: " + JSON.stringify(result)); console.log("result: " + JSON.stringify(result));
} }
function onRequestRedirectedCallback(request) { function onRequestRedirectedCallback(request) {
let abilityStartSetting = {want: request}; let abilityStartSetting = {want: request};
featureAbility.startAbility(abilityStartSetting, (err)=>{ featureAbility.startAbility(abilityStartSetting, (err)=>{
console.log("startAbility err: " + JSON.stringify(err)); console.log("startAbility err: " + JSON.stringify(err));
});
}
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, {
onResult: onResultCallback,
onRequestRedirected: onRequestRedirectedCallback
});
} catch (err) {
console.log("auth err: " + JSON.stringify(err));
}
```
### authenticate<sup>(deprecated)</sup>
authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
对应用帐户进行鉴权以获取OAuth令牌，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[auth](#auth9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | --------------- |
| name | string | 是 | 要鉴权的应用帐号名称。 |
| owner | string | 是 | 要鉴权的应用帐号所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| options | {[key: string]: any} | 是 | 鉴权所需的可选项。 |
| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 |
**示例：**
```js
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", "getSocialData", {}, {
onResult: onResultCallback,
onRequestRedirected: onRequestRedirectedCallback
});
```
### getAuthToken<sup>9+</sup>
getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback&lt;string&gt;): void
获取指定应用帐号和鉴权类型的Auth令牌，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ----------- |
| name | string | 是 | 应用帐号的名称。 |
| owner | string | 是 | 应用帐号的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 查询结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.getAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => {
console.log('getAuthToken err: ' + JSON.stringify(err));
console.log('getAuthToken token: ' + data);
}); });
} catch (err) {
console.log('getAuthToken err: ' + JSON.stringify(err));
} }
```
### getAuthToken<sup>9+</sup>
getAuthToken(name: string, owner: string, authType: string): Promise&lt;string&gt;
获取指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ----------- |
| name | string | 是 | 应用帐号的名称。 |
| owner | string | 是 | 应用帐号的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | --------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.authenticate("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { try {
onResult: onResultCallback, appAccountManager.getAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData").then((data) => {
onRequestRedirected: onRequestRedirectedCallback console.log('getAuthToken token: ' + data);
}); }).catch((err) => {
console.log("getAuthToken err: " + JSON.stringify(err));
});
} catch (err) {
console.log("getAuthToken err: " + JSON.stringify(err));
}
``` ```
### getOAuthToken<sup>8+</sup> ### getOAuthToken<sup>(deprecated)</sup>
getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback&lt;string&gt;): void getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback&lt;string&gt;): void
获取指定应用帐号和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 获取指定应用帐号和鉴权类型的OAuth令牌，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1074,12 +2361,16 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall ...@@ -1074,12 +2361,16 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall
}); });
``` ```
### getOAuthToken<sup>8+</sup> ### getOAuthToken<sup>(deprecated)</sup>
getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&gt; getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&gt;
获取指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 获取指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1090,7 +2381,7 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string& ...@@ -1090,7 +2381,7 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&
| owner | string | 是 | 应用帐号的所有者包名。 | | owner | string | 是 | 应用帐号的所有者包名。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | --------------------- | | --------------------- | --------------------- |
...@@ -1107,12 +2398,83 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string& ...@@ -1107,12 +2398,83 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&
}); });
``` ```
### setOAuthToken<sup>8+</sup> ### setAuthToken<sup>9+</sup>
setAuthToken(name: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void
设置指定应用帐号和鉴权类型的Auth令牌，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------- |
| name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 鉴权类型。 |
| token | string | 是 | Auth令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => {
console.log('setAuthToken err: ' + JSON.stringify(err));
});
} catch (err) {
console.log('setAuthToken err: ' + JSON.stringify(err));
}
```
### setAuthToken<sup>9+</sup>
setAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt;
设置指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | -------- |
| name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 鉴权类型。 |
| token | string | 是 | Auth令牌。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => {
console.log('setAuthToken successfully');
}).catch((err) => {
console.log('setAuthToken err: ' + JSON.stringify(err));
});
} catch (err) {
console.log('setAuthToken err: ' + JSON.stringify(err));
}
```
### setOAuthToken<sup>(deprecated)</sup>
setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void
设置指定应用帐号和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 设置指定应用帐号和鉴权类型的OAuth令牌，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1133,12 +2495,16 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall ...@@ -1133,12 +2495,16 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall
}); });
``` ```
### setOAuthToken<sup>8+</sup> ### setOAuthToken<sup>(deprecated)</sup>
setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt; setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt;
设置指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 设置指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1149,7 +2515,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt ...@@ -1149,7 +2515,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| token | string | 是 | OAuth令牌。 | | token | string | 是 | OAuth令牌。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | --------------------- | | ------------------- | --------------------- |
...@@ -1166,12 +2532,85 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt ...@@ -1166,12 +2532,85 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt
}); });
``` ```
### deleteOAuthToken<sup>8+</sup> ### deleteAuthToken<sup>9+</sup>
deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void
删除指定应用帐户和鉴权类型的Auth令牌，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------ |
| name | string | 是 | 应用帐号的名称。 |
| owner | string | 是 | 应用帐号的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| token | string | 是 | 要删除的Auth令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 删除结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => {
console.log('deleteAuthToken err: ' + JSON.stringify(err));
});
} catch (err) {
console.log('deleteAuthToken err: ' + JSON.stringify(err));
}
```
### deleteAuthToken<sup>9+</sup>
deleteAuthToken(name: string, owner: string, authType: string, token: string): Promise&lt;void&gt;
删除指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------ |
| name | string | 是 | 应用帐号的名称。 |
| owner | string | 是 | 应用帐号的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| token | string | 是 | 要删除的Auth令牌。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx").then(() => {
console.log('deleteAuthToken successfully');
}).catch((err) => {
console.log("deleteAuthToken err: " + JSON.stringify(err));
});
} catch (err) {
console.log("deleteAuthToken err: " + JSON.stringify(err));
}
```
### deleteOAuthToken<sup>(deprecated)</sup>
deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback&lt;void&gt;): void
删除指定应用帐户和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 删除指定应用帐户和鉴权类型的OAuth令牌，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[deleteAuthToken](#deleteauthtoken9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1193,12 +2632,16 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c ...@@ -1193,12 +2632,16 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c
}); });
``` ```
### deleteOAuthToken<sup>8+</sup> ### deleteOAuthToken<sup>(deprecated)</sup>
deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise&lt;void&gt; deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise&lt;void&gt;
删除指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 删除指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1210,7 +2653,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string): ...@@ -1210,7 +2653,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string):
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| token | string | 是 | 要删除的OAuth令牌。 | | token | string | 是 | 要删除的OAuth令牌。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | --------------------- | | ------------------- | --------------------- |
...@@ -1227,11 +2670,84 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string): ...@@ -1227,11 +2670,84 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string):
}); });
``` ```
### setOAuthTokenVisibility<sup>8+</sup> ### setAuthTokenVisibility<sup>9+</sup>
setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback&lt;void&gt;): void
设置指定鉴权类型的Auth令牌对特定应用的可见性，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------------- |
| name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。 |
| isVisible | boolean | 是 | 是否可见。当设置成true可见，false不可见。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => {
console.log('setAuthTokenVisibility err: ' + JSON.stringify(err));
});
} catch (err) {
console.log('setAuthTokenVisibility err: ' + JSON.stringify(err));
}
```
### setAuthTokenVisibility<sup>9+</sup>
setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise&lt;void&gt;
设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ------------ |
| name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。 |
| isVisible | boolean | 是 | 是否可见。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => {
console.log('setAuthTokenVisibility successfully');
}).catch((err) => {
console.log('setAuthTokenVisibility err: ' + JSON.stringify(err));
});
} catch (err) {
console.log('setAuthTokenVisibility err: ' + JSON.stringify(err));
}
```
### setOAuthTokenVisibility<sup>(deprecated)</sup>
setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback&lt;void&gt;): void setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback&lt;void&gt;): void
设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用callback回调异步返回结果。 设置指定鉴权类型的Auth令牌对特定应用的可见性，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
...@@ -1249,51 +2765,127 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi ...@@ -1249,51 +2765,127 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => { appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => {
console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err));
}); });
```
### setOAuthTokenVisibility<sup>(deprecated)</sup>
setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise&lt;void&gt;
设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ------------ |
| name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。 |
| isVisible | boolean | 是 | 是否可见。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => {
console.log('setOAuthTokenVisibility successfully');
}).catch((err) => {
console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err));
});
```
### checkAuthTokenVisibility<sup>9+</sup>
checkAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
检查指定鉴权类型的Auth令牌对特定应用的可见性，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------- | ---- | ----------- |
| name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 检查可见性的应用包名。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", (err, data) => {
console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err));
console.log('checkAuthTokenVisibility isVisible: ' + data);
});
} catch (err) {
console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err));
}
``` ```
### setOAuthTokenVisibility<sup>8+</sup> ### checkAuthTokenVisibility<sup>9+</sup>
setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise&lt;void&gt; checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise&lt;boolean&gt;
设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。 检查指定鉴权类型的Auth令牌对特定应用的可见性，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ------------ | | ---------- | ------ | ---- | ------------- |
| name | string | 是 | 应用帐号的名称。 | | name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。 | | bundleName | string | 是 | 用于检查可见性的应用包名。 |
| isVisible | boolean | 是 | 是否可见。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | --------------------- | | ---------------------- | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { try {
console.log('setOAuthTokenVisibility successfully'); appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo").then((data) => {
}).catch((err) => { console.log('checkAuthTokenVisibility isVisible: ' + data);
console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); }).catch((err) => {
}); console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err));
});
} catch (err) {
console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err));
}
``` ```
### checkOAuthTokenVisibility<sup>8+</sup> ### checkOAuthTokenVisibility<sup>(deprecated)</sup>
checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
检查指定鉴权类型的OAuth令牌对特定应用的可见性，使用callback回调异步返回结果。 检查指定鉴权类型的OAuth令牌对特定应用的可见性，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1315,12 +2907,17 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca ...@@ -1315,12 +2907,17 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca
}); });
``` ```
### checkOAuthTokenVisibility<sup>8+</sup>
### checkOAuthTokenVisibility<sup>(deprecated)</sup>
checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise&lt;boolean&gt; checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise&lt;boolean&gt;
检查指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。 检查指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1331,7 +2928,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P ...@@ -1331,7 +2928,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 用于检查可见性的应用包名。 | | bundleName | string | 是 | 用于检查可见性的应用包名。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | --------------------- | | ---------------------- | --------------------- |
...@@ -1348,12 +2945,82 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P ...@@ -1348,12 +2945,82 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P
}); });
``` ```
### getAllOAuthTokens<sup>8+</sup> ### getAllAuthTokens<sup>9+</sup>
getAllAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt;): void
获取指定应用对调用方全部可见的Auth令牌，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------- |
| name | string | 是 | 应用帐号的名称。 |
| owner | string | 是 | 应用帐号的所有者包名。 |
| callback | AsyncCallback&lt;Array&lt; [AuthTokenInfo](#authtokeninfo9)&gt;&gt; | 是 | 查询结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo", (err, data) => {
console.log("getAllAuthTokens err: " + JSON.stringify(err));
console.log('getAllAuthTokens data: ' + JSON.stringify(data));
});
} catch (err) {
console.log("getAllAuthTokens err: " + JSON.stringify(err));
}
```
### getAllAuthTokens<sup>9+</sup>
getAllAuthTokens(name: string, owner: string): Promise&lt;Array&lt;AuthTokenInfo&gt;&gt;
获取指定应用帐户对调用方可见的全部Auth令牌，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------- |
| name | string | 是 | 应用帐号的名称。 |
| owner | string | 是 | 应用帐号的所有者包名。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt; [AuthTokenInfo](#authtokeninfo9)&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => {
console.log('getAllAuthTokens data: ' + JSON.stringify(data));
}).catch((err) => {
console.log("getAllAuthTokens err: " + JSON.stringify(err));
});
} catch (err) {
console.log("getAllAuthTokens err: " + JSON.stringify(err));
}
```
### getAllOAuthTokens<sup>(deprecated)</sup>
getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt;): void getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt;): void
获取指定应用对调用方全部可见的OAuth令牌，使用callback回调异步返回结果。 获取指定应用对调用方全部可见的OAuth令牌，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1362,7 +3029,7 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array& ...@@ -1362,7 +3029,7 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&
| -------- | ---------------------------------------- | ---- | ----------- | | -------- | ---------------------------------------- | ---- | ----------- |
| name | string | 是 | 应用帐号的名称。 | | name | string | 是 | 应用帐号的名称。 |
| owner | string | 是 | 应用帐号的所有者包名。 | | owner | string | 是 | 应用帐号的所有者包名。 |
| callback | AsyncCallback&lt;Array&lt; [OAuthTokenInfo](#oauthtokeninfo8)&gt;&gt; | 是 | 查询结果的回调。 | | callback | AsyncCallback&lt;Array&lt; [OAuthTokenInfo](#oauthtokeninfodeprecated)&gt;&gt; | 是 | 查询结果的回调。 |
**示例：** **示例：**
...@@ -1374,12 +3041,16 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array& ...@@ -1374,12 +3041,16 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&
}); });
``` ```
### getAllOAuthTokens<sup>8+</sup> ### getAllOAuthTokens<sup>(deprecated)</sup>
getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenInfo&gt;&gt; getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenInfo&gt;&gt;
获取指定应用帐户对调用方可见的全部OAuth令牌，使用Promise方式异步返回结果。 获取指定应用帐户对调用方可见的全部OAuth令牌，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1389,11 +3060,11 @@ getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenIn ...@@ -1389,11 +3060,11 @@ getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenIn
| name | string | 是 | 应用帐号的名称。 | | name | string | 是 | 应用帐号的名称。 |
| owner | string | 是 | 应用帐号的所有者包名。 | | owner | string | 是 | 应用帐号的所有者包名。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt; [OAuthTokenInfo](#oauthtokeninfo8)&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt; [OAuthTokenInfo](#oauthtokeninfodeprecated)&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1406,12 +3077,82 @@ getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenIn ...@@ -1406,12 +3077,82 @@ getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenIn
}); });
``` ```
### getOAuthList<sup>8+</sup> ### getAuthList<sup>9+</sup>
getAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
获取指定应用帐户和鉴权类型的Auth令牌的授权列表，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------------------- |
| name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 查询结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData", (err, data) => {
console.log('getAuthList err: ' + JSON.stringify(err));
console.log('getAuthList data: ' + JSON.stringify(data));
});
} catch (err) {
console.log('getAuthList err: ' + JSON.stringify(err));
}
```
### getAuthList<sup>9+</sup>
getAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;
获取指定应用帐户和鉴权类型的Auth令牌的授权列表，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ----------------------- |
| name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | --------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => {
console.log('getAuthList data: ' + JSON.stringify(data));
}).catch((err) => {
console.log("getAuthList err: " + JSON.stringify(err));
});
} catch (err) {
console.log("getAuthList err: " + JSON.stringify(err));
}
```
### getOAuthList<sup>(deprecated)</sup>
getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
获取指定应用帐户和鉴权类型的OAuth令牌的授权列表，使用callback回调异步返回结果。 获取指定应用帐户和鉴权类型的OAuth令牌的授权列表，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1432,12 +3173,16 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt ...@@ -1432,12 +3173,16 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt
}); });
``` ```
### getOAuthList<sup>8+</sup> ### getOAuthList<sup>(deprecated)</sup>
getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt; getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;
获取指定应用帐户和鉴权类型的OAuth令牌的授权列表，使用Promise方式异步返回结果。 获取指定应用帐户和鉴权类型的OAuth令牌的授权列表，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1447,7 +3192,7 @@ getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt; ...@@ -1447,7 +3192,7 @@ getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;
| name | string | 是 | 应用帐号的名称。 | | name | string | 是 | 应用帐号的名称。 |
| authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表。 | | authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | --------------------- | | ---------------------------------- | --------------------- |
...@@ -1464,12 +3209,100 @@ getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt; ...@@ -1464,12 +3209,100 @@ getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;
}); });
``` ```
### getAuthenticatorCallback<sup>8+</sup> ### getAuthCallback<sup>9+</sup>
getAuthCallback(sessionId: string, callback: AsyncCallback&lt;AuthCallback&gt;): void
获取鉴权会话的认证器回调，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- |
| sessionId | string | 是 | 鉴权会话的标识。 |
| callback | AsyncCallback&lt;[AuthCallback](#authcallback9)&gt; | 是 | 查询结果的回调。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility';
const appAccountManager = account_appAccount.createAppAccountManager();
featureAbility.getWant((err, want) => {
var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
try {
appAccountManager.getAuthCallback(sessionId, (err, callback) => {
if (err.code != account_appAccount.ResultCode.SUCCESS) {
console.log("getAuthCallback err: " + JSON.stringify(err));
return;
}
var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
[account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo",
[account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
[account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
});
} catch (err) {
console.log("getAuthCallback err: " + JSON.stringify(err));
}
});
```
### getAuthCallback<sup>9+</sup>
getAuthCallback(sessionId: string): Promise&lt;AuthCallback&gt;
获取鉴权会话的认证器回调，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| sessionId | string | 是 | 鉴权会话的标识。 |
**返回值：**
| 类型 | 说明 |
| ------------------------------------ | --------------------- |
| Promise&lt;[AuthCallback](#authcallback9)&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
import featureAbility from '@ohos.ability.featureAbility';
const appAccountManager = account_appAccount.createAppAccountManager();
featureAbility.getWant().then((want) => {
var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID];
try {
appAccountManager.getAuthCallback(sessionId).then((callback) => {
var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
[account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo",
[account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
[account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
}).catch((err) => {
console.log("getAuthCallback err: " + JSON.stringify(err));
});
}
}).catch((err) => {
console.log("getWant err: " + JSON.stringify(err));
});
```
### getAuthenticatorCallback<sup>(deprecated)</sup>
getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;AuthenticatorCallback&gt;): void getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;AuthenticatorCallback&gt;): void
获取鉴权会话的认证器回调，使用callback回调异步返回结果。 获取鉴权会话的认证器回调，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getAuthCallback](#getauthcallback9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1477,7 +3310,7 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;Authentic ...@@ -1477,7 +3310,7 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;Authentic
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- | | --------- | ---------------------------------------- | ---- | -------- |
| sessionId | string | 是 | 鉴权会话的标识。 | | sessionId | string | 是 | 鉴权会话的标识。 |
| callback | AsyncCallback&lt;[AuthenticatorCallback](#authenticatorcallback8)&gt; | 是 | 查询结果的回调。 | | callback | AsyncCallback&lt;[AuthenticatorCallback](#authenticatorcallbackdeprecated)&gt; | 是 | 查询结果的回调。 |
**示例：** **示例：**
...@@ -1500,12 +3333,16 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;Authentic ...@@ -1500,12 +3333,16 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;Authentic
}); });
``` ```
### getAuthenticatorCallback<sup>8+</sup> ### getAuthenticatorCallback<sup>(deprecated)</sup>
getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt; getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt;
获取鉴权会话的认证器回调，使用Promise方式异步返回结果。 获取鉴权会话的认证器回调，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[getAuthCallback](#getauthcallback9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1514,11 +3351,11 @@ getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt ...@@ -1514,11 +3351,11 @@ getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt
| --------- | ------ | ---- | -------- | | --------- | ------ | ---- | -------- |
| sessionId | string | 是 | 鉴权会话的标识。 | | sessionId | string | 是 | 鉴权会话的标识。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------ | --------------------- | | ------------------------------------ | --------------------- |
| Promise&lt;[AuthenticatorCallback](#authenticatorcallback8)&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;[AuthenticatorCallback](#authenticatorcallbackdeprecated)&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
...@@ -1535,19 +3372,87 @@ getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt ...@@ -1535,19 +3372,87 @@ getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt
[account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
callback.onResult(account_appAccount.ResultCode.SUCCESS, result); callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
}).catch((err) => { }).catch((err) => {
console.log("getAuthenticatorCallback err: " + JSON.stringify(err)); console.log("getAuthenticatorCallback err: " + JSON.stringify(err));
});
}).catch((err) => {
console.log("getWant err: " + JSON.stringify(err));
});
```
### queryAuthenticatorInfo<sup>9+</sup>
queryAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void
获取指定应用帐号的认证器信息，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ----------- |
| owner | string | 是 | 应用帐号的所有者包名。 |
| callback | AsyncCallback&lt;[AuthenticatorInfo](#authenticatorinfo8)&gt; | 是 | 查询结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.queryAuthenticatorInfo("com.example.ohos.accountjsdemo", (err, data) => {
console.log("queryAuthenticatorInfo err: " + JSON.stringify(err));
console.log('queryAuthenticatorInfo data: ' + JSON.stringify(data));
});
} catch (err) {
console.log("queryAuthenticatorInfo err: " + JSON.stringify(err));
}
```
### queryAuthenticatorInfo<sup>9+</sup>
queryAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------- |
| owner | string | 是 | 应用帐号的所有者包名。 |
**返回值：**
| 类型 | 说明 |
| -------------------------------- | --------------------- |
| Promise&lt;[AuthenticatorInfo](#authenticatorinfo8)&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
try {
appAccountManager.queryAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => {
console.log('queryAuthenticatorInfo: ' + JSON.stringify(data));
}).catch((err) => {
console.log("queryAuthenticatorInfo err: " + JSON.stringify(err));
}); });
}).catch((err) => { } catch (err) {
console.log("getWant err: " + JSON.stringify(err)); console.log("queryAuthenticatorInfo err: " + JSON.stringify(err));
}); }
``` ```
### getAuthenticatorInfo<sup>8+</sup> ### getAuthenticatorInfo<sup>(deprecated)</sup>
getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void
获取指定应用帐号的认证器信息，使用callback回调异步返回结果。 获取指定应用帐号的认证器信息，使用callback回调异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1567,12 +3472,16 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo ...@@ -1567,12 +3472,16 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo
}); });
``` ```
### getAuthenticatorInfo<sup>8+</sup> ### getAuthenticatorInfo<sup>(deprecated)</sup>
getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。 获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。
> **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9-1)替代。
>
> 从 API version 8开始支持。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
...@@ -1581,7 +3490,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; ...@@ -1581,7 +3490,7 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
| ----- | ------ | ---- | ----------- | | ----- | ------ | ---- | ----------- |
| owner | string | 是 | 应用帐号的所有者包名。 | | owner | string | 是 | 应用帐号的所有者包名。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------------------- | | -------------------------------- | --------------------- |
...@@ -1598,62 +3507,74 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt; ...@@ -1598,62 +3507,74 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
}); });
``` ```
### checkAppAccess<sup>9+</sup> ### checkAccountLabels<sup>9+</sup>
checkAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void checkAccountLabels(name: string, owner: string, labels: Array&lt;string&gt;, callback: AsyncCallback&lt;boolean&gt;): void;
检查指定应用帐户对特定应用是否授权，使用callback回调异步返回结果。 检查指定帐户是否具有特定的标签集合，使用callback回调异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------- | ----- | ---------------- | | -------------- | ------------------------- | ----- | --------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| bundleName | string | 是 | 被检查的应用包名。 | | owner | string | 是 | 应用帐户的所有者。|
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查结果的回调。 | | labels | Array&lt;string&gt; | 是 | 标签数组。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查结果的回调。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.checkAppAccess("zhangsan", "com.example.ohos.accountjsdemo", (err, data) => { var labels = ["student"];
console.log('checkAppAccess: ' + JSON.stringify(data)); try {
console.log("checkAppAccess err: " + JSON.stringify(err)); appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", labels, (err, data) => {
}); console.log('checkAccountLabels: ' + JSON.stringify(data));
console.log("checkAccountLabels err: " + JSON.stringify(err));
});
} catch (err) {
console.log("checkAccountLabels err: " + JSON.stringify(err));
}
``` ```
### checkAppAccess<sup>9+</sup> ### checkAccountLabels<sup>9+</sup>
checkAppAccess(name: string, bundleName: string): Promise&lt;boolean&gt; checkAccountLabels(name: string, owner: string, labels: Array&lt;string&gt;): Promise&lt;boolean&gt;
检查指定应用帐户对特定应用是否授权，使用Promise方式异步返回结果。 检查指定帐户是否具有特定的标签集合，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount **系统能力：** SystemCapability.Account.AppAccount
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ----- | ---------------- | | -------------- | ------------------------- | ----- | --------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| bundleName | string | 是 | 被检查的应用包名。 | | owner | string | 是 | 应用帐户的所有者。|
| labels | Array&lt;string&gt; | 是 | 标签数组。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | --------------------------------- | | ------------------- | -------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.checkAppAccess("zhangsan", "com.example.ohos.accountjsdemo").then((data) => { var labels = ["student"];
console.log('checkAppAccess: ' + JSON.stringify(data)); try {
}).catch((err) => { appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", labels).then((data) => {
console.log("checkAppAccess err: " + JSON.stringify(err)); console.log('checkAccountLabels: ' + JSON.stringify(data));
}); }).catch((err) => {
console.log("checkAccountLabels err: " + JSON.stringify(err));
});
} catch (err) {
console.log("checkAccountLabels err: " + JSON.stringify(err));
}
``` ```
### deleteAccountCredential<sup>9+</sup> ### deleteAccountCredential<sup>9+</sup>
...@@ -1676,10 +3597,14 @@ deleteAccountCredential(name: string, credentialType: string, callback: AsyncCal ...@@ -1676,10 +3597,14 @@ deleteAccountCredential(name: string, credentialType: string, callback: AsyncCal
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.deleteAccountCredential("zhangsan", "pin", (err, data) => { try {
console.log('deleteAccountCredential: ' + JSON.stringify(data)); appAccountManager.deleteAccountCredential("zhangsan", "pin", (err, data) => {
console.log('deleteAccountCredential: ' + JSON.stringify(data));
console.log("deleteAccountCredential err: " + JSON.stringify(err));
});
} catch (err) {
console.log("deleteAccountCredential err: " + JSON.stringify(err)); console.log("deleteAccountCredential err: " + JSON.stringify(err));
}); }
``` ```
### deleteAccountCredential<sup>9+</sup> ### deleteAccountCredential<sup>9+</sup>
...@@ -1697,7 +3622,7 @@ deleteAccountCredential(name: string, credentialType: string): Promise&lt;void&g ...@@ -1697,7 +3622,7 @@ deleteAccountCredential(name: string, credentialType: string): Promise&lt;void&g
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| credentialType | string | 是 | 凭据类型。 | | credentialType | string | 是 | 凭据类型。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------------------- | | ------------------- | -------------------------------- |
...@@ -1707,73 +3632,15 @@ deleteAccountCredential(name: string, credentialType: string): Promise&lt;void&g ...@@ -1707,73 +3632,15 @@ deleteAccountCredential(name: string, credentialType: string): Promise&lt;void&g
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.deleteAccountCredential("zhangsan", "pin").then((data) => { try {
console.log('deleteAccountCredential: ' + JSON.stringify(data)); appAccountManager.deleteAccountCredential("zhangsan", "pin").then((data) => {
}).catch((err) => { console.log('deleteAccountCredential: ' + JSON.stringify(data));
}).catch((err) => {
console.log("deleteAccountCredential err: " + JSON.stringify(err));
});
} catch (err) {
console.log("deleteAccountCredential err: " + JSON.stringify(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&gt; | 是 | 标签数组。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查结果的回调。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
var labels = ["student"];
appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", labels, (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;boolean&gt;
检查指定帐户是否具有特定的标签集合，使用Promise方式异步返回结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------- | ----- | --------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者。|
| labels | Array&lt;string&gt; | 是 | 标签数组。 |
**参数：**
| 类型 | 说明 |
| ------------------- | -------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
var labels = ["student"];
appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", labels).then((data) => {
console.log('checkAccountLabels: ' + JSON.stringify(data));
}).catch((err) => {
console.log("checkAccountLabels err: " + JSON.stringify(err));
});
``` ```
### selectAccountsByOptions<sup>9+</sup> ### selectAccountsByOptions<sup>9+</sup>
...@@ -1798,10 +3665,14 @@ selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback& ...@@ -1798,10 +3665,14 @@ selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback&
var options = { var options = {
allowedOwners: ["com.example.ohos.accountjsdemo"] allowedOwners: ["com.example.ohos.accountjsdemo"]
}; };
appAccountManager.selectAccountsByOptions(options, (err, data) => { try {
console.log('selectAccountsByOptions: ' + JSON.stringify(data)); appAccountManager.selectAccountsByOptions(options, (err, data) => {
console.log('selectAccountsByOptions: ' + JSON.stringify(data));
console.log("selectAccountsByOptions err: " + JSON.stringify(err));
});
} catch (err) {
console.log("selectAccountsByOptions err: " + JSON.stringify(err)); console.log("selectAccountsByOptions err: " + JSON.stringify(err));
}); }
``` ```
### selectAccountsByOptions<sup>9+</sup> ### selectAccountsByOptions<sup>9+</sup>
...@@ -1818,7 +3689,7 @@ selectAccountsByOptions(options: SelectAccountsOptions): Promise&lt;Array&lt;App ...@@ -1818,7 +3689,7 @@ selectAccountsByOptions(options: SelectAccountsOptions): Promise&lt;Array&lt;App
| -------------- | ------------------------- | ----- | --------------- | | -------------- | ------------------------- | ----- | --------------- |
| options | [SelectAccountsOptions](#selectaccountsoptions9) | 是 | 选择帐户的选项。 | | options | [SelectAccountsOptions](#selectaccountsoptions9) | 是 | 选择帐户的选项。 |
**参数：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------------------- | | ------------------- | -------------------------------- |
...@@ -1831,11 +3702,15 @@ selectAccountsByOptions(options: SelectAccountsOptions): Promise&lt;Array&lt;App ...@@ -1831,11 +3702,15 @@ selectAccountsByOptions(options: SelectAccountsOptions): Promise&lt;Array&lt;App
var options = { var options = {
allowedOwners: ["com.example.ohos.accountjsdemo"] allowedOwners: ["com.example.ohos.accountjsdemo"]
}; };
appAccountManager.selectAccountsByOptions(options).then((data) => { try {
console.log('selectAccountsByOptions: ' + JSON.stringify(data)); appAccountManager.selectAccountsByOptions(options).then((data) => {
}).catch((err) => { console.log('selectAccountsByOptions: ' + JSON.stringify(data));
}).catch((err) => {
console.log("selectAccountsByOptions err: " + JSON.stringify(err));
});
} catch (err) {
console.log("selectAccountsByOptions err: " + JSON.stringify(err)); console.log("selectAccountsByOptions err: " + JSON.stringify(err));
}); }
``` ```
### verifyCredential<sup>9+</sup> ### verifyCredential<sup>9+</sup>
...@@ -1852,21 +3727,25 @@ verifyCredential(name: string, owner: string, callback: AuthenticatorCallback): ...@@ -1852,21 +3727,25 @@ verifyCredential(name: string, owner: string, callback: AuthenticatorCallback):
| -------- | --------------------- | ----- | ----------------------- | | -------- | --------------------- | ----- | ----------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者。 | | owner | string | 是 | 应用帐户的所有者。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，返回验证结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，返回验证结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", { try {
onResult: (resultCode, result) => { appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", {
console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode)); onResult: (resultCode, result) => {
console.log("verifyCredential onResult, result:" + JSON.stringify(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)); onRequestRedirected: (request) => {
} console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request));
}); }
});
} catch (err) {
console.log("verifyCredential err: " + JSON.stringify(err));
}
``` ```
### verifyCredential<sup>9+</sup> ### verifyCredential<sup>9+</sup>
...@@ -1884,7 +3763,7 @@ verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, ...@@ -1884,7 +3763,7 @@ verifyCredential(name: string, owner: string, options: VerifyCredentialOptions,
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者。 | | owner | string | 是 | 应用帐户的所有者。 |
| options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的选项。 | | options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的选项。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，返回验证结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，返回验证结果。 |
**示例：** **示例：**
...@@ -1894,20 +3773,24 @@ verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, ...@@ -1894,20 +3773,24 @@ verifyCredential(name: string, owner: string, options: VerifyCredentialOptions,
credentialType: "pin", credentialType: "pin",
credential: "123456" credential: "123456"
}; };
appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", options, { try {
onResult: (resultCode, result) => { appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", options, {
console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode)); onResult: (resultCode, result) => {
console.log("verifyCredential onResult, result:" + JSON.stringify(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)); onRequestRedirected: (request) => {
} console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request));
}); }
});
} catch (err) {
console.log("verifyCredential err: " + JSON.stringify(err));
}
``` ```
### setAuthenticatorProperties<sup>9+</sup> ### setAuthenticatorProperties<sup>9+</sup>
setAuthenticatorProperties(owner: string, callback: AuthenticatorCallback): void; setAuthenticatorProperties(owner: string, callback: AuthCallback): void;
设置认证器属性，使用callback回调异步返回结果。 设置认证器属性，使用callback回调异步返回结果。
...@@ -1918,27 +3801,30 @@ setAuthenticatorProperties(owner: string, callback: AuthenticatorCallback): void ...@@ -1918,27 +3801,30 @@ setAuthenticatorProperties(owner: string, callback: AuthenticatorCallback): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ----- | ----------------------- | | -------- | --------------------- | ----- | ----------------------- |
| owner | string | 是 | 认证器的所有者。 | | owner | string | 是 | 认证器的所有者。 |
| options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的选项。 | | callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置结果。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，返回设置结果。 |
**示例：** **示例：**
```js ```js
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
appAccountManager.setAuthenticatorProperties("com.example.ohos.accountjsdemo", { try {
onResult: (resultCode, result) => { appAccountManager.setAuthenticatorProperties("com.example.ohos.accountjsdemo", {
console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode)); onResult: (resultCode, result) => {
console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(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)); onRequestRedirected: (request) => {
} console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request));
}); }
});
} catch (err) {
console.log("setAuthenticatorProperties err: " + JSON.stringify(err));
}
``` ```
### setAuthenticatorProperties<sup>9+</sup> ### setAuthenticatorProperties<sup>9+</sup>
setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthenticatorCallback): void; setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthCallback): void;
设置认证器属性，使用callback回调异步返回结果。 设置认证器属性，使用callback回调异步返回结果。
...@@ -1950,7 +3836,7 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac ...@@ -1950,7 +3836,7 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac
| -------- | --------------------- | ----- | ----------------------- | | -------- | --------------------- | ----- | ----------------------- |
| owner | string | 是 | 认证器的所有者。 | | owner | string | 是 | 认证器的所有者。 |
| options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的选项。 | | options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的选项。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，返回设置结果。 | | callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置结果。 |
**示例：** **示例：**
...@@ -1959,15 +3845,20 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac ...@@ -1959,15 +3845,20 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac
var options = { var options = {
properties: {"prop1": "value1"} properties: {"prop1": "value1"}
}; };
appAccountManager.setAuthenticatorProperties("com.example.ohos.accountjsdemo", options, { try {
onResult: (resultCode, result) => { appAccountManager.setAuthenticatorProperties("com.example.ohos.accountjsdemo", options, {
console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode)); onResult: (resultCode, result) => {
console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(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)); onRequestRedirected: (request) => {
} console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request));
}); }
});
} catch (err) {
console.log("setAuthenticatorProperties err: " + JSON.stringify(err));
}
``` ```
## AppAccountInfo ## AppAccountInfo
...@@ -1981,17 +3872,33 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac ...@@ -1981,17 +3872,33 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac
| owner | string | 是 | 应用帐号的所有者包名。 | | owner | string | 是 | 应用帐号的所有者包名。 |
| name | string | 是 | 应用帐号的名称。 | | name | string | 是 | 应用帐号的名称。 |
## OAuthTokenInfo<sup>8+</sup> ## AuthTokenInfo<sup>9+</sup>
表示Auth令牌信息。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | -------------- | ----- | ---------------- |
| authType<sup>9+</sup> | string | 是 | 令牌的鉴权类型。 |
| token<sup>9+</sup> | string | 是 | 令牌的取值。 |
| account<sup>9+</sup> | [AppAccountInfo](#appaccountinfo) | 否 | 令牌所属的帐号信息。|
## OAuthTokenInfo<sup>(deprecated)</sup>
表示OAuth令牌信息。 表示OAuth令牌信息。
> **说明：** 从API version 9开始废弃, 建议使用[AuthTokenInfo](#authtokeninfo9)替代。
>
> 从 API version 8开始支持。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------------- | -------------- | ----- | ---------------- | | -------------------- | -------------- | ----- | ---------------- |
| authType | string | 是 | 令牌的鉴权类型。 | | authType | string | 是 | 令牌的鉴权类型。 |
| token | string | 是 | 令牌的取值。 | | token | string | 是 | 令牌的取值。 |
| account<sup>9+</sup> | AppAccountInfo | 否 | 令牌所属的帐号信息。| | account<sup>9+</sup> | [AppAccountInfo](#appaccountinfo) | 否 | 令牌所属的帐号信息。|
## AuthenticatorInfo<sup>8+</sup> ## AuthenticatorInfo<sup>8+</sup>
...@@ -2005,6 +3912,48 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac ...@@ -2005,6 +3912,48 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac
| iconId | number | 是 | 认证器的图标标识。 | | iconId | number | 是 | 认证器的图标标识。 |
| labelId | number | 是 | 认证器的标签标识。 | | labelId | number | 是 | 认证器的标签标识。 |
## AuthResult<sup>9+</sup>
表示认证结果信息。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------- |
| account | [AppAccountInfo](#appaccountinfo) | 否 | 令牌所属的帐号信息。 |
| tokenInfo | [AuthTokenInfo](#authtokeninfo9) | 否 | 令牌信息。 |
## AuthOptions<sup>9+</sup>
表示认证的选项。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------- |
| parameters | {[key:string]: Object} | 否 | 自定义参数对象。 |
## CreateAccountOptions<sup>9+</sup>
表示创建账号的选项。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------- |
| customData | {[key:string]: Object} | 否 | 自定义数据。 |
## CreateAccountImplicitlyOptions<sup>9+</sup>
表示隐式创建账号的选项。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------- |
| requiredLabels | {[key:string]: Object} | 否 | 必须的标签。 |
| authType | string | 否 | 鉴权类型。 |
| parameters | {[key:string]: Object} | 否 | 自定义参数对象。 |
## SelectAccountsOptions<sup>9+</sup> ## SelectAccountsOptions<sup>9+</sup>
表示用于选择帐号的选项。 表示用于选择帐号的选项。
...@@ -2049,8 +3998,10 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac ...@@ -2049,8 +3998,10 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------------------------------- | ---------------------- | ----------------------- | | -------------------------------- | ---------------------- | ----------------------- |
| ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作，隐式添加帐号。 | | ACTION_ADD_ACCOUNT_IMPLICITLY<sup>(deprecated)</sup> | "addAccountImplicitly" | 表示操作，隐式添加帐号。 |
| ACTION_AUTHENTICATE | "authenticate" | 表示操作，鉴权。 | | ACTION_AUTHENTICATE<sup>(deprecated)</sup> | "authenticate" | 表示操作，鉴权。 |
| ACTION_CREATE_ACCOUNT_IMPLICITLY<sup>9+</sup> | "createAccountImplicitly" | 表示操作，隐式创建帐号。 |
| ACTION_AUTH<sup>9+</sup> | "auth" | 表示操作，鉴权。 |
| KEY_NAME | "name" | 表示键名，应用帐号名称。 | | KEY_NAME | "name" | 表示键名，应用帐号名称。 |
| KEY_OWNER | "owner" | 表示键名，应用帐号所有者。| | KEY_OWNER | "owner" | 表示键名，应用帐号所有者。|
| KEY_TOKEN | "token" | 表示键名，令牌。 | | KEY_TOKEN | "token" | 表示键名，令牌。 |
...@@ -2091,10 +4042,103 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac ...@@ -2091,10 +4042,103 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac
| ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017 | 表示不支持的鉴权类型。 | | ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017 | 表示不支持的鉴权类型。 |
| ERROR_PERMISSION_DENIED | 10018 | 表示权限不足。 | | ERROR_PERMISSION_DENIED | 10018 | 表示权限不足。 |
## AuthenticatorCallback<sup>8+</sup> ## AuthCallback<sup>9+</sup>
认证回调接口。
### onResult<sup>9+</sup>
onResult: (code: number, result: {[key: string]: any}) =&gt; void
通知请求结果。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------- | ---- | ------ |
| code | number | 是 | 鉴权结果码。 |
| result | {[key: string]: any} | 否 | 鉴权结果。 |
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
var sessionId = "1234";
appAccountManager.getAuthCallback(sessionId).then((callback) => {
var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi",
[account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo",
[account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData",
[account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
}).catch((err) => {
console.log("getAuthCallback err: " + JSON.stringify(err));
});
```
### onRequestRedirected<sup>9+</sup>
onRequestRedirected: (request: Want) =&gt; void
通知请求被跳转。
**系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---- | ---- | ---------- |
| request | Want | 是 | 用于跳转的请求信息。 |
**示例：**
```js
class MyAuthenticator extends account_appAccount.Authenticator {
createAccountImplicitly(options, callback) {
callback.onRequestRedirected({
bundleName: "com.example.ohos.accountjsdemo",
abilityName: "com.example.ohos.accountjsdemo.LoginAbility",
});
}
auth(name, authType, options, callback) {
var result = {[account_appAccount.Constants.KEY_NAME]: name,
[account_appAccount.Constants.KEY_AUTH_TYPE]: authType,
[account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"};
callback.onResult(account_appAccount.ResultCode.SUCCESS, result);
}
}
```
### onRequestContinued<sup>9+</sup>
onRequestContinued?: () =&gt; void
通知请求被继续处理。
**系统能力：** SystemCapability.Account.AppAccount
**示例：**
```js
const appAccountManager = account_appAccount.createAppAccountManager();
var sessionId = "1234";
appAccountManager.getAuthCallback(sessionId).then((callback) => {
callback.onRequestContinued();
}).catch((err) => {
console.log("getAuthCallback err: " + JSON.stringify(err));
});
```
## AuthenticatorCallback<sup>(deprecated)</sup>
OAuth认证器回调接口。 OAuth认证器回调接口。
> **说明：** 从API version 9开始废弃。
>
> 从 API version 8开始支持, 建议使用[AuthCallback](#authcallback9)替代。
### onResult<sup>8+</sup> ### onResult<sup>8+</sup>
onResult: (code: number, result: {[key: string]: any}) =&gt; void onResult: (code: number, result: {[key: string]: any}) =&gt; void
...@@ -2199,7 +4243,7 @@ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: ...@@ -2199,7 +4243,7 @@ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key:
| authType | string | 是 | 应用帐号的鉴权类型。 | | authType | string | 是 | 应用帐号的鉴权类型。 |
| callerBundleName | string | 是 | 鉴权请求方的包名。 | | callerBundleName | string | 是 | 鉴权请求方的包名。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，用于返回鉴权结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 |
### authenticate<sup>8+</sup> ### authenticate<sup>8+</sup>
...@@ -2217,7 +4261,7 @@ authenticate(name: string, authType: string, callerBundleName: string, options: ...@@ -2217,7 +4261,7 @@ authenticate(name: string, authType: string, callerBundleName: string, options:
| authType | string | 是 | 应用帐号的鉴权类型。 | | authType | string | 是 | 应用帐号的鉴权类型。 |
| callerBundleName | string | 是 | 鉴权请求方的包名。 | | callerBundleName | string | 是 | 鉴权请求方的包名。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，用于返回鉴权结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 |
### verifyCredential<sup>9+</sup> ### verifyCredential<sup>9+</sup>
...@@ -2233,7 +4277,7 @@ verifyCredential(name: string, options: VerifyCredentialOptions, callback: Authe ...@@ -2233,7 +4277,7 @@ verifyCredential(name: string, options: VerifyCredentialOptions, callback: Authe
| ---------------- | --------------------- | ---- | --------------- | | ---------------- | --------------------- | ---- | --------------- |
| name | string | 是 | 应用帐号的名称。 | | name | string | 是 | 应用帐号的名称。 |
| options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的可选项。 | | options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的可选项。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，用于返回验证结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回验证结果。 |
### setProperties<sup>9+</sup> ### setProperties<sup>9+</sup>
...@@ -2248,7 +4292,7 @@ setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback): v ...@@ -2248,7 +4292,7 @@ setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback): v
| 接口名 | 类型 | 必填 | 说明 | | 接口名 | 类型 | 必填 | 说明 |
| ---------------- | --------------------- | ---- | --------------- | | ---------------- | --------------------- | ---- | --------------- |
| options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的可选项。 | | options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的可选项。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，用于返回设置结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回设置结果。 |
### checkAccountLabels<sup>9+</sup> ### checkAccountLabels<sup>9+</sup>
...@@ -2264,7 +4308,7 @@ checkAccountLabels(name: string, labels: Array&lt;string&gt;, callback: Authenti ...@@ -2264,7 +4308,7 @@ checkAccountLabels(name: string, labels: Array&lt;string&gt;, callback: Authenti
| ---------------- | --------------------- | ---- | --------------- | | ---------------- | --------------------- | ---- | --------------- |
| name | string | 是 | 应用帐号的名称。 | | name | string | 是 | 应用帐号的名称。 |
| labels | Array&lt;string&gt; | 是 | 标签数组。 | | labels | Array&lt;string&gt; | 是 | 标签数组。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，用于返回检查结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回检查结果。 |
### isAccountRemovable<sup>9+</sup> ### isAccountRemovable<sup>9+</sup>
...@@ -2279,7 +4323,7 @@ isAccountRemovable(name: string, callback: AuthenticatorCallback): void; ...@@ -2279,7 +4323,7 @@ isAccountRemovable(name: string, callback: AuthenticatorCallback): void;
| 接口名 | 类型 | 必填 | 说明 | | 接口名 | 类型 | 必填 | 说明 |
| ---------------- | --------------------- | ---- | --------------- | | ---------------- | --------------------- | ---- | --------------- |
| name | string | 是 | 应用帐号的名称。 | | name | string | 是 | 应用帐号的名称。 |
| callback | [AuthenticatorCallback](#authenticatorcallback8) | 是 | 认证器回调，用于返回判断结果。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回判断结果。 |
### getRemoteObject<sup>9+</sup> ### getRemoteObject<sup>9+</sup>
......
zh-cn/application-dev/reference/errorcodes/errcode-Account.md 0 → 100644
浏览文件 @ a584612c
# 账号子系统通用错误码
## 201 权限校验失败
### 错误信息
Permission denied.
### 可能原因
该错误码表示权限校验失败，可能原因如下：
1. 调用目标接口时，未申请权限。
2. 非会话请求方和响应方查询会话信息。
### 处理步骤
1. 请申请相应接口要求的权限。
2. 请取消非法查询，使用会话请求方和响应方查询会话信息。
## 401 参数检查失败
### 错误信息
Parameter check failed.
### 可能原因
该错误码表示参数检查失败，可能原因如下：
1. 必选参数没有传入，参数类型错误。
### 处理步骤
1. 请按照参数类型、位置，传入合法的参数。
## 801 API不支持
### 错误信息
Capability not supported.
### 可能原因
暂无
### 处理步骤
1. 取消调用和调用替代接口。
## 12300001 系统服务异常
### 错误信息
System service works abnormally.
### 可能原因
该错误码表示系统服务异常，可能原因如下：
1. 账号管理服务无法正常启动。
2. 账号管理的IPC对象无法获取。
3. 账号管理依赖的其他服务无法正常启动或者IPC对象无法获取。
4. 服务未初始化。
5. 磁盘空间不足。
6. 读写文件异常。
7. 创建目录异常。
8. 创建删除文件异常。
9. 读写数据库异常。
### 处理步骤
1. 请稍后重试，或重启设备。
## 12300002 无效参数
### 错误信息
Invalid parameter.
### 可能原因
该错误码表示传入无效的参数，可能原因如下：
1. 用户名为空。
2. 系统账号用户名长度大于1024。
3. 分布式账号用户名长度大于256。
4. 系统账号id小于0、小于100或大于1000。
5. 分布式账号id长度大于512。
6. 分布式账号传入不支持的事件类型。
7. 域名为空。
8. 域名长度大于128。
9. 域账号为空。
10. 域账号长度大于512。
11. 约束为空。
12. 约束长度大于128。
13. 传入无效的认证和查询参数。
14. 提供的系统账号头像编码字符串长度超过4KB。
15. 提供的分布式账号头像编码字符串长度超过2MB。
16. 提供非jpg和png的图片。
17. 应用账号名长度超过512。
18. 鉴权类型长度超过1024。
19. 令牌长度超过1024。
20. 键名长度超过1024。
21. 自定义数据值长度超过1024。
### 处理步骤
1. 请传入正确的参数。
## 12300003 账号不存在
### 错误信息
The account does not exist.
### 可能原因
该错误码表示操作的账号不存在，可能原因如下:
1. 查询/激活/删除未创建的账号。
2. 查询/激活/删除已删除的账号。
3. 为已删除的账号设置约束/用户名/头像。
4. 更新未创建的账号。
5. 为不存在的账号设置/取消账号信息访问授权。
6. 为不存在的账号设置/删除/查询密码。
7. 为不存在的账号设置/删除令牌。
8. 为不存在的账号设置额外信息。
9. 为不存在的账号设置/删除凭据。
10. 为不存在的账号设置自定义数据。
11. 为不存在的账号使能分布式同步功能。
### 处理步骤
1. 请检查账号是否存在。
## 12300004 操作受限账号
### 错误信息
The specified account is restricted.
### 可能原因
该错误码表示操作的是受限账号，可能原因如下:
1. 删除系统保留用户。
2. 查询系统保留用户的约束源类型。
3. 创建id为0-100的账号。
### 处理步骤
1. 指定id为系统保留用户，无法操作。
## 12300005 监听器已注册
### 错误信息
The listener has been registered.
### 可能原因
该错误码表示监听器已注册，可能原因如下:
1. 当前应用向系统注册一个已经注册过的监听器，无法重复注册。
### 处理步骤
1. 请取消注册，或使用未注册过的监听器重新注册。
## 12300006 监听器未注册
### 错误信息
The Listener is not registered.
### 可能原因
该错误码表示监听器未注册，可能原因如下:
1. 解注册一个未注册过的监听器。
### 处理步骤
1. 请使用注册的监听器执行解注册操作
## 12300007 PIN码输入器已注册
### 错误信息
The PIN inputer already exists.
### 可能原因
该错误码表示PIN码输入器已注册，可能原因如下:
1. PIN码输入器已注册，解注册之前无法重复注册。
### 处理步骤
1. PIN码输入器已存在，请勿重复操作。
## 12300008 账号已存在
### 错误信息
The account already exists.
### 可能原因
该错误码表示账号已存在，可能原因如下:
1. 创建已存在的账号。
### 处理步骤
1. 请取消创建，或使用其他账户号名重试。
## 12300009 账号已激活
### 错误信息
The account has been activated.
### 可能原因
该错误码表示账号已激活，可能原因如下:
1. 激活已激活的账号。
### 处理步骤
1. 当前账号已激活，请勿重复操作。
## 12300010 账号服务忙
### 错误信息
The account service is busy.
### 可能原因
该错误码表示账号服务忙，可能原因如下:
1. 短时间提交重复请求，如重复激活、重复设置等。
2. 应用账号的认证会话数量超过256，无法处理新的认证请求。
### 处理步骤
1. 请等待一段时间后重试，并降低调用频率。
## 12300011 账号数量已达上限
### 错误信息
The account number has reached the upper limit.
### 可能原因
该错误码表示账号数量已达上限，可能原因如下:
1. 创建系统账号/应用账号时，已存在1000个账号。
### 处理步骤
1. 请删除其他账号后再创建。
## 12300012 不支持多用户
### 错误信息
Multi-user is not supported.
### 可能原因
该错误码表示不支持多用户，可能原因如下:
1. 当前设备不支持多用户，无法创建账号
### 处理步骤
1. 无法创建其他账号，请取消创建
## 12300013 不支持的账号类型
### 错误信息
The account type is not supported.
### 可能原因
该错误码表示提供了不支持的账号类型，可能原因如下:
1. 当前设备不支持创建管理员账号
### 处理步骤
1. 请创建非管理员账号
## 12300014 可信等级不支持
### 错误信息
The trust level is not supported.
### 可能原因
该错误码表示提供了可信等级不支持，可能原因如下:
1. 传入系统不支持的可信等级。
### 处理步骤
1. 请输入正确的可信等级。
## 12300015 认证类型不支持
### 错误信息
The auth type is not supported.
### 可能原因
该错误码表示提供了认证类型不支持，可能原因如下:
1. 传入系统不支持的认证类型。
### 处理步骤
1. 请提供系统支持的认证类型。
## 12300016 认证超时
### 错误信息
The auth service is timeout.
### 可能原因
该错误码表示认证超时，可能原因如下:
1. 认证录入超过三分钟。
2. 认证服务因网络原因无法及时响应而超时。
### 处理步骤
1. 认证录入超时，请重试。
2. 请确认网络环境无问题后重试。
## 12300017 认证服务忙
### 错误信息
The auth service is busy.
### 可能原因
该错误码表示认证服务忙，可能原因如下:
1. 认证总数超过5个。
### 处理步骤
1. 当前认证服务忙，请稍后重试。
## 12300018 认证服务锁定
### 错误信息
The auth service is locked.
### 可能原因
该错误码表示认证服务锁定，可能原因如下:
1. 认证类型错误次数超过上限。
### 处理步骤
1. 认证错误次数超过上限，请在freezingTime之后重试。
## 12300019 凭据不存在
### 错误信息
The credential does not exist.
### 可能原因
该错误码表示凭据不存在，可能原因如下:
1. 认证未录入的凭据类型。
2. 查询未录入的凭据类型。
3. 删除未录入的凭据类型。
### 处理步骤
1. 请确认凭据类型是否存在。
## 12300020 无效的contextId
### 错误信息
The contextId is invalid.
### 可能原因
该错误码表示contextId无效，可能原因如下:
1. 传入取消的contexId未发起认证录入或已经完成。
### 处理步骤
1. 请输入正确的contextId。
# 应用账号错误码
## 12400001 应用不存在
### 错误信息
The application does not exist.
### 可能原因
该错误码表示应用不存在，可能原因如下:
1. 设置访问权限时，目标应用不存在。
2. 设置开放授权时，目标应用不存在。
### 处理步骤
1. 请取消设置，或使用已安装的应用包名重试。
## 12400002 账号认证器服务不存在
### 错误信息
The account authenticator service does not exist.
### 可能原因
该错误码表示账号认证器服务不存在，可能原因如下:
1. 请求鉴权时，账号所属应用不支持认证器服务。
2. 隐式添加账号时，账号所属应用不支持认证器服务。
3. 验证指定账号的凭据时，该账号所属应用不支持认证器服务。
4. 设置应用的认证器属性时，指定的应用不支持认证器服务。
### 处理步骤
1. 请取消操作，或使用支持认证器服务的应用的包名重试。
## 12400003 账号认证器服务异常
### 错误信息
The account authenticator service works abnormally.
### 可能原因
该错误码表示账号认证器服务异常，可能原因如下:
1. 三方应用的鉴权服务接连失败。
### 处理步骤
1. 请重试或重启系统。
## 12400004 鉴权类型不存在
### 错误信息
The auth type does not exist.
### 可能原因
该错误码表示鉴权类型不存在，可能原因如下:
1. 查询/删除令牌时，指定的鉴权类型不存在。
### 处理步骤
1. 请使用存在的鉴权类型查询/删除。
## 12400005 会话不存在
### 错误信息
The session does not exist.
### 可能原因
该错误码表示会话不存在，可能原因如下:
1. 查询不存在的会话回调。
### 处理步骤
1. 请使用已成功打开的会话标识查询会话回调。
## 12400006 授权列表已达上限
### 错误信息
The size of authorization list reaches upper limit.
### 可能原因
该错误码表示授权列表已达上限，可能原因如下:
1. 设置访问/开放授权时，授权列表的大小超过1024。
### 处理步骤
1. 请取消设置操作，或者撤销已存在的访问/开放授权后再设置。
## 12400007 令牌数量已达上限
### 错误信息
The number of token reaches upper limit.
### 可能原因
该错误码表示令牌数量已达上限，可能原因如下:
1. 添加令牌时，目标账号的令牌数量已达1024。
### 处理步骤
1. 请取消添加操作，或者删除已存在的令牌后再添加。
## 12400008 自定义数据的数量已达上限
### 错误信息
The number of custom data reaches upper limit.
### 可能原因
该错误码表示自定义数据的数量已达上限，可能原因如下:
1. 设置自定义数据时，目标账号的自定义数据数量已达512。
### 处理步骤
1. 请取消设置操作，或者删除已存在的自定义数据。
## 12400009 自定义数据不存在
### 错误信息
The custom data does not exist.
### 可能原因
该错误码表示自定义数据不存在，可能原因如下:
1. 查询账号的自定义数据时，输入的键名不存在。
### 处理步骤
1. 请使用存在的自定义数据的键名查询。
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或