Skip to content

D
Docs

Coping0606 / Docs
与 Fork 源项目一致

Fork自 OpenHarmony / Docs

通知 1
Star 1
Fork 0
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 11ab6920 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!10845 modify account api docs 

Merge pull request !10845 from jidong/dev_101903
上级 2a127cb9 bd51e500
隐藏空白更改
内联 并排
Showing with 2268 addition and 1721 deletion
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @ 11ab6920
因为 它太大了无法显示 source diff 。你可以改为 查看blob。
zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
浏览文件 @ 11ab6920
......@@ -54,20 +54,18 @@ getOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): voi
**错误码：**
| 错误码ID | 错误信息|
| ------- | -------|
| 201 | permission denied. |
| 401 | the parameter check failed. |
| 12300001 | system service exception. |
| 错误码ID | 错误信息|
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
const accountAbility = account_distributedAccount.getDistributedAccountAbility();
try {
accountAbility.getOsAccountDistributedInfo((err, data) => {
console.log("getOsAccountDistributedInfo err: " + JSON.stringify(err));
console.log('Query account info name: ' + data.name);
console.log('Query account info id: ' + data.id);
console.log("getOsAccountDistributedInfo err: " + JSON.stringify(err));
console.log('Query account info name: ' + data.name);
console.log('Query account info id: ' + data.id);
});
} catch (e) {
console.log("getOsAccountDistributedInfo exception: " + JSON.stringify(e));
......@@ -92,11 +90,9 @@ getOsAccountDistributedInfo(): Promise<DistributedInfo>
**错误码：**
| 错误码ID | 错误信息|
| ------- | -------|
| 201 | permission denied. |
| 401 | the parameter check failed. |
| 12300001 | system service exception. |
| 错误码ID | 错误信息|
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -146,6 +142,7 @@ queryOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): v
queryOsAccountDistributedInfo(): Promise<DistributedInfo>
获取分布式帐号信息。使用Promise异步回调。
> **说明：** 从API version 9开始废弃，建议使用[getOsAccountDistributedInfo](#getosaccountdistributedinfo9-1)
>
> 从 API version 7开始支持。
......@@ -190,12 +187,10 @@ setOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallbac
**错误码：**
| 错误码ID | 错误信息|
| ------- | -------|
| 201 | permission denied. |
| 401 | the parameter check failed. |
| 12300001 | system service exception. |
| 12300002 | invalid accountInfo. |
| 错误码ID | 错误信息|
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | invalid accountInfo. |
**示例：**
```js
......@@ -234,12 +229,10 @@ setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>
**错误码：**
| 错误码ID | 错误信息|
| ------- | -------|
| 201 | permission denied. |
| 401 | the parameter check failed. |
| 12300001 | system service exception. |
| 12300002 | invalid accountInfo. |
| 错误码ID | 错误信息|
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | invalid accountInfo. |
**示例：**
```js
......@@ -260,6 +253,7 @@ setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>
updateOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback<void>): void
更新分布式帐号信息。使用callback异步回调。
> **说明：** 从API version 9开始废弃，建议使用[setOsAccountDistributedInfo](#setosaccountdistributedinfo9)
>
> 从 API version 7开始支持。
......
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @ 11ab6920
......@@ -70,9 +70,11 @@ activateOsAccount(localId: number, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
| 12300009 | Account has been activated. |
**示例：** 激活ID为100的系统帐号
```js
......@@ -112,16 +114,18 @@ activateOsAccount(localId: number): Promise<void>
**返回值：**
| 类型 | 说明 |
| :------------------ | :----------------------------------- |
| ------------------- | ------------------------------------ |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
| 12300009 | Account has been activated. |
**示例：** 激活ID为100的系统帐号
```js
......@@ -152,12 +156,18 @@ checkMultiOsAccountEnabled(callback: AsyncCallback<boolean>): void
| -------- | ---------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示支持多系统帐号；返回false表示不支持。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
let accountManager = account_osAccount.getAccountManager();
try {
accountManager.checkMultiOsAccountEnabled((err, isEnalbed) => {
accountManager.checkMultiOsAccountEnabled((err, isEnabled) => {
if (err) {
console.log("checkMultiOsAccountEnabled failed, error: " + JSON.stringify(err));
} else {
......@@ -183,6 +193,12 @@ checkMultiOsAccountEnabled(): Promise<boolean>
| :--------------------- | :--------------------------------------------------------- |
| Promise<boolean> | Promise对象。返回true表示支持多系统帐号；返回false表示不支持。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -219,16 +235,17 @@ checkOsAccountActivated(localId: number, callback: AsyncCallback<boolean>)
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 判断ID为100的系统帐号是否处于激活状态
```js
let accountManager = account_osAccount.getAccountManager();
let osLocalId = 100;
let localId = 100;
try {
accountManager.checkOsAccountActivated(osLocalId, (err, isActivated)=>{
accountManager.checkOsAccountActivated(localId, (err, isActivated) => {
if (err) {
console.log('checkOsAccountActivated failed, error:' + JSON.stringify(err));
} else {
......@@ -246,7 +263,7 @@ checkOsAccountActivated(localId: number): Promise<boolean>
判断指定系统帐号是否处于激活状态。使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
......@@ -266,8 +283,9 @@ checkOsAccountActivated(localId: number): Promise<boolean>
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 判断ID为100的系统帐号是否处于激活状态
......@@ -291,7 +309,7 @@ checkConstraintEnabled(localId: number, constraint: string, callback: AsyncCallb
判断指定系统帐号是否具有指定约束。使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
......@@ -307,8 +325,9 @@ checkConstraintEnabled(localId: number, constraint: string, callback: AsyncCallb
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
......@@ -356,8 +375,9 @@ checkConstraintEnabled(localId: number, constraint: string): Promise<boolean&
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束
......@@ -394,8 +414,7 @@ checkOsAccountTestable(callback: AsyncCallback<boolean>): void
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300001 | System service exception. |
**示例：**
......@@ -432,8 +451,7 @@ checkOsAccountTestable(): Promise<boolean>
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300001 | System service exception. |
**示例：**
......@@ -470,8 +488,9 @@ checkOsAccountVerified(callback: AsyncCallback<boolean>): void
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：**
......@@ -511,8 +530,9 @@ checkOsAccountVerified(localId: number, callback: AsyncCallback<boolean>):
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：**
......@@ -520,7 +540,7 @@ checkOsAccountVerified(localId: number, callback: AsyncCallback<boolean>):
let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
accountManager.checkOsAccountVerified(localId, (err, result) => {
accountManager.checkOsAccountVerified(localId, (err, isVerified) => {
if (err) {
console.log("checkOsAccountVerified failed, error: " + JSON.stringify(err));
} else {
......@@ -558,8 +578,9 @@ checkOsAccountVerified(localId?: number): Promise<boolean>
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：**
......@@ -573,7 +594,7 @@ checkOsAccountVerified(localId?: number): Promise<boolean>
console.log("checkOsAccountVerified failed, error: " + JSON.stringify(err));
});
} catch (err) {
console.log('checkOsAccountVerified exception: ' + JSON.stringify(e));
console.log('checkOsAccountVerified exception: ' + JSON.stringify(err));
}
```
......@@ -600,9 +621,10 @@ removeOsAccount(localId: number, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
**示例：**
......@@ -652,9 +674,10 @@ removeOsAccount(localId: number): Promise<void>
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
**示例：**
......@@ -699,9 +722,10 @@ setOsAccountConstraints(localId: number, constraints: Array<string>, enabl
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
**示例：** 给ID为100的系统帐号设置禁止使用Wi-Fi的约束
......@@ -752,9 +776,10 @@ setOsAccountConstraints(localId: number, constraints: Array<string>, enabl
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
**示例：** 删除ID为100的系统帐号的禁止使用Wi-Fi的约束
......@@ -796,9 +821,10 @@ setOsAccountName(localId: number, localName: string, callback: AsyncCallback<
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300002 | Invalid parameters. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300001 | System service exception. |
| 12300002 | Invalid localId or localName. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
**示例：** 将ID为100的系统帐号的帐号名设置成demoName
......@@ -841,16 +867,17 @@ setOsAccountName(localId: number, localName: string): Promise<void>
**返回值：**
| 类型 | 说明 |
| :------------------ | :----------------------------------- |
| ------------------- | ------------------------------------ |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300001 | System service exception. |
| 12300002 | Invalid localId or localName. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
**示例：** 将ID为100的系统帐号的帐号名设置成demoName
......@@ -885,6 +912,12 @@ getOsAccountCount(callback: AsyncCallback<number>): void
| -------- | --------------------------- | ---- | -------------------------------------------------------------------------- |
| callback | AsyncCallback<number> | 是 | 回调函数。当获取成功时，err为null，data为已创建的系统帐号的数量；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -918,6 +951,12 @@ getOsAccountCount(): Promise<number>
| --------------------- | -------------------------------------- |
| Promise<number> | Promise对象，返回已创建的系统帐号的数量。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -947,6 +986,12 @@ queryOsAccountLocalIdFromProcess(callback: AsyncCallback<number>): void
| -------- | --------------------------- | ---- | ---------------------------------------------------------------------------- |
| callback | AsyncCallback<number> | 是 | 回调函数。当获取成功时，err为null，data为当前进程所属的系统帐号ID；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -975,9 +1020,15 @@ queryOsAccountLocalIdFromProcess(): Promise<number>
**返回值：**
| 类型 | 说明 |
| :-------------------- | :--------------------------------------- |
| --------------------- | ---------------------------------------- |
| Promise<number> | Promise对象，返回当前进程所属的系统帐号ID。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1008,10 +1059,11 @@ queryOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback<number>)
| uid | number | 是 | 进程uid。 |
| callback | AsyncCallback<number> | 是 | 回调函数。如果查询成功，err为null，data为对应的系统帐号ID；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid uid. |
**示例：** 查询值为12345678的uid所属的系统帐号的帐号ID
......@@ -1054,6 +1106,8 @@ queryOsAccountLocalIdFromUid(uid: number): Promise<number>
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid uid. |
**示例：** 查询值为12345678的uid所属的系统帐号ID
......@@ -1074,7 +1128,7 @@ queryOsAccountLocalIdFromUid(uid: number): Promise<number>
### queryOsAccountLocalIdFromDomain<sup>9+</sup>
getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;number&gt;): void
queryOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback&lt;number&gt;): void
根据域帐号信息，获取与其关联的系统帐号ID。使用callback异步回调。
......@@ -1089,6 +1143,13 @@ getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCall
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是 | 域帐号信息。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。如果查询成功，err为null，data为域帐号关联的系统帐号ID；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid domainInfo. |
**示例：**
```js
......@@ -1129,6 +1190,13 @@ queryOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise&lt;numbe
| :-------------------- | :------------------------------------- |
| Promise&lt;number&gt; | Promise对象，返回域帐号关联的系统帐号ID。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid domainInfo. |
**示例：**
```js
......@@ -1161,6 +1229,12 @@ queryMaxOsAccountNumber(callback: AsyncCallback&lt;number&gt;): void
| -------- | --------------------------- | ---- | -------------------------------------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，如果查询成功，err为null，data为允许创建的系统帐号的最大数量；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1194,6 +1268,12 @@ queryMaxOsAccountNumber(): Promise&lt;number&gt;
| --------------------- | ------------------------------------------- |
| Promise&lt;number&gt; | Promise对象，返回允许创建的系统帐号的最大数量。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1230,8 +1310,9 @@ getOsAccountConstraints(localId: number, callback: AsyncCallback&lt;Array&lt;str
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 获取ID为100的系统帐号的全部约束
......@@ -1277,8 +1358,9 @@ getOsAccountConstraints(localId: number): Promise&lt;Array&lt;string&gt;&gt;
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 获取ID为100的系统帐号的全部约束
......@@ -1314,6 +1396,12 @@ queryAllCreatedOsAccounts(callback: AsyncCallback&lt;Array&lt;OsAccountInfo&gt;&
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | 是 | 回调函数。如果查询成功，err为null，data为已创建的所有系统帐号的信息列表；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1346,6 +1434,12 @@ queryAllCreatedOsAccounts(): Promise&lt;Array&lt;OsAccountInfo&gt;&gt;
| ----------------------------------------------------------- | --------------------------------------------- |
| Promise&lt;Array&lt;[OsAccountInfo](#osaccountinfo)&gt;&gt; | Promise对象，返回已创建的所有系统帐号的信息列表。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1375,6 +1469,12 @@ getActivatedOsAccountIds(callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): vo
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是 | 回调函数。如果查询成功，err为null，data为当前处于激活状态的系统帐号的ID列表；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1406,6 +1506,12 @@ getActivatedOsAccountIds(): Promise&lt;Array&lt;number&gt;&gt;
| :--------------------------------- | :------------------------------------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | Promise对象，返回当前处于激活状态的系统帐号的ID列表。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1442,8 +1548,14 @@ createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback&
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调函数。如果创建成功，err为null，data为新创建的系统帐号的信息；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| 错误码ID | 错误信息 |
| -------- | ------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localName or type. |
| 12300005 | Multi-user not supported. |
| 12300006 | Unsupported account type. |
| 12300007 | The number of account reaches the upper limit. |
**示例：**
......@@ -1485,8 +1597,14 @@ createOsAccount(localName: string, type: OsAccountType): Promise&lt;OsAccountInf
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promis对象，返回新创建的系统帐号的信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| 错误码ID | 错误信息 |
| -------- | ------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localName or type. |
| 12300005 | Multi-user not supported. |
| 12300006 | Unsupported account type. |
| 12300007 | The number of account reaches the upper limit. |
**示例：**
......@@ -1518,14 +1636,20 @@ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, cal
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| :--------- | ---------------------------------------------------- | ---- | -------------------------------------------------------------------------- |
| ---------- | ---------------------------------------------------- | ---- | -------------------------------------------------------------------------- |
| type | [OsAccountType](#osaccounttype) | 是 | 创建的系统帐号的类型。 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是 | 域帐号信息。 |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调函数。如果创建成功，err为null，data为新创建的系统帐号的信息；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or domainInfo. |
| 12300005 | Multi-user not supported. |
| 12300006 | Unsupported account type. |
| 12300007 | The number of account reaches the upper limit. |
**示例：**
......@@ -1568,8 +1692,14 @@ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo): Pr
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise对象，返回新创建的系统帐号的信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or domainInfo. |
| 12300005 | Multi-user not supported. |
| 12300006 | Unsupported account type. |
| 12300007 | The number of account reaches the upper limit. |
**示例：**
......@@ -1603,6 +1733,12 @@ getCurrentOsAccount(callback: AsyncCallback&lt;OsAccountInfo&gt;): void
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调函数。如果查询成功，err为null，data为当前进程所属的系统帐号信息；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1633,6 +1769,12 @@ getCurrentOsAccount(): Promise&lt;OsAccountInfo&gt;
| ---------------------------------------------- | ----------------------------------------- |
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise对象，返回当前进程所属的系统帐号信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1668,10 +1810,12 @@ queryOsAccountById(localId: number, callback: AsyncCallback&lt;OsAccountInfo&gt;
| callback | AsyncCallback&lt;[OsAccountInfo](#osaccountinfo)&gt; | 是 | 回调函数。如果查询成功，err为null，data为查到的系统帐号的信息；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 查询ID为100的系统帐号信息
......@@ -1713,10 +1857,12 @@ queryOsAccountById(localId: number): Promise&lt;OsAccountInfo&gt;
| Promise&lt;[OsAccountInfo](#osaccountinfo)&gt; | Promise对象，返回查到的系统帐号的信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 查询ID为100的系统帐号信息
......@@ -1748,6 +1894,12 @@ getOsAccountType(callback: AsyncCallback&lt;OsAccountType&gt;): void
| -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback&lt;[OsAccountType](#osaccounttype)&gt; | 是 | 回调函数。如果查询成功，err为null，data为当前进程所属的系统帐号的帐号类型；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1776,6 +1928,12 @@ getOsAccountType(): Promise&lt;OsAccountType&gt;
| ---------------------------------------------- | ----------------------------------------------- |
| Promise&lt;[OsAccountType](#osaccounttype)&gt; | Promise对象，返回当前进程所属的系统帐号的帐号类型。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1797,7 +1955,7 @@ queryDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void
获取分布式虚拟设备ID。使用callback异步回调。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
......@@ -1807,6 +1965,12 @@ queryDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void
| -------- | --------------------------- | ---- | --------------------------------------------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。如果获取成功，err为null，data为分布式虚拟设备ID；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1827,7 +1991,7 @@ queryDistributedVirtualDeviceId(): Promise&lt;string&gt;
获取分布式虚拟设备ID。使用Promise异步回调。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
......@@ -1837,6 +2001,12 @@ queryDistributedVirtualDeviceId(): Promise&lt;string&gt;
| --------------------- | --------------------------------- |
| Promise&lt;string&gt; | Promise对象，返回分布式虚拟设备ID。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -1872,10 +2042,12 @@ getOsAccountProfilePhoto(localId: number, callback: AsyncCallback&lt;string&gt;)
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。如果获取成功，err为null，data为指定系统帐号的头像信息；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 获取ID为100的系统帐号的头像
......@@ -1917,10 +2089,12 @@ getOsAccountProfilePhoto(localId: number): Promise&lt;string&gt;
| Promise&lt;string&gt; | Promise对象，返回指定系统帐号的头像信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 获取ID为100的系统帐号的头像
......@@ -1959,11 +2133,13 @@ setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback
| callback | AsyncCallback&lt;void&gt; | 是 | 回调结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300001 | System service exception. |
| 12300002 | Invalid localId or photo. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
**示例：** 给ID为100的系统帐号设置头像
......@@ -2005,15 +2181,17 @@ setOsAccountProfilePhoto(localId: number, photo: string): Promise&lt;void&gt;
**返回值：**
| 类型 | 说明 |
| :------------------ | :----------------------------------- |
| ------------------- | ------------------------------------ |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300004 | Restricted Account. |
| 12300001 | System service exception. |
| 12300002 | Invalid localId or photo. |
| 12300003 | Account not found. |
| 12300008 | Restricted Account. |
**示例：** 给ID为100的系统帐号设置头像
......@@ -2051,8 +2229,12 @@ queryOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallbac
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。如果成功，err为null，data为与SN码关联的系统帐号的帐号ID；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid serialNumber. |
| 12300003 | Account not found. |
**示例：** 查询与SN码12345关联的系统帐号的ID
......@@ -2086,12 +2268,16 @@ queryOsAccountLocalIdBySerialNumber(serialNumber: number): Promise&lt;number&gt;
**返回值：**
| 类型 | 说明 |
| :-------------------- | :------------------- ----------------------- |
| --------------------- | -------------------------------------------- |
| Promise&lt;number&gt; | Promise对象，返回与SN码关联的系统帐号的帐号ID。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid serialNumber. |
| 12300003 | Account not found. |
**示例：** 查询与SN码12345关联的系统帐号的ID
......@@ -2128,8 +2314,9 @@ querySerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback&lt;
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 获取ID为100的系统帐号关联的SN码
......@@ -2170,8 +2357,9 @@ querySerialNumberByOsAccountLocalId(localId: number): Promise&lt;number&gt;
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId. |
| 12300003 | Account not exists. |
| 12300003 | Account not found. |
**示例：** 获取ID为100的系统帐号关联的SN码
......@@ -2209,6 +2397,14 @@ on(type: 'activate' | 'activating', name: string, callback: Callback&lt;number&g
| name | string | 是 | 订阅名称，可自定义，要求非空且长度不超过1024字节。 |
| callback | Callback&lt;number&gt; | 是 | 订阅系统帐号变动信息的回调，表示当前事件对应的系统帐号ID。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or name. |
| 12300011 | Callback has been registered. |
**示例：**
```js
......@@ -2243,6 +2439,14 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number
| name | string | 是 | 订阅名称，可自定义，，要求非空且长度不超过1024字节，需要与订阅接口传入的值保持一致。 |
| callback | Callback&lt;number&gt; | 否 | 取消订阅系统帐号变化的回调，默认返回0。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid type or name. |
| 12300012 | Callback has not been registered. |
**示例：**
```js
......@@ -2274,6 +2478,13 @@ getBundleIdFromUid(uid: number, callback: AsyncCallback&lt;number&gt;): void;
| uid | number | 是 | 进程uid。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。如果查询成功，err为null，data为与uid对应的bundleId；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid uid. |
**示例：**
```js
......@@ -2310,6 +2521,13 @@ getBundleIdFromUid(uid: number): Promise&lt;number&gt;;
| --------------------- | ------------------------------------ |
| Promise&lt;number&gt; | Promise对象，返回与uid对应的bundleId。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid uid. |
**示例：**
```js
......@@ -2344,6 +2562,12 @@ isMainOsAccount(callback: AsyncCallback&lt;boolean&gt;): void;
| -------- | ---------------------------- | ---- | ----------------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回true表示当前帐号为主帐号，返回false表示当前帐号非主帐号。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -2375,6 +2599,12 @@ isMainOsAccount(): Promise&lt;boolean&gt;;
| ---------------------- | --------------------------------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象，返回true表示当前帐号为主帐号，返回false表示当前帐号非主帐号。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
**示例：**
```js
......@@ -2409,6 +2639,14 @@ queryOsAccountConstraintSourceTypes(localId: number, constraint: string, callbac
| constraint | string | 是 | 要查询的[约束](#系统帐号约束列表)名称 |
| callback | AsyncCallback&lt;Array&lt;[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)&gt;&gt; | 是 | 回调函数。如果成功，err为null，data为指定系统帐号的指定[约束](#系统帐号约束列表)来源信息；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId or constraint. |
| 12300003 | Account not found. |
**示例：**
```js
......@@ -2445,9 +2683,17 @@ queryOsAccountConstraintSourceTypes(localId: number, constraint: string): Promis
**返回值：**
| 类型 | 说明 |
| :-------------------- | :----------------------------------------------------------- |
| --------------------- | ------------------------------------------------------------ |
| Promise&lt;Array&lt;[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)&gt;&gt; | Promise对象，返回指定系统帐号的指定[约束](#系统帐号约束列表)来源信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid localId or constraint. |
| 12300003 | Account not found. |
**示例：**
```js
......@@ -2485,7 +2731,7 @@ isMultiOsAccountEnable(callback: AsyncCallback&lt;boolean&gt;): void
```js
let accountManager = account_osAccount.getAccountManager();
accountManager.isMultiOsAccountEnable((err, isEnalbed) => {
accountManager.isMultiOsAccountEnable((err, isEnabled) => {
if (err) {
console.log("isMultiOsAccountEnable failed, error: " + JSON.stringify(err));
} else {
......@@ -2744,6 +2990,8 @@ isOsAccountVerified(callback: AsyncCallback&lt;boolean&gt;): void
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
**参数：**
......@@ -3361,7 +3609,7 @@ getDistributedVirtualDeviceId(callback: AsyncCallback&lt;string&gt;): void
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
......@@ -3391,7 +3639,7 @@ getDistributedVirtualDeviceId(): Promise&lt;string&gt;
>
> 从 API version 7开始支持。
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC
**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS
**系统能力：** SystemCapability.Account.OsAccount
......@@ -3565,7 +3813,6 @@ constructor()
let userAuth = new account_osAccount.UserAuth();
```
### getVersion<sup>8+</sup>
getVersion(): number;
......@@ -3593,7 +3840,7 @@ getVersion(): number;
getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;
检查身份认证功能是否可用。
获取指定认证类型和认证可信等级的认证能力的可用状态。
**系统接口：** 此接口为系统接口。
......@@ -3603,16 +3850,23 @@ getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | -----------------------------------------------| ---- | ------------------------- |
| authType | [AuthType](#authtype8) | 是 | 指示用于认证的凭据类型。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 表示身份验证结果的信任级别。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | -----------------------------------| ---- | ------------------------- |
| authType | [AuthType](#authtype8) | 是 | 认证类型。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 认证的可信等级。 |
**返回值：**
| 类型 | 说明 |
| :----- | :---------------------------------------- |
| number | 返回验证[结果](#resultcode8)。 |
| 类型 | 说明 |
| ------ | ----------------------------- |
| number | 返回认证能力的可用状态。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType or authTrustLevel. |
**示例：**
```js
......@@ -3642,9 +3896,16 @@ getProperty(request: GetPropertyRequest, callback: AsyncCallback&lt;ExecutorProp
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------------------------- | ---- | ---------------------------------- |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------ |
| request | [GetPropertyRequest](#getpropertyrequest8) | 是 | 请求信息，包括认证类型和属性类型列表。 |
| callback | AsyncCallback&lt;[ExecutorProperty](#executorproperty8)&gt; | 是 | 回调函数。如果获取成功，err为null，data为执行器属性信息；否则为错误对象。 |
| callback | AsyncCallback&lt;[ExecutorProperty](#executorproperty8)&gt; | 是 | 回调函数。如果获取成功，err为null，data为执行器属性信息；否则为错误对象。|
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |
**示例：**
```js
......@@ -3692,6 +3953,13 @@ getProperty(request: GetPropertyRequest): Promise&lt;ExecutorProperty&gt;;
| :---------------------------------------------------------------- | :-------------------------------------------------- |
| Promise&lt;[ExecutorProperty](#executorproperty8)&gt; | Promise对象，返回执行者属性信息。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |
**示例：**
```js
let userAuth = new account_osAccount.UserAuth();
......@@ -3734,6 +4002,13 @@ setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;number&gt;):
| request | [SetPropertyRequest](#setpropertyrequest8)| 是 | 请求信息，包括认证类型和要设置的密钥值。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。如果设置成功，err为null，data为一个[数值](#resultcode8)，指示属性设置是否成功；否则为错误对象。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |
**示例：**
```js
let userAuth = new account_osAccount.UserAuth();
......@@ -3776,6 +4051,13 @@ setProperty(request: SetPropertyRequest): Promise&lt;number&gt;;
| :-------------------- | :------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象，返回一个[数值](#resultcode8)，指示属性设置是否成功。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid request. |
**示例：**
```js
let userAuth = new account_osAccount.UserAuth();
......@@ -3809,20 +4091,32 @@ auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------------- | --- | ------------------------------------ |
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ---------------------------------------- | --- | ------------------------------------ |
| challenge | Uint8Array | 是 | 指示挑战值，挑战值为一个随机数，用于提升安全性。|
| authType | [AuthType](#authtype8) | 是 | 指示认证类型。 |
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 指示认证结果的信任级别。 |
| callback | [IUserAuthCallback](#iuserauthcallback8) | 是 | 回调对象，返回认证结果。 |
**返回值：**
| 类型 | 说明 |
| :--------- | :----------------- |
| ---------- | ------------------ |
| Uint8Array | 返回取消的上下文ID。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid challenge or authType or authTrustLevel. |
| 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. |
| 12300110 | Authentication locked. |
| 12300111 | Authentication timeout. |
| 12300112 | Authentication service busy. |
**示例：**
```js
let userAuth = new account_osAccount.UserAuth();
......@@ -3863,13 +4157,25 @@ authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLev
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | 是 | 指示认证结果的信任级别。 |
| callback | [IUserAuthCallback](#iuserauthcallback8) | 是 | 回调对象，返回认证结果。 |
**返回值：**
| 类型 | 说明 |
| :--------- | :----------------- |
| ---------- | ------------------ |
| Uint8Array | 返回取消的上下文ID。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid userId or challenge or authType or authTrustLevel. |
| 12300101 | Credential is incorrect. |
| 12300105 | Unsupported authTrustLevel. |
| 12300106 | Unsupported authType. |
| 12300110 | Authentication locked. |
| 12300111 | Authentication timeout. |
| 12300112 | Authentication service busy. |
**示例：**
```js
let userAuth = new account_osAccount.UserAuth();
......@@ -3880,8 +4186,8 @@ authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLev
try {
userAuth.authUser(userID, challenge, authType, authTrustLevel, {
onResult: function(result,extraInfo){
console.log('authUser result = ' + result);
console.log('authUser extraInfo = ' + JSON.stringify(extraInfo));
console.log('authUser result = ' + result);
console.log('authUser extraInfo = ' + JSON.stringify(extraInfo));
}
});
} catch (e) {
......@@ -3893,7 +4199,7 @@ authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLev
cancelAuth(contextID: Uint8Array): void;
取消特定的认证。
取消指定的认证操作。
**系统接口：** 此接口为系统接口。
......@@ -3905,21 +4211,28 @@ cancelAuth(contextID: Uint8Array): void;
| 参数名 | 类型 | 必填 | 说明 |
| ----------| ---------- | ---- | ------------------------------------------ |
| contextID | Uint8Array | 是 | 指示身份验证上下文ID，此ID动态生成没有具体值。 |
| contextId | Uint8Array | 是 | 指示身份验证上下文ID，此ID动态生成没有具体值。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------ |
| 12300001 | System service exception. |
| 12300002 | Invalid contextId. |
**示例：**
```js
let userAuth = new account_osAccount.UserAuth();
let pinAuth = new account_osAccount.PINAuth();
let challenge = new Uint8Array([0]);
let contextID = userAuth.auth(challenge, account_osAccount.AuthType.PIN, account_osAccount.AuthTrustLevel.ATL1, {
let contextId = userAuth.auth(challenge, account_osAccount.AuthType.PIN, account_osAccount.AuthTrustLevel.ATL1, {
onResult: (result, extraInfo) => {
console.log('auth result = ' + result);
console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
}
});
try {
userAuth.cancelAuth(contextID);
userAuth.cancelAuth(contextId);
} catch (e) {
console.log('cancelAuth exception = ' + JSON.stringify(e));
}
......@@ -3948,9 +4261,9 @@ constructor()
### registerInputer<sup>8+</sup>
registerInputer(inputer: IInputer): boolean;
registerInputer(inputer: IInputer): void;
注册输入器。
注册PIN码输入器。
**系统接口：** 此接口为系统接口。
......@@ -3960,9 +4273,9 @@ registerInputer(inputer: IInputer): boolean;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------| ----------------------------------- | --- | ------------------ |
| inputer | [IInputer](#iinputer8) | 是 | 指示密码输入框回调。 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------| ----------------------- | --- | -------------------------- |
| inputer | [IInputer](#iinputer8) | 是 | PIN码输入器，用于获取PIN码。 |
**返回值：**
......@@ -3970,6 +4283,13 @@ registerInputer(inputer: IInputer): boolean;
| :------ | :-------------------------------------------- |
| boolean | 返回布尔值，true表示注册成功，false表示注册失败。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
| 12300103 | Inputer already registered. |
**示例：**
```js
let pinAuth = new account_osAccount.PINAuth();
......@@ -3990,7 +4310,7 @@ registerInputer(inputer: IInputer): boolean;
unregisterInputer(): void;
卸载输入器。
解注册PIN码输入器。
**系统接口：** 此接口为系统接口。
......@@ -4014,7 +4334,7 @@ unregisterInputer(): void;
constructor()
创建用户认证的实例。
用户身份管理类的默认构造函数。
**系统接口：** 此接口为系统接口。
......@@ -4029,7 +4349,7 @@ constructor()
openSession(callback: AsyncCallback&lt;Uint8Array&gt;): void;
打开会话，启动IDM操作以获取挑战值。使用callback异步回调。
打开会话，获取挑战值。使用callback异步回调。
**系统接口：** 此接口为系统接口。
......@@ -4043,6 +4363,12 @@ openSession(callback: AsyncCallback&lt;Uint8Array&gt;): void;
| -------- | -------------------------------- | ---- | -------------------------------------------------------------- |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 回调函数。如果打开会话成功，err为null，data为挑战值；否则为错误对象。|
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
**示例：**
```js
let userIDM = new account_osAccount.UserIdentityManager();
......@@ -4060,7 +4386,7 @@ openSession(callback: AsyncCallback&lt;Uint8Array&gt;): void;
openSession(): Promise&lt;Uint8Array&gt;;
打开会话，启动IDM操作以获取挑战值。使用Promise异步回调。
打开会话，获取挑战值。使用Promise异步回调。
**系统接口：** 此接口为系统接口。
......@@ -4074,6 +4400,12 @@ openSession(): Promise&lt;Uint8Array&gt;;
| :------------------------ | ----------------------- |
| Promise&lt;Uint8Array&gt; | Promise对象，返回挑战值。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------------- |
| 12300001 | System service exception. |
**示例：**
```js
let userIDM = new account_osAccount.UserIdentityManager();
......@@ -4103,10 +4435,19 @@ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------ ----- | --- | ---------------------------- |
| --------------- | ------------------------------------ | --- | ---------------------------- |
| credentialInfo | [CredentialInfo](#credentialinfo8) | 是 | 指示凭据信息。 |
| callback | [IIdmCallback](#iidmcallback8) | 是 | 回调对象，返回添加凭据的结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialInfo, i.e. authType or authSubType. |
| 12300101 | Token is invalid. |
| 12300106 | Unsupported authType. |
**示例：**
```js
let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
......@@ -4155,6 +4496,15 @@ updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
| credentialInfo | [CredentialInfo](#credentialinfo8) | 是 | 指示凭据信息。 |
| callback | [IIdmCallback](#iidmcallback8) | 是 | 回调对象，返回更新凭据的结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialInfo, i.e. authType or authSubType or token. |
| 12300101 | Token is invalid. |
| 12300106 | Unsupported authType. |
**示例：**
```js
let userIDM = new account_osAccount.UserIdentityManager();
......@@ -4229,6 +4579,12 @@ cancel(challenge: Uint8Array): void;
| -------- | ----------- | ---- | ----- |
| challenge | Uint8Array | 是 | 挑战值。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid challenge. |
**示例：**
```js
......@@ -4260,6 +4616,13 @@ delUser(token: Uint8Array, callback: IIdmCallback): void;
| token | Uint8Array | 是 | 身份验证令牌。 |
| callback | [IIdmCallback](#iidmcallback8) | 是 | 回调对象，返回删除用户的结果。|
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300101 | Token is invalid. |
**示例：**
```js
let userIDM = new account_osAccount.UserIdentityManager();
......@@ -4296,6 +4659,15 @@ delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): vo
| token | Uint8Array | 是 | 身份验证令牌。 |
| callback | [IIdmCallback](#iidmcallback8) | 是 | 回调对象，返回删除凭据的结果。 |
**错误码：**
| 错误码ID | 错误信息 |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid credentialId. |
| 12300101 | Token is invalid. |
| 12300102 | Credential not found. |
**示例：**
```js
let userIDM = new account_osAccount.UserIdentityManager();
......@@ -4331,6 +4703,12 @@ getAuthInfo(callback: AsyncCallback&lt;Array&lt;EnrolledCredInfo&gt;&gt;): void;
| -------- | ------------------------------------------------------------------------ | ---- | --------------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | 是 | 回调函数。如果成功，err为null，data为当前用户指定类型的所有已注册凭据信息；否则为错误对象。|
**错误码：**
| 错误码ID | 错误信息 |
| -------- | --------------------- |
| 12300001 | System service exception. |
| 12300102 | Credential not found. |
**示例：**
```js
......@@ -4367,7 +4745,10 @@ getAuthInfo(authType: AuthType, callback: AsyncCallback&lt;Array&lt;EnrolledCred
**错误码：**
| 错误码ID | 错误信息 |
| 12300015 | Unsupported authType. |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType. |
| 12300102 | Credential not found. |
**示例：**
```js
......@@ -4403,13 +4784,16 @@ getAuthInfo(authType?: AuthType): Promise&lt;Array&lt;EnrolledCredInfo&gt;&gt;;
**返回值：**
| 类型 | 说明 |
| :------------------------------------------- | :------------------------------------------------------------ ---------- |
| :------------------------------------------- | :----------------------------------------------------------------------- |
| Promise&lt;Array&lt;[EnrolledCredInfo](#enrolledcredinfo8)&gt;&gt; | Promise对象，返回当前用户指定类型的所有已注册凭据信息。|
**错误码：**
| 错误码ID | 错误信息 |
| 12300015 | Unsupported authType. |
| -------- | ------------------- |
| 12300001 | System service exception. |
| 12300002 | Invalid authType. |
| 12300102 | Credential not found. |
**示例：**
```js
......@@ -4703,7 +5087,7 @@ onAcquireInfo?: (module: number, acquire: number, extraInfo: any) => void;
| ------------ | ---------------------------------------- | ----- | ----------------- |
| credType | [AuthType](#authtype8) | 是 | 指示凭据类型。 |
| credSubType | [AuthSubType](#authsubtype8) | 是 | 指示凭据子类型。 |
| token | Uint8Array | 是 | 指示认证令牌。 |
| token | Uint8Array | 是 | 指示认证令牌。 |
## RequestResult<sup>8+</sup>
......
zh-cn/application-dev/reference/errorcodes/errcode-Account.md
浏览文件 @ 11ab6920
# Account错误码
以下错误码包括系统帐号和分布式帐号错误码。
以下错误码包括系统帐号、分布式帐号和应用帐号错误码。
## 12300001 系统服务异常
......@@ -37,7 +37,7 @@ Invalid parameter.
1. 用户名为空。
2. 系统帐号用户名长度大于1024。
3. 分布式帐号用户名长度大于256。
4. 系统帐号id小于0、小于100或大于1000。
4. 系统帐号id小于0、小于100或大于1099。
5. 分布式帐号id长度大于512。
6. 分布式帐号传入不支持的事件类型。
7. 域名为空。
......@@ -55,6 +55,9 @@ Invalid parameter.
19. 令牌长度超过1024。
20. 键名长度超过1024。
21. 自定义数据值长度超过1024。
22. 无效的令牌。
23. 无效的上下文标识。
24. 无效的凭据标识。
**处理步骤**
......@@ -85,82 +88,82 @@ The account does not exist.
请检查帐号是否存在。
## 12300004 操作受限帐号
## 12300004 帐号已存在
**错误信息**
The specified account is restricted.
The account already exists.
**可能原因**
该错误码表示操作的是受限帐号，可能原因如下:
1. 删除系统保留用户。
2. 查询系统保留用户的约束源类型。
3. 创建id为0-100的帐号。
该错误码表示帐号已存在，可能原因如下:
创建已存在的帐号。
**处理步骤**
指定id为系统保留用户，无法操作。
请取消创建，或使用其他账户号名重试。
## 12300005 监听器已注册
## 12300005 不支持多用户
**错误信息**
The listener has been registered.
Multi-user is not supported.
**可能原因**
该错误码表示监听器已注册，可能原因如下:
当前应用向系统注册一个已经注册过的监听器，无法重复注册。
该错误码表示不支持多用户，可能原因如下:
当前设备不支持多用户，无法创建帐号
**处理步骤**
请取消注册，或使用未注册过的监听器重新注册。
无法创建其他帐号，请取消创建
## 12300006 监听器未注册
## 12300006 不支持的帐号类型
**错误信息**
The Listener is not registered.
The account type is not supported.
**可能原因**
该错误码表示监听器未注册，可能原因如下:
解注册一个未注册过的监听器。
该错误码表示提供了不支持的帐号类型，可能原因如下:
当前设备不支持创建指定类型的帐号
**处理步骤**
请使用注册的监听器执行解注册操作
请创建其他类型的帐号
## 12300007 PIN码输入器已注册
## 12300007 帐号数量已达上限
**错误信息**
The PIN inputer already exists.
The account number has reached the upper limit.
**可能原因**
该错误码表示PIN码输入器已注册，可能原因如下:
PIN码输入器已注册，解注册之前无法重复注册。
该错误码表示帐号数量已达上限，可能原因如下:
创建系统帐号/应用帐号时，已存在1000个帐号。
**处理步骤**
PIN码输入器已存在，请勿重复操作。
请删除其他帐号后再创建。
## 12300008 帐号已存在
## 12300008 受限的帐号
**错误信息**
The account already exists.
The specified account is restricted.
**可能原因**
该错误码表示帐号已存在，可能原因如下:
创建已存在的帐号。
该错误码表示操作的是受限帐号，可能原因如下:
1. 删除系统保留用户。
2. 查询系统保留用户的约束源类型。
3. 创建id为0-100的帐号。
**处理步骤**
请取消创建，或使用其他账户号名重试。
指定id为系统保留用户，无法操作。
## 12300009 帐号已激活
......@@ -177,7 +180,7 @@ The account has been activated.
当前帐号已激活，请勿重复操作。
## 12300010 帐号服务忙
## 12300010 帐号服务忙碌
**错误信息**
......@@ -193,52 +196,101 @@ The account service is busy.
请等待一段时间后重试，并降低调用频率。
## 12300011 帐号数量已达上限
## 12300011 事件监听器已注册
**错误信息**
The account number has reached the upper limit.
The event listener has been registered.
**可能原因**
该错误码表示帐号数量已达上限，可能原因如下:
创建系统帐号/应用帐号时，已存在1000个帐号。
该错误码表示监听器已注册，可能原因如下:
当前应用向系统注册一个已经注册过的监听器，无法重复注册。
**处理步骤**
请删除其他帐号后再创建。
请取消注册，或使用未注册过的监听器重新注册。
## 12300012 不支持多用户
## 12300012 事件监听器未注册
**错误信息**
Multi-user is not supported.
The event listener has not been registered.
**可能原因**
该错误码表示不支持多用户，可能原因如下:
当前设备不支持多用户，无法创建帐号
该错误码表示监听器未注册，可能原因如下:
解注册一个未注册过的监听器。
**处理步骤**
无法创建其他帐号，请取消创建
请使用注册的监听器执行解注册操作
## 12300013 不支持的帐号类型
## 12300101 凭据不正确
**错误信息**
The account type is not supported.
The credential is incorrect.
**可能原因**
该错误码表示提供了不支持的帐号类型，可能原因如下:
当前设备不支持创建管理员帐号
该错误码表示凭据不正确，可能原因如下:
1. 密码输入错误；
2. 生物特征不匹配；
2. 令牌失效；
**处理步骤**
请输入正确有效的凭据重试。
## 12300102 凭据不存在
**错误信息**
The credential does not exist.
**可能原因**
该错误码表示凭据不存在，可能原因如下:
1. 认证未录入的凭据类型。
2. 查询未录入的凭据类型。
3. 删除未录入的凭据类型。
**处理步骤**
请确认凭据类型是否存在。
## 12300103 凭据输入器已注册
**错误信息**
The crdential inputer already exists.
**可能原因**
该错误码表示凭据输入器已注册，可能原因如下:
PIN码输入器已注册，解注册之前无法重复注册。
**处理步骤**
请创建非管理员帐号
凭据输入器已存在，请勿重复操作。
## 12300014 可信等级不支持
## 12300104 凭据输入器不存在
**错误信息**
The crdential inputer not found.
**可能原因**
该错误码表示凭据输入器不存在，可能原因如下:
认证、添加、修改凭据时，未注册凭据输入器。
**处理步骤**
注册凭据输入器。
## 12300105 可信等级不支持
**错误信息**
......@@ -253,7 +305,7 @@ The trust level is not supported.
请输入正确的可信等级。
## 12300015 认证类型不支持
## 12300106 认证类型不支持
**错误信息**
......@@ -268,81 +320,130 @@ The auth type is not supported.
请提供系统支持的认证类型。
## 12300016 认证超时
## 12300007 认证类型不存在
**错误信息**
The auth service is timeout.
The auth type does not exist.
**可能原因**
该错误码表示认证类型不存在，可能原因如下:
查询/删除令牌时，指定的鉴权类型不存在。
**处理步骤**
请使用存在的认证类型查询/删除。
## 12300008 认证会话不存在
**错误信息**
The authentication session does not exist.
**可能原因**
该错误码表示认证超时，可能原因如下:
1. 认证录入超过三分钟。
2. 认证服务因网络原因无法及时响应而超时。
该错误码表示会话不存在，可能原因如下:
查询不存在的会话回调。
**处理步骤**
1. 认证录入超时，请重试。
2. 请确认网络环境无问题后重试。
请使用已成功打开的会话标识查询会话回调。
## 12300017 认证服务忙
## 12300109 认证被取消
**错误信息**
The auth service is busy.
The authentication is canceled.
**可能原因**
该错误码表示认证服务忙，可能原因如下:
认证总数超过5个。
该错误码表示认证被取消，可能原因如下:
认证过程中，用户取消认证操作。
**处理步骤**
当前认证服务忙，请稍后重试。
重新或结束认证操作。
## 12300018 认证服务锁定
## 12300110 认证被锁定
**错误信息**
The auth service is locked.
The authentication is locked.
**可能原因**
该错误码表示认证服务锁定，可能原因如下:
该错误码表示认证被锁定，可能原因如下:
认证类型错误次数超过上限。
**处理步骤**
认证错误次数超过上限，请在freezingTime之后重试。
## 12300019 凭据不存在
## 12300111 认证超时
**错误信息**
The credential does not exist.
The authentication is timeout.
**可能原因**
该错误码表示凭据不存在，可能原因如下:
1. 认证未录入的凭据类型。
2. 查询未录入的凭据类型。
3. 删除未录入的凭据类型。
该错误码表示认证超时，可能原因如下:
1. 对于系统帐号，认证、录入超过三分钟。
2. 认证服务因网络原因无法及时响应而超时。
**处理步骤**
请确认凭据类型是否存在。
1. 认证录入超时，请重试。
2. 请确认网络环境无问题后重试。
## 12300112 认证服务忙
**错误信息**
The auth service is busy.
**可能原因**
该错误码表示认证服务忙，可能原因如下:
系统帐号认证时，认证总数超过5个。
应用帐号认证时，三方应用的认证器服务忙碌（根据实际情况决定）。
**处理步骤**
当前认证服务忙，请稍后重试。
## 12300020 无效的contextId
## 12300113 认证服务不存在
**错误信息**
The contextId is invalid.
The account authenticator service does not exist.
**可能原因**
该错误码表示认证服务不存在，可能原因如下:
对于应用帐号：
1. 请求鉴权时，帐号所属应用不支持认证器服务。
2. 隐式添加帐号时，帐号所属应用不支持认证器服务。
3. 验证指定帐号的凭据时，该帐号所属应用不支持认证器服务。
4. 设置应用的认证器属性时，指定的应用不支持认证器服务。
5. 检查帐号标签时，指定的应用不支持认证器服务。
**处理步骤**
请取消操作，或向支持认证服务的应用进行认证。
## 12300114 认证服务异常
**错误信息**
The account authenticator service works abnormally.
**可能原因**
该错误码表示contextId无效，可能原因如下:
传入取消的contexId未发起认证录入或已经完成。
该错误码表示帐号认证服务异常，可能原因如下:
1. 身份认证服务出现未知错误；
2. 应用认证器不符合规范；
**处理步骤**
请输入正确的contextId。
1. 请重试或重启系统；
2. 按照规范开发应用认证器；
zh-cn/application-dev/reference/errorcodes/errorcode-app-account.md
浏览文件 @ 11ab6920
......@@ -16,85 +16,42 @@ The application does not exist.
请取消设置，或使用已安装的应用包名重试。
## 12400002 帐号认证器服务不存在
## 12400002 自定义数据不存在
**错误信息**
The account authenticator service does not exist.
**可能原因**
该错误码表示帐号认证器服务不存在，可能原因如下:
1. 请求鉴权时，帐号所属应用不支持认证器服务。
2. 隐式添加帐号时，帐号所属应用不支持认证器服务。
3. 验证指定帐号的凭据时，该帐号所属应用不支持认证器服务。
4. 设置应用的认证器属性时，指定的应用不支持认证器服务。
**处理步骤**
请取消操作，或使用支持认证器服务的应用的包名重试。
## 12400003 帐号认证器服务异常
**错误信息**
The account authenticator service works abnormally.
**可能原因**
该错误码表示帐号认证器服务异常，可能原因如下:
三方应用的鉴权服务接连失败。
**处理步骤**
请重试或重启系统。
## 12400004 鉴权类型不存在
**错误信息**
The custom data does not exist.
The auth type does not exist.
**可能原因**
该错误码表示鉴权类型不存在，可能原因如下:
查询/删除令牌时，指定的鉴权类型不存在。
该错误码表示自定义数据不存在，可能原因如下:
查询帐号的自定义数据时，输入的键名不存在。
**处理步骤**
请使用存在的鉴权类型查询/删除。
请使用存在的自定义数据的键名查询。
## 12400005 会话不存在
## 12400003 自定义数据的数量已达上限
**错误信息**
The session does not exist.
The number of custom data reaches upper limit.
**可能原因**
该错误码表示会话不存在，可能原因如下:
查询不存在的会话回调。
该错误码表示自定义数据的数量已达上限，可能原因如下:
设置自定义数据时，目标帐号的自定义数据数量已达512。
**处理步骤**
请使用已成功打开的会话标识查询会话回调。
## 12400006 授权列表已达上限
**错误信息**
The size of authorization list reaches upper limit.
**可能原因**
该错误码表示授权列表已达上限，可能原因如下:
设置访问/开放授权时，授权列表的大小超过1024。
**处理步骤**
1. 请取消设置操作，或者撤销已存在的访问/开放授权后再设置。
请取消设置操作，或者删除已存在的自定义数据。
## 12400007 令牌数量已达上限
## 12400004 令牌数量已达上限
**错误信息**
The number of token reaches upper limit.
**可能原因**
该错误码表示令牌数量已达上限，可能原因如下:
......@@ -104,31 +61,17 @@ The number of token reaches upper limit.
请取消添加操作，或者删除已存在的令牌后再添加。
## 12400008 自定义数据的数量已达上限
**错误信息**
The number of custom data reaches upper limit.
**可能原因**
该错误码表示自定义数据的数量已达上限，可能原因如下:
设置自定义数据时，目标帐号的自定义数据数量已达512。
**处理步骤**
请取消设置操作，或者删除已存在的自定义数据。
## 12400009 自定义数据不存在
## 12400005 授权列表已达上限
**错误信息**
The custom data does not exist.
The size of authorization list reaches upper limit.
**可能原因**
该错误码表示自定义数据不存在，可能原因如下:
查询帐号的自定义数据时，输入的键名不存在。
该错误码表示授权列表已达上限，可能原因如下:
设置访问/开放授权时，授权列表的大小超过1024。
**处理步骤**
请使用存在的自定义数据的键名查询。
1. 请取消设置操作，或者撤销已存在的访问/开放授权后再设置。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或