Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 379764bc 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 d30c6855
隐藏空白更改
内联 并排
Showing with 1362 addition and 1024 deletion
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @ 379764bc
...@@ -11,23 +11,20 @@ import account_appAccount from '@ohos.account.appAccount'; ...@@ -11,23 +11,20 @@ import account_appAccount from '@ohos.account.appAccount';
``` ```
## 系统能力
SystemCapability.Account.AppAccount
## account_appAccount.createAppAccountManager ## account_appAccount.createAppAccountManager
createAppAccountManager(): AppAccountManager; createAppAccountManager(): AppAccountManager
应用帐号管理：获取应用帐号模块对象。 应用帐号管理：获取应用帐号模块对象。
- 返回值： **系统能力：** SystemCapability.Account.AppAccount
| 类型 | 说明 |
| -------- | -------- | **返回值：**
| AppAccountManager | 获取应用帐号模块的实例。 | | 类型 | 说明 |
| ----------------- | ------------------------ |
| AppAccountManager | 获取应用帐号模块的实例。 |
- 示例： **示例：**
``` ```
var appAccountManager = account.createAppAccountManager(); var appAccountManager = account.createAppAccountManager();
``` ```
...@@ -38,20 +35,20 @@ createAppAccountManager(): AppAccountManager; ...@@ -38,20 +35,20 @@ createAppAccountManager(): AppAccountManager;
### addAccount ### addAccount
addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void; addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。 将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。
需要权限：无。 **系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ------------------------------------------ | | -------- | ------------------------- | ---- | ------------------------------------------ |
| name | string | 是 | 要添加的应用帐户的名称。 | | name | string | 是 | 要添加的应用帐户的名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 将此应用的帐号名添加到帐号管理服务的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 将此应用的帐号名添加到帐号管理服务的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -62,21 +59,21 @@ addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void; ...@@ -62,21 +59,21 @@ addAccount(name: string, callback: AsyncCallback&lt;void&gt;): void;
### addAccount ### addAccount
addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void; addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void
将此应用程序的帐号名和额外信息添加到帐号管理服务中，使用callback回调异步返回结果。 将此应用程序的帐号名和额外信息添加到帐号管理服务中，使用callback回调异步返回结果。
需要权限：无。 **系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------- | ---- | ------------------------------------------------------------ | | --------- | ------------------------- | ---- | ------------------------------------------------------------ |
| name | string | 是 | 要添加的应用帐户的名称。 | | name | string | 是 | 要添加的应用帐户的名称。 |
| extraInfo | string | 是 | 要添加的应用帐户的额外信息(例如token等)，额外的信息不能是应用帐号的敏感信息。 | | extraInfo | string | 是 | 要添加的应用帐户的额外信息(例如token等)，额外的信息不能是应用帐号的敏感信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -89,26 +86,26 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;) ...@@ -89,26 +86,26 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;)
### addAccount ### addAccount
addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;; addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;
将此应用的帐号名或额外信息添加到帐号管理服务中，使用Promise方式异步返回结果。 将此应用的帐号名或额外信息添加到帐号管理服务中，使用Promise方式异步返回结果。
需要权限：无。 **系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------------------------------------------------------ | | --------- | ------ | ---- | ------------------------------------------------------------ |
| name | string | 是 | 要添加的应用帐户的名称。 | | name | string | 是 | 要添加的应用帐户的名称。 |
| extraInfo | string | 是 | 要添加的应用帐户的额外信息，额外的信息不能是应用帐号的敏感信息。 | | extraInfo | string | 是 | 要添加的应用帐户的额外信息，额外的信息不能是应用帐号的敏感信息。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------- | ---------------------------------- | | ------------------- | ---------------------------------- |
| Promise&lt;void&gt; | romise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | romise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -121,22 +118,22 @@ addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;; ...@@ -121,22 +118,22 @@ addAccount(name: string, extraInfo?: string): Promise&lt;void&gt;;
### addAccountImplicitly<sup>8+</sup> ### addAccountImplicitly<sup>8+</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回调异步返回结果。
需要权限：无。 **系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | --- | -------------------------- | | -------- | --------------------- | ---- | ------------------------------ |
| owner | string | 是 | 要添加的应用帐户的所有者包名。 | | owner | string | 是 | 要添加的应用帐户的所有者包名。 |
| authType | string | 是 | 要添加的应用帐户的鉴权类型。 | | authType | string | 是 | 要添加的应用帐户的鉴权类型。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 | | callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
- 示例： **示例：**
``` ```
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -162,18 +159,20 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a ...@@ -162,18 +159,20 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a
### deleteAccount ### deleteAccount
deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void; deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void
从帐号管理服务中删除应用帐号，使用callback回调异步返回结果。 从帐号管理服务中删除应用帐号，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ------------------- | ---- | ---------------------------------- |
| name | string | 是 | 要删除的应用帐户的名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 帐号管理服务中删除应用帐号的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------- |
| name | string | 是 | 要删除的应用帐户的名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 帐号管理服务中删除应用帐号的回调。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -184,23 +183,25 @@ deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void; ...@@ -184,23 +183,25 @@ deleteAccount(name: string, callback: AsyncCallback&lt;void&gt;): void;
### deleteAccount ### deleteAccount
deleteAccount(name: string): Promise&lt;void&gt;; deleteAccount(name: string): Promise&lt;void&gt;
从帐号管理服务中删除应用帐号，使用Promise方式异步返回结果。 从帐号管理服务中删除应用帐号，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------ | | ------ | ------ | ---- | ------------------------ |
| name | string | 是 | 要删除的应用帐户的名称。 | | name | string | 是 | 要删除的应用帐户的名称。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -213,19 +214,21 @@ deleteAccount(name: string): Promise&lt;void&gt;; ...@@ -213,19 +214,21 @@ deleteAccount(name: string): Promise&lt;void&gt;;
### disableAppAccess ### disableAppAccess
disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void; disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void
禁止指定第三方应用帐户的名称访问指定包名称的第三方应用，使用callback回调异步返回结果。 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ---------- | ------------------- | ---- | ------------------------------------------------------------ |
| name | string | 是 | 要禁用访问的第三方应用帐户的名称。 |
| bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------------------------------------------------ |
| name | string | 是 | 要禁用访问的第三方应用帐户的名称。 |
| bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -236,24 +239,26 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;vo ...@@ -236,24 +239,26 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;vo
### disableAppAccess ### disableAppAccess
disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;; disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
禁止指定第三方应用帐户的名称访问指定包名称的第三方应用，使用Promise方式异步返回结果。 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---------------------------------- | | ---------- | ------ | ---- | ---------------------------------- |
| name | string | 是 | 要禁用访问的第三方应用帐户的名称。 | | name | string | 是 | 要禁用访问的第三方应用帐户的名称。 |
| bundleName | string | 是 | 第三方应用的包名。 | | bundleName | string | 是 | 第三方应用的包名。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -266,19 +271,21 @@ disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;; ...@@ -266,19 +271,21 @@ disableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;;
### enableAppAccess ### enableAppAccess
enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void; enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;void&gt;): void
允许指定第三方应用帐户的名称访问指定包名称的第三方应用，使用callback回调异步返回结果。 允许指定第三方应用帐户的名称访问指定包名称的第三方应用，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ---------- | ------------------- | ---- | ------------------------------------------------------------ |
| name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------------------------------------------------ |
| name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -289,24 +296,26 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;voi ...@@ -289,24 +296,26 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback&lt;voi
### enableAppAccess ### enableAppAccess
enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;; enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;
允许指定第三方应用帐户的名称访问指定包名称的第三方应用，使用Promise方式异步返回结果。 允许指定第三方应用帐户的名称访问指定包名称的第三方应用，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------------ | | ---------- | ------ | ---- | ------------------ |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| bundleName | string | 是 | 第三方应用的包名。 | | bundleName | string | 是 | 第三方应用的包名。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
app_account_instance.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { app_account_instance.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => {
...@@ -318,20 +327,22 @@ enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;; ...@@ -318,20 +327,22 @@ enableAppAccess(name: string, bundleName: string): Promise&lt;void&gt;;
### checkAppAccountSyncEnable ### checkAppAccountSyncEnable
checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): void; checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): void
检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。 检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。
需要权限：ohos.permission.DISTRIBUTED_DATASYNC，系统应用可用。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC，仅系统应用可用。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ---------------------- | ---- | -------------------------------------------- |
| name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查指定应用帐号是否允许应用数据同步的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | -------------------------------------------- |
| name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查指定应用帐号是否允许应用数据同步的回调。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -343,25 +354,27 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;): ...@@ -343,25 +354,27 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback&lt;boolean&gt;):
### checkAppAccountSyncEnable ### checkAppAccountSyncEnable
checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;; checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;
检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。 检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。
需要权限：ohos.permission.DISTRIBUTED_DATASYNC，系统应用可用。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- | | ------ | ------ | ---- | -------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------- | :---------------------------------- | | :--------------------- | :---------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -374,20 +387,22 @@ checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;; ...@@ -374,20 +387,22 @@ checkAppAccountSyncEnable(name: string): Promise&lt;boolean&gt;;
### setAccountCredential ### setAccountCredential
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回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------------- | ------------------- | ---- | ---------------------------- |
| name | string | 是 | 应用程序帐户的名称。 |
| credentialType | string | 是 | 要设置的凭据的类型。 |
| credential | string | 是 | 要设置的凭据。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置此应用帐号的凭据的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------- | ---- | ---------------------------- |
| name | string | 是 | 应用程序帐户的名称。 |
| credentialType | string | 是 | 要设置的凭据的类型。 |
| credential | string | 是 | 要设置的凭据。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置此应用帐号的凭据的回调。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -398,25 +413,27 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca ...@@ -398,25 +413,27 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca
### setAccountCredential ### setAccountCredential
setAccountCredential(name: string, credentialType: string, credential: string): Promise&lt;void&gt;; setAccountCredential(name: string, credentialType: string, credential: string): Promise&lt;void&gt;
设置此应用程序帐号的凭据，使用Promise方式异步返回结果。 设置此应用程序帐号的凭据，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | -------------------- | | -------------- | ------ | ---- | -------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| credentialType | string | 是 | 要设置的凭据的类型。 | | credentialType | string | 是 | 要设置的凭据的类型。 |
| credential | string | 是 | 要设置的凭据。 | | credential | string | 是 | 要设置的凭据。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -429,19 +446,21 @@ setAccountCredential(name: string, credentialType: string, credential: string): ...@@ -429,19 +446,21 @@ setAccountCredential(name: string, credentialType: string, credential: string):
### setAccountExtraInfo ### setAccountExtraInfo
setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void; setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;void&gt;): void
设置此应用程序帐号的额外信息，使用callback回调异步返回结果。 设置此应用程序帐号的额外信息，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------- | ---- | -------------------------------- | | --------- | ------------------------- | ---- | -------------------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| extraInfo | string | 是 | 要设置的额外信息。 | | extraInfo | string | 是 | 要设置的额外信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置此应用帐号的额外信息的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 设置此应用帐号的额外信息的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -452,24 +471,26 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt; ...@@ -452,24 +471,26 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback&lt;
### setAccountExtraInfo ### setAccountExtraInfo
setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;; setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;
设置此应用程序帐号的额外信息，使用Promise方式异步返回结果。 设置此应用程序帐号的额外信息，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| --------- | ------ | ---- | ------------------ |
| name | string | 是 | 应用帐户的名称。 |
| extraInfo | string | 是 | 要设置的额外信息。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------------ |
| name | string | 是 | 应用帐户的名称。 |
| extraInfo | string | 是 | 要设置的额外信息。 |
| 类型 | 说明 | **返回值：**
| :------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -482,21 +503,23 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;; ...@@ -482,21 +503,23 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise&lt;void&gt;;
### setAppAccountSyncEnable ### setAppAccountSyncEnable
setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void; setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback&lt;void&gt;): void
设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。 设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。
需要权限：ohos.permission.DISTRIBUTED_DATASYNC，系统应用可用。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | -------------------------------------------------- | | -------- | ------------------------- | ---- | -------------------------------------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| isEnable | boolean | 是 | 是否允许应用数据同步。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -507,26 +530,28 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback ...@@ -507,26 +530,28 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback
### setAppAccountSyncEnable ### setAppAccountSyncEnable
setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;; setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;
设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。 设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。
需要权限：ohos.permission.DISTRIBUTED_DATASYNC，系统应用可用。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC，仅系统应用可用。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ------- | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 |
| isEnable | boolean | 是 | 是否允许应用数据同步。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------- | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 |
| isEnable | boolean | 是 | 是否允许应用数据同步。 |
| 类型 | 说明 | **返回值：**
| :------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -539,20 +564,22 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;; ...@@ -539,20 +564,22 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise&lt;void&gt;;
### setAssociatedData ### setAssociatedData
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
设置与此应用程序帐号关联的数据，使用callback回调异步返回结果。 设置与此应用程序帐号关联的数据，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ---------------------------------- | | -------- | ------------------------- | ---- | ---------------------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 |
| value | string | 是 | 要设置的数据的值。 | | value | string | 是 | 要设置的数据的值。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置与此应用帐号关联的数据的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 设置与此应用帐号关联的数据的回调。 |
- 示例： **示例：**
``` ```
app_account_instance.setAssociatedData("ZhangSan", "k001", "v001", (err) => { app_account_instance.setAssociatedData("ZhangSan", "k001", "v001", (err) => {
...@@ -562,25 +589,27 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb ...@@ -562,25 +589,27 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb
### setAssociatedData ### setAssociatedData
setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;; setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;
设置与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 设置与此应用程序帐号关联的数据，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ------ | ------ | ---- | ---------------------------------- |
| name | string | 是 | 应用帐户的名称。 |
| key | string | 是 | 要设置的数据的键，密钥可以自定义。 |
| value | string | 是 | 要设置的数据的值。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------------- |
| name | string | 是 | 应用帐户的名称。 |
| key | string | 是 | 要设置的数据的键，密钥可以自定义。 |
| value | string | 是 | 要设置的数据的值。 |
| 类型 | 说明 | **返回值：**
| :------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -593,19 +622,21 @@ setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt; ...@@ -593,19 +622,21 @@ setAssociatedData(name: string, key: string, value: string): Promise&lt;void&gt;
### getAccountCredential ### getAccountCredential
getAccountCredential(name: string, credentialType: string, callback: AsyncCallback&lt;string&gt;): void; getAccountCredential(name: string, credentialType: string, callback: AsyncCallback&lt;string&gt;): void
获取此应用帐号的凭据，使用callback回调异步返回结果。 获取此应用帐号的凭据，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | --------------------- | ---- | ---------------------------- | | -------------- | --------------------------- | ---- | ---------------------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| credentialType | string | 是 | 要获取的凭据的类型。 | | credentialType | string | 是 | 要获取的凭据的类型。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的凭据的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的凭据的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -617,24 +648,26 @@ getAccountCredential(name: string, credentialType: string, callback: AsyncCallba ...@@ -617,24 +648,26 @@ getAccountCredential(name: string, credentialType: string, callback: AsyncCallba
### getAccountCredential ### getAccountCredential
getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt;; getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt;
获取此应用程序帐号的凭据，使用Promise方式异步返回结果。 获取此应用程序帐号的凭据，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------------- | ------ | ---- | -------------------- |
| name | string | 是 | 应用帐号名称。 |
| credentialType | string | 是 | 要获取的凭据的类型。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | -------------------- |
| name | string | 是 | 应用帐号名称。 |
| credentialType | string | 是 | 要获取的凭据的类型。 |
| 类型 | 说明 | **返回值：**
| :-------------- | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| :-------------------- | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -647,18 +680,20 @@ getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt ...@@ -647,18 +680,20 @@ getAccountCredential(name: string, credentialType: string): Promise&lt;string&gt
### getAccountExtraInfo ### getAccountExtraInfo
getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void; getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void
获取此应用帐号的额外信息，使用callback回调异步返回结果。 获取此应用帐号的额外信息，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | -------------------------------- | | -------- | --------------------------- | ---- | -------------------------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的额外信息的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 获取此应用帐号的额外信息的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -670,23 +705,25 @@ getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void; ...@@ -670,23 +705,25 @@ getAccountExtraInfo(name: string, callback: AsyncCallback&lt;string&gt;): void;
### getAccountExtraInfo ### getAccountExtraInfo
getAccountExtraInfo(name: string): Promise&lt;string&gt;; getAccountExtraInfo(name: string): Promise&lt;string&gt;
获取此应用程序帐号的额外信息，使用Promise方式异步返回结果。 获取此应用程序帐号的额外信息，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ------ | ------ | ---- | -------------- |
| name | string | 是 | 应用帐号名称。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------- |
| name | string | 是 | 应用帐号名称。 |
| 类型 | 说明 | **返回值：**
| :-------------- | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| :-------------------- | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -699,19 +736,21 @@ getAccountExtraInfo(name: string): Promise&lt;string&gt;; ...@@ -699,19 +736,21 @@ getAccountExtraInfo(name: string): Promise&lt;string&gt;;
### getAssociatedData ### getAssociatedData
getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void; getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&gt;): void
获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。 获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------------------------------- | | -------- | --------------------------- | ---- | ---------------------------------- |
| name | string | 是 | 应用帐号名称。 | | name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的key。 | | key | string | 是 | 要获取的数据的key。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 获取与此应用帐号关联的数据的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 获取与此应用帐号关联的数据的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -723,24 +762,26 @@ getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&g ...@@ -723,24 +762,26 @@ getAssociatedData(name: string, key: string, callback: AsyncCallback&lt;string&g
### getAssociatedData ### getAssociatedData
getAssociatedData(name: string, key: string): Promise&lt;string&gt;; getAssociatedData(name: string, key: string): Promise&lt;string&gt;
获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ------ | ------ | ---- | ------------------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的key。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------- |
| name | string | 是 | 应用帐号名称。 |
| key | string | 是 | 要获取的数据的key。 |
| 类型 | 说明 | **返回值：**
| :-------------- | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| :-------------------- | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -753,19 +794,21 @@ getAssociatedData(name: string, key: string): Promise&lt;string&gt;; ...@@ -753,19 +794,21 @@ getAssociatedData(name: string, key: string): Promise&lt;string&gt;;
### getAllAccessibleAccounts ### getAllAccessibleAccounts
getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void; getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
获取全部应用已授权帐号信息。 获取全部应用已授权帐号信息。
需要权限：ohos.permission.GET_ACCOUNTS_PRIVILEGED，系统应用可用。 **需要权限：** ohos.permission.GET_ACCOUNTS_PRIVILEGED，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ---------------- | | -------- | ------------------------------------------------ | ---- | ---------------- |
| callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 应用帐号信息列表 | | callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 应用帐号信息列表 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -777,19 +820,21 @@ getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;& ...@@ -777,19 +820,21 @@ getAllAccessibleAccounts(callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&
### getAllAccessibleAccounts ### getAllAccessibleAccounts
getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;; getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
获取全部应用已授权帐号信息。 获取全部应用已授权帐号信息。
需要权限：ohos.permission.GET_ACCOUNTS_PRIVILEGED，系统应用可用。 **需要权限：** ohos.permission.GET_ACCOUNTS_PRIVILEGED，仅系统应用可用。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 类型 | 说明 | **参数：**
| ------------------------------ | ----------------------------------- |
| Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| ------------------------------------------ | ----------------------------------- |
| Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -802,20 +847,22 @@ getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;; ...@@ -802,20 +847,22 @@ getAllAccessibleAccounts(): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;;
### getAllAccounts ### getAllAccounts
getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void; getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
获取指定应用全部帐号信息。 获取指定应用全部帐号信息。
需要权限：ohos.permission.GET_ACCOUNTS_PRIVILEGED，系统应用可用。 **需要权限：** ohos.permission.GET_ACCOUNTS_PRIVILEGED，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ---------------- | | -------- | ------------------------------------------------ | ---- | ---------------- |
| owner | string | 是 | 应用包名称 | | owner | string | 是 | 应用包名称 |
| callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 应用帐号信息列表 | | callback | AsyncCallback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 应用帐号信息列表 |
- 示例： **示例：**
``` ```
const appAccountManager = account.createAppAccountManager(); const appAccountManager = account.createAppAccountManager();
...@@ -828,25 +875,27 @@ getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo ...@@ -828,25 +875,27 @@ getAllAccounts(owner: string, callback: AsyncCallback&lt;Array&lt;AppAccountInfo
### getAllAccounts ### getAllAccounts
getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;; getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;
获取指定应用全部帐号信息。 获取指定应用全部帐号信息。
需要权限：ohos.permission.GET_ACCOUNTS_PRIVILEGED，系统应用可用。 **需要权限：** ohos.permission.GET_ACCOUNTS_PRIVILEGED，仅系统应用可用。
**系统能力：** SystemCapability.Account.AppAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- | | ------ | ------ | ---- | ---------- |
| owner | string | 是 | 应用包名称 | | owner | string | 是 | 应用包名称 |
- 参数： **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------ | ----------------------------------- | | ------------------------------------------ | ----------------------------------- |
| Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;AppAccountInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -860,19 +909,21 @@ getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;; ...@@ -860,19 +909,21 @@ getAllAccounts(owner: string): Promise&lt;Array&lt;AppAccountInfo&gt;&gt;;
### on('change') ### on('change')
on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void; on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;AppAccountInfo&gt;&gt;): void
订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。 订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| type | 'change' | 是 | 关于帐户更改事件，当帐户所有者更新帐户时，订阅者将收到通知。 |
| owners | Array&lt;string&gt; | 是 | 指示帐户的所有者。 |
| callback | Callback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 订阅指定帐号所有者的帐户变更事件的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | 'change' | 是 | 关于帐户更改事件，当帐户所有者更新帐户时，订阅者将收到通知。 |
| owners | Array&lt;string&gt; | 是 | 指示帐户的所有者。 |
| callback | Callback&lt;Array&lt;AppAccountInfo&gt;&gt; | 是 | 订阅指定帐号所有者的帐户变更事件的回调。 |
**示例：**
``` ```
const appAccountManager = account.createAppAccountManager(); const appAccountManager = account.createAppAccountManager();
...@@ -889,18 +940,20 @@ on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;A ...@@ -889,18 +940,20 @@ on(type: 'change', owners: Array&lt;string&gt;, callback: Callback&lt;Array&lt;A
### off('change') ### off('change')
off(type: 'change', callback?: Callback&lt;void&gt;): void; off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void
取消订阅帐号事件，使用callback回调异步返回结果。 取消订阅帐号事件，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------------------- | ---- | ------------------------ |
| type | 'change' | 是 | 关于帐户更改事件。 | | type | 'change' | 是 | 关于帐户更改事件。 |
| callback | Callback&lt;void&gt; | 否 | 取消订阅帐号事件的回调。 | | callback | Callback<Array\<AppAccountInfo>> | 否 | 取消订阅帐号事件的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account.createAppAccountManager(); const appAccountManager = account.createAppAccountManager();
...@@ -920,21 +973,23 @@ off(type: 'change', callback?: Callback&lt;void&gt;): void; ...@@ -920,21 +973,23 @@ off(type: 'change', callback?: Callback&lt;void&gt;): void;
### authenticate<sup>8+</sup> ### authenticate<sup>8+</sup>
authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void; authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
鉴权应用帐户以获取OAuth令牌，使用callback回调异步返回结果。 鉴权应用帐户以获取OAuth令牌，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | --------------------- | ---- | --------------------------- |
| name | string | 是 | 要鉴权的应用帐户的名称。 |
| owner | string | 是 | 要鉴权的应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| options | {[key: string]: any} | 是 | 鉴权所需的可选项。 |
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------ |
| name | string | 是 | 要鉴权的应用帐户的名称。 |
| owner | string | 是 | 要鉴权的应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| options | {[key: string]: any} | 是 | 鉴权所需的可选项。 |
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
**示例：**
``` ```
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
...@@ -960,20 +1015,22 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri ...@@ -960,20 +1015,22 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri
### getOAuthToken<sup>8+</sup> ### getOAuthToken<sup>8+</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回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------- | | -------- | --------------------------- | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 查询结果的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 查询结果的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -985,25 +1042,27 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall ...@@ -985,25 +1042,27 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall
### getOAuthToken<sup>8+</sup> ### getOAuthToken<sup>8+</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方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ------ | ---- | -------------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
- 参数： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| 类型 | 说明 | **参数：**
| --------------------- | -------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| --------------------- | ----------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1016,20 +1075,22 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string& ...@@ -1016,20 +1075,22 @@ getOAuthToken(name: string, owner: string, authType: string): Promise&lt;string&
### setOAuthToken<sup>8+</sup> ### setOAuthToken<sup>8+</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回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------- | | -------- | ------------------------- | ---- | ---------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| token | string | 是 | OAuth令牌。 | | token | string | 是 | OAuth令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置结果的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 设置结果的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1040,25 +1101,27 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall ...@@ -1040,25 +1101,27 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall
### setOAuthToken<sup>8+</sup> ### setOAuthToken<sup>8+</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方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ------ | ---- | ------------- |
| name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 |
| token | string | 是 | OAuth令牌。 |
- 参数： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------- |
| name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 |
| token | string | 是 | OAuth令牌。 |
| 类型 | 说明 | **参数：**
| ------------------- | -------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| ------------------- | ----------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1071,21 +1134,23 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt ...@@ -1071,21 +1134,23 @@ setOAuthToken(name: string, authType: string, token: string): Promise&lt;void&gt
### deleteOAuthToken<sup>8+</sup> ### deleteOAuthToken<sup>8+</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回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------ | | -------- | ------------------------- | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| token | string | 是 | 要删除的OAuth令牌。 | | token | string | 是 | 要删除的OAuth令牌。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 删除结果的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 删除结果的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1096,26 +1161,28 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c ...@@ -1096,26 +1161,28 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c
### deleteOAuthToken<sup>8+</sup> ### deleteOAuthToken<sup>8+</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方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ------ | ---- | ------------------ |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| token | string | 是 | 要删除的OAuth令牌。 |
- 参数： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| token | string | 是 | 要删除的OAuth令牌。 |
| 类型 | 说明 | **参数：**
| ------------------------------ | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| ------------------- | ----------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1128,21 +1195,23 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string): ...@@ -1128,21 +1195,23 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string):
### setOAuthTokenVisibility<sup>8+</sup> ### setOAuthTokenVisibility<sup>8+</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回调异步返回结果。 设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ------------------- | | ---------- | ------------------------- | ---- | ------------------------ |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。| | bundleName | string | 是 | 被设置可见性的应用包名。 |
| isVisible | boolean | 是 | 是否可见。 | | isVisible | boolean | 是 | 是否可见。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置结果的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 设置结果的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1153,26 +1222,28 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi ...@@ -1153,26 +1222,28 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
### setOAuthTokenVisibility<sup>8+</sup> ### setOAuthTokenVisibility<sup>8+</sup>
setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise&lt;void&gt;; setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise&lt;void&gt;
设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。 设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ---------- | ------------------------- | ---- | ------------------- |
| name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。|
| isVisible | boolean | 是 | 是否可见。 |
- 参数： | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ------------------------ |
| name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 被设置可见性的应用包名。 |
| isVisible | boolean | 是 | 是否可见。 |
| 类型 | 说明 | **参数：**
| ------------------------------ | --------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| ------------------- | ----------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1186,20 +1257,22 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi ...@@ -1186,20 +1257,22 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
### checkOAuthTokenVisibility<sup>8+</sup> ### checkOAuthTokenVisibility<sup>8+</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回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------- | ---- | ---------------------- | | ---------- | ---------------------------- | ---- | -------------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 | | authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 用于检查可见性的应用包名。 | | bundleName | string | 是 | 用于检查可见性的应用包名。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 检查结果的回调。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 检查结果的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1211,25 +1284,27 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca ...@@ -1211,25 +1284,27 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca
### checkOAuthTokenVisibility<sup>8+</sup> ### checkOAuthTokenVisibility<sup>8+</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方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ---------- | ------------------------- | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 用于检查可见性的应用包名。 |
- 参数： | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | -------------------------- |
| name | string | 是 | 应用帐户的名称。 |
| authType | string | 是 | 鉴权类型。 |
| bundleName | string | 是 | 用于检查可见性的应用包名。 |
| 类型 | 说明 | **参数：**
| ------------------------------ | ------------------------ |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： | 类型 | 说明 |
| ---------------------- | ----------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1242,19 +1317,21 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P ...@@ -1242,19 +1317,21 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P
### getAllOAuthTokens<sup>8+</sup> ### getAllOAuthTokens<sup>8+</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回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | ------------------- | | -------- | ------------------------------------------------ | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt; | 是 | 查询结果的回调。 | | callback | AsyncCallback&lt;Array&lt;OAuthTokenInfo&gt;&gt; | 是 | 查询结果的回调。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1266,24 +1343,26 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array& ...@@ -1266,24 +1343,26 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback&lt;Array&
### getAllOAuthTokens<sup>8+</sup> ### getAllOAuthTokens<sup>8+</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方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------- | | ------ | ------ | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
- 参数： **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------ | ----------------------------------- | | ------------------------------------------ | ----------------------------------- |
| Promise&lt;Array&lt;OAuthTokenInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;OAuthTokenInfo&gt;&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1296,19 +1375,21 @@ getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenIn ...@@ -1296,19 +1375,21 @@ getAllOAuthTokens(name: string, owner: string): Promise&lt;Array&lt;OAuthTokenIn
### getOAuthList<sup>8+</sup> ### getOAuthList<sup>8+</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回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ---------------------------------------- | ---- | ------------------ |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 查询结果的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 查询结果的回调。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1320,24 +1401,26 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt ...@@ -1320,24 +1401,26 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback&lt;Array&lt
### getOAuthList<sup>8+</sup> ### getOAuthList<sup>8+</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方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------- | | ------ | ------ | ---- | ---------------------- |
| name | string | 是 | 应用帐户的名称。 | | name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
- 参数： **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------ | ------------------------------------ | | ---------------------------------- | ----------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;Array&lt;string&gt;&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1350,18 +1433,20 @@ getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt; ...@@ -1350,18 +1433,20 @@ getOAuthList(name: string, authType: string): Promise&lt;Array&lt;string&gt;&gt;
### getAuthenticatorCallback<sup>8+</sup> ### getAuthenticatorCallback<sup>8+</sup>
getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;AuthenticatorCallback&gt;): void; getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;AuthenticatorCallback&gt;): void
获取鉴权会话的认证器回调，使用callback回调异步返回结果。 获取鉴权会话的认证器回调，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| --------- | ------------------------------------------ | ---- | -------------- |
| sessionId | string | 是 | 鉴权会话的标识。 |
| callback | AsyncCallback&lt;AuthenticatorCallback&gt; | 是 | 查询结果的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------------ | ---- | ---------------- |
| sessionId | string | 是 | 鉴权会话的标识。 |
| callback | AsyncCallback&lt;AuthenticatorCallback&gt; | 是 | 查询结果的回调。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1383,23 +1468,25 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;Authentic ...@@ -1383,23 +1468,25 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback&lt;Authentic
### getAuthenticatorCallback<sup>8+</sup> ### getAuthenticatorCallback<sup>8+</sup>
getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt;; getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt;
获取鉴权会话的认证器回调，使用Promise方式异步返回结果。 获取鉴权会话的认证器回调，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | -------------- | | --------- | ------ | ---- | ---------------- |
| sessionId | string | 是 | 鉴权会话的标识。 | | sessionId | string | 是 | 鉴权会话的标识。 |
- 参数： **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------ | -------------------------------- | | ------------------------------------ | ----------------------------------- |
| Promise&lt;AuthenticatorCallback&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;AuthenticatorCallback&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1421,18 +1508,20 @@ getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt ...@@ -1421,18 +1508,20 @@ getAuthenticatorCallback(sessionId: string): Promise&lt;AuthenticatorCallback&gt
### getAuthenticatorInfo<sup>8+</sup> ### getAuthenticatorInfo<sup>8+</sup>
getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void; getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo&gt;): void
获取指定应用帐户的认证器信息，使用callback回调异步返回结果。 获取指定应用帐户的认证器信息，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | -------------------------------------- | ---- | ------------------- |
| owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback&lt;AuthenticatorInfo&gt; | 是 | 查询结果的回调。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------------- |
| owner | string | 是 | 应用帐户的所有者包名。 |
| callback | AsyncCallback&lt;AuthenticatorInfo&gt; | 是 | 查询结果的回调。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1444,23 +1533,25 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo ...@@ -1444,23 +1533,25 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback&lt;AuthenticatorInfo
### getAuthenticatorInfo<sup>8+</sup> ### getAuthenticatorInfo<sup>8+</sup>
getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;; getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;
获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。 获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | -------------------- | | ------ | ------ | ---- | ---------------------- |
| owner | string | 是 | 应用帐户的所有者包名。 | | owner | string | 是 | 应用帐户的所有者包名。 |
- 参数： **参数：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------ | ----------------------------------- | | -------------------------------- | ----------------------------------- |
| Promise&lt;AuthenticatorInfo&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;AuthenticatorInfo&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1475,26 +1566,32 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;; ...@@ -1475,26 +1566,32 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;;
表示应用帐号信息。 表示应用帐号信息。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| ----- | ------ | ---- | ---------------- |
| owner | string | 是 | 应用帐户的所有者包名。 | | 参数名 | 类型 | 必填 | 说明 |
| name | string | 是 | 应用帐户的名称。 | | ------ | ------ | ---- | ---------------------- |
| owner | string | 是 | 应用帐户的所有者包名。 |
| name | string | 是 | 应用帐户的名称。 |
## OAuthTokenInfo<sup>8+</sup> ## OAuthTokenInfo<sup>8+</sup>
表示OAuth令牌信息。 表示OAuth令牌信息。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| -------- | ------ | ---- | -------------- |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------- |
| authType | string | 是 | 令牌的鉴权类型。 | | authType | string | 是 | 令牌的鉴权类型。 |
| token | string | 是 | 令牌的取值。 | | token | string | 是 | 令牌的取值。 |
## AuthenticatorInfo<sup>8+</sup> ## AuthenticatorInfo<sup>8+</sup>
表示OAuth认证器信息。 表示OAuth认证器信息。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| ------- | ------ | ---- | ------------------ |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------------- |
| owner | string | 是 | 认证器的所有者包名。 | | owner | string | 是 | 认证器的所有者包名。 |
| iconId | string | 是 | 认证器的图标标识。 | | iconId | string | 是 | 认证器的图标标识。 |
| labelId | string | 是 | 认证器的标签标识。 | | labelId | string | 是 | 认证器的标签标识。 |
...@@ -1503,45 +1600,49 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;; ...@@ -1503,45 +1600,49 @@ getAuthenticatorInfo(owner: string): Promise&lt;AuthenticatorInfo&gt;;
表示常量的枚举。 表示常量的枚举。
| 名称 | 默认值 | 描述 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| ----------------------------- | ---------------------- | ----------------------- |
| 名称 | 默认值 | 描述 |
| ----------------------------- | ---------------------- | ------------------------- |
| ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作_隐式添加帐号。 | | ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作_隐式添加帐号。 |
| ACTION_AUTHENTICATE | "authenticate" | 表示操作_鉴权。 | | ACTION_AUTHENTICATE | "authenticate" | 表示操作_鉴权。 |
| KEY_NAME | "name" | 表示键名_应用帐户名称。 | | KEY_NAME | "name" | 表示键名_应用帐户名称。 |
| KEY_OWNER | "owner" | 表示键名_应用帐户所有者。 | | KEY_OWNER | "owner" | 表示键名_应用帐户所有者。 |
| KEY_TOKEN | "token" | 表示键名_令牌。 | | KEY_TOKEN | "token" | 表示键名_令牌。 |
| KEY_ACTION | "action" | 表示键名_操作。 | | KEY_ACTION | "action" | 表示键名_操作。 |
| KEY_AUTH_TYPE | "authType" | 表示键名_鉴权类型。 | | KEY_AUTH_TYPE | "authType" | 表示键名_鉴权类型。 |
| KEY_SESSION_ID | "sessionId" | 表示键名_会话标识。 | | KEY_SESSION_ID | "sessionId" | 表示键名_会话标识。 |
| KEY_CALLER_PID | "callerPid" | 表示键名_调用方PID。 | | KEY_CALLER_PID | "callerPid" | 表示键名_调用方PID。 |
| KEY_CALLER_UID | "callerUid" | 表示键名_调用方UID。 | | KEY_CALLER_UID | "callerUid" | 表示键名_调用方UID。 |
| KEY_CALLER_BUNDLE_NAME | "callerBundleName" | 表示键名_调用方包名。 | | KEY_CALLER_BUNDLE_NAME | "callerBundleName" | 表示键名_调用方包名。 |
## ResultCode<sup>8+</sup> ## ResultCode<sup>8+</sup>
表示返回码的枚举。 表示返回码的枚举。
| 名称 | 默认值 | 描述 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| ----------------------------------- | ----- | ---------------------- |
| SUCCESS | 0 | 表示操作成功。 | | 名称 | 默认值 | 描述 |
| ERROR_ACCOUNT_NOT_EXIST | 10001 | 表示应用帐户不存在。 | | ----------------------------------- | ------ | ------------------------ |
| ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002 | 表示应用帐户服务异常。 | | SUCCESS | 0 | 表示操作成功。 |
| ERROR_INVALID_PASSWORD | 10003 | 表示密码无效。 | | ERROR_ACCOUNT_NOT_EXIST | 10001 | 表示应用帐户不存在。 |
| ERROR_INVALID_REQUEST | 10004 | 表示请求无效。 | | ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002 | 表示应用帐户服务异常。 |
| ERROR_INVALID_RESPONSE | 10005 | 表示响应无效。 | | ERROR_INVALID_PASSWORD | 10003 | 表示密码无效。 |
| ERROR_NETWORK_EXCEPTION | 10006 | 表示网络异常。 | | ERROR_INVALID_REQUEST | 10004 | 表示请求无效。 |
| ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST | 10007 | 表示认证器不存在。 | | ERROR_INVALID_RESPONSE | 10005 | 表示响应无效。 |
| ERROR_OAUTH_CANCELED | 10008 | 表示鉴权取消。 | | ERROR_NETWORK_EXCEPTION | 10006 | 表示网络异常。 |
| ERROR_OAUTH_LIST_TOO_LARGE | 10009 | 表示开放授权列表过大。 | | ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST | 10007 | 表示认证器不存在。 |
| ERROR_OAUTH_SERVICE_BUSY | 10010 | 表示开放授权服务忙碌。 | | ERROR_OAUTH_CANCELED | 10008 | 表示鉴权取消。 |
| ERROR_OAUTH_SERVICE_EXCEPTION | 10011 | 表示开放授权服务异常。 | | ERROR_OAUTH_LIST_TOO_LARGE | 10009 | 表示开放授权列表过大。 |
| ERROR_OAUTH_SESSION_NOT_EXIST | 10012 | 表示鉴权会话不存在。 | | ERROR_OAUTH_SERVICE_BUSY | 10010 | 表示开放授权服务忙碌。 |
| ERROR_OAUTH_TIMEOUT | 10013 | 表示鉴权超时。 | | ERROR_OAUTH_SERVICE_EXCEPTION | 10011 | 表示开放授权服务异常。 |
| ERROR_OAUTH_TOKEN_NOT_EXIST | 10014 | 表示开放授权令牌不存在。 | | ERROR_OAUTH_SESSION_NOT_EXIST | 10012 | 表示鉴权会话不存在。 |
| ERROR_OAUTH_TOKEN_TOO_MANY | 10015 | 表示开放授权令牌过多。 | | ERROR_OAUTH_TIMEOUT | 10013 | 表示鉴权超时。 |
| ERROR_OAUTH_UNSUPPORT_ACTION | 10016 | 表示不支持的鉴权操作。 | | ERROR_OAUTH_TOKEN_NOT_EXIST | 10014 | 表示开放授权令牌不存在。 |
| ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017 | 表示不支持的鉴权类型。 | | ERROR_OAUTH_TOKEN_TOO_MANY | 10015 | 表示开放授权令牌过多。 |
| ERROR_PERMISSION_DENIED | 10018 | 表示权限不足。 | | ERROR_OAUTH_UNSUPPORT_ACTION | 10016 | 表示不支持的鉴权操作。 |
| ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017 | 表示不支持的鉴权类型。 |
| ERROR_PERMISSION_DENIED | 10018 | 表示权限不足。 |
## AuthenticatorCallback<sup>8+</sup> ## AuthenticatorCallback<sup>8+</sup>
...@@ -1549,17 +1650,19 @@ OAuth认证器回调接口。 ...@@ -1549,17 +1650,19 @@ OAuth认证器回调接口。
### 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
通知鉴权结果。 通知鉴权结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------- | ---- | ----------- |
| code | number | 是 | 鉴权结果码。 |
| result | {[key: string]: any} | 是 | 鉴权结果。 |
- 示例： **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------- | ---- | ------------ |
| code | number | 是 | 鉴权结果码。 |
| result | {[key: string]: any} | 是 | 鉴权结果。 |
**示例：**
``` ```
const appAccountManager = account_appAccount.createAppAccountManager(); const appAccountManager = account_appAccount.createAppAccountManager();
...@@ -1577,16 +1680,18 @@ onResult: (code: number, result: {[key: string]: any}) =&gt; void; ...@@ -1577,16 +1680,18 @@ onResult: (code: number, result: {[key: string]: any}) =&gt; void;
### onRequestRedirected<sup>8+</sup> ### onRequestRedirected<sup>8+</sup>
onRequestRedirected: (request: Want) =&gt; void; onRequestRedirected: (request: Want) =&gt; void
通知鉴权请求被跳转。 通知鉴权请求被跳转。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---- | ---- | ------------------ | **参数：**
| request | Want | 是 | 用于跳转的请求信息。 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---- | ---- | -------------------- |
| request | Want | 是 | 用于跳转的请求信息。 |
- 示例： **示例：**
``` ```
class MyAuthenticator extends account_appAccount.Authenticator { class MyAuthenticator extends account_appAccount.Authenticator {
...@@ -1612,34 +1717,38 @@ OAuth认证器基类。 ...@@ -1612,34 +1717,38 @@ OAuth认证器基类。
### addAccountImplicitly<sup>8+</sup> ### addAccountImplicitly<sup>8+</sup>
addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void; addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
根据指定的鉴权类型和可选项，隐式地添加应用帐户，并使用callback回调异步返回结果。 根据指定的鉴权类型和可选项，隐式地添加应用帐户，并使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 参数名 | 类型 | 必填 | 说明 |
| ---------------- | --------------------- | --- | -------------------------- | **参数：**
| authType | string | 是 | 应用帐户的鉴权类型。 | | 参数名 | 类型 | 必填 | 说明 |
| callerBundleName | string | 是 | 鉴权请求方的包名。 | | ---------------- | --------------------- | ---- | ------------------------------ |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | authType | string | 是 | 应用帐户的鉴权类型。 |
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 | | callerBundleName | string | 是 | 鉴权请求方的包名。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
### authenticate<sup>8+</sup> ### authenticate<sup>8+</sup>
authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void; authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
对应用帐户进行鉴权，获取OAuth令牌，并使用callback回调异步返回结果。 对应用帐户进行鉴权，获取OAuth令牌，并使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.AppAccount
| 接口名 | 类型 | 必填 | 说明 |
| ---------------- | --------------------- | ---- | -------------------------- | **参数：**
| name | string | 是 | 应用帐户的名称。 | | 接口名 | 类型 | 必填 | 说明 |
| authType | string | 是 | 应用帐户的鉴权类型。 | | ---------------- | --------------------- | ---- | ------------------------------ |
| callerBundleName | string | 是 | 鉴权请求方的包名。 | | name | string | 是 | 应用帐户的名称。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | authType | string | 是 | 应用帐户的鉴权类型。 |
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 | | callerBundleName | string | 是 | 鉴权请求方的包名。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
| callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 |
- 示例： **示例：**
``` ```
class MyAuthenticator extends account_appAccount.Authenticator { class MyAuthenticator extends account_appAccount.Authenticator {
...@@ -1663,4 +1772,4 @@ authenticate(name: string, authType: string, callerBundleName: string, options: ...@@ -1663,4 +1772,4 @@ authenticate(name: string, authType: string, callerBundleName: string, options:
return new MyAuthenticator(); return new MyAuthenticator();
} }
} }
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @ 379764bc
...@@ -10,33 +10,34 @@ ...@@ -10,33 +10,34 @@
import account_osAccount from '@ohos.account.osAccount'; import account_osAccount from '@ohos.account.osAccount';
``` ```
## 系统能力
SystemCapability.Account.OsAccount
## account_osAccount.getAccountManager ## account_osAccount.getAccountManager
getAccountManager(): AccountManager getAccountManager(): AccountManager
获取系统帐号能力的实例。 获取系统帐号能力的实例。
- 返回值： **系统能力：** SystemCapability.Account.OsAccount
| 类型 | 说明 |
| -------- | -------- |
| [AccountManager](#accountmanager) | 获取系统帐号能力的实例。 |
- 示例： **返回值：**
| 类型 | 说明 |
| --------------------------------- | ------------------------ |
| [AccountManager](#accountmanager) | 获取系统帐号能力的实例。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
``` ```
## OsAccountType ## OsAccountType
枚举，系统帐号类型。 枚举，系统帐号类型。
| 参数 | 默认值 | 说明 |
| -------- | -------- | -------- | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。
| ADMIN | 0 | 管理员帐号。|
| NORMAL | 1 | 普通帐号。| | 参数 | 默认值 | 说明 |
| GUEST | 2 | 访客帐号。| | ------ | ------ | ------------ |
| ADMIN | 0 | 管理员帐号。 |
| NORMAL | 1 | 普通帐号。 |
| GUEST | 2 | 访客帐号。 |
## AccountManager ## AccountManager
...@@ -48,14 +49,18 @@ activateOsAccount(localId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -48,14 +49,18 @@ activateOsAccount(localId: number, callback: AsyncCallback&lt;void&gt;): void
激活指定系统帐号，使用callback回调异步返回结果。 激活指定系统帐号，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ------------------- | ---- | -------------------- |
| localId | number | 是 | 要激活的系统帐号ID。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
- 示例：激活ID为100的系统帐号 | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------- |
| localId | number | 是 | 要激活的系统帐号ID。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
**示例：**激活ID为100的系统帐号
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
var localId = 100; var localId = 100;
...@@ -70,19 +75,23 @@ activateOsAccount(localId: number): Promise&lt;void&gt; ...@@ -70,19 +75,23 @@ activateOsAccount(localId: number): Promise&lt;void&gt;
激活指定系统帐号，使用Promise方式异步返回结果。 激活指定系统帐号，使用Promise方式异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ------- | ------ | ---- | ------------ |
| localId | number | 是 | 要激活的系统帐号ID。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------------- |
| localId | number | 是 | 要激活的系统帐号ID。 |
| 类型 | 说明 | **返回值：**
| :------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例：激活ID为100的系统帐号 | 类型 | 说明 |
| :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**激活ID为100的系统帐号
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
var localId = 100; var localId = 100;
...@@ -99,13 +108,15 @@ isMultiOsAccountEnable(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -99,13 +108,15 @@ isMultiOsAccountEnable(callback: AsyncCallback&lt;boolean&gt;): void
判断是否支持多系统帐号，使用callback回调异步返回结果。 判断是否支持多系统帐号，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------ | | -------- | ---------------------------- | ---- | --------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，支持多系统帐号则返回true，否则返回false。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，支持多系统帐号则返回true，否则返回false。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -121,13 +132,15 @@ isMultiOsAccountEnable(): Promise&lt;boolean&gt; ...@@ -121,13 +132,15 @@ isMultiOsAccountEnable(): Promise&lt;boolean&gt;
判断是否支持多系统帐号，使用Promise方式异步返回结果。 判断是否支持多系统帐号，使用Promise方式异步返回结果。
- 返回值： **系统能力：** SystemCapability.Account.OsAccount
| 类型 | 说明 | **返回值：**
| :--------------- | :---------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，支持多系统帐号则返回true，否则返回false。 |
- 示例： | 类型 | 说明 |
| :--------------------- | :----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，支持多系统帐号则返回true，否则返回false。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -144,14 +157,18 @@ isOsAccountActived(localId: number, callback: AsyncCallback&lt;boolean&gt;): voi ...@@ -144,14 +157,18 @@ isOsAccountActived(localId: number, callback: AsyncCallback&lt;boolean&gt;): voi
判断指定系统帐号是否处于激活状态，使用callback回调异步返回结果。 判断指定系统帐号是否处于激活状态，使用callback回调异步返回结果。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS、ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ---------------------- | ---- | ------------------------------ |
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，处于激活状态则返回true，否则返回false。 |
- 示例：判断ID为100的系统帐号是否处于激活状态 | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------- |
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，处于激活状态则返回true，否则返回false。 |
**示例：**判断ID为100的系统帐号是否处于激活状态
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -168,19 +185,23 @@ isOsAccountActived(localId: number): Promise&lt;boolean&gt; ...@@ -168,19 +185,23 @@ isOsAccountActived(localId: number): Promise&lt;boolean&gt;
判断指定系统帐号是否处于激活状态，使用Promise方式异步返回结果。 判断指定系统帐号是否处于激活状态，使用Promise方式异步返回结果。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS、ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ | | ------- | ------ | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------- | :---------------------------------- | | :--------------------- | :----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，处于激活状态则返回true，否则返回false。 | | Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，处于激活状态则返回true，否则返回false。 |
- 示例：判断ID为100的系统帐号是否处于激活状态 **示例：**判断ID为100的系统帐号是否处于激活状态
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -196,17 +217,21 @@ isOsAccountActived(localId: number): Promise&lt;boolean&gt; ...@@ -196,17 +217,21 @@ isOsAccountActived(localId: number): Promise&lt;boolean&gt;
isOsAccountConstraintEnable(localId: number, constraint: string, callback: AsyncCallback&lt;boolean&gt;): void isOsAccountConstraintEnable(localId: number, constraint: string, callback: AsyncCallback&lt;boolean&gt;): void
判断指定系统帐号是否具有指定[约束](#系统帐号约束列表)，使用callback回调异步返回结果。 判断指定系统帐号是否具有指定约束，使用callback回调异步返回结果。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| ---------- | ---------------------- | ---- | ------------------------------ |
| localId | number | 是 | 指定的系统帐号ID。 |
| constraint | string | 是 | 指定的[约束](#系统帐号约束列表)名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，具有指定约束则返回true，否则返回false。 |
- 示例：判断ID为100的系统帐号是否有禁止使用wifi的[约束](#系统帐号约束列表) **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------- | ---- | ------------------------------------------------- |
| localId | number | 是 | 指定的系统帐号ID。 |
| constraint | string | 是 | 指定的[约束](#系统帐号约束列表)名称。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，具有指定约束则返回true，否则返回false。 |
**示例：**判断ID为100的系统帐号是否有禁止使用wifi的约束
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -221,22 +246,26 @@ isOsAccountConstraintEnable(localId: number, constraint: string, callback: Async ...@@ -221,22 +246,26 @@ isOsAccountConstraintEnable(localId: number, constraint: string, callback: Async
isOsAccountConstraintEnable(localId: number, constraint: string): Promise&lt;boolean&gt; isOsAccountConstraintEnable(localId: number, constraint: string): Promise&lt;boolean&gt;
判断指定系统帐号是否具有指定[约束](#系统帐号约束列表)，使用Promise方式异步返回结果。 判断指定系统帐号是否具有指定约束，使用Promise方式异步返回结果。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
- 参数： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---------------- | | ---------- | ------ | ---- | ------------------------------------- |
| localId | number | 是 | 指定的系统帐号ID。 | | localId | number | 是 | 指定的系统帐号ID。 |
| constraint | string | 是 | 指定的[约束](#系统帐号约束列表)名称。 | | constraint | string | 是 | 指定的[约束](#系统帐号约束列表)名称。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------- | :---------------------------------- | | :--------------------- | :----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，具有指定[约束](#系统帐号约束列表)则返回true，否则返回false。 | | Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，具有指定约束则返回true，否则返回false。 |
- 示例：判断ID为100的系统帐号是否有禁止使用wifi的[约束](#系统帐号约束列表) **示例：**判断ID为100的系统帐号是否有禁止使用wifi的约束
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -254,13 +283,15 @@ isTestOsAccount(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -254,13 +283,15 @@ isTestOsAccount(callback: AsyncCallback&lt;boolean&gt;): void
检查当前系统帐号是否为测试帐号，使用callback回调异步返回结果。 检查当前系统帐号是否为测试帐号，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ---------------------- | ---- | ------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，是测试帐号则返回true，否则返回false。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ----------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，是测试帐号则返回true，否则返回false。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -276,13 +307,15 @@ isTestOsAccount(): Promise&lt;boolean&gt; ...@@ -276,13 +307,15 @@ isTestOsAccount(): Promise&lt;boolean&gt;
检查当前系统帐号是否为测试帐号，使用Promise方式异步返回结果。 检查当前系统帐号是否为测试帐号，使用Promise方式异步返回结果。
- 返回值： **系统能力：** SystemCapability.Account.OsAccount
**返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------- | :---------------------------------- | | :--------------------- | :----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，是测试帐号则返回true，否则返回false。 | | Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，是测试帐号则返回true，否则返回false。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -299,13 +332,15 @@ isOsAccountVerified(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -299,13 +332,15 @@ isOsAccountVerified(callback: AsyncCallback&lt;boolean&gt;): void
检查当前系统帐号是否已验证，使用callback回调异步返回结果。 检查当前系统帐号是否已验证，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ---------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，已验证则返回true，否则返回false。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，已验证则返回true，否则返回false。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -321,14 +356,16 @@ isOsAccountVerified(localId: number, callback: AsyncCallback&lt;boolean&gt;): vo ...@@ -321,14 +356,16 @@ isOsAccountVerified(localId: number, callback: AsyncCallback&lt;boolean&gt;): vo
检查指定系统帐号是否已验证，使用callback回调异步返回结果。 检查指定系统帐号是否已验证，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------- | | -------- | ---------------------------- | ---- | ------------------------------------------- |
| localId | number | 否 | 指定的系统帐号ID。 | | localId | number | 否 | 指定的系统帐号ID。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，已验证则返回true，否则返回false。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 回调结果，已验证则返回true，否则返回false。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -340,23 +377,25 @@ isOsAccountVerified(localId: number, callback: AsyncCallback&lt;boolean&gt;): vo ...@@ -340,23 +377,25 @@ isOsAccountVerified(localId: number, callback: AsyncCallback&lt;boolean&gt;): vo
### isOsAccountVerified ### isOsAccountVerified
isOsAccountVerified(localId: number?): Promise&lt;boolean&gt; isOsAccountVerified(localId?: number): Promise&lt;boolean&gt;
检查指定系统帐号是否已验证，使用Promise方式异步返回结果。 检查指定系统帐号是否已验证，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ------- | ------ | ---- | ------------ |
| localId | number | 否 | 指定的系统帐号ID。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------ |
| localId | number | 否 | 指定的系统帐号ID。 |
| 类型 | 说明 | **返回值：**
| :--------------- | :---------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，已验证则返回true，否则返回false。 |
- 示例： | 类型 | 说明 |
| :--------------------- | :----------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise实例，用于获取异步返回结果，已验证则返回true，否则返回false。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -373,14 +412,20 @@ removeOsAccount(localId: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -373,14 +412,20 @@ removeOsAccount(localId: number, callback: AsyncCallback&lt;void&gt;): void
删除指定系统帐号，使用callback回调异步返回结果。 删除指定系统帐号，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ------------------------ | | -------- | ------------------------- | ---- | -------------------- |
| localId | number | 是 | 要删除的系统帐号ID。 | | localId | number | 是 | 要删除的系统帐号ID。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -399,19 +444,25 @@ removeOsAccount(localId: number): Promise&lt;void&gt; ...@@ -399,19 +444,25 @@ removeOsAccount(localId: number): Promise&lt;void&gt;
删除指定系统帐号，使用Promise方式异步返回结果。 删除指定系统帐号，使用Promise方式异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ | | ------- | ------ | ---- | -------------------- |
| localId | number | 是 | 要删除的系统帐号ID。 | | localId | number | 是 | 要删除的系统帐号ID。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------ | :---------------------------------- | | :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -431,18 +482,24 @@ removeOsAccount(localId: number): Promise&lt;void&gt; ...@@ -431,18 +482,24 @@ removeOsAccount(localId: number): Promise&lt;void&gt;
setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enable: boolean,callback: AsyncCallback&lt;void&gt;): void setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enable: boolean,callback: AsyncCallback&lt;void&gt;): void
为指定系统帐号设置/删除[约束](#系统帐号约束列表)，使用callback回调异步返回结果。 为指定系统帐号设置/删除约束返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
| 参数名 | 类型 | 必填 | 说明 | **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| ----------- | ------------------- | ---- | ------------------------------- |
| localId | number | 是 | 系统帐号ID。 |
| constraints | Array&lt;string&gt; | 是 | 待设置/删除的[约束](#系统帐号约束列表)列表。 |
| enable | boolean | 是 | 设置(true)/删除(false) |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
- 示例：给ID为100的系统帐号设置禁止使用wifi的[约束](#系统帐号约束列表) **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------- | ---- | -------------------------------------------- |
| localId | number | 是 | 系统帐号ID。 |
| constraints | Array&lt;string&gt; | 是 | 待设置/删除的[约束](#系统帐号约束列表)列表。 |
| enable | boolean | 是 | 设置(true)/删除(false) |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
**示例：**给ID为100的系统帐号设置禁止使用wifi的约束
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -456,23 +513,29 @@ setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enabl ...@@ -456,23 +513,29 @@ setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enabl
setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enable: boolean): Promise&lt;void&gt; setOsAccountConstraints(localId: number, constraints: Array&lt;string&gt;, enable: boolean): Promise&lt;void&gt;
为指定系统帐号设置/删除[约束](#系统帐号约束列表)，使用Promise方式异步返回结果。 为指定系统帐号设置/删除约束回结果。
此接口为系统接口，三方应用不支持调用。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| ----------- | ------------- | ---- | ----------------------- |
| localId | number | 是 | 系统帐号ID。 |
| constraints | Array&lt;string&gt; | 是 | 待设置/删除的[约束](#系统帐号约束列表)列表。 |
| enable | boolean | 是 | 设置(true)/删除(false)。 |
- 返回值： **参数：**
| 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :------------ | :---------------------------------- | | ----------- | ------------------- | ---- | -------------------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | localId | number | 是 | 系统帐号ID。 |
| constraints | Array&lt;string&gt; | 是 | 待设置/删除的[约束](#系统帐号约束列表)列表。 |
| enable | boolean | 是 | 设置(true)/删除(false)。 |
- 示例：删除ID为100的系统帐号的禁止使用wifi的[约束](#系统帐号约束列表) **返回值：**
| 类型 | 说明 |
| :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**删除ID为100的系统帐号的禁止使用wifi的约束
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -490,15 +553,19 @@ setOsAccountName(localId: number, localName: string, callback: AsyncCallback&lt; ...@@ -490,15 +553,19 @@ setOsAccountName(localId: number, localName: string, callback: AsyncCallback&lt;
设置指定系统帐号的帐号名，使用callback回调异步返回结果。 设置指定系统帐号的帐号名，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-------- | ------------------- | ---- | ------------------------ | | :-------- | ------------------------- | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
| localName | string | 是 | 帐号名。 | | localName | string | 是 | 帐号名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
- 示例：将ID为100的系统帐号的帐号名设置成demoName **示例：**将ID为100的系统帐号的帐号名设置成demoName
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -515,20 +582,24 @@ setOsAccountName(localId: number, localName: string): Promise&lt;void&gt; ...@@ -515,20 +582,24 @@ setOsAccountName(localId: number, localName: string): Promise&lt;void&gt;
设置指定系统帐号的帐号名，使用Promise方式异步返回结果。 设置指定系统帐号的帐号名，使用Promise方式异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| --------- | ------ | ---- | ----------------------- |
| localId | number | 是 | 系统帐号ID。 |
| localName | string | 是 | 帐号名。 |
- 返回值： **参数：**
| 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :------------ | :---------------------------------- | | --------- | ------ | ---- | ------------ |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | localId | number | 是 | 系统帐号ID。 |
| localName | string | 是 | 帐号名。 |
- 示例：将ID为100的系统帐号的帐号名设置成demoName **返回值：**
| 类型 | 说明 |
| :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**将ID为100的系统帐号的帐号名设置成demoName
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -547,13 +618,17 @@ getCreatedOsAccountsCount(callback: AsyncCallback&lt;number&gt;): void ...@@ -547,13 +618,17 @@ getCreatedOsAccountsCount(callback: AsyncCallback&lt;number&gt;): void
获取已创建的系统帐号数量，使用callback回调异步返回结果。 获取已创建的系统帐号数量，使用callback回调异步返回结果。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------ | | -------- | --------------------------- | ---- | ------------------------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是已创建的系统帐号的数量。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是已创建的系统帐号的数量。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -569,13 +644,17 @@ getCreatedOsAccountsCount(): Promise&lt;number&gt; ...@@ -569,13 +644,17 @@ getCreatedOsAccountsCount(): Promise&lt;number&gt;
获取已创建的系统帐号数量，使用Promise方式异步返回结果。 获取已创建的系统帐号数量，使用Promise方式异步返回结果。
- 返回值： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| 类型 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| :-------------- | :---------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是已创建的系统帐号的数量。 |
- 示例： **返回值：**
| 类型 | 说明 |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是已创建的系统帐号的数量。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -592,13 +671,15 @@ getOsAccountLocalIdFromProcess(callback: AsyncCallback&lt;number&gt;): void ...@@ -592,13 +671,15 @@ getOsAccountLocalIdFromProcess(callback: AsyncCallback&lt;number&gt;): void
获取当前进程所属的系统帐号的帐号ID，使用callback回调异步返回结果。 获取当前进程所属的系统帐号的帐号ID，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ----------------------------------------- | | -------- | --------------------------- | ---- | -------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是当前进程所属的系统帐号的帐号ID。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是当前进程所属的系统帐号的帐号ID。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -614,13 +695,15 @@ getOsAccountLocalIdFromProcess(): Promise&lt;number&gt; ...@@ -614,13 +695,15 @@ getOsAccountLocalIdFromProcess(): Promise&lt;number&gt;
获取当前进程所属的系统帐号的帐号ID，使用Promise方式异步返回结果。 获取当前进程所属的系统帐号的帐号ID，使用Promise方式异步返回结果。
- 返回值： **系统能力：** SystemCapability.Account.OsAccount
| 类型 | 说明 | **返回值：**
| :-------------- | :---------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是当前进程所属的系统帐号的帐号ID。 |
- 示例： | 类型 | 说明 |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是当前进程所属的系统帐号的帐号ID。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -637,14 +720,16 @@ getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback&lt;number&gt;): ...@@ -637,14 +720,16 @@ getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback&lt;number&gt;):
从进程uid中获取该uid所属的系统帐号的帐号ID，使用callback回调异步返回结果。 从进程uid中获取该uid所属的系统帐号的帐号ID，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | --------------------------------------- | | -------- | --------------------------- | ---- | --------------------------------------------- |
| uid | number | 是 | 进程uid。 | | uid | number | 是 | 进程uid。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是uid所属的系统帐号的帐号ID。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是uid所属的系统帐号的帐号ID。 |
- 示例：查询值为12345678的uid所属的系统帐号的帐号ID **示例：**查询值为12345678的uid所属的系统帐号的帐号ID
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -661,19 +746,21 @@ getOsAccountLocalIdFromUid(uid: number): Promise&lt;number&gt; ...@@ -661,19 +746,21 @@ getOsAccountLocalIdFromUid(uid: number): Promise&lt;number&gt;
从进程uid中获取该uid所属的系统帐号的帐号ID，使用Promise方式异步返回结果。 从进程uid中获取该uid所属的系统帐号的帐号ID，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ------ | ------ | ---- | ------------- |
| uid | number | 是 | 进程uid。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | --------- |
| uid | number | 是 | 进程uid。 |
| 类型 | 说明 | **返回值：**
| :-------------- | :---------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是uid所属的系统帐号的帐号ID。 |
- 示例：查询值为12345678的uid所属的系统帐号的帐号ID | 类型 | 说明 |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是uid所属的系统帐号的帐号ID。 |
**示例：**查询值为12345678的uid所属的系统帐号的帐号ID
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -685,20 +772,24 @@ getOsAccountLocalIdFromUid(uid: number): Promise&lt;number&gt; ...@@ -685,20 +772,24 @@ getOsAccountLocalIdFromUid(uid: number): Promise&lt;number&gt;
}); });
``` ```
### getOsAccountLocalIdFromDomain ### getOsAccountLocalIdFromDomain<sup>8+</sup>
getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;number&gt;): void getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;number&gt;): void
根据域帐号信息，获取与其关联的系统帐号的帐号ID。 根据域帐号信息，获取与其关联的系统帐号的帐号ID。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | --------------------- | ---- | --------------------------------------- |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 是 | 域帐号信息。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是和域帐号关联的系统帐号ID。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------------------------- | ---- | -------------------------------------------- |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 是 | 域帐号信息。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是和域帐号关联的系统帐号ID。 |
**示例：**
``` ```
var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; var domainInfo = {domain: "testDomain", accountName: "testAccountName"};
...@@ -709,25 +800,29 @@ getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCall ...@@ -709,25 +800,29 @@ getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCall
}); });
``` ```
### getOsAccountLocalIdFromDomain ### getOsAccountLocalIdFromDomain<sup>8+</sup>
getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise&lt;number&gt; getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise&lt;number&gt;
根据域帐号信息，获取与其关联的系统帐号的帐号ID，使用Promise方式异步返回结果。 根据域帐号信息，获取与其关联的系统帐号的帐号ID，使用Promise方式异步返回结果。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------- | | ---------- | --------------------------------------- | ---- | ------------ |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 是 | 域帐号信息。 | | domainInfo | [DomainAccountInfo](#domainaccountinfo) | 是 | 域帐号信息。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :---------------------------------- | | :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是和域帐号关联的系统帐号ID。 | | Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是和域帐号关联的系统帐号ID。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -745,13 +840,17 @@ queryMaxOsAccountNumber(callback: AsyncCallback&lt;number&gt;): void ...@@ -745,13 +840,17 @@ queryMaxOsAccountNumber(callback: AsyncCallback&lt;number&gt;): void
查询允许创建的系统帐号的最大数量，使用callback回调异步返回结果。 查询允许创建的系统帐号的最大数量，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| -------- | --------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是允许创建的系统帐号的最大数量。 |
- 示例： **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是允许创建的系统帐号的最大数量。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -767,13 +866,17 @@ queryMaxOsAccountNumber(): Promise&lt;number&gt; ...@@ -767,13 +866,17 @@ queryMaxOsAccountNumber(): Promise&lt;number&gt;
查询允许创建的系统帐号的最大数量，使用Promise方式异步返回结果。 查询允许创建的系统帐号的最大数量，使用Promise方式异步返回结果。
- 返回值： 此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount
**返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :---------------------------------- | | :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是允许创建的系统帐号的最大数量。 | | Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是允许创建的系统帐号的最大数量。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -788,16 +891,20 @@ queryMaxOsAccountNumber(): Promise&lt;number&gt; ...@@ -788,16 +891,20 @@ queryMaxOsAccountNumber(): Promise&lt;number&gt;
getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
获取指定系统帐号的全部[约束](#系统帐号约束列表)，使用callback回调异步返回结果。 获取指定系统帐号的全部约束，使用callback回调异步返回结果。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| -------- | ---------------------------- | ---- | ---------------------------------- |
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调结果，返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 |
- 示例：获取ID为100的系统帐号的全部[约束](#系统帐号约束列表) **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调结果，返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 |
**示例：**获取ID为100的系统帐号的全部约束
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -812,21 +919,25 @@ getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt; ...@@ -812,21 +919,25 @@ getOsAccountAllConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;
getOsAccountAllConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt; getOsAccountAllConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt;
获取指定系统帐号的全部[约束](#系统帐号约束列表)，使用Promise方式异步返回结果。 获取指定系统帐号的全部约束，使用Promise方式异步返回结果。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
- 参数： **系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ------- | ------ | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 |
| 类型 | 说明 | **返回值：**
| :--------------------- | :---------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例，用于获取异步返回结果，返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 |
- 示例：获取ID为100的系统帐号的全部[约束](#系统帐号约束列表) | 类型 | 说明 |
| :--------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例，用于获取异步返回结果，返回的是该系统帐号的全部[约束](#系统帐号约束列表)。 |
**示例：**获取ID为100的系统帐号的全部约束
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -844,13 +955,17 @@ queryAllCreatedOsAccounts(callback: AsyncCallback&lt;Array&lt;OsAccountInfo&gt;& ...@@ -844,13 +955,17 @@ queryAllCreatedOsAccounts(callback: AsyncCallback&lt;Array&lt;OsAccountInfo&gt;&
查询已创建的所有系统帐号的信息列表，使用callback回调异步返回结果。 查询已创建的所有系统帐号的信息列表，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | ----------------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | 是 | 回调结果，返回的是已创建的所有系统帐号的信息列表。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | 是 | 回调结果，返回的是已创建的所有系统帐号的信息列表。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -866,13 +981,17 @@ queryAllCreatedOsAccounts(): Promise&lt;Array&lt;OsAccountInfo&gt;&gt; ...@@ -866,13 +981,17 @@ queryAllCreatedOsAccounts(): Promise&lt;Array&lt;OsAccountInfo&gt;&gt;
查询已创建的所有系统帐号的信息列表，使用Promise方式异步返回结果。 查询已创建的所有系统帐号的信息列表，使用Promise方式异步返回结果。
- 返回值： 此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.Account.OsAccount
| 类型 | 说明 | **返回值：**
| :---------------------------- | :---------------------------------- |
| Promise&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | Promise实例，用于获取异步返回结果，返回的是已创建的所有系统帐号的信息列表。 |
- 示例： | 类型 | 说明 |
| :---------------------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | Promise实例，用于获取异步返回结果，返回的是已创建的所有系统帐号的信息列表。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -883,19 +1002,21 @@ queryAllCreatedOsAccounts(): Promise&lt;Array&lt;OsAccountInfo&gt;&gt; ...@@ -883,19 +1002,21 @@ queryAllCreatedOsAccounts(): Promise&lt;Array&lt;OsAccountInfo&gt;&gt;
}); });
``` ```
### queryActivatedOsAccountIds ### queryActivatedOsAccountIds<sup>8+</sup>
queryActivatedOsAccountIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void queryActivatedOsAccountIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
查询当前处于激活状态的系统帐号的ID列表，使用callback回调异步返回结果。 查询当前处于激活状态的系统帐号的ID列表，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | -------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 回调结果，返回的是当前处于激活状态的系统帐号的ID列表。 | | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 回调结果，返回的是当前处于激活状态的系统帐号的ID列表。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -908,19 +1029,21 @@ queryActivatedOsAccountIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): ...@@ -908,19 +1029,21 @@ queryActivatedOsAccountIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;):
}); });
``` ```
### queryActivatedOsAccountIds ### queryActivatedOsAccountIds<sup>8+</sup>
queryActivatedOsAccountIds(): Promise&lt;Array&lt;number&gt;&gt; queryActivatedOsAccountIds(): Promise&lt;Array&lt;number&gt;&gt;
查询当前处于激活状态的系统帐号的ID列表，使用Promise方式异步返回结果。 查询当前处于激活状态的系统帐号的ID列表，使用Promise方式异步返回结果。
- 返回值： **系统能力：** SystemCapability.Account.OsAccount
| 类型 | 说明 | **返回值：**
| :---------------------------- | :---------------------------------- |
| Promise&lt;Array&lt;number&gt;&gt; | Promise实例，用于获取异步返回结果，返回的是当前处于激活状态的系统帐号的ID列表。 |
- 示例： | 类型 | 说明 |
| :--------------------------------- | :----------------------------------------------------------- |
| Promise&lt;Array&lt;number&gt;&gt; | Promise实例，用于获取异步返回结果，返回的是当前处于激活状态的系统帐号的ID列表。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -937,15 +1060,21 @@ createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback& ...@@ -937,15 +1060,21 @@ createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback&
创建一个系统帐号，使用callback回调异步返回结果。 创建一个系统帐号，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| :-------- | ---------------------------- | ---- | -------------------- |
| localName | string | 是 | 创建的系统帐号的名称。 |
| type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果，返回的是新创建的系统帐号的信息。 |
- 示例： **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| :-------- | ---------------------------------------------------- | ---- | ------------------------------------------ |
| localName | string | 是 | 创建的系统帐号的名称。 |
| type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果，返回的是新创建的系统帐号的信息。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -961,20 +1090,26 @@ createOsAccount(localName: string, type: OsAccountType): Promise&lt;OsAccountInf ...@@ -961,20 +1090,26 @@ createOsAccount(localName: string, type: OsAccountType): Promise&lt;OsAccountInf
创建一个系统帐号，使用Promise方式异步返回结果。 创建一个系统帐号，使用Promise方式异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| --------- | ------------- | ---- | ---------------- |
| localName | string | 是 | 创建的系统帐号的名称。 |
| type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 |
- 返回值： | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ---------------------- |
| localName | string | 是 | 创建的系统帐号的名称。 |
| type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 |
| 类型 | 说明 | **返回值：**
| :--------------------- | :---------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例，用于获取异步返回结果，返回的是新创建的系统帐号的信息。 |
- 示例： | 类型 | 说明 |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例，用于获取异步返回结果，返回的是新创建的系统帐号的信息。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -985,21 +1120,27 @@ createOsAccount(localName: string, type: OsAccountType): Promise&lt;OsAccountInf ...@@ -985,21 +1120,27 @@ createOsAccount(localName: string, type: OsAccountType): Promise&lt;OsAccountInf
}); });
``` ```
### createOsAccountForDomain ### createOsAccountForDomain<sup>8+</sup>
createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;OsAccountInfo&gt;): void createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;OsAccountInfo&gt;): void
根据域帐号信息，创建一个系统帐号并将其与域帐号关联，使用callback回调异步返回结果。 根据域帐号信息，创建一个系统帐号并将其与域帐号关联，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| :-------- | ---------------------------- | ---- | -------------------- |
| type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 是 | 域帐号信息。 |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果，返回的是新创建的系统帐号的信息。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| :--------- | ---------------------------------------------------- | ---- | ------------------------------------------ |
| type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 是 | 域帐号信息。 |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果，返回的是新创建的系统帐号的信息。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1010,26 +1151,32 @@ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, cal ...@@ -1010,26 +1151,32 @@ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, cal
}); });
``` ```
### createOsAccountForDomain ### createOsAccountForDomain<sup>8+</sup>
createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo): Promise&lt;OsAccountInfo&gt; createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo): Promise&lt;OsAccountInfo&gt;
根据传入的域帐号信息，创建与其关联的系统帐号，使用Promise方式异步返回结果。 根据传入的域帐号信息，创建与其关联的系统帐号，使用Promise方式异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------- | ---- | ---------------- | | ---------- | --------------------------------------- | ---- | ---------------------- |
| type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 | | type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 是 | 域帐号信息。 | | domainInfo | [DomainAccountInfo](#domainaccountinfo) | 是 | 域帐号信息。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------------- | :---------------------------------- | | :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例，用于获取异步返回结果，返回的是新创建的系统帐号的信息。 | | Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例，用于获取异步返回结果，返回的是新创建的系统帐号的信息。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1047,13 +1194,17 @@ queryCurrentOsAccount(callback: AsyncCallback&lt;OsAccountInfo&gt;): void ...@@ -1047,13 +1194,17 @@ queryCurrentOsAccount(callback: AsyncCallback&lt;OsAccountInfo&gt;): void
查询当前进程所属的系统帐号的信息，使用callback回调异步返回结果。 查询当前进程所属的系统帐号的信息，使用callback回调异步返回结果。
- 参数： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| -------- | ---------------------------- | ---- | -------------------------- |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果，返回的是当前进程所属的系统帐号信息。 |
- 示例： **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果，返回的是当前进程所属的系统帐号信息。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1069,13 +1220,17 @@ queryCurrentOsAccount(): Promise&lt;OsAccountInfo&gt; ...@@ -1069,13 +1220,17 @@ queryCurrentOsAccount(): Promise&lt;OsAccountInfo&gt;
查询当前进程所属的系统帐号的信息，使用Promise方式异步返回结果。 查询当前进程所属的系统帐号的信息，使用Promise方式异步返回结果。
- 返回值： **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------------- | :---------------------------------- | | :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例，用于获取异步返回结果，返回的是当前进程所属的系统帐号信息。 | | Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例，用于获取异步返回结果，返回的是当前进程所属的系统帐号信息。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1092,14 +1247,20 @@ queryOsAccountById(localId: number, callback: AsyncCallback&lt;OsAccountInfo&gt; ...@@ -1092,14 +1247,20 @@ queryOsAccountById(localId: number, callback: AsyncCallback&lt;OsAccountInfo&gt;
查询指定系统帐号的信息，使用callback回调异步返回结果。 查询指定系统帐号的信息，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
| 参数名 | 类型 | 必填 | 说明 | **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS、ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
| -------- | ---------------------------- | ---- | -------------------------- |
| localId | number | 是 | 要查询的系统帐号的ID |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果，返回的是查到的系统帐号的信息。 |
- 示例：查询ID为100的系统帐号信息 **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------- |
| localId | number | 是 | 要查询的系统帐号的ID |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调结果，返回的是查到的系统帐号的信息。 |
**示例：**查询ID为100的系统帐号信息
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1116,19 +1277,25 @@ queryOsAccountById(localId: number): Promise&lt;OsAccountInfo&gt; ...@@ -1116,19 +1277,25 @@ queryOsAccountById(localId: number): Promise&lt;OsAccountInfo&gt;
查询指定系统帐号的信息，使用Promise方式异步返回结果。 查询指定系统帐号的信息，使用Promise方式异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS、ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| -------- | ---------------------------- | ---- | -------------------------- |
| localId | number | 是 | 要查询的系统帐号的ID |
- 返回值： **参数：**
| 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :--------------------- | :---------------------------------- | | ------- | ------ | ---- | -------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例，用于获取异步返回结果，返回的是查到的系统帐号的信息。 | | localId | number | 是 | 要查询的系统帐号的ID |
- 示例：查询ID为100的系统帐号信息 **返回值：**
| 类型 | 说明 |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise实例，用于获取异步返回结果，返回的是查到的系统帐号的信息。 |
**示例：**查询ID为100的系统帐号信息
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1146,13 +1313,15 @@ getOsAccountTypeFromProcess(callback: AsyncCallback&lt;OsAccountType&gt;): void ...@@ -1146,13 +1313,15 @@ getOsAccountTypeFromProcess(callback: AsyncCallback&lt;OsAccountType&gt;): void
查询当前进程所属的系统帐号的帐号类型，使用callback回调异步返回结果。 查询当前进程所属的系统帐号的帐号类型，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ---------------------------------------- | | -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountType](#osaccounttype)&gt; | 是 | 回调结果，返回的是当前进程所属的系统帐号的帐号类型。 | | callback | AsyncCallback&lt;[OsAccountType](#osaccounttype)&gt; | 是 | 回调结果，返回的是当前进程所属的系统帐号的帐号类型。 |
- 示例： **示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1168,13 +1337,15 @@ getOsAccountTypeFromProcess(): Promise&lt;OsAccountType&gt; ...@@ -1168,13 +1337,15 @@ getOsAccountTypeFromProcess(): Promise&lt;OsAccountType&gt;
查询当前进程所属的系统帐号的帐号类型，使用Promise方式异步返回结果。 查询当前进程所属的系统帐号的帐号类型，使用Promise方式异步返回结果。
- 返回值： **系统能力：** SystemCapability.Account.OsAccount
| 类型 | 说明 | **返回值：**
| :--------------------- | :---------------------------------- |
| Promise&lt;[OsAccountType](#osaccounttype)&gt; | Promise实例，用于获取异步返回结果，返回的是当前进程所属的系统帐号的帐号类型。 |
- 示例： | 类型 | 说明 |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise&lt;[OsAccountType](#osaccounttype)&gt; | Promise实例，用于获取异步返回结果，返回的是当前进程所属的系统帐号的帐号类型。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1191,13 +1362,17 @@ getDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void ...@@ -1191,13 +1362,17 @@ getDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void
获取分布式虚拟设备ID，使用callback回调异步返回结果。 获取分布式虚拟设备ID，使用callback回调异步返回结果。
- 参数： **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | --------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调结果，返回的是分布式虚拟设备ID。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调结果，返回的是分布式虚拟设备ID。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1213,13 +1388,17 @@ getDistributedVirtualDeviceId(): Promise&lt;string&gt; ...@@ -1213,13 +1388,17 @@ getDistributedVirtualDeviceId(): Promise&lt;string&gt;
获取分布式虚拟设备ID，使用Promise方式异步返回结果。 获取分布式虚拟设备ID，使用Promise方式异步返回结果。
- 返回值： **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**系统能力：** SystemCapability.Account.OsAccount
| 类型 | 说明 | **返回值：**
| :-------------- | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果，返回的是分布式虚拟设备ID。 |
- 示例： | 类型 | 说明 |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果，返回的是分布式虚拟设备ID。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1236,14 +1415,20 @@ getOsAccountProfilePhoto(localId: number, callback: AsyncCallback&lt;string&gt;) ...@@ -1236,14 +1415,20 @@ getOsAccountProfilePhoto(localId: number, callback: AsyncCallback&lt;string&gt;)
获取指定系统帐号的头像信息，使用callback回调异步返回结果。 获取指定系统帐号的头像信息，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------ | | -------- | --------------------------- | ---- | ---------------------------------------- |
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调结果，返回的是该系统帐号的头像信息。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调结果，返回的是该系统帐号的头像信息。 |
- 示例：获取ID为100的系统帐号的头像 **示例：**获取ID为100的系统帐号的头像
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1260,19 +1445,25 @@ getOsAccountProfilePhoto(localId: number): Promise&lt;string&gt; ...@@ -1260,19 +1445,25 @@ getOsAccountProfilePhoto(localId: number): Promise&lt;string&gt;
获取指定系统帐号的头像信息，使用Promise方式异步返回结果。 获取指定系统帐号的头像信息，使用Promise方式异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
| 参数名 | 类型 | 必填 | 说明 | **需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| ------- | ------ | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 |
- 返回值： **系统能力：** SystemCapability.Account.OsAccount
| 类型 | 说明 | **参数：**
| :-------------- | :---------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果，返回的是该系统帐号的头像信息。 |
- 示例：获取ID为100的系统帐号的头像 | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 |
**返回值：**
| 类型 | 说明 |
| :-------------------- | :----------------------------------------------------------- |
| Promise&lt;string&gt; | Promise实例，用于获取异步返回结果，返回的是该系统帐号的头像信息。 |
**示例：**获取ID为100的系统帐号的头像
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1290,15 +1481,21 @@ setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback ...@@ -1290,15 +1481,21 @@ setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback
为指定系统帐号设置头像信息，使用callback回调异步返回结果。 为指定系统帐号设置头像信息，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| -------- | ------------------- | ---- | ------------------------ |
| localId | number | 是 | 系统帐号ID。 |
| photo | string | 是 | 头像信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
- 示例：给ID为100的系统帐号设置头像 **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 |
| photo | string | 是 | 头像信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
**示例：**给ID为100的系统帐号设置头像
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1318,20 +1515,26 @@ setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt; ...@@ -1318,20 +1515,26 @@ setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt;
为指定系统帐号设置头像信息，使用Promise方式异步返回结果。 为指定系统帐号设置头像信息，使用Promise方式异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| ------- | ------ | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 |
| photo | string | 是 | 头像信息。 |
- 返回值： **参数：**
| 类型 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :------------ | :---------------------------------- | | ------- | ------ | ---- | ------------ |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 | | localId | number | 是 | 系统帐号ID。 |
| photo | string | 是 | 头像信息。 |
- 示例：给ID为100的系统帐号设置头像 **返回值：**
| 类型 | 说明 |
| :------------------ | :---------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果。 |
**示例：**给ID为100的系统帐号设置头像
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1347,20 +1550,22 @@ setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt; ...@@ -1347,20 +1550,22 @@ setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt;
}); });
``` ```
### getOsAccountLocalIdBySerialNumber ### getOsAccountLocalIdBySerialNumber<sup>8+</sup>
getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback&lt;number&gt;): void getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback&lt;number&gt;): void
通过SN码查询与其关联的系统帐号的帐号ID，使用callback回调异步返回结果。 通过SN码查询与其关联的系统帐号的帐号ID，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| ------------ | --------------------- | ---- | ------------------------------ |
| serialNumber | number | 是 | 帐号SN码。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是与SN码关联的系统帐号的帐号ID。 |
- 示例：查询与SN码12345关联的系统帐号的ID | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------- | ---- | ------------------------------------------------ |
| serialNumber | number | 是 | 帐号SN码。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是与SN码关联的系统帐号的帐号ID。 |
**示例：**查询与SN码12345关联的系统帐号的ID
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1371,25 +1576,27 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback& ...@@ -1371,25 +1576,27 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback&
}); });
``` ```
### getOsAccountLocalIdBySerialNumber ### getOsAccountLocalIdBySerialNumber<sup>8+</sup>
getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt; getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt;
通过SN码查询与其关联的系统帐号的帐号ID，使用Promise方式异步返回结果。 通过SN码查询与其关联的系统帐号的帐号ID，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------ | ---- | ---------- | | ------------ | ------ | ---- | ---------- |
| serialNumber | number | 是 | 帐号SN码。 | | serialNumber | number | 是 | 帐号SN码。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :---------------------------------- | | :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是与SN码关联的系统帐号的帐号ID。 | | Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是与SN码关联的系统帐号的帐号ID。 |
- 示例：查询与SN码12345关联的系统帐号的ID **示例：**查询与SN码12345关联的系统帐号的ID
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1401,20 +1608,22 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt; ...@@ -1401,20 +1608,22 @@ getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt;
}); });
``` ```
### getSerialNumberByOsAccountLocalId ### getSerialNumberByOsAccountLocalId<sup>8+</sup>
getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;number&gt;): void getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;number&gt;): void
通过系统帐号ID获取与该系统帐号关联的SN码，使用callback回调异步返回结果。 通过系统帐号ID获取与该系统帐号关联的SN码，使用callback回调异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | --------------------- | ---- | ------------------------------ |
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是与该系统帐号关联的SN码。 |
- 示例：获取ID为100的系统帐号关联的SN码 | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------ |
| localId | number | 是 | 系统帐号ID。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调结果，返回的是与该系统帐号关联的SN码。 |
**示例：**获取ID为100的系统帐号关联的SN码
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1425,25 +1634,27 @@ getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;nu ...@@ -1425,25 +1634,27 @@ getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;nu
}); });
``` ```
### getSerialNumberByOsAccountLocalId ### getSerialNumberByOsAccountLocalId<sup>8+</sup>
getSerialNumberByOsAccountLocalId(localId: number): Promise&lt;number&gt; getSerialNumberByOsAccountLocalId(localId: number): Promise&lt;number&gt;
通过系统帐号ID获取与该系统帐号关联的SN码，使用Promise方式异步返回结果。 通过系统帐号ID获取与该系统帐号关联的SN码，使用Promise方式异步返回结果。
- 参数： **系统能力：** SystemCapability.Account.OsAccount
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------ | | ------- | ------ | ---- | ------------ |
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
- 返回值： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :---------------------------------- | | :-------------------- | :----------------------------------------------------------- |
| Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是与该系统帐号关联的SN码。 | | Promise&lt;number&gt; | Promise实例，用于获取异步返回结果，返回的是与该系统帐号关联的SN码。 |
- 示例：获取ID为100的系统帐号关联的SN码 **示例：**获取ID为100的系统帐号关联的SN码
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1461,15 +1672,21 @@ on(type: 'activate' | 'activating', name: string, callback: Callback&lt;number&g ...@@ -1461,15 +1672,21 @@ on(type: 'activate' | 'activating', name: string, callback: Callback&lt;number&g
订阅系统帐号的变动信息，使用callback回调异步返回结果。 订阅系统帐号的变动信息，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
| 参数名 | 类型 | 必填 | 说明 | **系统能力：** SystemCapability.Account.OsAccount
| -------- | -------------------------- | ---- | ------------------------ |
| type | 'activate' \| 'activating' | 是 | 订阅类型，activate表示订阅的是帐号已激活完成的事件，activating表示订阅的是帐号正在激活的事件。 |
| name | string | 是 | 订阅名称，可自定义，要求非空且长度不超过1024字节。|
| callback | Callback&lt;number&gt; | 是 | 订阅系统帐号变动信息的回调，表示当前事件对应的系统帐号ID。 |
- 示例： **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| type | 'activate' \| 'activating' | 是 | 订阅类型，activate表示订阅的是帐号已激活完成的事件，activating表示订阅的是帐号正在激活的事件。 |
| name | string | 是 | 订阅名称，可自定义，要求非空且长度不超过1024字节。 |
| callback | Callback&lt;number&gt; | 是 | 订阅系统帐号变动信息的回调，表示当前事件对应的系统帐号ID。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1485,15 +1702,21 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number ...@@ -1485,15 +1702,21 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number
取消订阅系统帐号的变动信息，使用callback回调异步返回结果。 取消订阅系统帐号的变动信息，使用callback回调异步返回结果。
- 参数： 此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION
**系统能力：** SystemCapability.Account.OsAccount
| 参数名 | 类型 | 必填 | 说明 | **参数：**
| -------- | -------------------------- | ---- | ---------------------------- |
| type | 'activate' \| 'activating' | 是 | 取消订阅类型，activate表示取消订阅帐号已激活完成的事件，activating取消订阅帐号正在激活的事件。 |
| name | string | 是 | 订阅名称，可自定义，，要求非空且长度不超过1024字节，需要与订阅接口传入的值保持一致。 |
| callback | Callback&lt;number&gt; | 否 | 取消订阅系统帐号变化的回调，默认返回0。 |
- 示例： | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------------------------------------------------ |
| type | 'activate' \| 'activating' | 是 | 取消订阅类型，activate表示取消订阅帐号已激活完成的事件，activating取消订阅帐号正在激活的事件。 |
| name | string | 是 | 订阅名称，可自定义，，要求非空且长度不超过1024字节，需要与订阅接口传入的值保持一致。 |
| callback | Callback&lt;number&gt; | 否 | 取消订阅系统帐号变化的回调，默认返回0。 |
**示例：**
``` ```
const accountManager = account_osAccount.getAccountManager(); const accountManager = account_osAccount.getAccountManager();
...@@ -1504,45 +1727,51 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number ...@@ -1504,45 +1727,51 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number
``` ```
## OsAccountInfo ## OsAccountInfo
系统帐号信息 系统帐号信息。
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ---------------------------------- | ---- | ------------------------ | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。
| localId | number | 是 | 系统帐号ID。 |
| localName | string | 是 | 系统帐号名称。 | | 参数名 | 类型 | 必填 | 说明 |
| type | [OsAccountType](#osaccounttype) | 是 | 系统帐号类型 | | ----------------- | ------------------------------------------------------------ | ---- | --------------------------------- |
| constraints | Array&lt;string&gt; | 否 | 系统帐号[约束](#系统帐号约束列表) | | localId | number | 是 | 系统帐号ID。 |
| isVerified | boolean | 是 | 帐号是否锁屏 | | localName | string | 是 | 系统帐号名称。 |
| photo | string | 否 | 系统帐号头像 | | type | [OsAccountType](#osaccounttype) | 是 | 系统帐号类型 |
| createTime | number | 是 | 系统帐号创建时间 | | constraints | Array&lt;string&gt; | 否 | 系统帐号[约束](#系统帐号约束列表) |
| lastLoginTime | number | 否 | 系统帐号最后一次登录时间 | | isVerified | boolean | 是 | 帐号是否锁屏 |
| serialNumber | number | 是 | 系统帐号SN码 | | photo | string | 否 | 系统帐号头像 |
| isActived | boolean | 是 | 系统帐号激活状态 | | createTime | number | 是 | 系统帐号创建时间 |
| isCreateCompleted | boolean | 是 | 系统帐号创建是否完整 | | lastLoginTime | number | 否 | 系统帐号最后一次登录时间 |
| distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否 | 分布式帐号信息 | | serialNumber | number | 是 | 系统帐号SN码 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 否 | 域帐号信息 | | isActived | boolean | 是 | 系统帐号激活状态 |
| isCreateCompleted | boolean | 是 | 系统帐号创建是否完整 |
| distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否 | 分布式帐号信息 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 否 | 域帐号信息 |
## DomainAccountInfo ## DomainAccountInfo
域帐号信息 域帐号信息。
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ---------------------------------- | ---- | ------------------------ | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。
| domain | string | 是 | 域名。 |
| accountName | string | 是 | 域帐号名。 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---------- |
| domain | string | 是 | 域名。 |
| accountName | string | 是 | 域帐号名。 |
## 系统帐号约束列表 ## 系统帐号约束列表
| 约束 | 说明 | | 约束 | 说明 |
| ----------------- | ------------------- | | ------------------------------------- | ------------------------------ |
| constraint.wifi | 禁止使用wifi | | constraint.wifi | 禁止使用wifi |
| constraint.wifi.set | 禁止配置wifi | | constraint.wifi.set | 禁止配置wifi |
| constraint.locale.set | 禁止配置设备语言 | | constraint.locale.set | 禁止配置设备语言 |
| constraint.app.accounts | 禁止添加和删除应用帐号 | | constraint.app.accounts | 禁止添加和删除应用帐号 |
| constraint.apps.install | 禁止安装应用 | | constraint.apps.install | 禁止安装应用 |
| constraint.apps.uninstall | 禁止卸载应用 | | constraint.apps.uninstall | 禁止卸载应用 |
| constraint.location.shared | 禁止打开位置共享 | | constraint.location.shared | 禁止打开位置共享 |
| constraint.unknown.sources.install | 禁止安装未知来源的应用 | | constraint.unknown.sources.install | 禁止安装未知来源的应用 |
| constraint.global.unknown.app.install | 禁止所有用户安装未知来源的应用 | | constraint.global.unknown.app.install | 禁止所有用户安装未知来源的应用 |
| constraint.bluetooth.set | 禁止配置蓝牙 | | constraint.bluetooth.set | 禁止配置蓝牙 |
| constraint.bluetooth | 禁止使用蓝牙 | constraint.bluetooth | 禁止使用蓝牙 |
| constraint.bluetooth.share | 禁止共享使用蓝牙 | | constraint.bluetooth.share | 禁止共享使用蓝牙 |
| constraint.usb.file.transfer | 禁止通过USB传输文件 | | constraint.usb.file.transfer | 禁止通过USB传输文件 |
| constraint.credentials.set | 禁止配置用户凭据 | | constraint.credentials.set | 禁止配置用户凭据 |
...@@ -1594,4 +1823,4 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number ...@@ -1594,4 +1823,4 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number
| constraint.ambient.display | 禁止显示环境 | | constraint.ambient.display | 禁止显示环境 |
| constraint.screen.timeout.set | 禁止配置屏幕关闭的超时 | | constraint.screen.timeout.set | 禁止配置屏幕关闭的超时 |
| constraint.print | 禁止打印 | | constraint.print | 禁止打印 |
| constraint.private.dns.set | 禁止配置专用DNS | | constraint.private.dns.set | 禁止配置专用DNS |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或