diff --git a/zh-cn/application-dev/reference/apis/js-apis-appAccount.md b/zh-cn/application-dev/reference/apis/js-apis-appAccount.md index a11141d837c647265bb39b925f4d3a54d5cf6d28..2cd6742fd00715e88dac368cb493f1979790f96e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appAccount.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appAccount.md @@ -1,6 +1,6 @@ # 应用帐号管理 -本模块不仅用于对应用帐号的添加、删除、查询、修改和授权，且提供帐号将数据写入磁盘和数据同步的能力。 +本模块提供应用帐号信息的添加、删除、修改和查询基础能力，并支持应用间鉴权和分布式数据同步功能。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -17,7 +17,7 @@ import account_appAccount from '@ohos.account.appAccount'; createAppAccountManager(): AppAccountManager -获取应用帐号模块的对象。 +创建应用帐号管理器对象。 **系统能力：** SystemCapability.Account.AppAccount @@ -25,51 +25,51 @@ createAppAccountManager(): AppAccountManager | 类型 | 说明 | | ----------------- | ------------ | -| AppAccountManager | 获取应用帐号模块的实例。 | +| AppAccountManager | 应用帐号管理器对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); ``` ## AppAccountManager -管理应用帐号模块的实例。 +应用帐号管理器类。 ### createAccount9+ createAccount(name: string, callback: AsyncCallback<void>): void; -将此应用的帐号名添加到帐号管理服务中。使用callback异步回调。 +根据帐号名创建应用帐号。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | -------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当此应用的帐号名添加到帐号管理服务成功时，err为undefined，否则为错误对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ----- | -------------------- | +| name | string | 是 | 应用帐号的名称。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当创建成功时，err为null，否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or options. | - | 12300008 | the account indicated by name already exist. | - | 12300011 | the account number has reached the upper limit. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name. | +| 12300004 | Account already exists. | +| 12300007 | The number of accounts reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.createAccount("WangWu", (err) => { - console.log("createAccount err: " + JSON.stringify(err)); - }); + appAccountManager.createAccount("WangWu", (err) => { + console.log("createAccount err: " + JSON.stringify(err)); + }); } catch (err) { - console.log("createAccount err: " + JSON.stringify(err)); + console.log("createAccount err: " + JSON.stringify(err)); } ``` @@ -77,7 +77,7 @@ createAccount(name: string, callback: AsyncCallback<void>): void; createAccount(name: string, options: CreateAccountOptions, callback: AsyncCallback<void>): void -将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中。使用callback异步回调。 +根据帐号名和可选项创建应用帐号。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -85,42 +85,47 @@ createAccount(name: string, options: CreateAccountOptions, callback: AsyncCallba | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | ---------------------------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| options | [CreateAccountOptions](#createaccountoptions9) | 是 | 要添加的应用帐号的选项，选项中不能包含应用帐号的敏感信息（如应用帐号密码）。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当此应用程序的帐号名和额外信息添加到帐号管理服务成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| options | [CreateAccountOptions](#createaccountoptions9) | 是 | 创建应用帐号的选项，可提供自定义数据，但不建议包含敏感数据（如密码、Token等）。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当创建成功时，err为null，否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or options. | - | 12300008 | the account indicated by name already exist. | - | 12300011 | the account number has reached the upper limit. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or options. | +| 12300004 | Account already exists. | +| 12300007 | The number of accounts reaches the upper limit. | +| 12400003 | The number of custom data reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); + let options = { + customData: { + "age": "10" + } + } try { - var option : CreateAccountOptions = { - customData: { - "age":10 - } + appAccountManager.createAccount("LiSi", options, (err) => { + if (err) { + console.log("createAccount failed, error: " + JSON.stringify(err)); + } else { + console.log("createAccount successfully"); } - appAccountManager.createAccount("LiSi", option, (err) => { - console.log("createAccount err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("createAccount err: " + JSON.stringify(err)); + }); + } catch(err) { + console.log("createAccount exception: " + JSON.stringify(err)); } ``` ### createAccount9+ -createAccount(name: string, extraInfo?: string): Promise<void> +createAccount(name: string, options?: CreateAccountOptions): Promise<void> -将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中。使用Promise异步回调。 +根据帐号名和可选项创建应用帐号。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -128,8 +133,8 @@ createAccount(name: string, extraInfo?: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------------------------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| options | [CreateAccountOptions](#createaccountoptions9) | 否 | 要添加的应用帐号的选项，选项中不能包含应用帐号的敏感信息（如应用帐号密码），不填写不附带选项信息。 | +| name | string | 是 | 应用帐号的名称。 | +| options | [CreateAccountOptions](#createaccountoptions9) | 否 | 创建应用帐号的选项，可提供自定义数据，但不建议包含敏感数据（如密码、Token等）。不填无影响。 | **返回值：** @@ -139,30 +144,31 @@ createAccount(name: string, extraInfo?: string): Promise<void> **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or options. | - | 12300008 | the account indicated by name already exist. | - | 12300011 | the account number has reached the upper limit. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or options. | +| 12300004 | Account already exists. | +| 12300007 | The number of accounts reaches the upper limit. | +| 12400003 | The number of custom data reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); + let options = { + customData: { + "age": "10" + } + } try { - var option : CreateAccountOptions = { - customData: { - "age":10 - } - } - appAccountManager.createAccount("LiSi", option).then(()=> { - console.log('createAccount Success'); - }).catch((err) => { - console.log("createAccount err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("createAccount err: " + JSON.stringify(err)); + appAccountManager.createAccount("LiSi", options).then(() => { + console.log("createAccount successfully"); + }).catch((err) => { + console.log("createAccount failed, error: " + JSON.stringify(err)); + }); + } catch(err) { + console.log("createAccount exception: " + JSON.stringify(err)); } ``` @@ -170,25 +176,27 @@ createAccount(name: string, extraInfo?: string): Promise<void> createAccountImplicitly(owner: string, callback: AuthCallback): void -根据指定的帐号所有者隐式地添加应用帐号，并使用callback回调异步返回结果。 +根据指定的帐号所有者隐式地创建应用帐号。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ----------------------- | -| owner | string | 是 | 要添加的应用帐号所有者包名。 | -| callback | [AuthCallback](#authcallback9) | 是 | 认证回调，用于返回鉴权结果。 | +| owner | string | 是 | 应用帐号所有者的包名。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调对象，返回创建结果。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or options. | - | 12300011 | the account number has reached the upper limit. | - | 12300008 | the account authenticator service does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid owner. | +| 12300007 | The number of accounts reaches the upper limit. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** @@ -196,25 +204,25 @@ createAccountImplicitly(owner: string, callback: AuthCallback): void import featureAbility from '@ohos.ability.featureAbility'; function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); + console.log("resultCode: " + code); + console.log("result: " + JSON.stringify(result)); } function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); - }); + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err) => { + console.log("startAbility err: " + JSON.stringify(err)); + }); } - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.createAccountImplicitly("com.example.ohos.accountjsdemo", { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback - }); + appAccountManager.createAccountImplicitly("com.example.accountjsdemo", { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback + }); } catch (err) { - console.log("createAccountImplicitly err: " + JSON.stringify(err)); + console.log("createAccountImplicitly exception: " + JSON.stringify(err)); } ``` @@ -222,7 +230,7 @@ createAccountImplicitly(owner: string, callback: AuthCallback): void createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, callback: AuthCallback): void -根据指定的帐号所有者和可选项隐式地添加应用帐号，并使用callback回调异步返回结果。 +根据指定的帐号所有者和可选项隐式地创建应用帐号。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -230,18 +238,20 @@ createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ----------------------- | -| owner | string | 是 | 要添加的应用帐号所有者包名。 | -| options | [CreateAccountImplicitlyOptions](#createaccountimplicitlyoptions9) | 是 | 隐式创建账号的选项。 | -| callback | [AuthCallback](#authcallback9) | 是 | 认证回调，用于返回鉴权结果。 | +| owner | string | 是 | 应用帐号所有者的包名。 | +| options | [CreateAccountImplicitlyOptions](#createaccountimplicitlyoptions9) | 是 | 隐式创建账号的选项。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调对象，返回创建结果。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or options. | - | 12300011 | the account number has reached the upper limit. | - | 12300008 | the account authenticator service does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or options. | +| 12300007 | The number of accounts reaches the upper limit. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** @@ -249,35 +259,37 @@ createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, import featureAbility from '@ohos.ability.featureAbility'; function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); + console.log("resultCode: " + code); + console.log("result: " + JSON.stringify(result)); } function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); - }); + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err) => { + console.log("startAbility err: " + JSON.stringify(err)); + }); } - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); + let options = { + authType: "getSocialData", + requiredLabels: [ "student" ] + }; try { - appAccountManager.createAccountImplicitly("com.example.ohos.accountjsdemo", { - requiredLabels: ["student"], authType: "getSocialData"}, { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback + appAccountManager.createAccountImplicitly("com.example.accountjsdemo", options, { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback }); } catch (err) { - console.log("createAccountImplicitly err: " + JSON.stringify(err)); + console.log("createAccountImplicitly exception: " + JSON.stringify(err)); } - ``` ### removeAccount9+ removeAccount(name: string, callback: AsyncCallback<void>): void -从帐号管理服务中移除应用帐号。使用callback异步回调。 +删除应用帐号。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -285,36 +297,39 @@ removeAccount(name: string, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------- | -| name | string | 是 | 要删除的应用帐号名称。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当帐号管理服务中移除应用帐号成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当删除成功时，err为null，否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name. | - | 12300003 | the account indicated by name dose not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.removeAccount("ZhaoLiu", (err) => { - console.log("removeAccount err: " + JSON.stringify(err)); + appAccountManager.removeAccount("ZhaoLiu", (err) => { + if (err) { + console.log("removeAccount failed, error: " + JSON.stringify(err)); + } else { + console.log("removeAccount successfully"); + } }); - } catch (err) { - console.log("removeAccount err: " + JSON.stringify(err)); + } catch(err) { + console.log("removeAccount exception: " + JSON.stringify(err)); } - ``` ### removeAccount9+ -deleteAccount(name: string): Promise<void> +removeAccount(name: string): Promise<void> -从帐号管理服务中移除应用帐号。使用Promise异步回调。 +删除应用帐号。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -322,7 +337,7 @@ deleteAccount(name: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----------- | -| name | string | 是 | 要移除的应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | **返回值：** @@ -332,73 +347,75 @@ deleteAccount(name: string): Promise<void> **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name. | - | 12300003 | the account indicated by name dose not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.deleteAccount("ZhaoLiu").then(() => { - console.log('removeAccount Success'); - }).catch((err) => { - console.log("removeAccount err: " + JSON.stringify(err)); - }); + appAccountManager.removeAccount("Lisi").then(() => { + console.log("removeAccount successfully"); + }).catch((err) => { + console.log("removeAccount failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("removeAccount err: " + JSON.stringify(err)); + console.log("removeAccount exception: " + JSON.stringify(err)); } - ``` ### setAppAccess9+ setAppAccess(name: string, bundleName: string, isAccessible: boolean, callback: AsyncCallback<void>): void -设置指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，由isAccessible指明是允许访问还是禁止访问，callback回调异步返回结果。 +设置指定应用对特定帐号的访问权限。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------------- | ---- | --------------------------------- | -| name | string | 是 | 应用帐号名称。 | -| bundleName | string | 是 | 第三方应用的包名。 | -| isAccessible | boolean | 是 | 访问控制，允许访问或禁止访问。 | -| callback | AsyncCallback<void> | 是 | 访问权限设置的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ------------------------- | ---- | --------------------------------- | +| name | string | 是 | 应用帐号的名称。 | +| bundleName | string | 是 | 第三方应用的包名。 | +| isAccessible | boolean | 是 | 是否可访问。true表示允许访问，false表示禁止访问。 | +| callback | AsyncCallback<void> | 是 | 回调函数，如果设置成功，err为null，否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or bundlename. | - | 12300003 | the account indicated by localId dose not exist. | - | 12400001 | the application indicated by bundlename does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or bundleName. | +| 12300003 | Account not found. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", true, (err) => { - console.log("enableAppAccess: " + JSON.stringify(err)); - }); + appAccountManager.setAppAccess("ZhangSan", "com.example.accountjsdemo", true, (err) => { + if (err) { + console.log("setAppAccess failed: " + JSON.stringify(err)); + } else { + console.log("setAppAccess successfully"); + } + }); } catch (err) { - console.log("enableAppAccess: " + JSON.stringify(err)); + console.log("setAppAccess exception: " + JSON.stringify(err)); } - ``` ### setAppAccess9+ setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise<void> -设置指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，由isAccessible指明是允许访问还是禁止访问。使用Promise异步回调。 +设置指定应用对特定帐号的数据访问权限。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -406,9 +423,9 @@ setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise&l | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | -| isAccessible | boolean | 是 | 访问控制，允许访问或禁止访问。 | +| isAccessible | boolean | 是 | 是否可访问。true表示允许访问，false表示禁止访问。 | **返回值：** @@ -418,25 +435,25 @@ setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise&l **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or bundlename. | - | 12300003 | the account indicated by localId dose not exist. | - | 12400001 | the application indicated by bundlename does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or bundleName. | +| 12300003 | Account not found. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", true).then(() => { - console.log('setAppAccess Success'); - }).catch((err) => { - console.log("setAppAccess err: " + JSON.stringify(err)); - }); + appAccountManager.setAppAccess("ZhangSan", "com.example.accountjsdemo", true).then(() => { + console.log("setAppAccess successfully"); + }).catch((err) => { + console.log("setAppAccess failed: " + JSON.stringify(err)); + }); } catch (err) { - console.log("setAppAccess err: " + JSON.stringify(err)); + console.log("setAppAccess exception: " + JSON.stringify(err)); } ``` @@ -444,7 +461,7 @@ setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise&l checkAppAccess(name: string, bundleName: string, callback: AsyncCallback<boolean>): void -查看指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，callback回调异步返回结果。 +检查指定应用对特定帐号的数据是否可访问。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -452,38 +469,41 @@ checkAppAccess(name: string, bundleName: string, callback: AsyncCallback<bool | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | --------------------------------- | -| name | string | 是 | 应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | -| callback | AsyncCallback<void> | 是 | 查看访问权限的回调。 | +| callback | AsyncCallback<void> | 是 | 回调函数。返回true表示指定应用可访问特定帐号的数据；返回false表示不可访问。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or bundlename. | - | 12300003 | the account indicated by localId dose not exist. | - | 12400001 | the application indicated by bundlename does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or bundleName. | +| 12300003 | Account not found. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.checkAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { - console.log("checkAppAccess: " + JSON.stringify(err)); - }); + appAccountManager.checkAppAccess("ZhangSan", "com.example.accountjsdemo", (err, isAccessible) => { + if (err) { + console.log("checkAppAccess failed, error: " + JSON.stringify(err)); + } else { + console.log("checkAppAccess successfully"); + } + }); } catch (err) { - console.log("checkAppAccess: " + JSON.stringify(err)); + console.log("checkAppAccess exception: " + JSON.stringify(err)); } - ``` ### checkAppAccess9+ -checkAppAccess(name: string, bundleName: string): Promise<void> +checkAppAccess(name: string, bundleName: string): Promise<boolean> -查看指定第三方应用帐号名称对指定包名称的第三方应用的访问权限。使用Promise异步回调。 +检查指定应用对特定帐号的数据是否可访问。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -491,45 +511,44 @@ checkAppAccess(name: string, bundleName: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | **返回值：** | 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise对象。无返回结果的Promise对象。 | +| ------------------- | --------------------- | +| Promise<boolean> | Promise对象，返回true表示指定应用可访问特定帐号的数据；返回false表示不可访问。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or bundlename. | - | 12300003 | the account indicated by localId dose not exist. | - | 12400001 | the application indicated by bundlename does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or bundleName. | +| 12300003 | Account not found. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.checkAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { - console.log('checkAppAccess Success'); - }).catch((err) => { - console.log("checkAppAccess err: " + JSON.stringify(err)); - }); + appAccountManager.checkAppAccess("ZhangSan", "com.example.accountjsdemo").then((isAccessible) => { + console.log("checkAppAccess successfully, isAccessible: " + isAccessible); + }).catch((err) => { + console.log("checkAppAccess failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("checkAppAccess err: " + JSON.stringify(err)); + console.log("checkAppAccess exception: " + JSON.stringify(err)); } - ``` -### checkDataSyncEnabled9+ +### setDataSyncEnabled9+ -checkDataSyncEnabled(name: string, callback: AsyncCallback<boolean>): void +setDataSyncEnabled(name: string, isEnabled: boolean, callback: AsyncCallback<void>): void -检查指定应用帐号是否允许应用数据同步。使用callback异步回调。 +开启或禁止指定应用帐号的数据同步功能。使用callback异步回调。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC @@ -537,39 +556,38 @@ checkDataSyncEnabled(name: string, callback: AsyncCallback<boolean>): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------- | ---- | --------------------- | -| name | string | 是 | 应用帐号名称。 | -| callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示指定应用帐号允许应用数据同步；返回false表示指定应用帐号不允许应用数据同步。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------- | +| name | string | 是 | 应用帐号的名称。 | +| isEnabled | boolean | 是 | 是否开启数据同步。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当开启或禁止成功时，err为null，否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name. | - | 12300003 | the account indicated by localId dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.checkDataSyncEnabled("ZhangSan", (err, result) => { - console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); - console.log('checkDataSyncEnabled result: ' + result); + appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => { + console.log("setDataSyncEnabled err: " + JSON.stringify(err)); }); } catch (err) { - console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); + console.log("setDataSyncEnabled err: " + JSON.stringify(err)); } - ``` -### checkDataSyncEnabled9+ +### setDataSyncEnabled9+ -checkDataSyncEnabled(name: string): Promise<boolean> +setDataSyncEnabled(name: string, isEnabled: boolean): Promise<void> -检查指定应用帐号是否允许应用数据同步。使用Promise异步回调。 +开启或禁止指定应用帐号的数据同步功能。使用Promise异步回调。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC @@ -577,663 +595,679 @@ checkDataSyncEnabled(name: string): Promise<boolean> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ------- | -| name | string | 是 | 应用帐号名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------- | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| isEnabled | boolean | 是 | 是否开启数据同步。 | **返回值：** -| 类型 | 说明 | -| :--------------------- | :-------------------- | -| Promise<boolean> | Promise对象。返回true表示允许应用数据同步；返回false表示不允许应用数据同步。 | +| 类型 | 说明 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name. | - | 12300003 | the account indicated by localId dose not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.checkDataSyncEnabled("ZhangSan").then((data) => { - console.log('checkDataSyncEnabled, result: ' + data); + appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => { + console.log('setDataSyncEnabled Success'); }).catch((err) => { - console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); + console.log("setDataSyncEnabled err: " + JSON.stringify(err)); }); } catch (err) { - console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); + console.log("setDataSyncEnabled err: " + JSON.stringify(err)); } - ``` -### setCredential9+ +### checkDataSyncEnabled9+ -setCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void +checkDataSyncEnabled(name: string, callback: AsyncCallback<boolean>): void + +检查指定应用帐号是否开启数据同步功能。使用callback异步回调。 -设置此应用程序帐号的凭据。使用callback异步回调。 +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------------------------- | ---- | ------------- | -| name | string | 是 | 应用程序帐号名称。 | -| credentialType | string | 是 | 要设置的凭据类型。 | -| credential | string | 是 | 要设置的凭据。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置此应用程序帐号的凭据成功时，err为undefined，否则为错误对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | --------------------- | +| name | string | 是 | 应用帐号的名称。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示指定应用帐号已开启数据同步功能；返回false表示未开启。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or credentialType. | - | 12300003 | the account indicated by localId dose not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setCredential("ZhangSan", "credentialType001", "credential001", (err) => { - console.log("setCredential err: " + JSON.stringify(err)); - }); + appAccountManager.checkDataSyncEnabled("ZhangSan", (err, isEnabled) => { + if (err) { + console.log("checkDataSyncEnabled failed, err: " + JSON.stringify(err)); + } else { + console.log('checkDataSyncEnabled successfully, isEnabled: ' + isEnabled); + } + }); } catch (err) { - console.log("setCredential err: " + JSON.stringify(err)); + console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); } ``` -### setCredential9+ +### checkDataSyncEnabled9+ -setCredential(name: string, credentialType: string, credential: string): Promise<void> +checkDataSyncEnabled(name: string): Promise<boolean> -设置此应用程序帐号的凭据。使用Promise异步回调。 +检查指定应用帐号是否开启数据同步功能。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃。 -> -> 从 API version 7开始支持。 +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------ | ---- | ---------- | -| name | string | 是 | 应用帐号的名称。 | -| credentialType | string | 是 | 要设置的凭据的类型。 | -| credential | string | 是 | 要设置的凭据。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------- | +| name | string | 是 | 应用帐号的名称。 | **返回值：** -| 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise对象。无返回结果的Promise对象。 | +| 类型 | 说明 | +| :--------------------- | :-------------------- | +| Promise<boolean> | Promise对象，返回true表示指定应用帐号已开启数据同步功能；返回false表示未开启。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or credentialType. | - | 12300003 | the account indicated by localId dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setCredential("ZhangSan", "credentialType001", "credential001").then(() => { - console.log('setCredential Success'); - }).catch((err) => { - console.log("setCredential err: " + JSON.stringify(err)); - }); + appAccountManager.checkDataSyncEnabled("ZhangSan").then((isEnabled) => { + console.log("checkDataSyncEnabled successfully, isEnabled: " + isEnabled); + }).catch((err) => { + console.log("checkDataSyncEnabled failed, err: " + JSON.stringify(err)); + }); } catch (err) { - console.log("setCredential err: " + JSON.stringify(err)); + console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); } - ``` - -### setDataSyncEnabled9+ -setDataSyncEnabled(name: string, isEnable: boolean, callback: AsyncCallback<void>): void +### setCredential9+ -设置指定的应用程序帐号是否允许应用程序数据同步。使用callback异步回调。 +setCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void -**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC +设置指定应用帐号的凭据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ------------------------- | -| name | string | 是 | 应用帐号名称。 | -| isEnable | boolean | 是 | 是否允许应用数据同步。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当指定的应用帐号是否允许应用程序数据设置成功时，err为undefined，否则为错误对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------------------------- | ---- | ------------- | +| name | string | 是 | 应用帐号的名称。 | +| credentialType | string | 是 | 凭据类型。 | +| credential | string | 是 | 凭据取值。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当凭据设置成功时，err为null，否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name. | - | 12300003 | the account indicated by name dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or credentialType or credential. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => { - console.log("setDataSyncEnabled err: " + JSON.stringify(err)); - }); + appAccountManager.setCredential("ZhangSan", "PIN_SIX", "xxxxxx", (err) => { + if (err) { + console.log("setCredential failed, error: " + JSON.stringify(err)); + } else { + console.log("setCredential successfully"); + } + }); } catch (err) { - console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + console.log("setCredential exception: " + JSON.stringify(err)); } ``` -### setDataSyncEnabled9+ - -setDataSyncEnabled(name: string, isEnable: boolean): Promise<void> +### setCredential9+ -设置指定的应用程序帐号是否允许应用程序数据同步。使用Promise异步回调。 +setCredential(name: string, credentialType: string, credential: string): Promise<void> -**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC +设置指定应用帐号的凭据。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------- | ---- | ----------- | -| name | string | 是 | 应用帐号名称。 | -| isEnable | boolean | 是 | 是否允许应用数据同步。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------ | ---- | ---------- | +| name | string | 是 | 应用帐号的名称。 | +| credentialType | string | 是 | 凭据类型。 | +| credential | string | 是 | 凭据取值。 | **返回值：** -| 类型 | 说明 | +| 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise对象。无返回结果的Promise对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name. | - | 12300003 | the account indicated by name dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or credentialType or credential. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => { - console.log('setDataSyncEnabled Success'); - }).catch((err) => { - console.log("setDataSyncEnabled err: " + JSON.stringify(err)); - }); + appAccountManager.setCredential("ZhangSan", "PIN_SIX", "xxxxxx").then(() => { + console.log("setCredential successfully"); + }).catch((err) => { + console.log("setCredential failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + console.log("setCredential exception: " + JSON.stringify(err)); } ``` -### setCustomData9+ +### getCredential9+ -setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void +getCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void -设置与此应用程序帐号关联的数据。使用callback异步回调。 +获取指定应用帐号的凭据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | -| value | string | 是 | 要设置的数据的值。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置与此应用帐号关联的数据成功时，err为undefined，否则为错误对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | --------------------------- | ---- | -------------- | +| name | string | 是 | 应用帐号的名称。 | +| credentialType | string | 是 | 凭据类型。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取凭据成功时，err为null，data为指定应用帐号的凭据；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, key or value. | - | 12300003 | the account indicated by name dose not exist. | - | 12400008 | the number of customized data has reached the upper limit. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or credentialType. | +| 12300003 | Account not found. | +| 12300102 | Credential not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setCustomData("ZhangSan", "k001", "v001", (err) => { - console.log("setCustomData err: " + JSON.stringify(err)); - }); + appAccountManager.getCredential("ZhangSan", "PIN_SIX", (err, result) => { + if (err) { + console.log("getCredential failed, error: " + JSON.stringify(err)); + } else { + console.log('getCredential successfully, result: ' + result); + } + }); } catch (err) { - console.log("setCustomData err: " + JSON.stringify(err)); + console.log("getCredential err: " + JSON.stringify(err)); } ``` -### setCustomData9+ +### getCredential9+ -setAssociatedData(name: string, key: string, value: string): Promise<void> +getCredential(name: string, credentialType: string): Promise<string> -设置与此应用程序帐号关联的数据。使用Promise异步回调。 +获取指定应用帐号的凭据。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | -| value | string | 是 | 要设置的数据的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------ | ---- | ---------- | +| name | string | 是 | 应用帐号的名称。 | +| credentialType | string | 是 | 凭据类型。 | **返回值：** -| 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise对象。无返回结果的Promise对象。 | +| 类型 | 说明 | +| :-------------------- | :-------------------- | +| Promise<string> | Promise对象，返回指定应用帐号的凭据。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, key or value. | - | 12300003 | the account indicated by name dose not exist. | - | 12400008 | the number of customized data has reached the upper limit. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or credentialType. | +| 12300003 | Account not found. | +| 12300102 | Credential not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setCustomData("ZhangSan", "k001", "v001").then(() => { - console.log('setCustomData Success'); - }).catch((err) => { - console.log("setCustomData err: " + JSON.stringify(err)); - }); + appAccountManager.getCredential("ZhangSan", "PIN_SIX").then((credential) => { + console.log("getCredential successfully, credential: " + credential); + }).catch((err) => { + console.log("getCredential failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("setCustomData err: " + JSON.stringify(err)); + console.log("getCredential exception: " + JSON.stringify(err)); } ``` -### getAllAccounts9+ - -getAllAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void +### setCustomData9+ -获取全部应用已授权帐号信息。 +setCustomData(name: string, key: string, value: string, callback: AsyncCallback<void>): void -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +设置指定应用帐号的自定义数据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | --------- | -| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ----------------- | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 自定义数据的键名。 | +| value | string | 是 | 自定义数据的取值。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置自定义数据成功时，err为null，否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or key or value. | +| 12300003 | Account not found. | +| 12400003 | The number of custom data reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAllAccounts((err, data)=>{ - console.debug("getAllAccounts err:" + JSON.stringify(err)); - console.debug("getAllAccounts data:" + JSON.stringify(data)); - }); + appAccountManager.setCustomData("ZhangSan", "age", "12", (err) => { + if (err) { + console.log("setCustomData failed, error: " + JSON.stringify(err)); + } else { + console.log("setCustomData successfully"); + } + }); } catch (err) { - console.debug("getAllAccounts err:" + JSON.stringify(err)); + console.log("setCustomData exception: " + JSON.stringify(err)); } ``` -### getAllAccounts9+ - -getAllAccounts(): Promise<Array<AppAccountInfo>> +### setCustomData9+ -获取全部应用已授权帐号信息。 +setCustomData(name: string, key: string, value: string): Promise<void> -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +设置指定应用帐号的自定义数据。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------- | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 自定义数据的键名。 | +| value | string | 是 | 自定义数据的取值。 | + **返回值：** -| 类型 | 说明 | -| ---------------------------------------- | --------------------- | -| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象。返回全部应用已授权帐号信息对象。 | +| 类型 | 说明 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or key or value. | +| 12300003 | Account not found. | +| 12400003 | The number of custom data reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAllAccounts().then((data) => { - console.log('getAllAccounts: ' + data); - }).catch((err) => { - console.log("getAllAccounts err: " + JSON.stringify(err)); - }); + appAccountManager.setCustomData("ZhangSan", "age", "12").then(() => { + console.log("setCustomData successfully"); + }).catch((err) => { + console.log("setCustomData failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("getAllAccounts err: " + JSON.stringify(err)); + console.log("setCustomData exception: " + JSON.stringify(err)); } ``` -### getAccountsByOwner9+ - -getAccountsByOwner(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void +### getCustomData9+ -获取指定应用全部帐号信息。 +getCustomData(name: string, key: string, callback: AsyncCallback<string>): void -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +根据指定键名获取特定应用帐号的自定义数据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | --------- | -| owner | string | 是 | 应用包名称。 | -| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ----- | ------------------------ | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 自定义数据的键名。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取成功时，err为null，data为自定义数据的取值；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid owner. | - | 12300003 | the account indicated by owner dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or key. | +| 12300003 | Account not found. | +| 12400002 | Custom data not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - const selfBundle = "com.example.actsgetallaaccounts"; + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAccountsByOwner(selfBundle, (err, data)=>{ - console.debug("getAccountsByOwner err:" + JSON.stringify(err)); - console.debug("getAccountsByOwner data:" + JSON.stringify(data)); - }); + appAccountManager.getCustomData("ZhangSan", "age", (err, data) => { + if (err) { + console.log('getCustomData failed, error: ' + err); + } else { + console.log("getCustomData successfully, data: " + data); + } + }); } catch (err) { - console.debug("getAccountsByOwner err:" + JSON.stringify(err)); + console.log("getCustomData exception: " + JSON.stringify(err)); } ``` -### getAccountsByOwner9+ - -getAccountsByOwner(owner: string): Promise<Array<AppAccountInfo>> +### getCustomData9+ -获取指定应用全部帐号信息。 +getCustomData(name: string, key: string): Promise<string> -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +根据指定键名获取特定应用帐号的自定义数据。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ------ | -| owner | string | 是 | 应用包名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------- | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 自定义数据的键名。 | **返回值：** -| 类型 | 说明 | -| ---------------------------------------- | --------------------- | -| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象。返回指定应用全部帐号信息对象。 | +| 类型 | 说明 | +| --------------------- | --------------------- | +| Promise<string> | Promise对象，返回自定义数据的取值。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid owner. | - | 12300003 | the account indicated by owner dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or key. | +| 12300003 | Account not found. | +| 12400002 | Custom data not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - const selfBundle = "com.example.actsgetallaaccounts"; + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAccountsByOwner(selfBundle).then((data) => { - console.log('getAccountsByOwner: ' + data); - }).catch((err) => { - console.log("getAccountsByOwner err: " + JSON.stringify(err)); - }); + appAccountManager.getCustomData("ZhangSan", "age").then((data) => { + console.log("getCustomData successfully, data: " + data); + }).catch((err) => { + console.log("getCustomData failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("getAccountsByOwner err: " + JSON.stringify(err)); + console.log("getCustomData exception: " + JSON.stringify(err)); } ``` -### getCredential9+ +### getCustomDataSync9+ -getCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void +getCustomDataSync(name: string, key: string): string; -获取此应用帐号的凭据（如数字密码、人脸和PIN码等）。使用callback异步回调。 +根据指定键名获取特定应用帐号的自定义数据。使用同步方式返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | --------------------------- | ---- | -------------- | -| name | string | 是 | 应用帐号名称。 | -| credentialType | string | 是 | 获取此应用帐号的凭据的类型。 | -| callback | AsyncCallback<string> | 是 | 回调函数。当获取此应用帐号的凭据成功时，err为undefined，data返回此应用帐号的凭据对象；否则为错误对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------- | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 自定义数据的键名。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | --------------------- | +| string | 自定义数据的取值。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or credentialType. | - | 12300003 | the account indicated by name dose not exist. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or key. | +| 12300003 | Account not found. | +| 12400002 | Custom data not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getCredential("ZhangSan", "credentialType001", (err, result) => { - console.log("getCredential err: " + JSON.stringify(err)); - console.log('getCredential result: ' + result); - }); + let value = appAccountManager.getCustomDataSync("ZhangSan", "age"); + console.info("getCustomDataSync successfully, vaue:" + value); } catch (err) { - console.log("getCredential err: " + JSON.stringify(err)); + console.error("getCustomDataSync failed, error: " + JSON.stringify(err)); } ``` -### getCredential9+ +### getAllAccounts9+ -getCredential(name: string, credentialType: string): Promise<string> +getAllAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void -获取此应用程序帐号的凭据。使用Promise异步回调。 +获取所有可访问的应用帐号信息。使用callback异步回调。 + +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------ | ---- | ---------- | -| name | string | 是 | 应用帐号名称。 | -| credentialType | string | 是 | 要获取的凭据的类型。 | - -**返回值：** - -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| Promise<string> | Promise对象。返回此应用程序帐号的凭据对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 回调函数。当查询成功时，err为null，data为获取到的应用帐号信息列表；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or credentialType. | - | 12300003 | the account indicated by name dose not exist. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getCredential("ZhangSan", "credentialType001").then((data) => { - console.log('getCredential, result: ' + data); - }).catch((err) => { - console.log("getCredential err: " + JSON.stringify(err)); - }); + appAccountManager.getAllAccounts((err, data) => { + if (err) { + console.debug("getAllAccounts failed, error:" + JSON.stringify(err)); + } else { + console.debug("getAllAccounts successfully"); + } + }); } catch (err) { - console.log("getCredential err: " + JSON.stringify(err)); + console.debug("getAllAccounts exception: " + JSON.stringify(err)); } ``` -### getCustomData9+ +### getAllAccounts9+ -getCustomData(name: string, key: string, callback: AsyncCallback<string>): void +getAllAccounts(): Promise<Array<AppAccountInfo>> -获取与此应用程序帐号关联的数据。使用callback异步回调。 +获取所有可访问的应用帐号信息。使用Promise异步回调。 + +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS。 **系统能力：** SystemCapability.Account.AppAccount -**参数：** +**返回值：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------- | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | -| callback | AsyncCallback<string> | 是 | 回调函数。当获取与此应用程序帐号关联的数据成功时，err为undefined，data返回与此应用程序帐号关联的数据对象；否则为错误对象。 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象，返回全部应用已授权帐号信息对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or key. | - | 12300003 | the account indicated by name dose not exist. | - | 12400009 | the customData does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getCustomData("ZhangSan", "k001", (err, result) => { - console.log("getCustomData err: " + JSON.stringify(err)); - console.log('getCustomData result: ' + result); - }); + appAccountManager.getAllAccounts().then((data) => { + console.debug("getAllAccounts successfully"); + }).catch((err) => { + console.debug("getAllAccounts failed, error:" + JSON.stringify(err)); + }); } catch (err) { - console.log("getCustomData err: " + JSON.stringify(err)); + console.debug("getAllAccounts exception: " + JSON.stringify(err)); } ``` -### getCustomData9+ +### getAccountsByOwner9+ -getCustomData(name: string, key: string): Promise<string> +getAccountsByOwner(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void -获取与此应用程序帐号关联的数据。使用Promise异步回调。 +根据应用帐号所有者获取调用方可访问的应用帐号列表。使用callback异步回调。 + +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | - -**返回值：** - -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| Promise<string> | Promise对象。返回与此应用程序帐号关联的数据对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| owner | string | 是 | 应用帐号所有者的包名。 | +| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 回调函数。如果获取成功，err为null，data为获取到的应用帐号列表；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or key. | - | 12300003 | the account indicated by name dose not exist. | - | 12400009 | the customData does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid owner. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getCustomData("ZhangSan", "k001").then((data) => { - console.log('getCustomData: ' + data); - }).catch((err) => { - console.log("getCustomData err: " + JSON.stringify(err)); - }); + appAccountManager.getAccountsByOwner("com.example.accountjsdemo2", (err, data) => { + if (err) { + console.debug("getAccountsByOwner failed, error:" + JSON.stringify(err)); + } else { + console.debug("getAccountsByOwner successfully, data:" + JSON.stringify(data)); + } + }); } catch (err) { - console.log("getCustomData err: " + JSON.stringify(err)); + console.debug("getAccountsByOwner exception:" + JSON.stringify(err)); } ``` -### getCustomDataSync9+ +### getAccountsByOwner9+ + +getAccountsByOwner(owner: string): Promise<Array<AppAccountInfo>> -getCustomDataSync(name: string, key: string): string; +根据应用帐号所有者获取调用方可访问的应用帐号列表。使用Promise异步回调。 -获取与此应用程序帐号关联的数据，使用同步方式返回结果。 +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ------ | +| owner | string | 是 | 应用帐号所有者的包名。 | **返回值：** -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| string | 目标关联数据的取值。 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象，返回获取到的应用帐号列表。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or key. | - | 12300003 | the account indicated by name dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid owner. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - var backData = appAccountManager.getCustomDataSync("ZhangSan", "k001"); - console.info("getCustomDataSync backData:" + JSON.stringify(backData)); + appAccountManager.getAccountsByOwner("com.example.accountjsdemo2").then((data) => { + console.debug("getAccountsByOwner successfully, data:" + JSON.stringify(data)); + }).catch((err) => { + console.debug("getAccountsByOwner failed, error:" + JSON.stringify(err)); + }); } catch (err) { - console.error(`getCustomDataSync err, code is ${e.code}, message is ${e.message}`); + console.debug("getAccountsByOwner exception:" + JSON.stringify(err)); } ``` @@ -1241,7 +1275,7 @@ getCustomDataSync(name: string, key: string): string; on(type: 'accountChange', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void -订阅指定帐号所有者的帐户变更事件。使用callback异步回调。 +订阅指定应用的帐号信息变更事件。 **系统能力：** SystemCapability.Account.AppAccount @@ -1249,31 +1283,30 @@ on(type: 'accountChange', owners: Array<string>, callback: Callback<Arr | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | -| type | 'accountChange' | 是 | 事件回调类型，支持的事件为'accountChange'，当帐号所有者更新帐号时，触发该事件。 | -| owners | Array<string> | 是 | 指示帐号的所有者。 | -| callback | Callback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 回调函数。返回指定帐号所有者更新的帐号信息对象数组。 | +| type | 'accountChange' | 是 | 事件回调类型，支持的事件为'accountChange'，当目标应用更新帐号信息时，触发该事件。 | +| owners | Array<string> | 是 | 应用帐号所有者的包名列表。 | +| callback | Callback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 回调函数，返回信息发生变更的应用帐号列表。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid type or owners. | - | 12300003 | the account indicated by owners dose not exist. | - | 12300005 | the listener has been registered. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid type or owners. | +| 12300011 | Callback has been registered. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); function changeOnCallback(data){ - console.debug("receive change data:" + JSON.stringify(data)); + console.log("receive change data:" + JSON.stringify(data)); } try{ - appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback); - } - catch(err){ - console.error("on accountOnOffDemo err:" + JSON.stringify(err)); + appAccountManager.on("accountChange", ["com.example.actsaccounttest"], changeOnCallback); + } catch(err) { + console.error("on accountChange failed, error:" + JSON.stringify(err)); } ``` @@ -1281,7 +1314,7 @@ on(type: 'accountChange', owners: Array<string>, callback: Callback<Arr off(type: 'accountChange', callback?: Callback>): void -取消订阅帐号事件。使用callback异步回调。 +取消订阅帐号信息变更事件。 **系统能力：** SystemCapability.Account.AppAccount @@ -1289,32 +1322,34 @@ off(type: 'accountChange', callback?: Callback>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------- | ---- | ------------ | -| type | 'accountChange' | 是 | 事件回调类型，支持的事件为'accountChange'，当帐号所有者更新帐号时，触发该事件。 | -| callback | Callback> | 否 | 回调函数，返回指定帐号所有者更新的帐号信息数组。 | +| type | 'accountChange' | 是 | 事件回调类型，支持的事件为'accountChange'，当帐号所有者更新帐号信息时，触发该事件。 | +| callback | Callback> | 否 | 回调函数，返回信息发生变更的应用帐号列表。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid type. | - | 12300005 | the listener has been registered. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid type. | +| 12300012 | Callback has not been registered. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); function changeOnCallback(data){ - console.debug("receive change data:" + JSON.stringify(data)); - appAccountManager.off('accountChange', function(){ - console.debug("off finish"); - }) + console.log("receive change data:" + JSON.stringify(data)); + } + try{ + appAccountManager.on("accountChange", ["com.example.actsaccounttest"], changeOnCallback); + } catch(err) { + console.error("on accountChange failed, error:" + JSON.stringify(err)); } try{ - appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback); + appAccountManager.off('accountChange', changeOnCallback); } catch(err){ - console.error("on accountOnOffDemo err:" + JSON.stringify(err)); + console.error("off accountChange failed, error:" + JSON.stringify(err)); } ``` @@ -1322,7 +1357,7 @@ off(type: 'accountChange', callback?: Callback>): void auth(name: string, owner: string, authType: string, callback: AuthCallback): void -对应用帐户进行鉴权以获取Auth令牌。使用callback异步回调。 +对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1330,48 +1365,47 @@ auth(name: string, owner: string, authType: string, callback: AuthCallback): voi | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | --------------- | -| name | string | 是 | 要鉴权的应用帐号名称。 | -| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | -| callback | [AuthCallback](#authcallback9) | 是 | 回调函数。返回鉴权结果对象。 | +| callback | [AuthCallback](#authcallback9) | 是 | 回调对象，返回鉴权结果。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner, authType or options. | - | 12300003 | the account indicated by owner dose not exist. | - | 12300016 | authentication timeout. | - | 12300017 | authentication service is busy. | - | 12300018 | authentication service is locked. | - | 12400001 | the application indicated by name does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner or authType. | +| 12300003 | Account not found. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; - function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); + function onResultCallback(code, authResult) { + console.log("resultCode: " + code); + console.log("authResult: " + JSON.stringify(authResult)); } function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); - }); + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err) => { + console.log("startAbility err: " + JSON.stringify(err)); + }); } - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback - }); + appAccountManager.auth("LiSi", "com.example.accountjsdemo", "getSocialData", { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback + }); } catch (err) { - console.log("auth err: " + JSON.stringify(err)); + console.log("auth exception: " + JSON.stringify(err)); } ``` @@ -1379,7 +1413,7 @@ auth(name: string, owner: string, authType: string, callback: AuthCallback): voi auth(name: string, owner: string, authType: string, options: {[key: string]: Object}, callback: AuthCallback): void -对应用帐户进行鉴权以获取OAuth令牌。使用callback异步回调。 +对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1387,49 +1421,51 @@ auth(name: string, owner: string, authType: string, options: {[key: string]: Obj | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | --------------- | -| name | string | 是 | 要鉴权的应用帐号名称。 | -| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | | options | {[key: string]: Object} | 是 | 鉴权所需的可选项。 | -| callback | [AuthCallback](#authcallback9) | 是 | 回调函数。返回鉴权结果对象。 | +| callback | [AuthCallback](#authcallback9) | 是 | 回调对象，返回鉴权结果。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner, authType or options. | - | 12300003 | the account indicated by owner dose not exist. | - | 12300016 | authentication timeout. | - | 12300017 | authentication service is busy. | - | 12300018 | authentication service is locked. | - | 12400001 | the application indicated by name does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner or authType. | +| 12300003 | Account not exist. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; - function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); + function onResultCallback(code, authResult) { + console.log("resultCode: " + code); + console.log("authResult: " + JSON.stringify(authResult)); } function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); - }); + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err) => { + console.log("startAbility err: " + JSON.stringify(err)); + }); } - const appAccountManager = account_appAccount.createAppAccountManager(); + let options = { + "password": "xxxx", + }; + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback - }); + appAccountManager.auth("LiSi", "com.example.accountjsdemo", "getSocialData", options, { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback + }); } catch (err) { - console.log("auth err: " + JSON.stringify(err)); + console.log("auth exception: " + JSON.stringify(err)); } ``` @@ -1437,7 +1473,7 @@ auth(name: string, owner: string, authType: string, options: {[key: string]: Obj getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void -获取指定应用帐号和鉴权类型的Auth令牌。使用callback异步回调。 +获取指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1446,31 +1482,33 @@ getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallb | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | -| callback | AsyncCallback<string> | 是 | 回调函数。当获取指定应用帐号和鉴权类型的Auth令牌成功时，err为undefined，data返回Auth令牌对象；否则为错误对象。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取成功时，err为null，data为授权令牌值；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner or authType. | - | 12300003 | the account indicated by owner dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12400001 | the application indicated by name does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name, owner or authType. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { - console.log('getAuthToken err: ' + JSON.stringify(err)); - console.log('getAuthToken token: ' + data); - }); + appAccountManager.getAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", (err, token) => { + if (err) { + console.log("getAuthToken failed, error: " + JSON.stringify(err)); + } else { + console.log("getAuthToken successfully, token: " + token); + } + }); } catch (err) { - console.log('getAuthToken err: ' + JSON.stringify(err)); + console.log("getAuthToken exception: " + JSON.stringify(err)); } ``` @@ -1478,7 +1516,7 @@ getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallb getAuthToken(name: string, owner: string, authType: string): Promise<string> -获取指定应用帐户和鉴权类型的Auth令牌。使用Promise异步回调。 +获取指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1487,37 +1525,36 @@ getAuthToken(name: string, owner: string, authType: string): Promise<string&g | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | **返回值：** -| 类型 | 说明 | +| 类型 | 说明 | | --------------------- | --------------------- | -| Promise<string> | Promise对象。返回指定应用帐户和鉴权类型的Auth令牌对象。 | +| Promise<string> | Promise对象，返回授权令牌。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner or authType. | - | 12300003 | the account indicated by owner dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12400001 | the application indicated by name does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner or authType. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData").then((data) => { - console.log('getAuthToken token: ' + data); - }).catch((err) => { - console.log("getAuthToken err: " + JSON.stringify(err)); - }); + appAccountManager.getAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData").then((token) => { + console.log("getAuthToken successfully, token: " + token); + }).catch((err) => { + console.log("getAuthToken failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("getAuthToken err: " + JSON.stringify(err)); + console.log("getAuthToken exception: " + JSON.stringify(err)); } ``` @@ -1525,7 +1562,7 @@ getAuthToken(name: string, owner: string, authType: string): Promise<string&g setAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void -设置指定应用帐号和鉴权类型的Auth令牌。使用callback异步回调。 +为指定应用帐号设置特定鉴权类型的授权令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1535,30 +1572,32 @@ setAuthToken(name: string, authType: string, token: string, callback: AsyncCallb | -------- | ------------------------- | ---- | -------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | -| token | string | 是 | Auth令牌。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定应用帐号和鉴权类型的Auth令牌成功时，err为undefined；否则为错误对象。 | +| token | string | 是 | 授权令牌。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置成功时，err为null；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner, authType or token. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | - | 12400007 | the number of token has reached the upper limit. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or authType or token. | +| 12300003 | Account not found. | +| 12400004 | The number of token reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => { - console.log('setAuthToken err: ' + JSON.stringify(err)); - }); + appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => { + if (err) { + console.log("setAuthToken failed, error: " + JSON.stringify(err)); + } else { + console.log("setAuthToken successfully"); + } + }); } catch (err) { - console.log('setAuthToken err: ' + JSON.stringify(err)); + console.log('setAuthToken exception: ' + JSON.stringify(err)); } ``` @@ -1566,7 +1605,7 @@ setAuthToken(name: string, authType: string, token: string, callback: AsyncCallb setAuthToken(name: string, authType: string, token: string): Promise<void> -设置指定应用帐户和鉴权类型的Auth令牌。使用Promise异步回调。 +为指定应用帐号设置特定鉴权类型的授权令牌。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1576,7 +1615,7 @@ setAuthToken(name: string, authType: string, token: string): Promise<void> | -------- | ------ | ---- | -------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | -| token | string | 是 | Auth令牌。 | +| token | string | 是 | 授权令牌。 | **返回值：** @@ -1586,27 +1625,25 @@ setAuthToken(name: string, authType: string, token: string): Promise<void> **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner, authType or token. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | - | 12400007 | the number of token has reached the upper limit. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or authType or token. | +| 12300003 | Account not found. | +| 12400004 | The number of token reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => { - console.log('setAuthToken successfully'); - }).catch((err) => { - console.log('setAuthToken err: ' + JSON.stringify(err)); - }); + appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => { + console.log("setAuthToken successfully"); + }).catch((err) => { + console.log("setAuthToken failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log('setAuthToken err: ' + JSON.stringify(err)); + console.log("setAuthToken exception: " + JSON.stringify(err)); } ``` @@ -1614,7 +1651,7 @@ setAuthToken(name: string, authType: string, token: string): Promise<void> deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void -删除指定应用帐户和鉴权类型的Auth令牌。使用callback异步回调。 +删除指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1623,31 +1660,34 @@ deleteAuthToken(name: string, owner: string, authType: string, token: string, ca | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------ | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | -| token | string | 是 | 要删除的Auth令牌。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当删除指定应用帐户和鉴权类型的Auth令牌成功时，err为undefined；否则为错误对象。 | +| token | string | 是 | 授权令牌。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当删除成功时，err为null；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner, authType or token. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner or authType or token. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => { - console.log('deleteAuthToken err: ' + JSON.stringify(err)); + appAccountManager.deleteAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx", (err) => { + if (err) { + console.log('deleteAuthToken failed, error: ' + JSON.stringify(err)); + } else { + console.log("deleteAuthToken successfully"); + } }); } catch (err) { - console.log('deleteAuthToken err: ' + JSON.stringify(err)); + console.log('deleteAuthToken exception: ' + JSON.stringify(err)); } ``` @@ -1655,7 +1695,7 @@ deleteAuthToken(name: string, owner: string, authType: string, token: string, ca deleteAuthToken(name: string, owner: string, authType: string, token: string): Promise<void> -删除指定应用帐户和鉴权类型的Auth令牌。使用Promise异步回调。 +删除指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1664,9 +1704,9 @@ deleteAuthToken(name: string, owner: string, authType: string, token: string): P | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------ | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | -| token | string | 是 | 要删除的Auth令牌。 | +| token | string | 是 | 授权令牌。 | **返回值：** @@ -1676,26 +1716,25 @@ deleteAuthToken(name: string, owner: string, authType: string, token: string): P **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner, authType or token. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner or authType or token. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx").then(() => { - console.log('deleteAuthToken successfully'); - }).catch((err) => { - console.log("deleteAuthToken err: " + JSON.stringify(err)); - }); + appAccountManager.deleteAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx").then(() => { + console.log("deleteAuthToken successfully"); + }).catch((err) => { + console.log('deleteAuthToken failed, error: ' + JSON.stringify(err)); + }); } catch (err) { - console.log("deleteAuthToken err: " + JSON.stringify(err)); + console.log('deleteAuthToken exception: ' + JSON.stringify(err)); } ``` @@ -1703,7 +1742,7 @@ deleteAuthToken(name: string, owner: string, authType: string, token: string): P setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void -设置指定鉴权类型的Auth令牌对特定应用的可见性。使用callback异步回调。 +设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1714,29 +1753,34 @@ setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVis | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 被设置可见性的应用包名。 | -| isVisible | boolean | 是 | 是否可见。当设置成true可见，false不可见。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定鉴权类型的Auth令牌对特定应用的可见性成功时，err为undefined；否则为错误对象。 | +| isVisible | boolean | 是 | 是否可见。true表示可见，false表示不可见。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置成功时，err为null；否则为错误对象。| **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, authType or bundleName. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or authType or bundleName. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | +| 12400001 | Application not found. | +| 12400005 | The size of authorization list reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => { - console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); + appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true, (err) => { + if (err) { + console.log("setAuthTokenVisibility failed, error: " + JSON.stringify(err)); + } else { + console.log("setAuthTokenVisibility successfully"); + } }); } catch (err) { - console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); + console.log("setAuthTokenVisibility exception: " + JSON.stringify(err)); } ``` @@ -1744,18 +1788,18 @@ setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVis setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void> -设置指定鉴权类型的OAuth令牌对特定应用的可见性。使用Promise异步回调。 +设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------- | ---- | ------------ | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 被设置可见性的应用包名。 | -| isVisible | boolean | 是 | 是否可见。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------- | ---- | ------------------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 被设置可见性的应用包名。 | +| isVisible | boolean | 是 | 是否可见。true表示可见，false表示不可见。 | **返回值：** @@ -1765,26 +1809,27 @@ setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVis **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, authType or bundleName. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or authType or bundleName. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | +| 12400001 | Application not found. | +| 12400005 | The size of authorization list reaches the upper limit. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { - console.log('setAuthTokenVisibility successfully'); - }).catch((err) => { - console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); - }); + appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true).then(() => { + console.log("setAuthTokenVisibility successfully"); + }).catch((err) => { + console.log("setAuthTokenVisibility failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); + console.log("setAuthTokenVisibility exception: " + JSON.stringify(err)); } ``` @@ -1792,7 +1837,7 @@ setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVis checkAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void -检查指定鉴权类型的Auth令牌对特定应用的可见性。使用callback异步回调。 +检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1803,29 +1848,32 @@ checkAuthTokenVisibility(name: string, authType: string, bundleName: string, cal | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 检查可见性的应用包名。 | -| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查指定鉴权类型的Auth令牌对特定应用的可见性时，err为undefined，data为true表示可见，data为false表示不可见；否则为错误对象。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查成功时，err为null，data为true表示可见，data为false表示不可见；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, authType or bundleName. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or authType or bundleName. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", (err, data) => { - console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); - console.log('checkAuthTokenVisibility isVisible: ' + data); - }); + appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", (err, isVisible) => { + if (err) { + console.log("checkAuthTokenVisibility failed, error: " + JSON.stringify(err)); + } else { + console.log("checkAuthTokenVisibility successfully, isVisible: " + isVisible); + } + }); } catch (err) { - console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); + console.log("checkAuthTokenVisibility exception: " + JSON.stringify(err)); } ``` @@ -1833,7 +1881,7 @@ checkAuthTokenVisibility(name: string, authType: string, bundleName: string, cal checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean> -检查指定鉴权类型的Auth令牌对特定应用的可见性。使用Promise异步回调。 +检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1849,38 +1897,38 @@ checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Pr | 类型 | 说明 | | ---------------------- | --------------------- | -| Promise<boolean> | Promise对象。返回true表示指定鉴权类型的Auth令牌对特定应用的可见，返回false表示不可见。 | +| Promise<boolean> | Promise对象，返回true表示授权令牌对指定应用的可见，返回false表示不可见。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, authType or bundleName. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or authType or bundleName. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | +| 12400001 | Application not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo").then((data) => { - console.log('checkAuthTokenVisibility isVisible: ' + data); - }).catch((err) => { - console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); - }); + appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo").then((isVisible) => { + console.log("checkAuthTokenVisibility successfully, isVisible: " + isVisible); + }).catch((err) => { + console.log("checkAuthTokenVisibility failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); + console.log("checkAuthTokenVisibility exception: " + JSON.stringify(err)); } ``` ### getAllAuthTokens9+ -getAllAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void +getAllAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<AuthTokenInfo>>): void -获取指定应用对调用方全部可见的Auth令牌。使用callback异步回调。 +获取指定帐号对调用方可见的所有授权令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1889,29 +1937,31 @@ getAllAuthTokens(name: string, owner: string, callback: AsyncCallback<Array&l | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| callback | AsyncCallback<Array< [AuthTokenInfo](#authtokeninfo9)>> | 是 | 回调函数。当获取指定应用对调 -用方全部可见的Auth令牌成功时，err为undefined，data为全部可见的Auth令牌数组；否则为错误对象。 | +| owner | string | 是 | 应用帐号所有者的包名。 | +| callback | AsyncCallback<Array<[AuthTokenInfo](#authtokeninfo9)>> | 是 | 回调函数。当获取成功时，err为null，data为授权令牌数组；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or owner. | - | 12300003 | the account indicated by name dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo", (err, data) => { - console.log("getAllAuthTokens err: " + JSON.stringify(err)); - console.log('getAllAuthTokens data: ' + JSON.stringify(data)); - }); + appAccountManager.getAllAuthTokens("LiSi", "com.example.accountjsdemo", (err, tokenArr) => { + if (err) { + console.log("getAllAuthTokens failed, error: " + JSON.stringify(err)); + } else { + console.log('getAllAuthTokens successfully, tokenArr: ' + tokenArr); + } + }); } catch (err) { - console.log("getAllAuthTokens err: " + JSON.stringify(err)); + console.log("getAllAuthTokens exception: " + JSON.stringify(err)); } ``` @@ -1919,7 +1969,7 @@ getAllAuthTokens(name: string, owner: string, callback: AsyncCallback<Array&l getAllAuthTokens(name: string, owner: string): Promise<Array<AuthTokenInfo>> -获取指定应用帐户对调用方可见的全部Auth令牌。使用Promise异步回调。 +获取指定帐号对调用方可见的所有授权令牌。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1928,34 +1978,34 @@ getAllAuthTokens(name: string, owner: string): Promise<Array<AuthTokenInfo | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | **返回值：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | -| Promise<Array< [AuthTokenInfo](#authtokeninfo9)>> | Promise对象。返回指定应用帐户对调用方可见的全部Auth令牌对象。 | +| Promise<Array<[AuthTokenInfo](#authtokeninfo9)>> | Promise对象，返回授权令牌数组。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or owner. | - | 12300003 | the account indicated by name dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner. | +| 12300003 | Account not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => { - console.log('getAllAuthTokens data: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("getAllAuthTokens err: " + JSON.stringify(err)); - }); + appAccountManager.getAllAuthTokens("LiSi", "com.example.accountjsdemo").then((tokenArr) => { + console.log('getAllAuthTokens successfully, tokenArr: ' + JSON.stringify(tokenArr)); + }).catch((err) => { + console.log("getAllAuthTokens failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("getAllAuthTokens err: " + JSON.stringify(err)); + console.log("getAllAuthTokens exception: " + JSON.stringify(err)); } ``` @@ -1963,7 +2013,7 @@ getAllAuthTokens(name: string, owner: string): Promise<Array<AuthTokenInfo getAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void -获取指定应用帐户和鉴权类型的Auth令牌的授权列表。使用callback异步回调。 +获取指定应用帐号的特定鉴权类型的授权列表，即被授权的包名数组（令牌的授权列表通过[setAuthTokenVisibility](#setauthtokenvisibility9)来设置）。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -1972,30 +2022,32 @@ getAuthList(name: string, authType: string, callback: AsyncCallback<Array< | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------------------- | | name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 | -| callback | AsyncCallback<Array<string>> | 是 | 回调函数。当获取指定应用帐户和鉴权类型的Auth令牌的授权列表成功时，err为undefined，data为Auth令牌的授权列表；否则为错误对象。 | +| authType | string | 是 | 鉴权类型。 | +| callback | AsyncCallback<Array<string>> | 是 | 回调函数。当获取成功时，err为null，data为被授权的包名数组；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or authType. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or authType. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { - console.log('getAuthList err: ' + JSON.stringify(err)); - console.log('getAuthList data: ' + JSON.stringify(data)); - }); + appAccountManager.getAuthList("com.example.accountjsdemo", "getSocialData", (err, authList) => { + if (err) { + console.log("getAuthList failed, error: " + JSON.stringify(err)); + } else { + console.log("getAuthList successfully, authList: " + authList); + } + }); } catch (err) { - console.log('getAuthList err: ' + JSON.stringify(err)); + console.log('getAuthList exception: ' + JSON.stringify(err)); } ``` @@ -2003,45 +2055,44 @@ getAuthList(name: string, authType: string, callback: AsyncCallback<Array< getAuthList(name: string, authType: string): Promise<Array<string>> -获取指定应用帐户和鉴权类型的Auth令牌的授权列表。使用Promise异步回调。 +获取指定应用帐号的特定鉴权类型的授权列表，即被授权的包名数组（令牌的授权列表通过[setAuthTokenVisibility](#setauthtokenvisibility9)来设置）。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ----------------------- | +| -------- | ------ | ---- | ------------------------------ | | name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 | +| authType | string | 是 | 鉴权类型。 | **返回值：** | 类型 | 说明 | | ---------------------------------- | --------------------- | -| Promise<Array<string>> | Promise对象。返回指定应用帐户和鉴权类型的Auth令牌的授权列表对象。 | +| Promise<Array<string>> | Promise对象，返回被授权的包名数组。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or authType. | - | 12300003 | the account indicated by name dose not exist. | - | 12300015 | the authType is not supported on current device. | - | 12300019 | credential does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or authType. | +| 12300003 | Account not found. | +| 12300107 | AuthType not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => { - console.log('getAuthList data: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("getAuthList err: " + JSON.stringify(err)); - }); + appAccountManager.getAuthList("com.example.accountjsdemo", "getSocialData").then((authList) => { + console.log("getAuthList successfully, authList: " + authList); + }).catch((err) => { + console.log("getAuthList failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("getAuthList err: " + JSON.stringify(err)); + console.log("getAuthList exception: " + JSON.stringify(err)); } ``` @@ -2049,7 +2100,7 @@ getAuthList(name: string, authType: string): Promise<Array<string>> getAuthCallback(sessionId: string, callback: AsyncCallback<AuthCallback>): void -获取鉴权会话的认证器回调。使用callback异步回调。 +获取鉴权会话的认证器回调对象。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -2058,37 +2109,44 @@ getAuthCallback(sessionId: string, callback: AsyncCallback<AuthCallback>): | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------- | | sessionId | string | 是 | 鉴权会话的标识。 | -| callback | AsyncCallback<[AuthCallback](#authcallback9)> | 是 | 回调函数。当获取鉴权会话的认证器回调函数成功时，err为undefined，data为认证器回调函数；否则为错误对象。 | +| callback | AsyncCallback<[AuthCallback](#authcallback9)> | 是 | 回调函数。当获取成功时，err为null，data为鉴权会话的认证器回调对象；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12400005 | the session indicated by sessionId does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid sessionId. | +| 12300108 | Session not found. | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); featureAbility.getWant((err, want) => { - var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; - try { - appAccountManager.getAuthCallback(sessionId, (err, callback) => { - if (err.code != account_appAccount.ResultCode.SUCCESS) { - console.log("getAuthCallback err: " + JSON.stringify(err)); - return; - } - var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", - [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", - [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", - [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.onResult(account_appAccount.ResultCode.SUCCESS, result); - }); - } catch (err) { - console.log("getAuthCallback err: " + JSON.stringify(err)); - } + var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; + try { + appAccountManager.getAuthCallback(sessionId, (err, callback) => { + if (err.code != account_appAccount.ResultCode.SUCCESS) { + console.log("getAuthCallback err: " + JSON.stringify(err)); + return; + } + var result = { + accountInfo: { + name: "Lisi", + owner: "com.example.accountjsdemo", + }, + tokenInfo: { + token: "xxxxxx", + authType: "getSocialData" + } + }; + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); + }); + } catch (err) { + console.log("getAuthCallback exception: " + JSON.stringify(err)); + } }); ``` @@ -2096,7 +2154,7 @@ getAuthCallback(sessionId: string, callback: AsyncCallback<AuthCallback>): getAuthCallback(sessionId: string): Promise<AuthCallback> -获取鉴权会话的认证器回调。使用Promise异步回调。 +获取鉴权会话的认证器回调对象。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -2110,33 +2168,42 @@ getAuthCallback(sessionId: string): Promise<AuthCallback> | 类型 | 说明 | | ------------------------------------ | --------------------- | -| Promise<[AuthCallback](#authcallback9)> | Promise对象。返回鉴权会话的认证器回调对象。 | +| Promise<[AuthCallback](#authcallback9)> | Promise对象，返回鉴权会话的认证器回调对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12400005 | the session indicated by sessionId does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid sessionId. | +| 12300108 | Session not found. | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); featureAbility.getWant().then((want) => { var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; try { - appAccountManager.getAuthCallback(sessionId).then((callback) => { - var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", - [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", - [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", - [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.onResult(account_appAccount.ResultCode.SUCCESS, result); - }).catch((err) => { - console.log("getAuthCallback err: " + JSON.stringify(err)); - }); + appAccountManager.getAuthCallback(sessionId).then((callback) => { + var result = { + accountInfo: { + name: "Lisi", + owner: "com.example.accountjsdemo", + }, + tokenInfo: { + token: "xxxxxx", + authType: "getSocialData" + } + }; + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); + }).catch((err) => { + console.log("getAuthCallback err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("getAuthCallback exception: " + JSON.stringify(err)); } }).catch((err) => { console.log("getWant err: " + JSON.stringify(err)); @@ -2147,7 +2214,7 @@ getAuthCallback(sessionId: string): Promise<AuthCallback> queryAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void -获取指定应用帐号的认证器信息。使用callback异步回调。 +获取指定应用的认证器信息。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -2155,28 +2222,31 @@ queryAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorIn | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | -| callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 回调函数。当获取指定应用帐号的认证器信息成功时，err为undefined，data为认证器信息对象；否则为错误对象。 | +| owner | string | 是 | 应用包名。 | +| callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 回调函数。当获取成功时，err为null，data为认证器信息对象；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid owner. | - | 12300003 | the account indicated by owner dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid owner. | +| 12300113 | Authenticator service not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.queryAuthenticatorInfo("com.example.ohos.accountjsdemo", (err, data) => { - console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); - console.log('queryAuthenticatorInfo data: ' + JSON.stringify(data)); - }); + appAccountManager.queryAuthenticatorInfo("com.example.accountjsdemo", (err, info) => { + if (err) { + console.log("queryAuthenticatorInfo failed, error: " + JSON.stringify(err)); + } else { + console.log('queryAuthenticatorInfo successfully, info: ' + JSON.stringify(info)); + } + }); } catch (err) { - console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); + console.log("queryAuthenticatorInfo exception: " + JSON.stringify(err)); } ``` @@ -2184,7 +2254,7 @@ queryAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorIn queryAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> -获取指定应用帐户的认证器信息。使用Promise异步回调。 +获取指定应用的认证器信息。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -2192,34 +2262,34 @@ queryAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用包名。 | **返回值：** | 类型 | 说明 | | -------------------------------- | --------------------- | -| Promise<[AuthenticatorInfo](#authenticatorinfo8)> | Promise对象。返回指定应用帐户的认证器信息对象。 | +| Promise<[AuthenticatorInfo](#authenticatorinfo8)> | Promise对象，返回指定应用的认证器信息对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid owner. | - | 12300003 | the account indicated by owner dose not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid owner. | +| 12300113 | Authenticator service not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.queryAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => { - console.log('queryAuthenticatorInfo: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); - }); + appAccountManager.queryAuthenticatorInfo("com.example.accountjsdemo").then((info) => { + console.log("queryAuthenticatorInfo successfully, info: " + JSON.stringify(info)); + }).catch((err) => { + console.log("queryAuthenticatorInfo failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); + console.log("queryAuthenticatorInfo exception: " + JSON.stringify(err)); } ``` @@ -2227,7 +2297,7 @@ queryAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> checkAccountLabels(name: string, owner: string, labels: Array<string>, callback: AsyncCallback<boolean>): void; -检查指定帐户是否具有特定的标签集合。使用callback异步回调。 +检查指定应用帐号是否满足特定的标签集合。使用callback异步回调。该方法依赖目标应用的认证器提供标签检查的能力。 **系统能力：** SystemCapability.Account.AppAccount @@ -2235,32 +2305,37 @@ checkAccountLabels(name: string, owner: string, labels: Array<string>, cal | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ----- | --------------- | -| name | string | 是 | 应用帐户的名称。 | -| owner | string | 是 | 应用帐户的所有者。| +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者。| | labels | Array<string> | 是 | 标签数组。 | -| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查指定帐户是否具有特定的标签集合成功时，err为undefined，data为true表示具有特定标签，data为false表示不具有特定标签；否则为错误对象。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查成功时，err为null，data为true表示满足特定的标签集合，data为false表示不满足；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or owner. | - | 12300003 | the account indicated by owner dose not exist. | - | 12400001 | the application indicated by name does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner or labels. | +| 12300003 | Account not found. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - var labels = ["student"]; + let appAccountManager = account_appAccount.createAppAccountManager(); + let labels = ["student"]; try { - appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", labels, (err, data) => { - console.log('checkAccountLabels: ' + JSON.stringify(data)); - console.log("checkAccountLabels err: " + JSON.stringify(err)); - }); + appAccountManager.checkAccountLabels("zhangsan", "com.example.accountjsdemo", labels, (err, hasAllLabels) => { + if (err) { + console.log("checkAccountLabels failed, error: " + JSON.stringify(err)); + } else { + console.log("checkAccountLabels successfully, hasAllLabels: " + hasAllLabels); + } + }); } catch (err) { - console.log("checkAccountLabels err: " + JSON.stringify(err)); + console.log("checkAccountLabels exception: " + JSON.stringify(err)); } ``` @@ -2268,7 +2343,7 @@ checkAccountLabels(name: string, owner: string, labels: Array<string>, cal checkAccountLabels(name: string, owner: string, labels: Array<string>): Promise<boolean> -检查指定帐户是否具有特定的标签集合。使用Promise异步回调。 +检查指定应用帐号是否满足特定的标签集合。使用Promise异步回调。该方法依赖目标应用的认证器提供标签检查的能力。 **系统能力：** SystemCapability.Account.AppAccount @@ -2276,38 +2351,40 @@ checkAccountLabels(name: string, owner: string, labels: Array<string>): Pr | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ----- | --------------- | -| name | string | 是 | 应用帐户的名称。 | -| owner | string | 是 | 应用帐户的所有者。| +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者。| | labels | Array<string> | 是 | 标签数组。 | **返回值：** | 类型 | 说明 | | ------------------- | -------------------------------- | -| Promise<boolean> | Promise对象。返回true表示指定帐户具有特定的标签集合，返回false表示不具有特性的标签集合。 | +| Promise<boolean> | Promise对象，返回true表示指定帐号满足特定的标签集合，返回false表示不满足。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or owner. | - | 12300003 | the account indicated by owner dose not exist. | - | 12400001 | the application indicated by name does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner or labels. | +| 12300003 | Account not found. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - var labels = ["student"]; + let appAccountManager = account_appAccount.createAppAccountManager(); + let labels = ["student"]; try { - appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", labels).then((data) => { - console.log('checkAccountLabels: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("checkAccountLabels err: " + JSON.stringify(err)); - }); + appAccountManager.checkAccountLabels("zhangsan", "com.example.accountjsdemo", labels).then((hasAllLabels) => { + console.log('checkAccountLabels successfully: ' + hasAllLabels); + }).catch((err) => { + console.log("checkAccountLabels failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("checkAccountLabels err: " + JSON.stringify(err)); + console.log("checkAccountLabels exception: " + JSON.stringify(err)); } ``` @@ -2315,7 +2392,7 @@ checkAccountLabels(name: string, owner: string, labels: Array<string>): Pr deleteCredential(name: string, credentialType: string, callback: AsyncCallback<void>): void -删除指定应用帐户的指定类型的凭据信息。使用callback异步回调。 +删除指定应用帐号的特定类型的凭据信息。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -2323,30 +2400,33 @@ deleteCredential(name: string, credentialType: string, callback: AsyncCallback&l | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ----- | -------------- | -| name | string | 是 | 应用帐户的名称。 | +| name | string | 是 | 应用帐号的名称。 | | credentialType | string | 是 | 凭据类型。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当删除指定应用帐户的指定类型的凭据信息成功时，err为undefined；否则为错误对象。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当删除成功时，err为null；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or credentialType. | - | 12300019 | credential does not exist. | - | 12400001 | the application indicated by name does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or credentialType. | +| 12300003 | Account not found. | +| 12300102 | Credential not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.deleteCredential("zhangsan", "pin", (err, data) => { - console.log('deleteCredential: ' + JSON.stringify(data)); - console.log("deleteCredential err: " + JSON.stringify(err)); - }); + appAccountManager.deleteCredential("zhangsan", "PIN_SIX", (err) => { + if (err) { + console.log("deleteCredential failed, error: " + JSON.stringify(err)); + } else { + console.log("deleteCredential successfully"); + } + }); } catch (err) { - console.log("deleteCredential err: " + JSON.stringify(err)); + console.log("deleteCredential exception: " + JSON.stringify(err)); } ``` @@ -2354,7 +2434,7 @@ deleteCredential(name: string, credentialType: string, callback: AsyncCallback&l deleteCredential(name: string, credentialType: string): Promise<void> -删除指定应用帐户的指定类型的凭据信息。使用Promise异步回调。 +删除指定应用帐号的特定类型的凭据信息。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -2362,7 +2442,7 @@ deleteCredential(name: string, credentialType: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ----- | --------------- | -| name | string | 是 | 应用帐户的名称。 | +| name | string | 是 | 应用帐号的名称。 | | credentialType | string | 是 | 凭据类型。 | **返回值：** @@ -2373,33 +2453,33 @@ deleteCredential(name: string, credentialType: string): Promise<void> **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name or credentialType. | - | 12300019 | credential does not exist. | - | 12400001 | the application indicated by name does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid name or credentialType. | +| 12300003 | Account not found. | +| 12300102 | Credential not found. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.deleteCredential("zhangsan", "pin").then((data) => { - console.log('deleteCredential: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("deleteCredential err: " + JSON.stringify(err)); - }); + appAccountManager.deleteCredential("zhangsan", "PIN_SIX").then(() => { + console.log("deleteCredential successfully"); + }).catch((err) => { + console.log("deleteCredential failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("deleteCredential err: " + JSON.stringify(err)); + console.log("deleteCredential exception: " + JSON.stringify(err)); } ``` ### selectAccountsByOptions9+ -selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback<Array<AppAccountInfo>>); +selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback<Array<AppAccountInfo>>): void -根据选项选择请求方可访问的帐号列表。使用callback异步回调。 +根据选项选择调用方可访问的帐号列表。使用callback异步回调。如果选项中包含标签约束，则该方法依赖目标应用的认证器提供标签检查的能力。 **系统能力：** SystemCapability.Account.AppAccount @@ -2407,30 +2487,36 @@ selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback& | 参数名 | 类型 | 必填 | 说明 | | -------------- | ----------------------------------- | ----- | --------------- | -| options | SelectAccountsOptions | 是 | 选择帐户的选项。 | -| callback | AsyncCallback<[AppAccountInfo](#appaccountinfo)> | 是 | 回调函数。当根据选项选择请求方可访问的帐号列表时，err为undefined，data为可访问的帐号信息对象；否则为错误对象。 | +| options | SelectAccountsOptions | 是 | 选择帐号的选项。 | +| callback | AsyncCallback<[AppAccountInfo](#appaccountinfo)> | 是 | 回调函数。当根据选项选择请求方可访问的帐号列表时，err为null，data为可访问的帐号信息对象；否则为错误对象。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid options. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid options. | +| 12300010 | Account service busy. | +| 12300114 | Authenticator service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - var options = { - allowedOwners: ["com.example.ohos.accountjsdemo"] + let appAccountManager = account_appAccount.createAppAccountManager(); + let options = { + allowedOwners: [ "com.example.accountjsdemo" ], + requiredLabels: [ "student" ] }; try { - appAccountManager.selectAccountsByOptions(options, (err, data) => { - console.log('selectAccountsByOptions: ' + JSON.stringify(data)); - console.log("selectAccountsByOptions err: " + JSON.stringify(err)); - }); + appAccountManager.selectAccountsByOptions(options, (err, accountArr) => { + if (err) { + console.log("selectAccountsByOptions failed, error: " + JSON.stringify(err)); + } else { + console.log("selectAccountsByOptions successfully, accountArr: " + JSON.stringify(accountArr)); + } + }); } catch (err) { - console.log("selectAccountsByOptions err: " + JSON.stringify(err)); + console.log("selectAccountsByOptions exception: " + JSON.stringify(err)); } ``` @@ -2438,7 +2524,7 @@ selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback& selectAccountsByOptions(options: SelectAccountsOptions): Promise<Array<AppAccountInfo>> -根据选项选择请求方可访问的帐户列表。使用Promise异步回调。 +根据选项选择调用方可访问的帐号列表。使用Promise异步回调。如果选项中包含标签约束，则该方法依赖目标应用的认证器提供标签检查的能力。 **系统能力：** SystemCapability.Account.AppAccount @@ -2446,44 +2532,46 @@ selectAccountsByOptions(options: SelectAccountsOptions): Promise<Array<App | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ----- | --------------- | -| options | [SelectAccountsOptions](#selectaccountsoptions9) | 是 | 选择帐户的选项。 | +| options | [SelectAccountsOptions](#selectaccountsoptions9) | 是 | 选择帐号的选项。 | **返回值：** | 类型 | 说明 | | ------------------- | -------------------------------- | -| Promise<[AppAccountInfo](#appaccountinfo)> | Promise对象。返回请求方可访问的帐户对象。 | +| Promise<[AppAccountInfo](#appaccountinfo)> | Promise对象，返回调用方可访问的帐号列表。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid options. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid options. | +| 12300010 | Account service busy. | +| 12300114 | Authenticator service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - var options = { - allowedOwners: ["com.example.ohos.accountjsdemo"] + let appAccountManager = account_appAccount.createAppAccountManager(); + let options = { + allowedOwners: ["com.example.accountjsdemo"] }; try { - appAccountManager.selectAccountsByOptions(options).then((data) => { - console.log('selectAccountsByOptions: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("selectAccountsByOptions err: " + JSON.stringify(err)); - }); + appAccountManager.selectAccountsByOptions(options).then((accountArr) => { + console.log("selectAccountsByOptions successfully, accountArr: " + JSON.stringify(accountArr)); + }).catch((err) => { + console.log("selectAccountsByOptions failed, error: " + JSON.stringify(err)); + }); } catch (err) { - console.log("selectAccountsByOptions err: " + JSON.stringify(err)); + console.log("selectAccountsByOptions exception: " + JSON.stringify(err)); } ``` ### verifyCredential9+ -verifyCredential(name: string, owner: string, callback: AuthenticatorCallback): void; +verifyCredential(name: string, owner: string, callback: AuthCallback): void; -验证用户凭据。使用callback异步回调。 +验证指定帐号的凭据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -2491,26 +2579,27 @@ verifyCredential(name: string, owner: string, callback: AuthenticatorCallback): | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ----- | ----------------------- | -| name | string | 是 | 应用帐户的名称。 | -| owner | string | 是 | 应用帐户的所有者。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 回调函数。返回认证结果回调函数。 | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号所有者的包名。 | +| callback | [AuthCallback](#authcallback9) | 是 | 回调函数，返回验证结果。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner or options. | - | 12300003 | the account indicated by owner dose not exist. | - | 12400001 | the application indicated by name does not exist. | - | 12400002 | the account authenticator service does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner. | +| 12300003 | Account not found. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", { + appAccountManager.verifyCredential("zhangsan", "com.example.accountjsdemo", { onResult: (resultCode, result) => { console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode)); console.log("verifyCredential onResult, result:" + JSON.stringify(result)); @@ -2526,7 +2615,7 @@ verifyCredential(name: string, owner: string, callback: AuthenticatorCallback): ### verifyCredential9+ -verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback): void; +verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, callback: AuthCallback): void; 验证用户凭据。使用callback异步回调。 @@ -2536,39 +2625,40 @@ verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ----- | ----------------------- | -| name | string | 是 | 应用帐户的名称。 | -| owner | string | 是 | 应用帐户的所有者。 | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的选项。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 回调函数。返回认证结果回调函数。 | +| callback | [AuthCallback](#authcallback9) | 是 | 回调函数，返回验证结果。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid name, owner or options. | - | 12300003 | the account indicated by owner dose not exist. | - | 12400001 | the application indicated by name does not exist. | - | 12400002 | the account authenticator service does not exist. | +| 错误码ID | 错误信息| +| ------- | -------| +| 12300001 | System service exception. | +| 12300002 | Invalid name or owner or options. | +| 12300003 | Account not found. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - var options = { + let appAccountManager = account_appAccount.createAppAccountManager(); + let options = { credentialType: "pin", credential: "123456" }; try { - appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", options, { - onResult: (resultCode, result) => { - console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode)); - console.log("verifyCredential onResult, result:" + JSON.stringify(result)); - }, - onRequestRedirected: (request) => { - console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request)); - } - }); + appAccountManager.verifyCredential("zhangsan", "com.example.accountjsdemo", options, { + onResult: (resultCode, result) => { + console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode)); + console.log("verifyCredential onResult, result:" + JSON.stringify(result)); + }, + onRequestRedirected: (request) => { + console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request)); + } + }); } catch (err) { console.log("verifyCredential err: " + JSON.stringify(err)); } @@ -2578,7 +2668,7 @@ verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, setAuthenticatorProperties(owner: string, callback: AuthCallback): void; -设置认证器属性。使用callback异步回调。 +设置指定应用的认证器属性。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -2587,33 +2677,34 @@ setAuthenticatorProperties(owner: string, callback: AuthCallback): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ----- | ----------------------- | | owner | string | 是 | 认证器的所有者。 | -| callback | [AuthCallback](#authcallback9) | 是 | 回调函数。返回设置属性结果回调函数。 | +| callback | [AuthCallback](#authcallback9) | 是 | 回调函数，返回设置属性的结果。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid owner or options. | - | 12300003 | the account indicated by owner dose not exist. | - | 12400002 | the account authenticator service does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid owner. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setAuthenticatorProperties("com.example.ohos.accountjsdemo", { - onResult: (resultCode, result) => { - console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode)); - console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(result)); - }, - onRequestRedirected: (request) => { - console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request)); - } - }); + appAccountManager.setAuthenticatorProperties("com.example.accountjsdemo", { + onResult: (resultCode, result) => { + console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode)); + console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(result)); + }, + onRequestRedirected: (request) => { + console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request)); + } + }); } catch (err) { - console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); + console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); } ``` @@ -2631,36 +2722,37 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac | -------- | --------------------- | ----- | ----------------------- | | owner | string | 是 | 认证器的所有者。 | | options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的选项。 | -| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置属性结果回调函数。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置属性的结果。 | **错误码：** - | 错误码ID | 错误信息| - | ------- | -------| - | 12300001 | system service exception. | - | 12300002 | invalid owner or options. | - | 12300003 | the account indicated by owner dose not exist. | - | 12400002 | the account authenticator service does not exist. | +| 错误码ID | 错误信息 | +| ------- | ------- | +| 12300001 | System service exception. | +| 12300002 | Invalid owner or options. | +| 12300010 | Account service busy. | +| 12300113 | Authenticator service not found. | +| 12300114 | Authenticator service exception. | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - var options = { + let appAccountManager = account_appAccount.createAppAccountManager(); + let options = { properties: {"prop1": "value1"} }; try { - appAccountManager.setAuthenticatorProperties("com.example.ohos.accountjsdemo", options, { - onResult: (resultCode, result) => { - console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode)); - console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(result)); - }, - onRequestRedirected: (request) => { - console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request)); - } - }); + appAccountManager.setAuthenticatorProperties("com.example.accountjsdemo", options, { + onResult: (resultCode, result) => { + console.log("setAuthenticatorProperties onResult, resultCode:" + JSON.stringify(resultCode)); + console.log("setAuthenticatorProperties onResult, result:" + JSON.stringify(result)); + }, + onRequestRedirected: (request) => { + console.log("setAuthenticatorProperties onRequestRedirected, request:" + JSON.stringify(request)); + } + }); } catch (err) { - console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); + console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); } ``` @@ -2669,7 +2761,7 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac addAccount(name: string, callback: AsyncCallback<void>): void -将此应用的帐号名添加到帐号管理服务中。使用callback异步回调。 +根据帐号名添加应用帐号。使用callback异步回调。 > **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9)替代 @@ -2682,13 +2774,13 @@ addAccount(name: string, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | -------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当此应用的帐号名添加到帐号管理服务成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当创建成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.addAccount("WangWu", (err) => { console.log("addAccount err: " + JSON.stringify(err)); }); @@ -2698,7 +2790,7 @@ addAccount(name: string, callback: AsyncCallback<void>): void addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void -将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中。使用callback异步回调。 +根据帐号名和额外信息添加应用帐号。使用callback异步回调。 > **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-1)替代 > 从 API version 7开始支持。 @@ -2709,16 +2801,16 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>) | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | ---------------------------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| extraInfo | string | 是 | 要添加的应用帐号的额外信息(能转换string类型的其它信息，如token等)，额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当此应用程序的帐号名和额外信息添加到帐号管理服务成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| extraInfo | string | 是 | 额外信息(能转换string类型的其它信息)，额外信息不能是应用帐号的敏感信息（如应用账号密码、token等）。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当创建成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.addAccount("LiSi", "token101", (err) => { - console.log("addAccount err: " + JSON.stringify(err)); + console.log("addAccount err: " + JSON.stringify(err)); }); ``` @@ -2726,7 +2818,7 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>) addAccount(name: string, extraInfo?: string): Promise<void> -将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中。使用Promise异步回调。 +根据帐号名和额外信息添加应用帐号。使用callback异步回调。使用Promise异步回调。 > **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-2)替代 > 从 API version 7开始支持。 @@ -2737,8 +2829,8 @@ addAccount(name: string, extraInfo?: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------------------------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| extraInfo | string | 否 | 要添加的应用帐号的额外信息（能转换成string类型的其它信息），额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | +| name | string | 是 | 应用帐号的名称。 | +| extraInfo | string | 否 | 额外信息(能转换string类型的其它信息)，额外信息不能是应用帐号的敏感信息（如应用账号密码、token等）。 | **返回值：** @@ -2749,11 +2841,11 @@ addAccount(name: string, extraInfo?: string): Promise<void> **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.addAccount("LiSi", "token101").then(()=> { - console.log('addAccount Success'); + console.log('addAccount Success'); }).catch((err) => { - console.log("addAccount err: " + JSON.stringify(err)); + console.log("addAccount err: " + JSON.stringify(err)); }); ``` @@ -2761,7 +2853,7 @@ addAccount(name: string, extraInfo?: string): Promise<void> addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void -根据指定的帐号所有者、鉴权类型和可选项隐式地添加应用帐号，并使用callback回调异步返回结果。 +根据指定的帐号所有者隐式地添加应用帐号。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[createAccountImplicitly](#createaccountimplicitly9)替代。 > @@ -2773,10 +2865,10 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ----------------------- | -| owner | string | 是 | 要添加的应用帐号所有者包名。 | -| authType | string | 是 | 要添加的应用帐号鉴权类型。鉴权类型为自定义。 | +| owner | string | 是 | 应用帐号所有者的包名。 | +| authType | string | 是 | 鉴权类型。鉴权类型为自定义。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。可选项可根据自己需要设置。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 | +| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调对象，返回添加结果。 | **示例：** @@ -2784,21 +2876,21 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a import featureAbility from '@ohos.ability.featureAbility'; function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); + console.log("resultCode: " + code); + console.log("result: " + JSON.stringify(result)); } function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); - }); + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err)=>{ + console.log("startAbility err: " + JSON.stringify(err)); + }); } - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.addAccountImplicitly("com.example.ohos.accountjsdemo", "getSocialData", {}, { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.addAccountImplicitly("com.example.accountjsdemo", "getSocialData", {}, { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback }); ``` @@ -2806,7 +2898,7 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a deleteAccount(name: string, callback: AsyncCallback<void>): void -从帐号管理服务中删除应用帐号。使用callback异步回调。 +删除应用帐号。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。 > @@ -2818,13 +2910,13 @@ deleteAccount(name: string, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------- | -| name | string | 是 | 要删除的应用帐号名称。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当帐号管理服务中删除应用帐号成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当删除成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.deleteAccount("ZhaoLiu", (err) => { console.log("deleteAccount err: " + JSON.stringify(err)); }); @@ -2834,7 +2926,7 @@ deleteAccount(name: string, callback: AsyncCallback<void>): void deleteAccount(name: string): Promise<void> -从帐号管理服务中删除应用帐号。使用Promise异步回调。 +删除应用帐号。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。 > @@ -2846,7 +2938,7 @@ deleteAccount(name: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----------- | -| name | string | 是 | 要删除的应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | **返回值：** @@ -2857,7 +2949,7 @@ deleteAccount(name: string): Promise<void> **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.deleteAccount("ZhaoLiu").then(() => { console.log('deleteAccount Success'); }).catch((err) => { @@ -2880,15 +2972,15 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<vo | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | --------------------------------- | -| name | string | 是 | 要禁用访问的第三方应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时，err为undefined，否则为错误对象。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.disableAppAccess("ZhangSan", "com.example.accountjsdemo", (err) => { console.log("disableAppAccess err: " + JSON.stringify(err)); }); ``` @@ -2909,7 +3001,7 @@ disableAppAccess(name: string, bundleName: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ---------------- | -| name | string | 是 | 要禁用访问的第三方应用帐号名称。 | +| name | string | 是 | 要禁用访问的第三方应用帐号的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | **返回值：** @@ -2921,8 +3013,8 @@ disableAppAccess(name: string, bundleName: string): Promise<void> **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.disableAppAccess("ZhangSan", "com.example.accountjsdemo").then(() => { console.log('disableAppAccess Success'); }).catch((err) => { console.log("disableAppAccess err: " + JSON.stringify(err)); @@ -2945,15 +3037,15 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback<voi | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | --------------------------------- | -| name | string | 是 | 应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时，err为undefined，否则为错误对象。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.enableAppAccess("ZhangSan", "com.example.accountjsdemo", (err) => { console.log("enableAppAccess: " + JSON.stringify(err)); }); ``` @@ -2974,7 +3066,7 @@ enableAppAccess(name: string, bundleName: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | **返回值：** @@ -2986,8 +3078,8 @@ enableAppAccess(name: string, bundleName: string): Promise<void> **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.enableAppAccess("ZhangSan", "com.example.accountjsdemo").then(() => { console.log('enableAppAccess Success'); }).catch((err) => { console.log("enableAppAccess err: " + JSON.stringify(err)); @@ -2998,7 +3090,7 @@ enableAppAccess(name: string, bundleName: string): Promise<void> checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): void -检查指定应用帐号是否允许应用数据同步。使用callback异步回调。 +检查指定应用帐号是否开启数据同步功能。使用callback异步回调。 > **说明：** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9)替代。 > @@ -3012,13 +3104,13 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------- | ---- | --------------------- | -| name | string | 是 | 应用帐号名称。 | -| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查指定应用帐号是否允许应用数据同步成功，err为undefined，data返回true表示指定应用帐号允许应用数据同步，data返回false表示指定应用帐号不允许应用数据同步；否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示指定应用帐号已开启数据同步功能；返回false表示未开启。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err)); console.log('checkAppAccountSyncEnable result: ' + result); @@ -3029,7 +3121,7 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): checkAppAccountSyncEnable(name: string): Promise<boolean> -检查指定应用帐号是否允许应用数据同步。使用Promise异步回调。 +检查指定应用帐号是否开启数据同步功能。使用Promise异步回调。 > **说明：** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9-1)替代。 > @@ -3043,18 +3135,18 @@ checkAppAccountSyncEnable(name: string): Promise<boolean> | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------- | -| name | string | 是 | 应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | **返回值：** | 类型 | 说明 | -| :--------------------- | :-------------------- | -| Promise<boolean> | Promise对象。返回true表示允许应用数据同步；返回false表示不允许应用数据同步。 | +| ---------------------- | --------------------- | +| Promise<boolean> | Promise对象，返回true表示指定应用帐号已开启数据同步功能；返回false表示未开启。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { console.log('checkAppAccountSyncEnable, result: ' + data); }).catch((err) => { @@ -3066,7 +3158,7 @@ checkAppAccountSyncEnable(name: string): Promise<boolean> setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void -设置此应用程序帐号的凭据。使用callback异步回调。 +设置指定应用帐号的凭据。使用callback异步回调。 > **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9)替代。 > @@ -3078,15 +3170,15 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ---- | ------------- | -| name | string | 是 | 应用程序帐号名称。 | -| credentialType | string | 是 | 要设置的凭据类型。 | -| credential | string | 是 | 要设置的凭据。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置此应用程序帐号的凭据成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| credentialType | string | 是 | 凭据类型。 | +| credential | string | 是 | 凭据取值。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置此应用程序帐号的凭据成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { console.log("setAccountCredential err: " + JSON.stringify(err)); }); @@ -3096,7 +3188,7 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca setAccountCredential(name: string, credentialType: string, credential: string): Promise<void> -设置此应用程序帐号的凭据。使用Promise异步回调。 +设置指定应用帐号的凭据。使用Promise异步回调。 > **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9-1)替代。 > @@ -3109,8 +3201,8 @@ setAccountCredential(name: string, credentialType: string, credential: string): | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------- | | name | string | 是 | 应用帐号的名称。 | -| credentialType | string | 是 | 要设置的凭据的类型。 | -| credential | string | 是 | 要设置的凭据。 | +| credentialType | string | 是 | 凭据类型。 | +| credential | string | 是 | 凭据取值。 | **返回值：** @@ -3121,7 +3213,7 @@ setAccountCredential(name: string, credentialType: string, credential: string): **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001").then(() => { console.log('setAccountCredential Success'); }).catch((err) => { @@ -3133,9 +3225,9 @@ setAccountCredential(name: string, credentialType: string, credential: string): setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<void>): void -设置此应用程序帐号的额外信息。使用callback异步回调。 +设置指定应用帐号的额外信息。使用callback异步回调。 -> **说明：** 从API version 9开始废弃。 +> **说明：** 从API version 9开始废弃，建议使用[setCustomData](#setcustomdata9)替代。 > > 从 API version 7开始支持。 @@ -3146,14 +3238,14 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback< | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | --------------- | -| name | string | 是 | 应用帐号名称。 | -| extraInfo | string | 是 | 要设置的额外信息。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置此应用程序帐号的额外信息成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| extraInfo | string | 是 | 额外信息(能转换string类型的其它信息)，额外信息不能是应用帐号的敏感信息（如应用账号密码、token等）。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { console.log("setAccountExtraInfo err: " + JSON.stringify(err)); }); @@ -3165,7 +3257,7 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise<void> 设置此应用程序帐号的额外信息。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃。 +> **说明：** 从API version 9开始废弃，建议使用[setCustomData](#setcustomdata9-1)替代。 > > 从 API version 7开始支持。 @@ -3176,8 +3268,8 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| extraInfo | string | 是 | 要设置的额外信息。 | +| name | string | 是 | 应用帐号的名称。 | +| extraInfo | string | 是 | 额外信息(能转换string类型的其它信息)，额外信息不能是应用帐号的敏感信息（如应用账号密码、token等）。 | **返回值：** @@ -3188,7 +3280,7 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise<void> **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { console.log('setAccountExtraInfo Success'); }).catch((err) => { @@ -3200,7 +3292,7 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise<void> setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback<void>): void -设置指定的应用程序帐号是否允许应用程序数据同步。使用callback异步回调。 +开启或禁止指定应用帐号的数据同步功能。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9)替代。 > @@ -3214,14 +3306,14 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------- | -| name | string | 是 | 应用帐号名称。 | -| isEnable | boolean | 是 | 是否允许应用数据同步。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定的应用帐号是否允许应用程序数据同步成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| isEnable | boolean | 是 | 是否开启数据同步。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当开启或禁止成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); }); @@ -3231,7 +3323,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> -设置指定的应用程序帐号是否允许应用程序数据同步。使用Promise异步回调。 +开启或禁止指定应用帐号的数据同步功能。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9-1)替代。 > @@ -3245,8 +3337,8 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | -------- | ------- | ---- | ----------- | -| name | string | 是 | 应用帐号名称。 | -| isEnable | boolean | 是 | 是否允许应用数据同步。 | +| name | string | 是 | 应用帐号的名称。 | +| isEnable | boolean | 是 | 是否开启数据同步。 | **返回值：** @@ -3257,7 +3349,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { console.log('setAppAccountSyncEnable Success'); }).catch((err) => { @@ -3269,7 +3361,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void -设置与此应用程序帐号关联的数据。使用callback异步回调。 +设置指定应用帐号的关联数据。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9)替代。 > @@ -3282,15 +3374,15 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | -| value | string | 是 | 要设置的数据的值。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置与此应用帐号关联的数据成功时，err为undefined，否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 关联数据的键名。 | +| value | string | 是 | 关联数据的取值。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置与此应用帐号关联的数据成功时，err为null，否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { console.log("setAssociatedData err: " + JSON.stringify(err)); }); @@ -3300,7 +3392,7 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb setAssociatedData(name: string, key: string, value: string): Promise<void> -设置与此应用程序帐号关联的数据。使用Promise异步回调。 +设置指定应用帐号的关联数据。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9-1)替代。 > @@ -3313,9 +3405,9 @@ setAssociatedData(name: string, key: string, value: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | -| value | string | 是 | 要设置的数据的值。 | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 关联数据的键名。 | +| value | string | 是 | 关联数据的取值。 | **返回值：** @@ -3326,7 +3418,7 @@ setAssociatedData(name: string, key: string, value: string): Promise<void> **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { console.log('setAssociatedData Success'); }).catch((err) => { @@ -3338,13 +3430,13 @@ setAssociatedData(name: string, key: string, value: string): Promise<void> getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void -获取全部应用已授权帐号信息。 +获取所有可访问的应用帐号信息。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9)替代。 > > 从 API version 7开始支持。 -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS。 **系统能力：** SystemCapability.Account.AppAccount @@ -3352,12 +3444,12 @@ getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>& | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | -| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | +| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 回调函数。当查询成功时，err为null，data为获取到的应用帐号信息列表；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAllAccessibleAccounts((err, data)=>{ console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err)); console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data)); @@ -3368,13 +3460,13 @@ getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>& getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>> -获取全部应用已授权帐号信息。 +获取所有可访问的应用帐号信息。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9-1)替代。 > > 从 API version 7开始支持。 -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS。 **系统能力：** SystemCapability.Account.AppAccount @@ -3382,12 +3474,12 @@ getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>> | 类型 | 说明 | | ---------------------------------------- | --------------------- | -| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象。返回全部应用已授权帐号信息对象。 | +| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象，返回全部应用已授权帐号信息对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAllAccessibleAccounts().then((data) => { console.log('getAllAccessibleAccounts: ' + data); }).catch((err) => { @@ -3399,13 +3491,13 @@ getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>> getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void -获取指定应用全部帐号信息。 +根据应用帐号所有者获取调用方可访问的应用帐号列表。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner]替代。 +> **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner](#getaccountsbyowner9)替代。 > > 从 API version 7开始支持。 -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS。 **系统能力：** SystemCapability.Account.AppAccount @@ -3413,13 +3505,13 @@ getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | -| owner | string | 是 | 应用包名称。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); const selfBundle = "com.example.actsgetallaaccounts"; appAccountManager.getAllAccounts(selfBundle, (err, data)=>{ console.debug("getAllAccounts err:" + JSON.stringify(err)); @@ -3431,7 +3523,7 @@ getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo getAllAccounts(owner: string): Promise<Array<AppAccountInfo>> -获取指定应用全部帐号信息。 +根据应用帐号所有者获取调用方可访问的应用帐号列表。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner](#getaccountsbyowner9-1)替代。 > @@ -3451,12 +3543,12 @@ getAllAccounts(owner: string): Promise<Array<AppAccountInfo>> | 类型 | 说明 | | ---------------------------------------- | --------------------- | -| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象。返回指定应用全部帐号信息对象。 | +| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象，返回指定应用全部帐号信息对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); const selfBundle = "com.example.actsgetallaaccounts"; appAccountManager.getAllAccounts(selfBundle).then((data) => { console.log('getAllAccounts: ' + data); @@ -3469,7 +3561,7 @@ getAllAccounts(owner: string): Promise<Array<AppAccountInfo>> getAccountCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void -获取此应用帐号的凭据（如数字密码、人脸和PIN码等）。使用callback异步回调。 +获取指定应用帐号的凭据。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9)替代。 > @@ -3481,14 +3573,14 @@ getAccountCredential(name: string, credentialType: string, callback: AsyncCallba | 参数名 | 类型 | 必填 | 说明 | | -------------- | --------------------------- | ---- | -------------- | -| name | string | 是 | 应用帐号名称。 | -| credentialType | string | 是 | 获取此应用帐号的凭据的类型。 | -| callback | AsyncCallback<string> | 是 | 回调函数。当获取此应用帐号的凭据成功时，err为undefined，data返回此应用帐号的凭据对象；否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| credentialType | string | 是 | 凭据类型。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取凭据成功时，err为null，data为指定应用帐号的凭据；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { console.log("getAccountCredential err: " + JSON.stringify(err)); console.log('getAccountCredential result: ' + result); @@ -3499,7 +3591,7 @@ getAccountCredential(name: string, credentialType: string, callback: AsyncCallba getAccountCredential(name: string, credentialType: string): Promise<string> -获取此应用程序帐号的凭据。使用Promise异步回调。 +获取指定应用帐号的凭据。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9-1)替代。 > @@ -3511,19 +3603,19 @@ getAccountCredential(name: string, credentialType: string): Promise<string> | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------- | -| name | string | 是 | 应用帐号名称。 | -| credentialType | string | 是 | 要获取的凭据的类型。 | +| name | string | 是 | 应用帐号的名称。 | +| credentialType | string | 是 | 凭据类型。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | -| Promise<string> | Promise对象。返回此应用程序帐号的凭据对象。 | +| Promise<string> | Promise对象，返回指定应用帐号的凭据。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { console.log('getAccountCredential, result: ' + data); }).catch((err) => { @@ -3535,9 +3627,9 @@ getAccountCredential(name: string, credentialType: string): Promise<string> getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void -获取此应用帐号的额外信息（能转换成string类型的其它信息）。使用callback异步回调。 +获取指定应用帐号的额外信息（能转换成string类型的其它信息）。使用callback异步回调。 -> **说明：** 从API version 9开始废弃。 +> **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9)替代。 > > 从 API version 7开始支持。 @@ -3547,13 +3639,13 @@ getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | --------------- | -| name | string | 是 | 应用帐号名称。 | -| callback | AsyncCallback<string> | 是 | 回调函数。当获取此应用帐号的额外信息成功时，err为undefined，data返回此应用帐号的额外信息对象；否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取此应用帐号的额外信息成功时，err为null，data返回此应用帐号的额外信息对象；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { console.log("getAccountExtraInfo err: " + JSON.stringify(err)); console.log('getAccountExtraInfo result: ' + result); @@ -3564,9 +3656,9 @@ getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void getAccountExtraInfo(name: string): Promise<string> -获取此应用程序帐号的额外信息。使用Promise异步回调。 +获取指定应用帐号的额外信息（能转换成string类型的其它信息）。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃。 +> **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9-1)替代。 > > 从 API version 7开始支持。 @@ -3576,18 +3668,18 @@ getAccountExtraInfo(name: string): Promise<string> | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------- | -| name | string | 是 | 应用帐号名称。 | +| name | string | 是 | 应用帐号的名称。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | -| Promise<string> | Promise对象。返回此应用程序帐号的额外信息对象。 | +| Promise<string> | Promise对象，返回此应用程序帐号的额外信息对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { console.log('getAccountExtraInfo, result: ' + data); }).catch((err) => { @@ -3599,7 +3691,7 @@ getAccountExtraInfo(name: string): Promise<string> getAssociatedData(name: string, key: string, callback: AsyncCallback<string>): void -获取与此应用程序帐号关联的数据。使用callback异步回调。 +根据指定键名获取特定应用帐号的关联数据。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9)替代。 > @@ -3611,14 +3703,14 @@ getAssociatedData(name: string, key: string, callback: AsyncCallback<string&g | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | -| callback | AsyncCallback<string> | 是 | 回调函数。当获取与此应用程序帐号关联的数据成功时，err为undefined，data返回与此应用程序帐号关联的数据对象；否则为错误对象。 | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 关联数据的键名。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取成功时，err为null，data为关联数据的取值；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { console.log("getAssociatedData err: " + JSON.stringify(err)); console.log('getAssociatedData result: ' + result); @@ -3641,19 +3733,19 @@ getAssociatedData(name: string, key: string): Promise<string> | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | +| name | string | 是 | 应用帐号的名称。 | +| key | string | 是 | 关联数据的键名。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | -| Promise<string> | Promise对象。返回与此应用程序帐号关联的数据对象。 | +| Promise<string> | Promise对象，返回关联数据的取值。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { console.log('getAssociatedData: ' + data); }).catch((err) => { @@ -3665,7 +3757,7 @@ getAssociatedData(name: string, key: string): Promise<string> on(type: 'change', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void -订阅指定帐号所有者的帐户变更事件。使用callback异步回调。 +订阅指定应用的帐号信息变更事件。 > **说明：** 从API version 9开始废弃, 建议使用[on('accountChange')](#onaccountchange9)替代。 > @@ -3677,14 +3769,14 @@ on(type: 'change', owners: Array<string>, callback: Callback<Array<A | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | -| type | 'change' | 是 | 事件回调类型，支持的事件为'change'，当帐号所有者更新帐号时，触发该事件。 | -| owners | Array<string> | 是 | 指示帐号的所有者。 | -| callback | Callback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 回调函数。返回指定帐号所有者更新的帐号信息数组。 | +| type | 'change' | 是 | 事件回调类型，支持的事件为'change'，当帐号所有者更新帐号信息时，触发该事件。 | +| owners | Array<string> | 是 | 应用帐号所有者的包名列表。 | +| callback | Callback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 回调函数，返回信息发生变更的应用帐号列表。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); function changeOnCallback(data){ console.debug("receive change data:" + JSON.stringify(data)); } @@ -3700,7 +3792,7 @@ on(type: 'change', owners: Array<string>, callback: Callback<Array<A off(type: 'change', callback?: Callback>): void -取消订阅帐号事件。使用callback异步回调。 +取消订阅帐号信息变更事件。 > **说明：** 从API version 9开始废弃, 建议使用[off('accountChange')](#offaccountchange9)替代。 > @@ -3712,13 +3804,13 @@ off(type: 'change', callback?: Callback>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------- | ---- | ------------ | -| type | 'change' | 是 | 事件回调类型，支持的事件为'change'，当帐号所有者更新帐号时，触发该事件。 | -| callback | Callback> | 否 | 回调函数，返回指定帐号所有者更新的帐号信息数组。 | +| type | 'change' | 是 | 事件回调类型，支持的事件为'change'，当帐号所有者更新帐号信息时，触发该事件。 | +| callback | Callback> | 否 | 回调函数，返回信息发生变更的应用帐号列表。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); function changeOnCallback(data){ console.debug("receive change data:" + JSON.stringify(data)); appAccountManager.off('change', function(){ @@ -3737,7 +3829,7 @@ off(type: 'change', callback?: Callback>): void authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void -对应用帐户进行鉴权以获取OAuth令牌。使用callback异步回调。 +对应用帐号进行鉴权以获取授权令牌。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[auth](#auth9)替代。 > @@ -3749,11 +3841,11 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | --------------- | -| name | string | 是 | 要鉴权的应用帐号名称。 | -| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | | options | {[key: string]: any} | 是 | 鉴权所需的可选项。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 回调函数。返回鉴权结果对象。 | +| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 回调对象，返回鉴权结果。 | **示例：** @@ -3772,8 +3864,8 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri }); } - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.authenticate("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.authenticate("LiSi", "com.example.accountjsdemo", "getSocialData", {}, { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); @@ -3783,7 +3875,7 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void -获取指定应用帐号和鉴权类型的OAuth令牌。使用callback异步回调。 +获取指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9)替代。 > @@ -3796,15 +3888,15 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | -| callback | AsyncCallback<string> | 是 | 回调函数。当获取指定应用帐号和鉴权类型的Auth令牌成功时，err为undefined，data返回Auth令牌对象；否则为错误对象。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取成功时，err为null，data为授权令牌值；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", (err, data) => { console.log('getOAuthToken err: ' + JSON.stringify(err)); console.log('getOAuthToken token: ' + data); }); @@ -3814,7 +3906,7 @@ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCall getOAuthToken(name: string, owner: string, authType: string): Promise<string> -获取指定应用帐户和鉴权类型的OAuth令牌。使用Promise异步回调。 +获取指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9-1)替代。 > @@ -3827,20 +3919,20 @@ getOAuthToken(name: string, owner: string, authType: string): Promise<string& | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | **返回值：** | 类型 | 说明 | | --------------------- | --------------------- | -| Promise<string> | Promise对象。返回指定应用帐户和鉴权类型的OAuth令牌对象。 | +| Promise<string> | Promise对象，返回授权令牌。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData").then((data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData").then((data) => { console.log('getOAuthToken token: ' + data); }).catch((err) => { console.log("getOAuthToken err: " + JSON.stringify(err)); @@ -3851,7 +3943,7 @@ getOAuthToken(name: string, owner: string, authType: string): Promise<string& setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void -设置指定应用帐号和鉴权类型的OAuth令牌。使用callback异步回调。 +为指定应用帐号设置特定鉴权类型的授权令牌。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9)替代。 > @@ -3865,13 +3957,13 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall | -------- | ------------------------- | ---- | -------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | -| token | string | 是 | OAuth令牌。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定应用帐号和鉴权类型的OAuth令牌成功时，err为undefined；否则为错误对象。 | +| token | string | 是 | 授权令牌。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置成功时，err为null；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx", (err) => { console.log('setOAuthToken err: ' + JSON.stringify(err)); }); @@ -3881,7 +3973,7 @@ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCall setOAuthToken(name: string, authType: string, token: string): Promise<void> -设置指定应用帐户和鉴权类型的OAuth令牌。使用Promise异步回调。 +为指定应用帐号设置特定鉴权类型的授权令牌。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。 > @@ -3895,7 +3987,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise<void> | -------- | ------ | ---- | -------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | -| token | string | 是 | OAuth令牌。 | +| token | string | 是 | 授权令牌。 | **返回值：** @@ -3906,7 +3998,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise<void> **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx").then(() => { console.log('setOAuthToken successfully'); }).catch((err) => { @@ -3918,7 +4010,7 @@ setOAuthToken(name: string, authType: string, token: string): Promise<void> deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void -删除指定应用帐户和鉴权类型的OAuth令牌。使用callback异步回调。 +删除指定应用帐号的特定鉴权类型的授权令牌。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[deleteAuthToken](#deleteauthtoken9)替代。 > @@ -3931,16 +4023,16 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------ | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | -| token | string | 是 | 要删除的OAuth令牌。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当删除指定应用帐户和鉴权类型的OAuth令牌成功时，err为undefined；否则为错误对象。 | +| token | string | 是 | 授权令牌。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当删除成功时，err为null；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.deleteOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx", (err) => { console.log('deleteOAuthToken err: ' + JSON.stringify(err)); }); ``` @@ -3949,9 +4041,9 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise<void> -删除指定应用帐户和鉴权类型的OAuth令牌。使用Promise异步回调。 +删除指定应用帐号的特定鉴权类型的授权令牌。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[deleteAuthToken](#deleteauthtoken9-1)替代。 > > 从 API version 8开始支持。 @@ -3962,9 +4054,9 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string): | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------ | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | authType | string | 是 | 鉴权类型。 | -| token | string | 是 | 要删除的OAuth令牌。 | +| token | string | 是 | 授权令牌。 | **返回值：** @@ -3975,8 +4067,8 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string): **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx").then(() => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.deleteOAuthToken("LiSi", "com.example.accountjsdemo", "getSocialData", "xxxxx").then(() => { console.log('deleteOAuthToken successfully'); }).catch((err) => { console.log("deleteOAuthToken err: " + JSON.stringify(err)); @@ -3987,7 +4079,7 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string): setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void -设置指定鉴权类型的Auth令牌对特定应用的可见性。使用callback异步回调。 +设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9)替代。 > @@ -4002,14 +4094,14 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 被设置可见性的应用包名。 | -| isVisible | boolean | 是 | 是否可见。当设置成true可见，false不可见。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定鉴权类型的Auth令牌对特定应用的可见性成功时，err为undefined；否则为错误对象。 | +| isVisible | boolean | 是 | 是否可见。true表示可见，false表示不可见。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置成功时，err为null；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true, (err) => { console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); }); ``` @@ -4018,7 +4110,7 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void> -设置指定鉴权类型的OAuth令牌对特定应用的可见性。使用Promise异步回调。 +设置指定帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9-1)替代。 > @@ -4033,7 +4125,7 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 被设置可见性的应用包名。 | -| isVisible | boolean | 是 | 是否可见。 | +| isVisible | boolean | 是 | 是否可见。true表示可见，false表示不可见。 | **返回值：** @@ -4044,8 +4136,8 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", true).then(() => { console.log('setOAuthTokenVisibility successfully'); }).catch((err) => { console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); @@ -4056,7 +4148,7 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void -检查指定鉴权类型的OAuth令牌对特定应用的可见性。使用callback异步回调。 +检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9)替代。 > @@ -4071,13 +4163,13 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 检查可见性的应用包名。 | -| callback | AsyncCallback<boolean> | 是 | 回调函数。检查指定鉴权类型的OAuth令牌对特定应用的可见性时，err为undefined，data为true表示可见，data为false表示不可见；否则为错误对象。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查成功时，err为null，data为true表示可见，data为false表示不可见；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", (err, data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo", (err, data) => { console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); console.log('checkOAuthTokenVisibility isVisible: ' + data); }); @@ -4087,7 +4179,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean> -检查指定鉴权类型的OAuth令牌对特定应用的可见性。使用Promise异步回调。 +检查指定应用帐号的特定鉴权类型的授权令牌对指定应用的可见性。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9-1)替代。 > @@ -4107,13 +4199,13 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P | 类型 | 说明 | | ---------------------- | --------------------- | -| Promise<boolean> | Promise对象。返回true表示指定鉴权类型的OAuth令牌对特定应用的可见，返回false表示不可见。 | +| Promise<boolean> | Promise对象，返回true表示指定鉴权类型的OAuth令牌对特定应用的可见，返回false表示不可见。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo").then((data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.accountjsdemo").then((data) => { console.log('checkOAuthTokenVisibility isVisible: ' + data); }).catch((err) => { console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); @@ -4124,7 +4216,7 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void -获取指定应用对调用方全部可见的OAuth令牌。使用callback异步回调。 +获取指定帐号对调用方可见的所有授权令牌。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9)替代。 > @@ -4137,14 +4229,14 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array& | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| callback | AsyncCallback<Array< [OAuthTokenInfo](#oauthtokeninfodeprecated)>> | 是 | 回调函数。当获取指定应用对调用方全部可见的OAuth令牌成功时，err为undefined，data为全部可见的OAuth令牌数组；否则为错误对象。 | +| owner | string | 是 | 应用帐号所有者的包名。 | +| callback | AsyncCallback<Array< [OAuthTokenInfo](#oauthtokeninfodeprecated)>> | 是 | 回调函数。当获取成功时，err为null，data为授权令牌数组；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo", (err, data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getAllOAuthTokens("LiSi", "com.example.accountjsdemo", (err, data) => { console.log("getAllOAuthTokens err: " + JSON.stringify(err)); console.log('getAllOAuthTokens data: ' + JSON.stringify(data)); }); @@ -4154,7 +4246,7 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array& getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenInfo>> -获取指定应用帐户对调用方可见的全部OAuth令牌。使用Promise异步回调。 +获取指定帐号对调用方可见的所有授权令牌。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9-1)替代。 > @@ -4167,19 +4259,19 @@ getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenIn | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | **返回值：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | -| Promise<Array< [OAuthTokenInfo](#oauthtokeninfodeprecated)>> | Promise对象。返回指定应用帐户对调用方可见的全部OAuth令牌对象。 | +| Promise<Array< [OAuthTokenInfo](#oauthtokeninfodeprecated)>> | Promise对象，返回授权令牌数组。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getAllOAuthTokens("LiSi", "com.example.accountjsdemo").then((data) => { console.log('getAllOAuthTokens data: ' + JSON.stringify(data)); }).catch((err) => { console.log("getAllOAuthTokens err: " + JSON.stringify(err)); @@ -4190,7 +4282,7 @@ getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenIn getOAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void -获取指定应用帐户和鉴权类型的OAuth令牌的授权列表。使用callback异步回调。 +获取指定应用帐号的特定鉴权类型的授权列表，即被授权的包名数组（令牌的授权列表通过setOAuthTokenVisibility(#setoauthtokenvisibilitydeprecated)来设置）。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9)替代。 > @@ -4203,16 +4295,16 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback<Array< | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------------------- | | name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表。 | -| callback | AsyncCallback<Array<string>> | 是 | 回调函数。当获取指定应用帐户和鉴权类型的OAuth令牌的授权列表成功时，err为undefined，data为OAuth令牌的授权列表；否则为错误对象。 | +| authType | string | 是 | 鉴权类型。 | +| callback | AsyncCallback<Array<string>> | 是 | 回调函数。当获取成功时，err为null，data为被授权的包名数组；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { - console.log('getOAuthList err: ' + JSON.stringify(err)); - console.log('getOAuthList data: ' + JSON.stringify(data)); + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getOAuthList("com.example.accountjsdemo", "getSocialData", (err, data) => { + console.log('getOAuthList err: ' + JSON.stringify(err)); + console.log('getOAuthList data: ' + JSON.stringify(data)); }); ``` @@ -4220,7 +4312,7 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback<Array< getOAuthList(name: string, authType: string): Promise<Array<string>> -获取指定应用帐户和鉴权类型的OAuth令牌的授权列表。使用Promise异步回调。 +获取指定应用帐号的特定鉴权类型的授权列表，即被授权的包名数组（令牌的授权列表通过setOAuthTokenVisibility(#setoauthtokenvisibilitydeprecated)来设置）。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9-1)替代。 > @@ -4233,19 +4325,19 @@ getOAuthList(name: string, authType: string): Promise<Array<string>> | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ----------------------- | | name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表。 | +| authType | string | 是 | 鉴权类型。 | **返回值：** | 类型 | 说明 | | ---------------------------------- | --------------------- | -| Promise<Array<string>> | Promise对象。返回指定应用帐户和鉴权类型的OAuth令牌的授权列表对象。 | +| Promise<Array<string>> | Promise对象，返回被授权的包名数组。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getOAuthList("com.example.accountjsdemo", "getSocialData").then((data) => { console.log('getOAuthList data: ' + JSON.stringify(data)); }).catch((err) => { console.log("getOAuthList err: " + JSON.stringify(err)); @@ -4269,13 +4361,13 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<Authentic | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------- | | sessionId | string | 是 | 鉴权会话的标识。 | -| callback | AsyncCallback<[AuthenticatorCallback](#authenticatorcallbackdeprecated)> | 是 | 回调函数。当获取鉴权会话的认证器回调函数成功时，err为undefined，data为认证器回调函数；否则为错误对象。 | +| callback | AsyncCallback<[AuthenticatorCallback](#authenticatorcallbackdeprecated)> | 是 | 回调函数。当获取鉴权会话的认证器回调函数成功时，err为null，data为认证器回调函数；否则为错误对象。 | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); featureAbility.getWant((err, want) => { var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; appAccountManager.getAuthenticatorCallback(sessionId, (err, callback) => { @@ -4284,7 +4376,7 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<Authentic return; } var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", - [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", + [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo", [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); @@ -4314,19 +4406,19 @@ getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback> | 类型 | 说明 | | ------------------------------------ | --------------------- | -| Promise<[AuthenticatorCallback](#authenticatorcallbackdeprecated)> | Promise对象。返回鉴权会话的认证器回调对象。 | +| Promise<[AuthenticatorCallback](#authenticatorcallbackdeprecated)> | Promise对象，返回鉴权会话的认证器回调对象。 | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); featureAbility.getWant().then((want) => { var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => { var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", - [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", + [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo", [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); @@ -4342,7 +4434,7 @@ getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback> getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void -获取指定应用帐号的认证器信息。使用callback异步回调。 +获取指定应用的认证器信息。使用callback异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9)替代。 > @@ -4354,14 +4446,14 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | -| callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 回调函数。当获取指定应用帐号的认证器信息成功时，err为undefined，data为认证器信息对象；否则为错误对象。 | +| owner | string | 是 | 应用帐号所有者的包名。 | +| callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 回调函数。当获取成功时，err为null，data为认证器信息对象；否则为错误对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo", (err, data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getAuthenticatorInfo("com.example.accountjsdemo", (err, data) => { console.log("getAuthenticatorInfo err: " + JSON.stringify(err)); console.log('getAuthenticatorInfo data: ' + JSON.stringify(data)); }); @@ -4371,7 +4463,7 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> -获取指定应用帐户的认证器信息。使用Promise异步回调。 +获取指定应用的认证器信息。使用Promise异步回调。 > **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9-1)替代。 > @@ -4383,19 +4475,19 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | **返回值：** | 类型 | 说明 | | -------------------------------- | --------------------- | -| Promise<[AuthenticatorInfo](#authenticatorinfo8)> | Promise对象。返回指定应用帐户的认证器信息对象。 | +| Promise<[AuthenticatorInfo](#authenticatorinfo8)> | Promise对象，返回指定应用的认证器信息对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => { + let appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getAuthenticatorInfo("com.example.accountjsdemo").then((data) => { console.log('getAuthenticatorInfo: ' + JSON.stringify(data)); }).catch((err) => { console.log("getAuthenticatorInfo err: " + JSON.stringify(err)); @@ -4410,7 +4502,7 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | +| owner | string | 是 | 应用帐号所有者的包名。 | | name | string | 是 | 应用帐号的名称。 | ## AuthTokenInfo9+ @@ -4464,16 +4556,6 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> | account | [AppAccountInfo](#appaccountinfo) | 否 | 令牌所属的帐号信息。 | | tokenInfo | [AuthTokenInfo](#authtokeninfo9) | 否 | 令牌信息。 | -## AuthOptions9+ - -表示认证的选项。 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------ | ---- | ---------- | -| parameters | {[key:string]: Object} | 否 | 自定义参数对象。 | - ## CreateAccountOptions9+ 表示创建账号的选项。 @@ -4543,7 +4625,9 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> | ACTION_AUTHENTICATE(deprecated) | "authenticate" | 表示操作，鉴权。 | | ACTION_CREATE_ACCOUNT_IMPLICITLY9+ | "createAccountImplicitly" | 表示操作，隐式创建帐号。 | | ACTION_AUTH9+ | "auth" | 表示操作，鉴权。 | -| KEY_NAME | "name" | 表示键名，应用帐号名称。 | +| ACTION_VERIFY_CREDENTIAL9+ | "verifyCredential" | 表示操作，验证凭据。 | +| ACTION_SET_AUTHENTICATOR_PROPERTIES9+ | "setAuthenticatorProperties" | 表示操作，设置认证器属性。 | +| KEY_NAME | "name" | 表示键名，应用帐号的名称。 | | KEY_OWNER | "owner" | 表示键名，应用帐号所有者。| | KEY_TOKEN | "token" | 表示键名，令牌。 | | KEY_ACTION | "action" | 表示键名，操作。 | @@ -4585,11 +4669,11 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> ## AuthCallback9+ -认证回调接口。 +认证器回调类。 ### onResult9+ -onResult: (code: number, result: {[key: string]: any}) => void +onResult: (code: number, result?: AuthResult) => void 通知请求结果。 @@ -4600,16 +4684,16 @@ onResult: (code: number, result: {[key: string]: any}) => void | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------- | ---- | ------ | | code | number | 是 | 鉴权结果码。 | -| result | {[key: string]: any} | 否 | 鉴权结果。 | +| result | [AuthResult](#authresult9) | 否 | 鉴权结果。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthCallback(sessionId).then((callback) => { var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", - [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", + [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo", [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); @@ -4638,8 +4722,8 @@ onRequestRedirected: (request: Want) => void class MyAuthenticator extends account_appAccount.Authenticator { createAccountImplicitly(options, callback) { callback.onRequestRedirected({ - bundleName: "com.example.ohos.accountjsdemo", - abilityName: "com.example.ohos.accountjsdemo.LoginAbility", + bundleName: "com.example.accountjsdemo", + abilityName: "com.example.accountjsdemo.LoginAbility", }); } @@ -4663,7 +4747,7 @@ onRequestContinued?: () => void **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthCallback(sessionId).then((callback) => { callback.onRequestContinued(); @@ -4698,11 +4782,11 @@ onResult: (code: number, result: {[key: string]: any}) => void **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => { var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", - [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", + [account_appAccount.Constants.KEY_OWNER]: "com.example.accountjsdemo", [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); @@ -4731,8 +4815,8 @@ onRequestRedirected: (request: Want) => void class MyAuthenticator extends account_appAccount.Authenticator { addAccountImplicitly(authType, callerBundleName, options, callback) { callback.onRequestRedirected({ - bundleName: "com.example.ohos.accountjsdemo", - abilityName: "com.example.ohos.accountjsdemo.LoginAbility", + bundleName: "com.example.accountjsdemo", + abilityName: "com.example.accountjsdemo.LoginAbility", }); } @@ -4756,7 +4840,7 @@ onRequestContinued?: () => void **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); + let appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => { callback.onRequestContinued(); @@ -4769,11 +4853,30 @@ onRequestContinued?: () => void 认证器基类。 -### addAccountImplicitly8+ +### createAccountImplicitly9+ + +createAccountImplicitly(options: CreateAccountImplicitlyOptions, callback: AuthCallback): void + +根据指定的帐号所有者隐式地创建应用帐号，并使用callback异步回调返回结果。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------------- | --------------------- | ---- | --------------- | +| options | {[key: string]: any} | 是 | 隐式创建账号的选项。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调对象，用于返回创建结果。 | + +### addAccountImplicitlydeprecated addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void -根据指定的鉴权类型和可选项，隐式地添加应用帐户，并使用callback回调异步返回结果。 +根据指定的鉴权类型和可选项，隐式地添加应用帐号，并使用callback异步回调返回结果。 + +> **说明：** 从API version 9开始废弃。 +> +> 从 API version 8开始支持, 建议使用[createAccountImplicitly](#createaccountimplicitly9-2)替代。 **系统能力：** SystemCapability.Account.AppAccount @@ -4786,11 +4889,33 @@ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 | -### authenticate8+ +### auth9+ + +auth(name: string, authType: string, options: {[key:string]: Object}, callback: AuthCallback): void + +对应用帐号进行鉴权以获取授权令牌，并使用callback异步回调返回结果。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 接口名 | 类型 | 必填 | 说明 | +| ---------------- | --------------------- | ---- | --------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 应用帐号的鉴权类型。 | +| callerBundleName | string | 是 | 鉴权类型。 | +| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | +| callback | [AuthCallback](#authcallback9) | 是 | 回调对象，用于返回鉴权结果。 | + +### authenticatedeprecated authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void -对应用帐户进行鉴权，获取OAuth令牌，并使用callback回调异步返回结果。 +对应用帐号进行鉴权，获取OAuth令牌，并使用callback异步回调返回结果。 + +> **说明：** 从API version 9开始废弃。 +> +> 从 API version 8开始支持, 建议使用[auth](#auth9-2)替代。 **系统能力：** SystemCapability.Account.AppAccount @@ -4806,9 +4931,9 @@ authenticate(name: string, authType: string, callerBundleName: string, options: ### verifyCredential9+ -verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback): void; +verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthCallback): void; -验证应用帐户的凭据，并使用callback回调异步返回结果。 +验证应用帐号的凭据，并使用callback异步回调返回结果。 **系统能力：** SystemCapability.Account.AppAccount @@ -4818,13 +4943,13 @@ verifyCredential(name: string, options: VerifyCredentialOptions, callback: Authe | ---------------- | --------------------- | ---- | --------------- | | name | string | 是 | 应用帐号的名称。 | | options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的可选项。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回验证结果。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回验证结果。 | ### setProperties9+ -setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback): void; +setProperties(options: SetPropertiesOptions, callback: AuthCallback): void; -设置认证器属性，并使用callback回调异步返回结果。 +设置认证器属性，并使用callback异步回调返回结果。 **系统能力：** SystemCapability.Account.AppAccount @@ -4833,13 +4958,13 @@ setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback): v | 接口名 | 类型 | 必填 | 说明 | | ---------------- | --------------------- | ---- | --------------- | | options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的可选项。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回设置结果。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回设置结果。 | ### checkAccountLabels9+ -checkAccountLabels(name: string, labels: Array<string>, callback: AuthenticatorCallback): void; +checkAccountLabels(name: string, labels: Array<string>, callback: AuthCallback): void; -检查帐号标签，并使用callback回调异步返回结果。 +检查帐号标签，并使用callback异步回调返回结果。 **系统能力：** SystemCapability.Account.AppAccount @@ -4849,13 +4974,13 @@ checkAccountLabels(name: string, labels: Array<string>, callback: Authenti | ---------------- | --------------------- | ---- | --------------- | | name | string | 是 | 应用帐号的名称。 | | labels | Array<string> | 是 | 标签数组。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回检查结果。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回检查结果。 | ### isAccountRemovable9+ -isAccountRemovable(name: string, callback: AuthenticatorCallback): void; +isAccountRemovable(name: string, callback: AuthCallback): void; -判断帐号是否可以删除，并使用callback回调异步返回结果。 +判断帐号是否可以删除，并使用callback异步回调返回结果。 **系统能力：** SystemCapability.Account.AppAccount @@ -4864,7 +4989,7 @@ isAccountRemovable(name: string, callback: AuthenticatorCallback): void; | 接口名 | 类型 | 必填 | 说明 | | ---------------- | --------------------- | ---- | --------------- | | name | string | 是 | 应用帐号的名称。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回判断结果。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回判断结果。 | ### getRemoteObject9+ @@ -4878,49 +5003,49 @@ getRemoteObject(): rpc.RemoteObject; ```js class MyAuthenticator extends account_appAccount.Authenticator { - addAccountImplicitly(authType, callerBundleName, options, callback) { - callback.onRequestRedirected({ - bundleName: "com.example.ohos.accountjsdemo", - abilityName: "com.example.ohos.accountjsdemo.LoginAbility", - }); - } - - authenticate(name, authType, callerBundleName, options, callback) { - var result = {[account_appAccount.Constants.KEY_NAME]: name, - [account_appAccount.Constants.KEY_AUTH_TYPE]: authType, - [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.onResult(account_appAccount.ResultCode.SUCCESS, result); - } + addAccountImplicitly(authType, callerBundleName, options, callback) { + callback.onRequestRedirected({ + bundleName: "com.example.accountjsdemo", + abilityName: "com.example.accountjsdemo.LoginAbility", + }); + } - verifyCredential(name, options, callback) { - callback.onRequestRedirected({ - bundleName: "com.example.ohos.accountjsdemo", - abilityName: "com.example.ohos.accountjsdemo.VerifyAbility", - parameters: { - name: name - } - }); - } + authenticate(name, authType, callerBundleName, options, callback) { + var result = {[account_appAccount.Constants.KEY_NAME]: name, + [account_appAccount.Constants.KEY_AUTH_TYPE]: authType, + [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); + } + + verifyCredential(name, options, callback) { + callback.onRequestRedirected({ + bundleName: "com.example.accountjsdemo", + abilityName: "com.example.accountjsdemo.VerifyAbility", + parameters: { + name: name + } + }); + } - setProperties(options, callback) { - callback.onResult(account_appAccount.ResultCode.SUCCESS, {}); - } + setProperties(options, callback) { + callback.onResult(account_appAccount.ResultCode.SUCCESS, {}); + } - checkAccountLabels(name, labels, callback) { - var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: false}; - callback.onResult(account_appAccount.ResultCode.SUCCESS, result); - } - - isAccountRemovable(name, callback) { - var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: true}; - callback.onResult(account_appAccount.ResultCode.SUCCESS, result); - } + checkAccountLabels(name, labels, callback) { + var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: false}; + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); + } + + isAccountRemovable(name, callback) { + var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: true}; + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); + } } var authenticator = null; export default { - onConnect(want) { - authenticator = new MyAuthenticator(); - return authenticator.getRemoteObject(); - } + onConnect(want) { + authenticator = new MyAuthenticator(); + return authenticator.getRemoteObject(); + } } ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-account.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-account.md index 5d62db3f113c60af609aa15ce4aa6990fb079ab3..eca0200f6b2aac960d82d6195642d6d2ab26ef07 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-account.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-account.md @@ -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开始支持。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-osAccount.md b/zh-cn/application-dev/reference/apis/js-apis-osAccount.md index b8c557185193c2f1ca58fcd399d54a2a69d5a7b1..a9a1c265c231ec3b93bf0e3a55a302c4ceb6a94f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-osAccount.md +++ b/zh-cn/application-dev/reference/apis/js-apis-osAccount.md @@ -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> ### queryOsAccountLocalIdFromDomain9+ -getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void +queryOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void 根据域帐号信息，获取与其关联的系统帐号ID。使用callback异步回调。 @@ -1089,6 +1143,13 @@ getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCall | domainInfo | [DomainAccountInfo](#domainaccountinfo8) | 是 | 域帐号信息。 | | callback | AsyncCallback<number> | 是 | 回调函数。如果查询成功，err为null，data为域帐号关联的系统帐号ID；否则为错误对象。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | +| 12300002 | Invalid domainInfo. | + **示例：** ```js @@ -1129,6 +1190,13 @@ queryOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise<numbe | :-------------------- | :------------------------------------- | | Promise<number> | Promise对象，返回域帐号关联的系统帐号ID。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | +| 12300002 | Invalid domainInfo. | + **示例：** ```js @@ -1161,6 +1229,12 @@ queryMaxOsAccountNumber(callback: AsyncCallback<number>): void | -------- | --------------------------- | ---- | -------------------------------------------------------------------------------- | | callback | AsyncCallback<number> | 是 | 回调函数，如果查询成功，err为null，data为允许创建的系统帐号的最大数量；否则为错误对象。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1194,6 +1268,12 @@ queryMaxOsAccountNumber(): Promise<number> | --------------------- | ------------------------------------------- | | Promise<number> | Promise对象，返回允许创建的系统帐号的最大数量。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1230,8 +1310,9 @@ getOsAccountConstraints(localId: number, callback: AsyncCallback<Array<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<Array<string>> | 错误码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<Array<OsAccountInfo>& | -------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- | | callback | AsyncCallback<Array<[OsAccountInfo](#osaccountinfo)>> | 是 | 回调函数。如果查询成功，err为null，data为已创建的所有系统帐号的信息列表；否则为错误对象。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1346,6 +1434,12 @@ queryAllCreatedOsAccounts(): Promise<Array<OsAccountInfo>> | ----------------------------------------------------------- | --------------------------------------------- | | Promise<Array<[OsAccountInfo](#osaccountinfo)>> | Promise对象，返回已创建的所有系统帐号的信息列表。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1375,6 +1469,12 @@ getActivatedOsAccountIds(callback: AsyncCallback<Array<number>>): vo | -------- | ---------------------------------------- | ---- | ------------------------------------------------------ | | callback | AsyncCallback<Array<number>> | 是 | 回调函数。如果查询成功，err为null，data为当前处于激活状态的系统帐号的ID列表；否则为错误对象。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1406,6 +1506,12 @@ getActivatedOsAccountIds(): Promise<Array<number>> | :--------------------------------- | :------------------------------------------------ | | Promise<Array<number>> | Promise对象，返回当前处于激活状态的系统帐号的ID列表。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1442,8 +1548,14 @@ createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback& | callback | AsyncCallback<[OsAccountInfo](#osaccountinfo)> | 是 | 回调函数。如果创建成功，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<OsAccountInf | Promise<[OsAccountInfo](#osaccountinfo)> | 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<[OsAccountInfo](#osaccountinfo)> | 是 | 回调函数。如果创建成功，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<[OsAccountInfo](#osaccountinfo)> | 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<OsAccountInfo>): void | -------- | ---------------------------------------------------- | ---- | ---------------------------------------------- | | callback | AsyncCallback<[OsAccountInfo](#osaccountinfo)> | 是 | 回调函数。如果查询成功，err为null，data为当前进程所属的系统帐号信息；否则为错误对象。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1633,6 +1769,12 @@ getCurrentOsAccount(): Promise<OsAccountInfo> | ---------------------------------------------- | ----------------------------------------- | | Promise<[OsAccountInfo](#osaccountinfo)> | Promise对象，返回当前进程所属的系统帐号信息。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1668,10 +1810,12 @@ queryOsAccountById(localId: number, callback: AsyncCallback<OsAccountInfo> | callback | AsyncCallback<[OsAccountInfo](#osaccountinfo)> | 是 | 回调函数。如果查询成功，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<OsAccountInfo> | Promise<[OsAccountInfo](#osaccountinfo)> | 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<OsAccountType>): void | -------- | ---------------------------------------------------- | ---- | ---------------------------------------------------- | | callback | AsyncCallback<[OsAccountType](#osaccounttype)> | 是 | 回调函数。如果查询成功，err为null，data为当前进程所属的系统帐号的帐号类型；否则为错误对象。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1776,6 +1928,12 @@ getOsAccountType(): Promise<OsAccountType> | ---------------------------------------------- | ----------------------------------------------- | | Promise<[OsAccountType](#osaccounttype)> | Promise对象，返回当前进程所属的系统帐号的帐号类型。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1797,7 +1955,7 @@ queryDistributedVirtualDeviceId(callback: AsyncCallback<string>): 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<string>): void | -------- | --------------------------- | ---- | --------------------------------------------------------------------- | | callback | AsyncCallback<string> | 是 | 回调函数。如果获取成功，err为null，data为分布式虚拟设备ID；否则为错误对象。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1827,7 +1991,7 @@ queryDistributedVirtualDeviceId(): Promise<string> 获取分布式虚拟设备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<string> | --------------------- | --------------------------------- | | Promise<string> | Promise对象，返回分布式虚拟设备ID。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -1872,10 +2042,12 @@ getOsAccountProfilePhoto(localId: number, callback: AsyncCallback<string>) | callback | AsyncCallback<string> | 是 | 回调函数。如果获取成功，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<string> | Promise<string> | 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<void> | 是 | 回调结果。 | **错误码：** + | 错误码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<void> **返回值：** | 类型 | 说明 | -| :------------------ | :----------------------------------- | +| ------------------- | ------------------------------------ | | Promise<void> | 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<number> | 是 | 回调函数。如果成功，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<number> **返回值：** | 类型 | 说明 | -| :-------------------- | :------------------- ----------------------- | +| --------------------- | -------------------------------------------- | | Promise<number> | 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< | 错误码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<number> | 错误码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<number&g | name | string | 是 | 订阅名称，可自定义，要求非空且长度不超过1024字节。 | | callback | Callback<number> | 是 | 订阅系统帐号变动信息的回调，表示当前事件对应的系统帐号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<number | name | string | 是 | 订阅名称，可自定义，，要求非空且长度不超过1024字节，需要与订阅接口传入的值保持一致。 | | callback | Callback<number> | 否 | 取消订阅系统帐号变化的回调，默认返回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<number>): void; | uid | number | 是 | 进程uid。 | | callback | AsyncCallback<number> | 是 | 回调函数。如果查询成功，err为null，data为与uid对应的bundleId；否则为错误对象。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | +| 12300002 | Invalid uid. | + **示例：** ```js @@ -2310,6 +2521,13 @@ getBundleIdFromUid(uid: number): Promise<number>; | --------------------- | ------------------------------------ | | Promise<number> | Promise对象，返回与uid对应的bundleId。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | +| 12300002 | Invalid uid. | + **示例：** ```js @@ -2344,6 +2562,12 @@ isMainOsAccount(callback: AsyncCallback<boolean>): void; | -------- | ---------------------------- | ---- | ----------------------------------------------------------------- | | callback | AsyncCallback<boolean> | 是 | 回调函数，返回true表示当前帐号为主帐号，返回false表示当前帐号非主帐号。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -2375,6 +2599,12 @@ isMainOsAccount(): Promise<boolean>; | ---------------------- | --------------------------------------------------------------------- | | Promise<boolean> | Promise对象，返回true表示当前帐号为主帐号，返回false表示当前帐号非主帐号。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | + **示例：** ```js @@ -2409,6 +2639,14 @@ queryOsAccountConstraintSourceTypes(localId: number, constraint: string, callbac | constraint | string | 是 | 要查询的[约束](#系统帐号约束列表)名称 | | callback | AsyncCallback<Array<[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)>> | 是 | 回调函数。如果成功，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<Array<[ConstraintSourceTypeInfo](#constraintsourcetypeinfo)>> | Promise对象，返回指定系统帐号的指定[约束](#系统帐号约束列表)来源信息。 | +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ------------- | +| 12300001 | System service exception. | +| 12300002 | Invalid localId or constraint. | +| 12300003 | Account not found. | + **示例：** ```js @@ -2485,7 +2731,7 @@ isMultiOsAccountEnable(callback: AsyncCallback<boolean>): 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<boolean>): 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<string>): 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<string> > > 从 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(); ``` - ### getVersion8+ 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<ExecutorProp **参数：** | 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------------------- | ---- | ---------------------------------- | +| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------ | | request | [GetPropertyRequest](#getpropertyrequest8) | 是 | 请求信息，包括认证类型和属性类型列表。 | -| callback | AsyncCallback<[ExecutorProperty](#executorproperty8)> | 是 | 回调函数。如果获取成功，err为null，data为执行器属性信息；否则为错误对象。 | +| callback | AsyncCallback<[ExecutorProperty](#executorproperty8)> | 是 | 回调函数。如果获取成功，err为null，data为执行器属性信息；否则为错误对象。| + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | --------------------------- | +| 12300001 | System service exception. | +| 12300002 | Invalid request. | **示例：** ```js @@ -3692,6 +3953,13 @@ getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>; | :---------------------------------------------------------------- | :-------------------------------------------------- | | Promise<[ExecutorProperty](#executorproperty8)> | 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<number>): | request | [SetPropertyRequest](#setpropertyrequest8)| 是 | 请求信息，包括认证类型和要设置的密钥值。 | | callback | AsyncCallback<number> | 是 | 回调函数。如果设置成功，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<number>; | :-------------------- | :------------------------------------------------------------ | | Promise<number> | 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() ### registerInputer8+ -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<Uint8Array>): void; -打开会话，启动IDM操作以获取挑战值。使用callback异步回调。 +打开会话，获取挑战值。使用callback异步回调。 **系统接口：** 此接口为系统接口。 @@ -4043,6 +4363,12 @@ openSession(callback: AsyncCallback<Uint8Array>): void; | -------- | -------------------------------- | ---- | -------------------------------------------------------------- | | callback | AsyncCallback<Uint8Array> | 是 | 回调函数。如果打开会话成功，err为null，data为挑战值；否则为错误对象。| +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | --------------------------- | +| 12300001 | System service exception. | + **示例：** ```js let userIDM = new account_osAccount.UserIdentityManager(); @@ -4060,7 +4386,7 @@ openSession(callback: AsyncCallback<Uint8Array>): void; openSession(): Promise<Uint8Array>; -打开会话，启动IDM操作以获取挑战值。使用Promise异步回调。 +打开会话，获取挑战值。使用Promise异步回调。 **系统接口：** 此接口为系统接口。 @@ -4074,6 +4400,12 @@ openSession(): Promise<Uint8Array>; | :------------------------ | ----------------------- | | Promise<Uint8Array> | 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<Array<EnrolledCredInfo>>): void; | -------- | ------------------------------------------------------------------------ | ---- | --------------------------------------------- | | callback | AsyncCallback<Array<[EnrolledCredInfo](#enrolledcredinfo8)>> | 是 | 回调函数。如果成功，err为null，data为当前用户指定类型的所有已注册凭据信息；否则为错误对象。| +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | --------------------- | +| 12300001 | System service exception. | +| 12300102 | Credential not found. | **示例：** ```js @@ -4367,7 +4745,10 @@ getAuthInfo(authType: AuthType, callback: AsyncCallback<Array<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<Array<EnrolledCredInfo>>; **返回值：** | 类型 | 说明 | -| :------------------------------------------- | :------------------------------------------------------------ ---------- | +| :------------------------------------------- | :----------------------------------------------------------------------- | | Promise<Array<[EnrolledCredInfo](#enrolledcredinfo8)>> | 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 | 是 | 指示认证令牌。 | ## RequestResult8+ diff --git a/zh-cn/application-dev/reference/errorcodes/errcode-Account.md b/zh-cn/application-dev/reference/errorcodes/errcode-Account.md index e176a23a6f7d23a11f5a3afd3990649183c10d98..26baf2f9e9954af7ae89022507f53445ed5a994b 100644 --- a/zh-cn/application-dev/reference/errorcodes/errcode-Account.md +++ b/zh-cn/application-dev/reference/errorcodes/errcode-Account.md @@ -1,6 +1,6 @@ # 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. 按照规范开发应用认证器； diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-app-account.md b/zh-cn/application-dev/reference/errorcodes/errorcode-app-account.md index e9d1820c857b5bf10b2424e3aca47f9e96460033..a9751d48fadbb8227537ccff2f65708638c89325 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-app-account.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-app-account.md @@ -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. 请取消设置操作，或者撤销已存在的访问/开放授权后再设置。