From 9c23c8854408835947367e4a0473e3d93e1e25fe Mon Sep 17 00:00:00 2001 From: libing23 Date: Tue, 18 Oct 2022 00:22:26 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9appaccount=E6=A0=BC=E5=BC=8F?= =?UTF-8?q?=20Signed-off-by:=20libing=20?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../reference/apis/js-apis-appAccount.md | 4495 +++++++++-------- .../apis/js-apis-distributed-account.md | 68 +- .../reference/apis/js-apis-osAccount.md | 6 +- 3 files changed, 2572 insertions(+), 1997 deletions(-) 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 cbe6af5410..a11141d837 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appAccount.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appAccount.md @@ -40,7 +40,7 @@ createAppAccountManager(): AppAccountManager createAccount(name: string, callback: AsyncCallback<void>): void; -将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。 +将此应用的帐号名添加到帐号管理服务中。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -49,7 +49,16 @@ createAccount(name: string, callback: AsyncCallback<void>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | -------------------- | | name | string | 是 | 要添加的应用帐号名称。 | -| callback | AsyncCallback<void> | 是 | 将此应用的帐号名添加到帐号管理服务回调。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当此应用的帐号名添加到帐号管理服务成功时，err为undefined，否则为错误对象。 | + +**错误码：** + + | 错误码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. | **示例：** @@ -66,9 +75,9 @@ createAccount(name: string, callback: AsyncCallback<void>): void; ### createAccount9+ -createAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void +createAccount(name: string, options: CreateAccountOptions, callback: AsyncCallback<void>): void -将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中，使用callback回调异步返回结果。 +将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -77,15 +86,29 @@ createAccount(name: string, extraInfo: string, callback: AsyncCallback<void&g | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | ---------------------------------------- | | name | string | 是 | 要添加的应用帐号名称。 | -| extraInfo | string | 是 | 要添加的应用帐号的额外信息(能转换string类型的其它信息，如token等)，额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | -| callback | AsyncCallback<void> | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中回调。 | +| options | [CreateAccountOptions](#createaccountoptions9) | 是 | 要添加的应用帐号的选项，选项中不能包含应用帐号的敏感信息（如应用帐号密码）。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当此应用程序的帐号名和额外信息添加到帐号管理服务成功时，err为undefined，否则为错误对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.createAccount("LiSi", "token101", (err) => { + var option : CreateAccountOptions = { + customData: { + "age":10 + } + } + appAccountManager.createAccount("LiSi", option, (err) => { console.log("createAccount err: " + JSON.stringify(err)); }); } catch (err) { @@ -97,7 +120,7 @@ createAccount(name: string, extraInfo: string, callback: AsyncCallback<void&g createAccount(name: string, extraInfo?: string): Promise<void> -将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中，使用Promise方式异步返回结果。 +将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -106,20 +129,34 @@ createAccount(name: string, extraInfo?: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------------------------------------- | | name | string | 是 | 要添加的应用帐号名称。 | -| extraInfo | string | 否 | 要添加的应用帐号的额外信息（能转换成string类型的其它信息），额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | +| options | [CreateAccountOptions](#createaccountoptions9) | 否 | 要添加的应用帐号的选项，选项中不能包含应用帐号的敏感信息（如应用帐号密码），不填写不附带选项信息。 | **返回值：** | 类型 | 说明 | | ------------------- | --------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.createAccount("LiSi", "token101").then(()=> { + var option : CreateAccountOptions = { + customData: { + "age":10 + } + } + appAccountManager.createAccount("LiSi", option).then(()=> { console.log('createAccount Success'); }).catch((err) => { console.log("createAccount err: " + JSON.stringify(err)); @@ -129,98 +166,6 @@ createAccount(name: string, extraInfo?: string): Promise<void> } ``` -### addAccount(deprecated) - -addAccount(name: string, callback: AsyncCallback<void>): void - -将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。 - -> **说明：** -> 从API version 9开始废弃, 建议使用[createAccount](#createaccount9)替代 -> -> 从 API version 7开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | -------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| callback | AsyncCallback<void> | 是 | 将此应用的帐号名添加到帐号管理服务回调。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.addAccount("WangWu", (err) => { - console.log("addAccount err: " + JSON.stringify(err)); - }); - ``` - -### addAccount(deprecated) - -addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void - -将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中，使用callback回调异步返回结果。 - -> **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-1)替代 -> 从 API version 7开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------------------------- | ---- | ---------------------------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| extraInfo | string | 是 | 要添加的应用帐号的额外信息(能转换string类型的其它信息，如token等)，额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | -| callback | AsyncCallback<void> | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中回调。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.addAccount("LiSi", "token101", (err) => { - console.log("addAccount err: " + JSON.stringify(err)); - }); - ``` - -### addAccount(deprecated) - -addAccount(name: string, extraInfo?: string): Promise<void> - -将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中，使用Promise方式异步返回结果。 - -> **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-2)替代 -> 从 API version 7开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------ | ---- | ---------------------------------------- | -| name | string | 是 | 要添加的应用帐号名称。 | -| extraInfo | string | 否 | 要添加的应用帐号的额外信息（能转换成string类型的其它信息），额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------- | --------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.addAccount("LiSi", "token101").then(()=> { - console.log('addAccount Success'); - }).catch((err) => { - console.log("addAccount err: " + JSON.stringify(err)); - }); - ``` - ### createAccountImplicitly9+ createAccountImplicitly(owner: string, callback: AuthCallback): void @@ -236,6 +181,15 @@ createAccountImplicitly(owner: string, callback: AuthCallback): void | 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. | + **示例：** ```js @@ -280,6 +234,15 @@ createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, | 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. | + **示例：** ```js @@ -310,56 +273,11 @@ createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, ``` -### addAccountImplicitly(deprecated) - -addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void - -根据指定的帐号所有者、鉴权类型和可选项隐式地添加应用帐号，并使用callback回调异步返回结果。 - -> **说明：** 从API version 9开始废弃, 建议使用[createAccountImplicitly](#createaccountimplicitly9)替代。 -> -> 从 API version 8开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ---- | ----------------------- | -| owner | string | 是 | 要添加的应用帐号所有者包名。 | -| authType | string | 是 | 要添加的应用帐号鉴权类型。鉴权类型为自定义。 | -| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。可选项可根据自己需要设置。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 | - -**示例：** - - ```js - import featureAbility from '@ohos.ability.featureAbility'; - - function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); - } - - function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); - }); - } - - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.addAccountImplicitly("com.example.ohos.accountjsdemo", "getSocialData", {}, { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback - }); - ``` - ### removeAccount9+ removeAccount(name: string, callback: AsyncCallback<void>): void -从帐号管理服务中移除应用帐号，使用callback回调异步返回结果。 +从帐号管理服务中移除应用帐号。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -368,7 +286,15 @@ removeAccount(name: string, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------- | | name | string | 是 | 要删除的应用帐号名称。 | -| callback | AsyncCallback<void> | 是 | 帐号管理服务中移除应用帐号的回调。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当帐号管理服务中移除应用帐号成功时，err为undefined，否则为错误对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name. | + | 12300003 | the account indicated by name dose not exist. | **示例：** @@ -388,7 +314,7 @@ removeAccount(name: string, callback: AsyncCallback<void>): void deleteAccount(name: string): Promise<void> -从帐号管理服务中移除应用帐号，使用Promise方式异步返回结果。 +从帐号管理服务中移除应用帐号。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -402,7 +328,15 @@ deleteAccount(name: string): Promise<void> | 类型 | 说明 | | :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name. | + | 12300003 | the account indicated by name dose not exist. | **示例：** @@ -420,69 +354,6 @@ deleteAccount(name: string): Promise<void> ``` -### deleteAccount(deprecated) - -deleteAccount(name: string, callback: AsyncCallback<void>): void - -从帐号管理服务中删除应用帐号，使用callback回调异步返回结果。 - -> **说明：** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。 -> -> 从 API version 7开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ---------------- | -| name | string | 是 | 要删除的应用帐号名称。 | -| callback | AsyncCallback<void> | 是 | 帐号管理服务中删除应用帐号回调。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.deleteAccount("ZhaoLiu", (err) => { - console.log("deleteAccount err: " + JSON.stringify(err)); - }); - ``` - -### deleteAccount(deprecated) - -deleteAccount(name: string): Promise<void> - -从帐号管理服务中删除应用帐号，使用Promise方式异步返回结果。 - -> **说明：** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。 -> -> 从 API version 7开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ----------- | -| name | string | 是 | 要删除的应用帐号名称。 | - -**返回值：** - -| 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.deleteAccount("ZhaoLiu").then(() => { - console.log('deleteAccount Success'); - }).catch((err) => { - console.log("deleteAccount err: " + JSON.stringify(err)); - }); - ``` - ### setAppAccess9+ setAppAccess(name: string, bundleName: string, isAccessible: boolean, callback: AsyncCallback<void>): void @@ -500,6 +371,15 @@ setAppAccess(name: string, bundleName: string, isAccessible: boolean, callback: | isAccessible | boolean | 是 | 访问控制，允许访问或禁止访问。 | | callback | AsyncCallback<void> | 是 | 访问权限设置的回调。 | +**错误码：** + + | 错误码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. | + **示例：** ```js @@ -518,7 +398,7 @@ setAppAccess(name: string, bundleName: string, isAccessible: boolean, callback: setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise<void> -设置指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，由isAccessible指明是允许访问还是禁止访问，使用Promise方式异步返回结果。 +设置指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，由isAccessible指明是允许访问还是禁止访问。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -534,7 +414,16 @@ setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise&l | 类型 | 说明 | | :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码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. | **示例：** @@ -551,15 +440,11 @@ setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise&l } ``` -### disableAppAccess(deprecated) - -disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void +### checkAppAccess9+ -禁止指定第三方应用帐号名称对指定的第三方应用进行访问，使用callback回调异步返回结果。 +checkAppAccess(name: string, bundleName: string, callback: AsyncCallback<boolean>): void -> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。 -> -> 从 API version 7开始支持。 +查看指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount @@ -567,170 +452,62 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<vo | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | --------------------------------- | -| name | string | 是 | 要禁用访问的第三方应用帐号名称。 | +| name | string | 是 | 应用帐号名称。 | | bundleName | string | 是 | 第三方应用的包名。 | -| callback | AsyncCallback<void> | 是 | 禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问的回调。 | +| callback | AsyncCallback<void> | 是 | 查看访问权限的回调。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { - console.log("disableAppAccess err: " + JSON.stringify(err)); - }); - ``` + try { + appAccountManager.checkAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { + console.log("checkAppAccess: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("checkAppAccess: " + JSON.stringify(err)); + } -### disableAppAccess(deprecated) + ``` -disableAppAccess(name: string, bundleName: string): Promise<void> +### checkAppAccess9+ -禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问，使用Promise方式异步返回结果。 +checkAppAccess(name: string, bundleName: string): Promise<void> -> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。 -> -> 从 API version 7开始支持。 +查看指定第三方应用帐号名称对指定包名称的第三方应用的访问权限。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------ | ---- | ---------------- | -| name | string | 是 | 要禁用访问的第三方应用帐号名称。 | -| bundleName | string | 是 | 第三方应用的包名。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | --------- | +| name | string | 是 | 应用帐号名称。 | +| bundleName | string | 是 | 第三方应用的包名。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | -**示例：** +**错误码：** - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { - console.log('disableAppAccess Success'); - }).catch((err) => { - console.log("disableAppAccess err: " + JSON.stringify(err)); - }); - ``` - -### enableAppAccess(deprecated) - -enableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void - -允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问，使用callback回调异步返回结果。 - -> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。 -> -> 从 API version 7开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------------- | ---- | --------------------------------- | -| name | string | 是 | 应用帐号名称。 | -| bundleName | string | 是 | 第三方应用的包名。 | -| callback | AsyncCallback<void> | 是 | 允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问的回调。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { - console.log("enableAppAccess: " + JSON.stringify(err)); - }); - ``` - -### enableAppAccess(deprecated) - -enableAppAccess(name: string, bundleName: string): Promise<void> - -允许指定第三方应用帐号的名称对指定包名称的第三方应用进行访问，使用Promise方式异步返回结果。 - -> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。 -> -> 从 API version 7开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| bundleName | string | 是 | 第三方应用的包名。 | - -**返回值：** - -| 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { - console.log('enableAppAccess Success'); - }).catch((err) => { - console.log("enableAppAccess err: " + JSON.stringify(err)); - }); - ``` - -### checkAppAccess9+ - -checkAppAccess(name: string, bundleName: string, callback: AsyncCallback<boolean>): void - -查看指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，callback回调异步返回结果。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------------- | ---- | --------------------------------- | -| name | string | 是 | 应用帐号名称。 | -| bundleName | string | 是 | 第三方应用的包名。 | -| callback | AsyncCallback<void> | 是 | 查看访问权限的回调。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.checkAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { - console.log("checkAppAccess: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("checkAppAccess: " + JSON.stringify(err)); - } - - ``` - -### checkAppAccess9+ - -checkAppAccess(name: string, bundleName: string): Promise<void> - -查看指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，使用Promise方式异步返回结果。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| bundleName | string | 是 | 第三方应用的包名。 | - -**返回值：** - -| 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | + | 错误码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. | **示例：** @@ -752,7 +529,7 @@ checkAppAccess(name: string, bundleName: string): Promise<void> checkDataSyncEnabled(name: string, callback: AsyncCallback<boolean>): void -检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。 +检查指定应用帐号是否允许应用数据同步。使用callback异步回调。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC @@ -763,7 +540,15 @@ checkDataSyncEnabled(name: string, callback: AsyncCallback<boolean>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------- | ---- | --------------------- | | name | string | 是 | 应用帐号名称。 | -| callback | AsyncCallback<boolean> | 是 | 检查指定应用帐号是否允许应用数据同步回调。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示指定应用帐号允许应用数据同步；返回false表示指定应用帐号不允许应用数据同步。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name. | + | 12300003 | the account indicated by localId dose not exist. | **示例：** @@ -784,7 +569,7 @@ checkDataSyncEnabled(name: string, callback: AsyncCallback<boolean>): void checkDataSyncEnabled(name: string): Promise<boolean> -检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。 +检查指定应用帐号是否允许应用数据同步。使用Promise异步回调。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC @@ -800,7 +585,15 @@ checkDataSyncEnabled(name: string): Promise<boolean> | 类型 | 说明 | | :--------------------- | :-------------------- | -| Promise<boolean> | Promise实例，用于获取异步返回结果。 | +| Promise<boolean> | Promise对象。返回true表示允许应用数据同步；返回false表示不允许应用数据同步。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name. | + | 12300003 | the account indicated by localId dose not exist. | **示例：** @@ -818,79 +611,11 @@ checkDataSyncEnabled(name: string): Promise<boolean> ``` -### checkAppAccountSyncEnable(deprecated) - -checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): void - -检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。 - -> **说明：** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9)替代。 -> -> 从 API version 7开始支持。 - -**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------- | ---- | --------------------- | -| name | string | 是 | 应用帐号名称。 | -| callback | AsyncCallback<boolean> | 是 | 检查指定应用帐号是否允许应用数据同步回调。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { - console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err)); - console.log('checkAppAccountSyncEnable result: ' + result); - }); - ``` - -### checkAppAccountSyncEnable(deprecated) - -checkAppAccountSyncEnable(name: string): Promise<boolean> - -检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。 - -> **说明：** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9-1)替代。 -> -> 从 API version 7开始支持。 - -**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ------- | -| name | string | 是 | 应用帐号名称。 | - -**返回值：** - -| 类型 | 说明 | -| :--------------------- | :-------------------- | -| Promise<boolean> | Promise实例，用于获取异步返回结果。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { - console.log('checkAppAccountSyncEnable, result: ' + data); - }).catch((err) => { - console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err)); - }); - ``` - ### setCredential9+ setCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void -设置此应用程序帐号的凭据，使用callback回调异步返回结果。 +设置此应用程序帐号的凭据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount @@ -901,7 +626,15 @@ setCredential(name: string, credentialType: string, credential: string,callback: | name | string | 是 | 应用程序帐号名称。 | | credentialType | string | 是 | 要设置的凭据类型。 | | credential | string | 是 | 要设置的凭据。 | -| callback | AsyncCallback<void> | 是 | 设置此应用帐号的凭据回调。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置此应用程序帐号的凭据成功时，err为undefined，否则为错误对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name or credentialType. | + | 12300003 | the account indicated by localId dose not exist. | **示例：** @@ -920,7 +653,7 @@ setCredential(name: string, credentialType: string, credential: string,callback: setCredential(name: string, credentialType: string, credential: string): Promise<void> -设置此应用程序帐号的凭据，使用Promise方式异步返回结果。 +设置此应用程序帐号的凭据。使用Promise异步回调。 > **说明：** 从API version 9开始废弃。 > @@ -940,7 +673,15 @@ setCredential(name: string, credentialType: string, credential: string): Promise | 类型 | 说明 | | :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name or credentialType. | + | 12300003 | the account indicated by localId dose not exist. | **示例：** @@ -957,2908 +698,3708 @@ setCredential(name: string, credentialType: string, credential: string): Promise } ``` + +### setDataSyncEnabled9+ -### setAccountCredential(deprecated) - -setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void +setDataSyncEnabled(name: string, isEnable: boolean, callback: AsyncCallback<void>): void -设置此应用程序帐号的凭据，使用callback回调异步返回结果。 +设置指定的应用程序帐号是否允许应用程序数据同步。使用callback异步回调。 -> **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9)替代。 -> -> 从 API version 7开始支持。 +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------------------------- | ---- | ------------- | -| name | string | 是 | 应用程序帐号名称。 | -| credentialType | string | 是 | 要设置的凭据类型。 | -| credential | string | 是 | 要设置的凭据。 | -| callback | AsyncCallback<void> | 是 | 设置此应用帐号的凭据回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------- | +| name | string | 是 | 应用帐号名称。 | +| isEnable | boolean | 是 | 是否允许应用数据同步。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当指定的应用帐号是否允许应用程序数据设置成功时，err为undefined，否则为错误对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name. | + | 12300003 | the account indicated by name dose not exist. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { - console.log("setAccountCredential err: " + JSON.stringify(err)); - }); + try { + appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => { + console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + } ``` -### setAccountCredential(deprecated) +### setDataSyncEnabled9+ -setAccountCredential(name: string, credentialType: string, credential: string): Promise<void> +setDataSyncEnabled(name: string, isEnable: boolean): Promise<void> -设置此应用程序帐号的凭据，使用Promise方式异步返回结果。 +设置指定的应用程序帐号是否允许应用程序数据同步。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9-1)替代。 -> -> 从 API version 7开始支持。 +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------ | ---- | ---------- | -| name | string | 是 | 应用帐号的名称。 | -| credentialType | string | 是 | 要设置的凭据的类型。 | -| credential | string | 是 | 要设置的凭据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------- | ---- | ----------- | +| name | string | 是 | 应用帐号名称。 | +| isEnable | boolean | 是 | 是否允许应用数据同步。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name. | + | 12300003 | the account indicated by name dose not exist. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001").then(() => { - console.log('setAccountCredential Success'); - }).catch((err) => { - console.log("setAccountCredential err: " + JSON.stringify(err)); - }); + try { + appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => { + console.log('setDataSyncEnabled Success'); + }).catch((err) => { + console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + } ``` -### setAccountExtraInfo(deprecated) +### setCustomData9+ -setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<void>): void - -设置此应用程序帐号的额外信息，使用callback回调异步返回结果。 - -> **说明：** 从API version 9开始废弃。 -> -> 从 API version 7开始支持。 +setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void +设置与此应用程序帐号关联的数据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------------------------- | ---- | --------------- | -| name | string | 是 | 应用帐号名称。 | -| extraInfo | string | 是 | 要设置的额外信息。 | -| callback | AsyncCallback<void> | 是 | 设置此应用帐号的额外信息回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ----------------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | +| value | string | 是 | 要设置的数据的值。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置与此应用帐号关联的数据成功时，err为undefined，否则为错误对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { - console.log("setAccountExtraInfo err: " + JSON.stringify(err)); - }); + try { + appAccountManager.setCustomData("ZhangSan", "k001", "v001", (err) => { + console.log("setCustomData err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("setCustomData err: " + JSON.stringify(err)); + } ``` -### setAccountExtraInfo(deprecated) - -setAccountExtraInfo(name: string, extraInfo: string): Promise<void> - -设置此应用程序帐号的额外信息，使用Promise方式异步返回结果。 +### setCustomData9+ -> **说明：** 从API version 9开始废弃。 -> -> 从 API version 7开始支持。 +setAssociatedData(name: string, key: string, value: string): Promise<void> +设置与此应用程序帐号关联的数据。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| extraInfo | string | 是 | 要设置的额外信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | +| value | string | 是 | 要设置的数据的值。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| Promise<void> | Promise对象。无返回结果的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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { - console.log('setAccountExtraInfo Success'); - }).catch((err) => { - console.log("setAccountExtraInfo err: " + JSON.stringify(err)); - }); + try { + appAccountManager.setCustomData("ZhangSan", "k001", "v001").then(() => { + console.log('setCustomData Success'); + }).catch((err) => { + console.log("setCustomData err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("setCustomData err: " + JSON.stringify(err)); + } ``` - -### setDataSyncEnabled9+ -setDataSyncEnabled(name: string, isEnable: boolean, callback: AsyncCallback<void>): void +### getAllAccounts9+ -设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。 +getAllAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void -**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC +获取全部应用已授权帐号信息。 + +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ------------------------- | -| name | string | 是 | 应用帐号名称。 | -| isEnable | boolean | 是 | 是否允许应用数据同步。 | -| callback | AsyncCallback<void> | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => { - console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + appAccountManager.getAllAccounts((err, data)=>{ + console.debug("getAllAccounts err:" + JSON.stringify(err)); + console.debug("getAllAccounts data:" + JSON.stringify(data)); }); } catch (err) { - console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + console.debug("getAllAccounts err:" + JSON.stringify(err)); } ``` -### setDataSyncEnabled9+ +### getAllAccounts9+ -setDataSyncEnabled(name: string, isEnable: boolean): Promise<void> +getAllAccounts(): Promise<Array<AppAccountInfo>> -设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。 +获取全部应用已授权帐号信息。 -**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount -**参数：** +**返回值：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------- | ---- | ----------- | -| name | string | 是 | 应用帐号名称。 | -| isEnable | boolean | 是 | 是否允许应用数据同步。 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象。返回全部应用已授权帐号信息对象。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => { - console.log('setDataSyncEnabled Success'); + appAccountManager.getAllAccounts().then((data) => { + console.log('getAllAccounts: ' + data); }).catch((err) => { - console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + console.log("getAllAccounts err: " + JSON.stringify(err)); }); } catch (err) { - console.log("setDataSyncEnabled err: " + JSON.stringify(err)); + console.log("getAllAccounts err: " + JSON.stringify(err)); } ``` -### setAppAccountSyncEnable(deprecated) - -setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback<void>): void +### getAccountsByOwner9+ -设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。 +getAccountsByOwner(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void -> **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9)替代。 -> -> 从 API version 7开始支持。 +获取指定应用全部帐号信息。 -**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ------------------------- | -| name | string | 是 | 应用帐号名称。 | -| isEnable | boolean | 是 | 是否允许应用数据同步。 | -| callback | AsyncCallback<void> | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| owner | string | 是 | 应用包名称。 | +| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid owner. | + | 12300003 | the account indicated by owner dose not exist. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { - console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); - }); + const selfBundle = "com.example.actsgetallaaccounts"; + try { + appAccountManager.getAccountsByOwner(selfBundle, (err, data)=>{ + console.debug("getAccountsByOwner err:" + JSON.stringify(err)); + console.debug("getAccountsByOwner data:" + JSON.stringify(data)); + }); + } catch (err) { + console.debug("getAccountsByOwner err:" + JSON.stringify(err)); + } ``` -### setAppAccountSyncEnable(deprecated) - -setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> +### getAccountsByOwner9+ -设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。 +getAccountsByOwner(owner: string): Promise<Array<AppAccountInfo>> -> **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9-1)替代。 -> -> 从 API version 7开始支持。 +获取指定应用全部帐号信息。 -**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------- | ---- | ----------- | -| name | string | 是 | 应用帐号名称。 | -| isEnable | boolean | 是 | 是否允许应用数据同步。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ------ | +| owner | string | 是 | 应用包名称。 | **返回值：** -| 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象。返回指定应用全部帐号信息对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid owner. | + | 12300003 | the account indicated by owner dose not exist. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { - console.log('setAppAccountSyncEnable Success'); - }).catch((err) => { - console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); - }); + const selfBundle = "com.example.actsgetallaaccounts"; + try { + appAccountManager.getAccountsByOwner(selfBundle).then((data) => { + console.log('getAccountsByOwner: ' + data); + }).catch((err) => { + console.log("getAccountsByOwner err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("getAccountsByOwner err: " + 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回调异步返回结果。 +获取此应用帐号的凭据（如数字密码、人脸和PIN码等）。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | -| value | string | 是 | 要设置的数据的值。 | -| callback | AsyncCallback<void> | 是 | 设置与此应用帐号关联的数据的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | --------------------------- | ---- | -------------- | +| name | string | 是 | 应用帐号名称。 | +| credentialType | string | 是 | 获取此应用帐号的凭据的类型。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取此应用帐号的凭据成功时，err为undefined，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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setCustomData("ZhangSan", "k001", "v001", (err) => { - console.log("setCustomData err: " + JSON.stringify(err)); - }); + appAccountManager.getCredential("ZhangSan", "credentialType001", (err, result) => { + console.log("getCredential err: " + JSON.stringify(err)); + console.log('getCredential 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<string> | Promise对象。返回此应用程序帐号的凭据对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name or credentialType. | + | 12300003 | the account indicated by name dose not exist. | + | 12300019 | credential does not exist. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.setCustomData("ZhangSan", "k001", "v001").then(() => { - console.log('setCustomData Success'); + appAccountManager.getCredential("ZhangSan", "credentialType001").then((data) => { + console.log('getCredential, result: ' + data); }).catch((err) => { - console.log("setCustomData err: " + JSON.stringify(err)); + console.log("getCredential err: " + JSON.stringify(err)); }); } catch (err) { - console.log("setCustomData err: " + JSON.stringify(err)); + console.log("getCredential err: " + JSON.stringify(err)); } ``` -### setAssociatedData(deprecated) - -setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void - -设置与此应用程序帐号关联的数据，使用callback回调异步返回结果。 +### getCustomData9+ -> **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9)替代。 -> -> 从 API version 7开始支持。 +getCustomData(name: string, key: string, callback: AsyncCallback<string>): void +获取与此应用程序帐号关联的数据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | -| value | string | 是 | 要设置的数据的值。 | -| callback | AsyncCallback<void> | 是 | 设置与此应用帐号关联的数据的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ----------------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要获取的数据的键。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取与此应用程序帐号关联的数据成功时，err为undefined，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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { - console.log("setAssociatedData err: " + JSON.stringify(err)); - }); + try { + appAccountManager.getCustomData("ZhangSan", "k001", (err, result) => { + console.log("getCustomData err: " + JSON.stringify(err)); + console.log('getCustomData result: ' + result); + }); + } catch (err) { + console.log("getCustomData err: " + JSON.stringify(err)); + } ``` -### setAssociatedData(deprecated) - -setAssociatedData(name: string, key: string, value: string): Promise<void> - -设置与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 +### getCustomData9+ -> **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9-1)替代。 -> -> 从 API version 7开始支持。 +getCustomData(name: string, key: string): Promise<string> +获取与此应用程序帐号关联的数据。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | -| value | string | 是 | 要设置的数据的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要获取的数据的键。 | **返回值：** -| 类型 | 说明 | -| :------------------ | :-------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { - console.log('setAssociatedData Success'); - }).catch((err) => { - console.log("setAssociatedData err: " + JSON.stringify(err)); - }); - ``` - -### getAllAccounts9+ - -getAllAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void - -获取全部应用已授权帐号信息。 - -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 - -**系统能力：** SystemCapability.Account.AppAccount +| 类型 | 说明 | +| :-------------------- | :-------------------- | +| Promise<string> | Promise对象。返回与此应用程序帐号关联的数据对象。 | -**参数：** +**错误码：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | --------- | -| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAllAccounts((err, data)=>{ - console.debug("getAllAccounts err:" + JSON.stringify(err)); - console.debug("getAllAccounts data:" + JSON.stringify(data)); + appAccountManager.getCustomData("ZhangSan", "k001").then((data) => { + console.log('getCustomData: ' + data); + }).catch((err) => { + console.log("getCustomData err: " + JSON.stringify(err)); }); } catch (err) { - console.debug("getAllAccounts err:" + JSON.stringify(err)); + console.log("getCustomData err: " + JSON.stringify(err)); } ``` -### getAllAccounts9+ - -getAllAccounts(): Promise<Array<AppAccountInfo>> +### getCustomDataSync9+ -获取全部应用已授权帐号信息。 +getCustomDataSync(name: string, key: string): string; -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +获取与此应用程序帐号关联的数据，使用同步方式返回结果。 **系统能力：** SystemCapability.Account.AppAccount +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要获取的数据的键。 | + **返回值：** -| 类型 | 说明 | -| ---------------------------------------- | --------------------- | -| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :-------------------- | :-------------------- | +| string | 目标关联数据的取值。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name or key. | + | 12300003 | the account indicated by name dose not exist. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getAllAccounts().then((data) => { - console.log('getAllAccounts: ' + data); - }).catch((err) => { - console.log("getAllAccounts err: " + JSON.stringify(err)); - }); + var backData = appAccountManager.getCustomDataSync("ZhangSan", "k001"); + console.info("getCustomDataSync backData:" + JSON.stringify(backData)); } catch (err) { - console.log("getAllAccounts err: " + JSON.stringify(err)); + console.error(`getCustomDataSync err, code is ${e.code}, message is ${e.message}`); } ``` -### getAllAccessibleAccounts(deprecated) - -getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void - -获取全部应用已授权帐号信息。 +### on('accountChange')9+ -> **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9)替代。 -> -> 从 API version 7开始支持。 +on(type: 'accountChange', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +订阅指定帐号所有者的帐户变更事件。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | --------- | -| callback | AsyncCallback<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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAllAccessibleAccounts((err, data)=>{ - console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err)); - console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data)); - }); + function changeOnCallback(data){ + console.debug("receive change data:" + JSON.stringify(data)); + } + try{ + appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback); + } + catch(err){ + console.error("on accountOnOffDemo err:" + JSON.stringify(err)); + } ``` -### getAllAccessibleAccounts(deprecated) +### off('accountChange')9+ -getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>> +off(type: 'accountChange', callback?: Callback>): void -获取全部应用已授权帐号信息。 +取消订阅帐号事件。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9-1)替代。 -> -> 从 API version 7开始支持。 +**系统能力：** SystemCapability.Account.AppAccount -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +**参数：** -**系统能力：** SystemCapability.Account.AppAccount +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ------------ | +| type | 'accountChange' | 是 | 事件回调类型，支持的事件为'accountChange'，当帐号所有者更新帐号时，触发该事件。 | +| callback | Callback> | 否 | 回调函数，返回指定帐号所有者更新的帐号信息数组。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ---------------------------------------- | --------------------- | -| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise实例，用于获取异步返回结果。 | + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid type. | + | 12300005 | the listener has been registered. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAllAccessibleAccounts().then((data) => { - console.log('getAllAccessibleAccounts: ' + data); - }).catch((err) => { - console.log("getAllAccessibleAccounts err: " + JSON.stringify(err)); - }); + function changeOnCallback(data){ + console.debug("receive change data:" + JSON.stringify(data)); + appAccountManager.off('accountChange', function(){ + console.debug("off finish"); + }) + } + try{ + appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback); + } + catch(err){ + console.error("on accountOnOffDemo err:" + JSON.stringify(err)); + } ``` -### getAccountsByOwner9+ - -getAccountsByOwner(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void +### auth9+ -获取指定应用全部帐号信息。 +auth(name: string, owner: string, authType: string, callback: AuthCallback): void -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +对应用帐户进行鉴权以获取Auth令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | --------- | -| owner | string | 是 | 应用包名称。 | -| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | --------------- | +| name | string | 是 | 要鉴权的应用帐号名称。 | +| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| 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. | **示例：** ```js + import featureAbility from '@ohos.ability.featureAbility'; + + function onResultCallback(code, result) { + console.log("resultCode: " + code); + console.log("result: " + JSON.stringify(result)); + } + + function onRequestRedirectedCallback(request) { + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err)=>{ + console.log("startAbility err: " + JSON.stringify(err)); + }); + } + const appAccountManager = account_appAccount.createAppAccountManager(); - const selfBundle = "com.example.actsgetallaaccounts"; try { - appAccountManager.getAccountsByOwner(selfBundle, (err, data)=>{ - console.debug("getAccountsByOwner err:" + JSON.stringify(err)); - console.debug("getAccountsByOwner data:" + JSON.stringify(data)); + appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback }); } catch (err) { - console.debug("getAccountsByOwner err:" + JSON.stringify(err)); + console.log("auth err: " + JSON.stringify(err)); } ``` -### getAccountsByOwner9+ - -getAccountsByOwner(owner: string): Promise<Array<AppAccountInfo>> +### auth9+ -获取指定应用全部帐号信息。 +auth(name: string, owner: string, authType: string, options: {[key: string]: Object}, callback: AuthCallback): void -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +对应用帐户进行鉴权以获取OAuth令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ------ | -| owner | string | 是 | 应用包名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | --------------- | +| name | string | 是 | 要鉴权的应用帐号名称。 | +| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| options | {[key: string]: Object} | 是 | 鉴权所需的可选项。 | +| callback | [AuthCallback](#authcallback9) | 是 | 回调函数。返回鉴权结果对象。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ---------------------------------------- | --------------------- | -| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise实例，用于获取异步返回结果。 | + | 错误码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. | **示例：** ```js + import featureAbility from '@ohos.ability.featureAbility'; + + function onResultCallback(code, result) { + console.log("resultCode: " + code); + console.log("result: " + JSON.stringify(result)); + } + + function onRequestRedirectedCallback(request) { + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err)=>{ + console.log("startAbility err: " + JSON.stringify(err)); + }); + } + const appAccountManager = account_appAccount.createAppAccountManager(); - const selfBundle = "com.example.actsgetallaaccounts"; try { - appAccountManager.getAccountsByOwner(selfBundle).then((data) => { - console.log('getAccountsByOwner: ' + data); - }).catch((err) => { - console.log("getAccountsByOwner err: " + JSON.stringify(err)); + appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback }); } catch (err) { - console.log("getAccountsByOwner err: " + JSON.stringify(err)); + console.log("auth err: " + JSON.stringify(err)); } ``` -### getAllAccounts(deprecated) - -getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void - -获取指定应用全部帐号信息。 +### getAuthToken9+ -> **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner]替代。 -> -> 从 API version 7开始支持。 +getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +获取指定应用帐号和鉴权类型的Auth令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | --------- | -| owner | string | 是 | 应用包名称。 | -| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取指定应用帐号和鉴权类型的Auth令牌成功时，err为undefined，data返回Auth令牌对象；否则为错误对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - const selfBundle = "com.example.actsgetallaaccounts"; - appAccountManager.getAllAccounts(selfBundle, (err, data)=>{ - console.debug("getAllAccounts err:" + JSON.stringify(err)); - console.debug("getAllAccounts data:" + JSON.stringify(data)); - }); + try { + appAccountManager.getAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { + console.log('getAuthToken err: ' + JSON.stringify(err)); + console.log('getAuthToken token: ' + data); + }); + } catch (err) { + console.log('getAuthToken err: ' + JSON.stringify(err)); + } ``` -### getAllAccounts(deprecated) - -getAllAccounts(owner: string): Promise<Array<AppAccountInfo>> - -获取指定应用全部帐号信息。 +### getAuthToken9+ -> **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner](#getaccountsbyowner9-1)替代。 -> -> 从 API version 7开始支持。 +getAuthToken(name: string, owner: string, authType: string): Promise<string> -**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 +获取指定应用帐户和鉴权类型的Auth令牌。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ------ | -| owner | string | 是 | 应用包名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| authType | string | 是 | 鉴权类型。 | **返回值：** -| 类型 | 说明 | -| ---------------------------------------- | --------------------- | -| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| --------------------- | --------------------- | +| Promise<string> | Promise对象。返回指定应用帐户和鉴权类型的Auth令牌对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - const selfBundle = "com.example.actsgetallaaccounts"; - appAccountManager.getAllAccounts(selfBundle).then((data) => { - console.log('getAllAccounts: ' + data); - }).catch((err) => { - console.log("getAllAccounts err: " + JSON.stringify(err)); - }); + 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)); + }); + } catch (err) { + console.log("getAuthToken err: " + JSON.stringify(err)); + } ``` -### getCredential9+ +### setAuthToken9+ -getCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void +setAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void -获取此应用帐号的凭据（如数字密码、人脸和PIN码等），使用callback回调异步返回结果。 +设置指定应用帐号和鉴权类型的Auth令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | --------------------------- | ---- | -------------- | -| name | string | 是 | 应用帐号名称。 | -| credentialType | string | 是 | 获取此应用帐号的凭据的类型。 | -| callback | AsyncCallback<string> | 是 | 获取此应用帐号的凭据的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| token | string | 是 | Auth令牌。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定应用帐号和鉴权类型的Auth令牌成功时，err为undefined；否则为错误对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getCredential("ZhangSan", "credentialType001", (err, result) => { - console.log("getCredential err: " + JSON.stringify(err)); - console.log('getCredential result: ' + result); + appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => { + console.log('setAuthToken err: ' + JSON.stringify(err)); }); } catch (err) { - console.log("getCredential err: " + JSON.stringify(err)); + console.log('setAuthToken err: ' + JSON.stringify(err)); } ``` -### getCredential9+ +### setAuthToken9+ -getCredential(name: string, credentialType: string): Promise<string> +setAuthToken(name: string, authType: string, token: string): Promise<void> -获取此应用程序帐号的凭据，使用Promise方式异步返回结果。 +设置指定应用帐户和鉴权类型的Auth令牌。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------ | ---- | ---------- | -| name | string | 是 | 应用帐号名称。 | -| credentialType | string | 是 | 要获取的凭据的类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | -------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| token | string | 是 | Auth令牌。 | **返回值：** -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| Promise<string> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ------------------- | --------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getCredential("ZhangSan", "credentialType001").then((data) => { - console.log('getCredential, result: ' + data); + appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => { + console.log('setAuthToken successfully'); }).catch((err) => { - console.log("getCredential err: " + JSON.stringify(err)); + console.log('setAuthToken err: ' + JSON.stringify(err)); }); } catch (err) { - console.log("getCredential err: " + JSON.stringify(err)); + console.log('setAuthToken err: ' + JSON.stringify(err)); } ``` -### getAccountCredential(deprecated) - -getAccountCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void +### deleteAuthToken9+ -获取此应用帐号的凭据（如数字密码、人脸和PIN码等），使用callback回调异步返回结果。 +deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void -> **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9)替代。 -> -> 从 API version 7开始支持。 +删除指定应用帐户和鉴权类型的Auth令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | --------------------------- | ---- | -------------- | -| name | string | 是 | 应用帐号名称。 | -| credentialType | string | 是 | 获取此应用帐号的凭据的类型。 | -| callback | AsyncCallback<string> | 是 | 获取此应用帐号的凭据的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------ | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| token | string | 是 | 要删除的Auth令牌。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当删除指定应用帐户和鉴权类型的Auth令牌成功时，err为undefined；否则为错误对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { - console.log("getAccountCredential err: " + JSON.stringify(err)); - console.log('getAccountCredential result: ' + result); - }); + try { + appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => { + console.log('deleteAuthToken err: ' + JSON.stringify(err)); + }); + } catch (err) { + console.log('deleteAuthToken err: ' + JSON.stringify(err)); + } ``` -### getAccountCredential(deprecated) - -getAccountCredential(name: string, credentialType: string): Promise<string> +### deleteAuthToken9+ -获取此应用程序帐号的凭据，使用Promise方式异步返回结果。 +deleteAuthToken(name: string, owner: string, authType: string, token: string): Promise<void> -> **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9-1)替代。 -> -> 从 API version 7开始支持。 +删除指定应用帐户和鉴权类型的Auth令牌。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------ | ---- | ---------- | -| name | string | 是 | 应用帐号名称。 | -| credentialType | string | 是 | 要获取的凭据的类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------ | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| token | string | 是 | 要删除的Auth令牌。 | **返回值：** -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| Promise<string> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ------------------- | --------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { - console.log('getAccountCredential, result: ' + data); - }).catch((err) => { - console.log("getAccountCredential err: " + JSON.stringify(err)); - }); + try { + appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx").then(() => { + console.log('deleteAuthToken successfully'); + }).catch((err) => { + console.log("deleteAuthToken err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("deleteAuthToken err: " + JSON.stringify(err)); + } ``` -### getAccountExtraInfo(deprecated) - -getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void +### setAuthTokenVisibility9+ -获取此应用帐号的额外信息（能转换成string类型的其它信息），使用callback回调异步返回结果。 +setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void -> **说明：** 从API version 9开始废弃。 -> -> 从 API version 7开始支持。 +设置指定鉴权类型的Auth令牌对特定应用的可见性。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------- | ---- | --------------- | -| name | string | 是 | 应用帐号名称。 | -| callback | AsyncCallback<string> | 是 | 获取此应用帐号的额外信息回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------- | ---- | ------------------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 被设置可见性的应用包名。 | +| isVisible | boolean | 是 | 是否可见。当设置成true可见，false不可见。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定鉴权类型的Auth令牌对特定应用的可见性成功时，err为undefined；否则为错误对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { - console.log("getAccountExtraInfo err: " + JSON.stringify(err)); - console.log('getAccountExtraInfo result: ' + result); - }); + try { + appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => { + console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); + }); + } catch (err) { + console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); + } ``` -### getAccountExtraInfo(deprecated) - -getAccountExtraInfo(name: string): Promise<string> +### setAuthTokenVisibility9+ -获取此应用程序帐号的额外信息，使用Promise方式异步返回结果。 +setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void> -> **说明：** 从API version 9开始废弃。 -> -> 从 API version 7开始支持。 +设置指定鉴权类型的OAuth令牌对特定应用的可见性。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | ------- | -| name | string | 是 | 应用帐号名称。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------- | ---- | ------------ | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 被设置可见性的应用包名。 | +| isVisible | boolean | 是 | 是否可见。 | **返回值：** -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| Promise<string> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ------------------- | --------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { - console.log('getAccountExtraInfo, result: ' + data); - }).catch((err) => { - console.log("getAccountExtraInfo err: " + JSON.stringify(err)); - }); + try { + appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { + console.log('setAuthTokenVisibility successfully'); + }).catch((err) => { + console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); + }); + } catch (err) { + console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); + } ``` -### getCustomData9+ +### checkAuthTokenVisibility9+ -getCustomData(name: string, key: string, callback: AsyncCallback<string>): void +checkAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void -获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。 +检查指定鉴权类型的Auth令牌对特定应用的可见性。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------- | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | -| callback | AsyncCallback<string> | 是 | 获取与此应用帐号关联的数据的回调。 | - +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ---------------------------- | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 检查可见性的应用包名。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查指定鉴权类型的Auth令牌对特定应用的可见性时，err为undefined，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. | + **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getCustomData("ZhangSan", "k001", (err, result) => { - console.log("getCustomData err: " + JSON.stringify(err)); - console.log('getCustomData result: ' + result); + appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", (err, data) => { + console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); + console.log('checkAuthTokenVisibility isVisible: ' + data); }); } catch (err) { - console.log("getCustomData err: " + JSON.stringify(err)); + console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); } ``` -### getCustomData9+ +### checkAuthTokenVisibility9+ -getCustomData(name: string, key: string): Promise<string> +checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean> -获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 +检查指定鉴权类型的Auth令牌对特定应用的可见性。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | ------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 用于检查可见性的应用包名。 | **返回值：** -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| Promise<string> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ---------------------- | --------------------- | +| Promise<boolean> | Promise对象。返回true表示指定鉴权类型的Auth令牌对特定应用的可见，返回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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.getCustomData("ZhangSan", "k001").then((data) => { - console.log('getCustomData: ' + data); + appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo").then((data) => { + console.log('checkAuthTokenVisibility isVisible: ' + data); }).catch((err) => { - console.log("getCustomData err: " + JSON.stringify(err)); + console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); }); } catch (err) { - console.log("getCustomData err: " + JSON.stringify(err)); + console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); } ``` -### getAssociatedData(deprecated) - -getAssociatedData(name: string, key: string, callback: AsyncCallback<string>): void +### getAllAuthTokens9+ -获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。 +getAllAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void -> **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9)替代。 -> -> 从 API version 7开始支持。 +获取指定应用对调用方全部可见的Auth令牌。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------- | ---- | ----------------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | -| callback | AsyncCallback<string> | 是 | 获取与此应用帐号关联的数据的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| callback | AsyncCallback<Array< [AuthTokenInfo](#authtokeninfo9)>> | 是 | 回调函数。当获取指定应用对调 +用方全部可见的Auth令牌成功时，err为undefined，data为全部可见的Auth令牌数组；否则为错误对象。 | -**示例：** +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name or owner. | + | 12300003 | the account indicated by name dose not exist. | + +**示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { - console.log("getAssociatedData err: " + JSON.stringify(err)); - console.log('getAssociatedData result: ' + result); - }); + try { + appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo", (err, data) => { + console.log("getAllAuthTokens err: " + JSON.stringify(err)); + console.log('getAllAuthTokens data: ' + JSON.stringify(data)); + }); + } catch (err) { + console.log("getAllAuthTokens err: " + JSON.stringify(err)); + } ``` -### getAssociatedData(deprecated) - -getAssociatedData(name: string, key: string): Promise<string> +### getAllAuthTokens9+ -获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 +getAllAuthTokens(name: string, owner: string): Promise<Array<AuthTokenInfo>> -> **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9-1)替代。 -> -> 从 API version 7开始支持。 +获取指定应用帐户对调用方可见的全部Auth令牌。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | **返回值：** -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| Promise<string> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise<Array< [AuthTokenInfo](#authtokeninfo9)>> | Promise对象。返回指定应用帐户对调用方可见的全部Auth令牌对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name or owner. | + | 12300003 | the account indicated by name dose not exist. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { - console.log('getAssociatedData: ' + data); - }).catch((err) => { - console.log("getAssociatedData err: " + JSON.stringify(err)); - }); + try { + appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => { + console.log('getAllAuthTokens data: ' + JSON.stringify(data)); + }).catch((err) => { + console.log("getAllAuthTokens err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("getAllAuthTokens err: " + JSON.stringify(err)); + } ``` -### getAssociatedDataSync9+ +### getAuthList9+ -getAssociatedDataSync(name: string, key: string): string; +getAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void -获取与此应用程序帐号关联的数据，使用同步方式返回结果。 +获取指定应用帐户和鉴权类型的Auth令牌的授权列表。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------ | ---- | --------- | -| name | string | 是 | 应用帐号名称。 | -| key | string | 是 | 要获取的数据的键。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ----------------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 | +| callback | AsyncCallback<Array<string>> | 是 | 回调函数。当获取指定应用帐户和鉴权类型的Auth令牌的授权列表成功时，err为undefined，data为Auth令牌的授权列表；否则为错误对象。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| :-------------------- | :-------------------- | -| string | 目标关联数据的取值。 | + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - var backData = appAccountManager.getAssociatedDataSync("ZhangSan", "k001"); - console.info("getAssociatedDataSync backData:" + JSON.stringify(backData)); + appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { + console.log('getAuthList err: ' + JSON.stringify(err)); + console.log('getAuthList data: ' + JSON.stringify(data)); + }); } catch (err) { - console.error(`getAssociatedDataSync err, code is ${e.code}, message is ${e.message}`); + console.log('getAuthList err: ' + JSON.stringify(err)); } ``` -### on('accountChange')9+ +### getAuthList9+ -on(type: 'accountChange', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void +getAuthList(name: string, authType: string): Promise<Array<string>> -订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。 +获取指定应用帐户和鉴权类型的Auth令牌的授权列表。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------------------------ | -| type | 'accountChange' | 是 | 关于帐号更改事件，当帐号所有者更新帐号时，订阅者将收到通知。 | -| owners | Array<string> | 是 | 指示帐号的所有者。 | -| callback | Callback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 订阅指定帐号所有者的帐号变更事件的回调。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - function changeOnCallback(data){ - console.debug("receive change data:" + JSON.stringify(data)); - } - try{ - appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback); - } - catch(err){ - console.error("on accountOnOffDemo err:" + JSON.stringify(err)); - } - ``` - -### on('change')(deprecated) - -on(type: 'change', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void - -订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。 +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ----------------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 | -> **说明：** 从API version 9开始废弃, 建议使用[on('accountChange')](#onaccountchange9)替代。 -> -> 从 API version 7开始支持。 +**返回值：** -**系统能力：** SystemCapability.Account.AppAccount +| 类型 | 说明 | +| ---------------------------------- | --------------------- | +| Promise<Array<string>> | Promise对象。返回指定应用帐户和鉴权类型的Auth令牌的授权列表对象。 | -**参数：** +**错误码：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------------------------ | -| type | 'change' | 是 | 关于帐号更改事件，当帐号所有者更新帐号时，订阅者将收到通知。 | -| owners | Array<string> | 是 | 指示帐号的所有者。 | -| callback | Callback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 订阅指定帐号所有者的帐号变更事件的回调。 | + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - function changeOnCallback(data){ - console.debug("receive change data:" + JSON.stringify(data)); - } - try{ - appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback); - } - catch(err){ - console.error("on accountOnOffDemo err:" + JSON.stringify(err)); + try { + appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => { + console.log('getAuthList data: ' + JSON.stringify(data)); + }).catch((err) => { + console.log("getAuthList err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("getAuthList err: " + JSON.stringify(err)); } ``` -### off('accountChange')9+ +### getAuthCallback9+ -off(type: 'accountChange', callback?: Callback>): void +getAuthCallback(sessionId: string, callback: AsyncCallback<AuthCallback>): void -取消订阅帐号事件，使用callback回调异步返回结果。 +获取鉴权会话的认证器回调。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------- | ---- | ------------ | -| type | 'accountChange' | 是 | 关于帐号更改事件。 | -| callback | Callback> | 否 | 取消订阅帐号事件的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------------------- | ---- | -------- | +| sessionId | string | 是 | 鉴权会话的标识。 | +| callback | AsyncCallback<[AuthCallback](#authcallback9)> | 是 | 回调函数。当获取鉴权会话的认证器回调函数成功时，err为undefined，data为认证器回调函数；否则为错误对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12400005 | the session indicated by sessionId does not exist. | **示例：** ```js + import featureAbility from '@ohos.ability.featureAbility'; const appAccountManager = account_appAccount.createAppAccountManager(); - function changeOnCallback(data){ - console.debug("receive change data:" + JSON.stringify(data)); - appAccountManager.off('accountChange', function(){ - console.debug("off finish"); - }) - } - try{ - appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback); - } - catch(err){ - console.error("on accountOnOffDemo err:" + JSON.stringify(err)); - } + 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)); + } + }); ``` -### off('change')(deprecated) - -off(type: 'change', callback?: Callback>): void +### getAuthCallback9+ -取消订阅帐号事件，使用callback回调异步返回结果。 +getAuthCallback(sessionId: string): Promise<AuthCallback> -> **说明：** 从API version 9开始废弃, 建议使用[off('accountChange')](#offaccountchange9)替代。 -> -> 从 API version 7开始支持。 +获取鉴权会话的认证器回调。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------- | ---- | ------------ | -| type | 'change' | 是 | 关于帐号更改事件。 | -| callback | Callback> | 否 | 取消订阅帐号事件的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | -------- | +| sessionId | string | 是 | 鉴权会话的标识。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------ | --------------------- | +| Promise<[AuthCallback](#authcallback9)> | Promise对象。返回鉴权会话的认证器回调对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12400005 | the session indicated by sessionId does not exist. | **示例：** ```js + import featureAbility from '@ohos.ability.featureAbility'; + const appAccountManager = account_appAccount.createAppAccountManager(); - function changeOnCallback(data){ - console.debug("receive change data:" + JSON.stringify(data)); - appAccountManager.off('change', function(){ - console.debug("off finish"); - }) - } - try{ - appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback); - } - catch(err){ - console.error("on accountOnOffDemo err:" + JSON.stringify(err)); - } + featureAbility.getWant().then((want) => { + var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; + try { + appAccountManager.getAuthCallback(sessionId).then((callback) => { + var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", + [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", + [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", + [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); + }).catch((err) => { + console.log("getAuthCallback err: " + JSON.stringify(err)); + }); + } + }).catch((err) => { + console.log("getWant err: " + JSON.stringify(err)); + }); ``` -### auth9+ +### queryAuthenticatorInfo9+ -auth(name: string, owner: string, authType: string, callback: AuthCallback): void +queryAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void -对应用帐户进行鉴权以获取Auth令牌，使用callback回调异步返回结果。 +获取指定应用帐号的认证器信息。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ---- | --------------- | -| name | string | 是 | 要鉴权的应用帐号名称。 | -| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回鉴权结果。 | - -**示例：** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ----------- | +| owner | string | 是 | 应用帐号的所有者包名。 | +| callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 回调函数。当获取指定应用帐号的认证器信息成功时，err为undefined，data为认证器信息对象；否则为错误对象。 | - ```js - import featureAbility from '@ohos.ability.featureAbility'; +**错误码：** - function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); - } + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid owner. | + | 12300003 | the account indicated by owner dose not exist. | - function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); - }); - } +**示例：** + ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback + appAccountManager.queryAuthenticatorInfo("com.example.ohos.accountjsdemo", (err, data) => { + console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); + console.log('queryAuthenticatorInfo data: ' + JSON.stringify(data)); }); } catch (err) { - console.log("auth err: " + JSON.stringify(err)); + console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); } ``` -### auth9+ +### queryAuthenticatorInfo9+ -auth(name: string, owner: string, authType: string, options: {[key: string]: Object}, callback: AuthCallback): void +queryAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> -对应用帐户进行鉴权以获取OAuth令牌，使用callback回调异步返回结果。 +获取指定应用帐户的认证器信息。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ---- | --------------- | -| name | string | 是 | 要鉴权的应用帐号名称。 | -| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| options | {[key: string]: Object} | 是 | 鉴权所需的可选项。 | -| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回鉴权结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------- | +| owner | string | 是 | 应用帐号的所有者包名。 | -**示例：** +**返回值：** - ```js - import featureAbility from '@ohos.ability.featureAbility'; +| 类型 | 说明 | +| -------------------------------- | --------------------- | +| Promise<[AuthenticatorInfo](#authenticatorinfo8)> | Promise对象。返回指定应用帐户的认证器信息对象。 | - function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); - } +**错误码：** - function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); - }); - } + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid owner. | + | 12300003 | the account indicated by owner dose not exist. | + +**示例：** + ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback + appAccountManager.queryAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => { + console.log('queryAuthenticatorInfo: ' + JSON.stringify(data)); + }).catch((err) => { + console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); }); } catch (err) { - console.log("auth err: " + JSON.stringify(err)); + console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); } ``` -### authenticate(deprecated) - -authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void +### checkAccountLabels9+ -对应用帐户进行鉴权以获取OAuth令牌，使用callback回调异步返回结果。 +checkAccountLabels(name: string, owner: string, labels: Array<string>, callback: AsyncCallback<boolean>): void; -> **说明：** 从API version 9开始废弃, 建议使用[auth](#auth9)替代。 -> -> 从 API version 8开始支持。 +检查指定帐户是否具有特定的标签集合。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ---- | --------------- | -| name | string | 是 | 要鉴权的应用帐号名称。 | -| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| options | {[key: string]: any} | 是 | 鉴权所需的可选项。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------------------------- | ----- | --------------- | +| name | string | 是 | 应用帐户的名称。 | +| owner | string | 是 | 应用帐户的所有者。| +| labels | Array<string> | 是 | 标签数组。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查指定帐户是否具有特定的标签集合成功时，err为undefined，data为true表示具有特定标签，data为false表示不具有特定标签；否则为错误对象。 | -**示例：** +**错误码：** - ```js - import featureAbility from '@ohos.ability.featureAbility'; + | 错误码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. | - function onResultCallback(code, result) { - console.log("resultCode: " + code); - console.log("result: " + JSON.stringify(result)); - } +**示例：** - function onRequestRedirectedCallback(request) { - let abilityStartSetting = {want: request}; - featureAbility.startAbility(abilityStartSetting, (err)=>{ - console.log("startAbility err: " + JSON.stringify(err)); + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + var 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)); }); + } catch (err) { + console.log("checkAccountLabels err: " + JSON.stringify(err)); } - - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.authenticate("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { - onResult: onResultCallback, - onRequestRedirected: onRequestRedirectedCallback - }); ``` -### getAuthToken9+ +### checkAccountLabels9+ -getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void +checkAccountLabels(name: string, owner: string, labels: Array<string>): Promise<boolean> -获取指定应用帐号和鉴权类型的Auth令牌，使用callback回调异步返回结果。 +检查指定帐户是否具有特定的标签集合。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------- | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| callback | AsyncCallback<string> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------------------------- | ----- | --------------- | +| name | string | 是 | 应用帐户的名称。 | +| owner | string | 是 | 应用帐户的所有者。| +| labels | Array<string> | 是 | 标签数组。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------- | -------------------------------- | +| 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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); + var labels = ["student"]; try { - appAccountManager.getAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { - console.log('getAuthToken err: ' + JSON.stringify(err)); - console.log('getAuthToken token: ' + data); + 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)); }); } catch (err) { - console.log('getAuthToken err: ' + JSON.stringify(err)); + console.log("checkAccountLabels err: " + JSON.stringify(err)); } ``` -### getAuthToken9+ +### deleteCredential9+ -getAuthToken(name: string, owner: string, authType: string): Promise<string> +deleteCredential(name: string, credentialType: string, callback: AsyncCallback<void>): void -获取指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。 +删除指定应用帐户的指定类型的凭据信息。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| authType | string | 是 | 鉴权类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------------------------- | ----- | -------------- | +| name | string | 是 | 应用帐户的名称。 | +| credentialType | string | 是 | 凭据类型。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当删除指定应用帐户的指定类型的凭据信息成功时，err为undefined；否则为错误对象。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| --------------------- | --------------------- | -| Promise<string> | Promise实例，用于获取异步返回结果。 | + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name or credentialType. | + | 12300019 | credential does not exist. | + | 12400001 | the application indicated by name does not exist. | **示例：** ```js const 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.deleteCredential("zhangsan", "pin", (err, data) => { + console.log('deleteCredential: ' + JSON.stringify(data)); + console.log("deleteCredential err: " + JSON.stringify(err)); }); } catch (err) { - console.log("getAuthToken err: " + JSON.stringify(err)); + console.log("deleteCredential err: " + JSON.stringify(err)); } ``` -### getOAuthToken(deprecated) - -getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void +### deleteCredential9+ -获取指定应用帐号和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 +deleteCredential(name: string, credentialType: string): Promise<void> -> **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9)替代。 -> -> 从 API version 8开始支持。 +删除指定应用帐户的指定类型的凭据信息。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------- | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| callback | AsyncCallback<string> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------ | ----- | --------------- | +| name | string | 是 | 应用帐户的名称。 | +| credentialType | string | 是 | 凭据类型。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------- | -------------------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid name or credentialType. | + | 12300019 | credential does not exist. | + | 12400001 | the application indicated by name does not exist. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { - console.log('getOAuthToken err: ' + JSON.stringify(err)); - console.log('getOAuthToken token: ' + data); - }); + try { + appAccountManager.deleteCredential("zhangsan", "pin").then((data) => { + console.log('deleteCredential: ' + JSON.stringify(data)); + }).catch((err) => { + console.log("deleteCredential err: " + JSON.stringify(err)); + }); + } catch (err) { + console.log("deleteCredential err: " + JSON.stringify(err)); + } ``` -### getOAuthToken(deprecated) - -getOAuthToken(name: string, owner: string, authType: string): Promise<string> +### selectAccountsByOptions9+ -获取指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 +selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback<Array<AppAccountInfo>>); -> **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9-1)替代。 -> -> 从 API version 8开始支持。 +根据选项选择请求方可访问的帐号列表。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| authType | string | 是 | 鉴权类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ----------------------------------- | ----- | --------------- | +| options | SelectAccountsOptions | 是 | 选择帐户的选项。 | +| callback | AsyncCallback<[AppAccountInfo](#appaccountinfo)> | 是 | 回调函数。当根据选项选择请求方可访问的帐号列表时，err为undefined，data为可访问的帐号信息对象；否则为错误对象。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| --------------------- | --------------------- | -| Promise<string> | Promise实例，用于获取异步返回结果。 | - -**示例：** - - ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData").then((data) => { - console.log('getOAuthToken token: ' + data); - }).catch((err) => { - console.log("getOAuthToken err: " + JSON.stringify(err)); - }); - ``` - -### setAuthToken9+ - -setAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void - -设置指定应用帐号和鉴权类型的Auth令牌，使用callback回调异步返回结果。 - -**系统能力：** SystemCapability.Account.AppAccount - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | -------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| token | string | 是 | Auth令牌。 | -| callback | AsyncCallback<void> | 是 | 设置结果的回调。 | + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid options. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); + var options = { + allowedOwners: ["com.example.ohos.accountjsdemo"] + }; try { - appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => { - console.log('setAuthToken err: ' + JSON.stringify(err)); + appAccountManager.selectAccountsByOptions(options, (err, data) => { + console.log('selectAccountsByOptions: ' + JSON.stringify(data)); + console.log("selectAccountsByOptions err: " + JSON.stringify(err)); }); } catch (err) { - console.log('setAuthToken err: ' + JSON.stringify(err)); + console.log("selectAccountsByOptions err: " + JSON.stringify(err)); } ``` -### setAuthToken9+ +### selectAccountsByOptions9+ -setAuthToken(name: string, authType: string, token: string): Promise<void> +selectAccountsByOptions(options: SelectAccountsOptions): Promise<Array<AppAccountInfo>> -设置指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。 +根据选项选择请求方可访问的帐户列表。使用Promise异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | -------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| token | string | 是 | Auth令牌。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------------------------- | ----- | --------------- | +| options | [SelectAccountsOptions](#selectaccountsoptions9) | 是 | 选择帐户的选项。 | **返回值：** -| 类型 | 说明 | -| ------------------- | --------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ------------------- | -------------------------------- | +| Promise<[AppAccountInfo](#appaccountinfo)> | Promise对象。返回请求方可访问的帐户对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 12300001 | system service exception. | + | 12300002 | invalid options. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); + var options = { + allowedOwners: ["com.example.ohos.accountjsdemo"] + }; try { - appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => { - console.log('setAuthToken successfully'); + appAccountManager.selectAccountsByOptions(options).then((data) => { + console.log('selectAccountsByOptions: ' + JSON.stringify(data)); }).catch((err) => { - console.log('setAuthToken err: ' + JSON.stringify(err)); + console.log("selectAccountsByOptions err: " + JSON.stringify(err)); }); } catch (err) { - console.log('setAuthToken err: ' + JSON.stringify(err)); + console.log("selectAccountsByOptions err: " + JSON.stringify(err)); } ``` -### setOAuthToken(deprecated) - -setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void +### verifyCredential9+ -设置指定应用帐号和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 +verifyCredential(name: string, owner: string, callback: AuthenticatorCallback): void; -> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9)替代。 -> -> 从 API version 8开始支持。 +验证用户凭据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | -------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| token | string | 是 | OAuth令牌。 | -| callback | AsyncCallback<void> | 是 | 设置结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ----- | ----------------------- | +| name | string | 是 | 应用帐户的名称。 | +| owner | string | 是 | 应用帐户的所有者。 | +| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 回调函数。返回认证结果回调函数。 | + +**错误码：** + + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx", (err) => { - console.log('setOAuthToken err: ' + JSON.stringify(err)); - }); + try { + appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", { + onResult: (resultCode, result) => { + console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode)); + console.log("verifyCredential onResult, result:" + JSON.stringify(result)); + }, + onRequestRedirected: (request) => { + console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request)); + } + }); + } catch (err) { + console.log("verifyCredential err: " + JSON.stringify(err)); + } ``` -### setOAuthToken(deprecated) - -setOAuthToken(name: string, authType: string, token: string): Promise<void> +### verifyCredential9+ -设置指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 +verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback): void; -> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。 -> -> 从 API version 8开始支持。 +验证用户凭据。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | -------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| token | string | 是 | OAuth令牌。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ----- | ----------------------- | +| name | string | 是 | 应用帐户的名称。 | +| owner | string | 是 | 应用帐户的所有者。 | +| options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的选项。 | +| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 回调函数。返回认证结果回调函数。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ------------------- | --------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx").then(() => { - console.log('setOAuthToken successfully'); - }).catch((err) => { - console.log('setOAuthToken err: ' + JSON.stringify(err)); - }); + var 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)); + } + }); + } catch (err) { + console.log("verifyCredential err: " + JSON.stringify(err)); + } ``` -### deleteAuthToken9+ +### setAuthenticatorProperties9+ -deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void +setAuthenticatorProperties(owner: string, callback: AuthCallback): void; -删除指定应用帐户和鉴权类型的Auth令牌，使用callback回调异步返回结果。 +设置认证器属性。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ------------ | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| token | string | 是 | 要删除的Auth令牌。 | -| callback | AsyncCallback<void> | 是 | 删除结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ----- | ----------------------- | +| owner | string | 是 | 认证器的所有者。 | +| 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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { - appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => { - console.log('deleteAuthToken err: ' + JSON.stringify(err)); + 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)); + } }); } catch (err) { - console.log('deleteAuthToken err: ' + JSON.stringify(err)); + console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); } ``` -### deleteAuthToken9+ +### setAuthenticatorProperties9+ -deleteAuthToken(name: string, owner: string, authType: string, token: string): Promise<void> +setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthCallback): void; -删除指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。 +设置认证器属性。使用callback异步回调。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ------------ | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| token | string | 是 | 要删除的Auth令牌。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ----- | ----------------------- | +| owner | string | 是 | 认证器的所有者。 | +| options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的选项。 | +| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置属性结果回调函数。 | -**返回值：** +**错误码：** -| 类型 | 说明 | -| ------------------- | --------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | + | 错误码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. | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); + var options = { + properties: {"prop1": "value1"} + }; 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.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)); + } + }); } catch (err) { - console.log("deleteAuthToken err: " + JSON.stringify(err)); - } + console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); + } + ``` -### deleteOAuthToken(deprecated) +### addAccount(deprecated) -deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void +addAccount(name: string, callback: AsyncCallback<void>): void -删除指定应用帐户和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 +将此应用的帐号名添加到帐号管理服务中。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[deleteAuthToken](#deleteauthtoken9)替代。 +> **说明：** +> 从API version 9开始废弃, 建议使用[createAccount](#createaccount9)替代 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ------------ | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| token | string | 是 | 要删除的OAuth令牌。 | -| callback | AsyncCallback<void> | 是 | 删除结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------- | +| name | string | 是 | 要添加的应用帐号名称。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当此应用的帐号名添加到帐号管理服务成功时，err为undefined，否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => { - console.log('deleteOAuthToken err: ' + JSON.stringify(err)); + appAccountManager.addAccount("WangWu", (err) => { + console.log("addAccount err: " + JSON.stringify(err)); }); ``` -### deleteOAuthToken(deprecated) +### addAccount(deprecated) -deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise<void> +addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void -删除指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 +将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。 -> -> 从 API version 8开始支持。 +> **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-1)替代 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ------------ | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| authType | string | 是 | 鉴权类型。 | -| token | string | 是 | 要删除的OAuth令牌。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------- | --------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------------------------- | ---- | ---------------------------------------- | +| name | string | 是 | 要添加的应用帐号名称。 | +| extraInfo | string | 是 | 要添加的应用帐号的额外信息(能转换string类型的其它信息，如token等)，额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当此应用程序的帐号名和额外信息添加到帐号管理服务成功时，err为undefined，否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx").then(() => { - console.log('deleteOAuthToken successfully'); - }).catch((err) => { - console.log("deleteOAuthToken err: " + JSON.stringify(err)); + appAccountManager.addAccount("LiSi", "token101", (err) => { + console.log("addAccount err: " + JSON.stringify(err)); }); ``` -### setAuthTokenVisibility9+ +### addAccount(deprecated) -setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void +addAccount(name: string, extraInfo?: string): Promise<void> + +将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中。使用Promise异步回调。 -设置指定鉴权类型的Auth令牌对特定应用的可见性，使用callback回调异步返回结果。 +> **说明：** > 从API version 9开始废弃, 建议使用[createAccount](#createaccount9-2)替代 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------------- | ---- | ------------------------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 被设置可见性的应用包名。 | -| isVisible | boolean | 是 | 是否可见。当设置成true可见，false不可见。 | -| callback | AsyncCallback<void> | 是 | 设置结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ---------------------------------------- | +| name | string | 是 | 要添加的应用帐号名称。 | +| extraInfo | string | 否 | 要添加的应用帐号的额外信息（能转换成string类型的其它信息），额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------- | --------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => { - console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); - }); - } catch (err) { - console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); - } + appAccountManager.addAccount("LiSi", "token101").then(()=> { + console.log('addAccount Success'); + }).catch((err) => { + console.log("addAccount err: " + JSON.stringify(err)); + }); ``` -### setAuthTokenVisibility9+ +### addAccountImplicitly(deprecated) -setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void> +addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void + +根据指定的帐号所有者、鉴权类型和可选项隐式地添加应用帐号，并使用callback回调异步返回结果。 -设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[createAccountImplicitly](#createaccountimplicitly9)替代。 +> +> 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------- | ---- | ------------ | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 被设置可见性的应用包名。 | -| isVisible | boolean | 是 | 是否可见。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------- | --------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | ----------------------- | +| owner | string | 是 | 要添加的应用帐号所有者包名。 | +| authType | string | 是 | 要添加的应用帐号鉴权类型。鉴权类型为自定义。 | +| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。可选项可根据自己需要设置。 | +| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { - console.log('setAuthTokenVisibility successfully'); - }).catch((err) => { - console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); + import featureAbility from '@ohos.ability.featureAbility'; + + function onResultCallback(code, result) { + console.log("resultCode: " + code); + console.log("result: " + JSON.stringify(result)); + } + + function onRequestRedirectedCallback(request) { + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err)=>{ + console.log("startAbility err: " + JSON.stringify(err)); }); - } catch (err) { - console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); } + + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.addAccountImplicitly("com.example.ohos.accountjsdemo", "getSocialData", {}, { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback + }); ``` -### setOAuthTokenVisibility(deprecated) +### deleteAccount(deprecated) -setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void +deleteAccount(name: string, callback: AsyncCallback<void>): void -设置指定鉴权类型的Auth令牌对特定应用的可见性，使用callback回调异步返回结果。 +从帐号管理服务中删除应用帐号。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------------------------- | ---- | ------------------------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 被设置可见性的应用包名。 | -| isVisible | boolean | 是 | 是否可见。当设置成true可见，false不可见。 | -| callback | AsyncCallback<void> | 是 | 设置结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------- | +| name | string | 是 | 要删除的应用帐号名称。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当帐号管理服务中删除应用帐号成功时，err为undefined，否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => { - console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); - }); + appAccountManager.deleteAccount("ZhaoLiu", (err) => { + console.log("deleteAccount err: " + JSON.stringify(err)); + }); ``` -### setOAuthTokenVisibility(deprecated) +### deleteAccount(deprecated) -setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void> +deleteAccount(name: string): Promise<void> -设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。 +从帐号管理服务中删除应用帐号。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9-1)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[removeAccount](#removeaccount9)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------- | ---- | ------------ | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 被设置可见性的应用包名。 | -| isVisible | boolean | 是 | 是否可见。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ----------- | +| name | string | 是 | 要删除的应用帐号名称。 | **返回值：** | 类型 | 说明 | -| ------------------- | --------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { - console.log('setOAuthTokenVisibility successfully'); - }).catch((err) => { - console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); + appAccountManager.deleteAccount("ZhaoLiu").then(() => { + console.log('deleteAccount Success'); + }).catch((err) => { + console.log("deleteAccount err: " + JSON.stringify(err)); }); ``` +### disableAppAccess(deprecated) -### checkAuthTokenVisibility9+ +disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void -checkAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void +禁止指定第三方应用帐号名称对指定的第三方应用进行访问。使用callback异步回调。 -检查指定鉴权类型的Auth令牌对特定应用的可见性，使用callback回调异步返回结果。 +> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。 +> +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ---------------------------- | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 检查可见性的应用包名。 | -| callback | AsyncCallback<boolean> | 是 | 检查结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------- | ---- | --------------------------------- | +| name | string | 是 | 要禁用访问的第三方应用帐号名称。 | +| bundleName | string | 是 | 第三方应用的包名。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时，err为undefined，否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.checkAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", (err, data) => { - console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); - console.log('checkAuthTokenVisibility isVisible: ' + data); - }); - } catch (err) { - console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); - } + appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { + console.log("disableAppAccess err: " + JSON.stringify(err)); + }); ``` -### checkAuthTokenVisibility9+ +### disableAppAccess(deprecated) -checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean> +disableAppAccess(name: string, bundleName: string): Promise<void> + +禁止指定第三方应用帐号名称对指定包名称的第三方应用进行访问。使用Promise异步回调。 -检查指定鉴权类型的Auth令牌对特定应用的可见性，使用Promise方式异步返回结果。 +> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。 +> +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------ | ---- | ------------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 用于检查可见性的应用包名。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | ---------------- | +| name | string | 是 | 要禁用访问的第三方应用帐号名称。 | +| bundleName | string | 是 | 第三方应用的包名。 | **返回值：** -| 类型 | 说明 | -| ---------------------- | --------------------- | -| Promise<boolean> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js const 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)); - }); - } catch (err) { - console.log('checkAuthTokenVisibility err: ' + JSON.stringify(err)); - } + appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { + console.log('disableAppAccess Success'); + }).catch((err) => { + console.log("disableAppAccess err: " + JSON.stringify(err)); + }); ``` -### checkOAuthTokenVisibility(deprecated) +### enableAppAccess(deprecated) -checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void +enableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void -检查指定鉴权类型的OAuth令牌对特定应用的可见性，使用callback回调异步返回结果。 +允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9)替代。 +> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ---------------------------- | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 检查可见性的应用包名。 | -| callback | AsyncCallback<boolean> | 是 | 检查结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------- | ---- | --------------------------------- | +| name | string | 是 | 应用帐号名称。 | +| bundleName | string | 是 | 第三方应用的包名。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当允许指定第三方应用帐号名称对指定包名称的第三方应用进行访问设置成功时，err为undefined，否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", (err, data) => { - console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); - console.log('checkOAuthTokenVisibility isVisible: ' + data); - }); + appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { + console.log("enableAppAccess: " + JSON.stringify(err)); + }); ``` +### enableAppAccess(deprecated) -### checkOAuthTokenVisibility(deprecated) - -checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean> +enableAppAccess(name: string, bundleName: string): Promise<void> -检查指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。 +允许指定第三方应用帐号的名称对指定包名称的第三方应用进行访问。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9-1)替代。 +> **说明：** 从API version 9开始废弃。建议使用[setAppAccess](#setappaccess9-1)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------ | ---- | ------------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 鉴权类型。 | -| bundleName | string | 是 | 用于检查可见性的应用包名。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | --------- | +| name | string | 是 | 应用帐号名称。 | +| bundleName | string | 是 | 第三方应用的包名。 | **返回值：** -| 类型 | 说明 | -| ---------------------- | --------------------- | -| Promise<boolean> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo").then((data) => { - console.log('checkOAuthTokenVisibility isVisible: ' + data); + appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { + console.log('enableAppAccess Success'); }).catch((err) => { - console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); + console.log("enableAppAccess err: " + JSON.stringify(err)); }); ``` -### getAllAuthTokens9+ +### checkAppAccountSyncEnable(deprecated) -getAllAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void +checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): void + +检查指定应用帐号是否允许应用数据同步。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9)替代。 +> +> 从 API version 7开始支持。 -获取指定应用对调用方全部可见的Auth令牌，使用callback回调异步返回结果。 +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| callback | AsyncCallback<Array< [AuthTokenInfo](#authtokeninfo9)>> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------- | ---- | --------------------- | +| name | string | 是 | 应用帐号名称。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当检查指定应用帐号是否允许应用数据同步成功，err为undefined，data返回true表示指定应用帐号允许应用数据同步，data返回false表示指定应用帐号不允许应用数据同步；否则为错误对象。 | -**示例：** +**示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo", (err, data) => { - console.log("getAllAuthTokens err: " + JSON.stringify(err)); - console.log('getAllAuthTokens data: ' + JSON.stringify(data)); - }); - } catch (err) { - console.log("getAllAuthTokens err: " + JSON.stringify(err)); - } + appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { + console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err)); + console.log('checkAppAccountSyncEnable result: ' + result); + }); ``` -### getAllAuthTokens9+ +### checkAppAccountSyncEnable(deprecated) -getAllAuthTokens(name: string, owner: string): Promise<Array<AuthTokenInfo>> +checkAppAccountSyncEnable(name: string): Promise<boolean> + +检查指定应用帐号是否允许应用数据同步。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃。建议使用[checkDataSyncEnabled](#checkdatasyncenabled9-1)替代。 +> +> 从 API version 7开始支持。 -获取指定应用帐户对调用方可见的全部Auth令牌，使用Promise方式异步返回结果。 +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------- | +| name | string | 是 | 应用帐号名称。 | **返回值：** -| 类型 | 说明 | -| ---------------------------------------- | --------------------- | -| Promise<Array< [AuthTokenInfo](#authtokeninfo9)>> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :--------------------- | :-------------------- | +| Promise<boolean> | Promise对象。返回true表示允许应用数据同步；返回false表示不允许应用数据同步。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => { - console.log('getAllAuthTokens data: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("getAllAuthTokens err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("getAllAuthTokens err: " + JSON.stringify(err)); - } + appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { + console.log('checkAppAccountSyncEnable, result: ' + data); + }).catch((err) => { + console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err)); + }); ``` -### getAllOAuthTokens(deprecated) +### setAccountCredential(deprecated) -getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void +setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void -获取指定应用对调用方全部可见的OAuth令牌，使用callback回调异步返回结果。 +设置此应用程序帐号的凭据。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9)替代。 +> **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | -| callback | AsyncCallback<Array< [OAuthTokenInfo](#oauthtokeninfodeprecated)>> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------------------------- | ---- | ------------- | +| name | string | 是 | 应用程序帐号名称。 | +| credentialType | string | 是 | 要设置的凭据类型。 | +| credential | string | 是 | 要设置的凭据。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置此应用程序帐号的凭据成功时，err为undefined，否则为错误对象。 | -**示例：** +**示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo", (err, data) => { - console.log("getAllOAuthTokens err: " + JSON.stringify(err)); - console.log('getAllOAuthTokens data: ' + JSON.stringify(data)); + appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { + console.log("setAccountCredential err: " + JSON.stringify(err)); }); ``` -### getAllOAuthTokens(deprecated) +### setAccountCredential(deprecated) -getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenInfo>> +setAccountCredential(name: string, credentialType: string, credential: string): Promise<void> -获取指定应用帐户对调用方可见的全部OAuth令牌，使用Promise方式异步返回结果。 +设置此应用程序帐号的凭据。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9-1)替代。 +> **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9-1)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------- | -| name | string | 是 | 应用帐号的名称。 | -| owner | string | 是 | 应用帐号的所有者包名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------ | ---- | ---------- | +| name | string | 是 | 应用帐号的名称。 | +| credentialType | string | 是 | 要设置的凭据的类型。 | +| credential | string | 是 | 要设置的凭据。 | **返回值：** -| 类型 | 说明 | -| ---------------------------------------- | --------------------- | -| Promise<Array< [OAuthTokenInfo](#oauthtokeninfodeprecated)>> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => { - console.log('getAllOAuthTokens data: ' + JSON.stringify(data)); + appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001").then(() => { + console.log('setAccountCredential Success'); }).catch((err) => { - console.log("getAllOAuthTokens err: " + JSON.stringify(err)); + console.log("setAccountCredential err: " + JSON.stringify(err)); }); ``` -### getAuthList9+ +### setAccountExtraInfo(deprecated) -getAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void +setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<void>): void + +设置此应用程序帐号的额外信息。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃。 +> +> 从 API version 7开始支持。 -获取指定应用帐户和鉴权类型的Auth令牌的授权列表，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ----------------------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 | -| callback | AsyncCallback<Array<string>> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------------------------- | ---- | --------------- | +| name | string | 是 | 应用帐号名称。 | +| extraInfo | string | 是 | 要设置的额外信息。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置此应用程序帐号的额外信息成功时，err为undefined，否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { - console.log('getAuthList err: ' + JSON.stringify(err)); - console.log('getAuthList data: ' + JSON.stringify(data)); - }); - } catch (err) { - console.log('getAuthList err: ' + JSON.stringify(err)); - } + appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { + console.log("setAccountExtraInfo err: " + JSON.stringify(err)); + }); ``` -### getAuthList9+ +### setAccountExtraInfo(deprecated) -getAuthList(name: string, authType: string): Promise<Array<string>> +setAccountExtraInfo(name: string, extraInfo: string): Promise<void> + +设置此应用程序帐号的额外信息。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃。 +> +> 从 API version 7开始支持。 -获取指定应用帐户和鉴权类型的Auth令牌的授权列表，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ----------------------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | --------- | +| name | string | 是 | 应用帐号名称。 | +| extraInfo | string | 是 | 要设置的额外信息。 | **返回值：** -| 类型 | 说明 | -| ---------------------------------- | --------------------- | -| Promise<Array<string>> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => { - console.log('getAuthList data: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("getAuthList err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("getAuthList err: " + JSON.stringify(err)); - } + appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { + console.log('setAccountExtraInfo Success'); + }).catch((err) => { + console.log("setAccountExtraInfo err: " + JSON.stringify(err)); + }); ``` -### getOAuthList(deprecated) +### setAppAccountSyncEnable(deprecated) -getOAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void +setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback<void>): void -获取指定应用帐户和鉴权类型的OAuth令牌的授权列表，使用callback回调异步返回结果。 +设置指定的应用程序帐号是否允许应用程序数据同步。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 + +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ----------------------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表。 | -| callback | AsyncCallback<Array<string>> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------- | +| name | string | 是 | 应用帐号名称。 | +| isEnable | boolean | 是 | 是否允许应用数据同步。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定的应用帐号是否允许应用程序数据同步成功时，err为undefined，否则为错误对象。 | **示例：** ```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)); + appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { + console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); }); ``` -### getOAuthList(deprecated) +### setAppAccountSyncEnable(deprecated) -getOAuthList(name: string, authType: string): Promise<Array<string>> +setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> -获取指定应用帐户和鉴权类型的OAuth令牌的授权列表，使用Promise方式异步返回结果。 +设置指定的应用程序帐号是否允许应用程序数据同步。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9-1)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9-1)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 + +**需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ----------------------- | -| name | string | 是 | 应用帐号的名称。 | -| authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------- | ---- | ----------- | +| name | string | 是 | 应用帐号名称。 | +| isEnable | boolean | 是 | 是否允许应用数据同步。 | **返回值：** -| 类型 | 说明 | -| ---------------------------------- | --------------------- | -| Promise<Array<string>> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => { - console.log('getOAuthList data: ' + JSON.stringify(data)); + appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { + console.log('setAppAccountSyncEnable Success'); }).catch((err) => { - console.log("getOAuthList err: " + JSON.stringify(err)); + console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); }); ``` -### getAuthCallback9+ +### setAssociatedData(deprecated) -getAuthCallback(sessionId: string, callback: AsyncCallback<AuthCallback>): void +setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void + +设置与此应用程序帐号关联的数据。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9)替代。 +> +> 从 API version 7开始支持。 -获取鉴权会话的认证器回调，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | -------- | -| sessionId | string | 是 | 鉴权会话的标识。 | -| callback | AsyncCallback<[AuthCallback](#authcallback9)> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ----------------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | +| value | string | 是 | 要设置的数据的值。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置与此应用帐号关联的数据成功时，err为undefined，否则为错误对象。 | **示例：** ```js - import featureAbility from '@ohos.ability.featureAbility'; const appAccountManager = account_appAccount.createAppAccountManager(); - featureAbility.getWant((err, want) => { - var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; - try { - appAccountManager.getAuthCallback(sessionId, (err, callback) => { - if (err.code != account_appAccount.ResultCode.SUCCESS) { - console.log("getAuthCallback err: " + JSON.stringify(err)); - return; - } - var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", - [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", - [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", - [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.onResult(account_appAccount.ResultCode.SUCCESS, result); - }); - } catch (err) { - console.log("getAuthCallback err: " + JSON.stringify(err)); - } + appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { + console.log("setAssociatedData err: " + JSON.stringify(err)); }); ``` -### getAuthCallback9+ +### setAssociatedData(deprecated) -getAuthCallback(sessionId: string): Promise<AuthCallback> +setAssociatedData(name: string, key: string, value: string): Promise<void> + +设置与此应用程序帐号关联的数据。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9-1)替代。 +> +> 从 API version 7开始支持。 -获取鉴权会话的认证器回调，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------ | ---- | -------- | -| sessionId | string | 是 | 鉴权会话的标识。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要设置的数据的键，密钥可以自定义。 | +| value | string | 是 | 要设置的数据的值。 | **返回值：** -| 类型 | 说明 | -| ------------------------------------ | --------------------- | -| Promise<[AuthCallback](#authcallback9)> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :------------------ | :-------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js - import featureAbility from '@ohos.ability.featureAbility'; - const appAccountManager = account_appAccount.createAppAccountManager(); - featureAbility.getWant().then((want) => { - var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; - try { - appAccountManager.getAuthCallback(sessionId).then((callback) => { - var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", - [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", - [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", - [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.onResult(account_appAccount.ResultCode.SUCCESS, result); - }).catch((err) => { - console.log("getAuthCallback err: " + JSON.stringify(err)); - }); - } + appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { + console.log('setAssociatedData Success'); }).catch((err) => { - console.log("getWant err: " + JSON.stringify(err)); + console.log("setAssociatedData err: " + JSON.stringify(err)); }); ``` -### getAuthenticatorCallback(deprecated) +### getAllAccessibleAccounts(deprecated) -getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<AuthenticatorCallback>): void +getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void -获取鉴权会话的认证器回调，使用callback回调异步返回结果。 +获取全部应用已授权帐号信息。 -> **说明：** 从API version 9开始废弃, 建议使用[getAuthCallback](#getauthcallback9)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 + +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | -------- | -| sessionId | string | 是 | 鉴权会话的标识。 | -| callback | AsyncCallback<[AuthenticatorCallback](#authenticatorcallbackdeprecated)> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | **示例：** ```js - import featureAbility from '@ohos.ability.featureAbility'; const appAccountManager = account_appAccount.createAppAccountManager(); - featureAbility.getWant((err, want) => { - var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; - appAccountManager.getAuthenticatorCallback(sessionId, (err, callback) => { - if (err.code != account_appAccount.ResultCode.SUCCESS) { - console.log("getAuthenticatorCallback 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); - }); + appAccountManager.getAllAccessibleAccounts((err, data)=>{ + console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err)); + console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data)); }); ``` -### getAuthenticatorCallback(deprecated) +### getAllAccessibleAccounts(deprecated) -getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback> +getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>> -获取鉴权会话的认证器回调，使用Promise方式异步返回结果。 +获取全部应用已授权帐号信息。 -> **说明：** 从API version 9开始废弃, 建议使用[getAuthCallback](#getauthcallback9-1)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9-1)替代。 > -> 从 API version 8开始支持。 - -**系统能力：** SystemCapability.Account.AppAccount +> 从 API version 7开始支持。 -**参数：** +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------ | ---- | -------- | -| sessionId | string | 是 | 鉴权会话的标识。 | +**系统能力：** SystemCapability.Account.AppAccount **返回值：** -| 类型 | 说明 | -| ------------------------------------ | --------------------- | -| Promise<[AuthenticatorCallback](#authenticatorcallbackdeprecated)> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象。返回全部应用已授权帐号信息对象。 | **示例：** ```js - import featureAbility from '@ohos.ability.featureAbility'; - const appAccountManager = account_appAccount.createAppAccountManager(); - featureAbility.getWant().then((want) => { - var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; - 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_AUTH_TYPE]: "getSocialData", - [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.onResult(account_appAccount.ResultCode.SUCCESS, result); - }).catch((err) => { - console.log("getAuthenticatorCallback err: " + JSON.stringify(err)); - }); + appAccountManager.getAllAccessibleAccounts().then((data) => { + console.log('getAllAccessibleAccounts: ' + data); }).catch((err) => { - console.log("getWant err: " + JSON.stringify(err)); + console.log("getAllAccessibleAccounts err: " + JSON.stringify(err)); }); ``` -### queryAuthenticatorInfo9+ +### getAllAccounts(deprecated) -queryAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void +getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void + +获取指定应用全部帐号信息。 -获取指定应用帐号的认证器信息，使用callback回调异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner]替代。 +> +> 从 API version 7开始支持。 + +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------- | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | -| callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | --------- | +| owner | string | 是 | 应用包名称。 | +| callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.queryAuthenticatorInfo("com.example.ohos.accountjsdemo", (err, data) => { - console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); - console.log('queryAuthenticatorInfo data: ' + JSON.stringify(data)); - }); - } catch (err) { - console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); - } + const selfBundle = "com.example.actsgetallaaccounts"; + appAccountManager.getAllAccounts(selfBundle, (err, data)=>{ + console.debug("getAllAccounts err:" + JSON.stringify(err)); + console.debug("getAllAccounts data:" + JSON.stringify(data)); + }); ``` -### queryAuthenticatorInfo9+ +### getAllAccounts(deprecated) -queryAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> +getAllAccounts(owner: string): Promise<Array<AppAccountInfo>> + +获取指定应用全部帐号信息。 + +> **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner](#getaccountsbyowner9-1)替代。 +> +> 从 API version 7开始支持。 -获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。 +**需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ------ | +| owner | string | 是 | 应用包名称。 | **返回值：** -| 类型 | 说明 | -| -------------------------------- | --------------------- | -| Promise<[AuthenticatorInfo](#authenticatorinfo8)> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise对象。返回指定应用全部帐号信息对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.queryAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => { - console.log('queryAuthenticatorInfo: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("queryAuthenticatorInfo err: " + JSON.stringify(err)); - } + const selfBundle = "com.example.actsgetallaaccounts"; + appAccountManager.getAllAccounts(selfBundle).then((data) => { + console.log('getAllAccounts: ' + data); + }).catch((err) => { + console.log("getAllAccounts err: " + JSON.stringify(err)); + }); ``` -### getAuthenticatorInfo(deprecated) +### getAccountCredential(deprecated) -getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void +getAccountCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void -获取指定应用帐号的认证器信息，使用callback回调异步返回结果。 +获取此应用帐号的凭据（如数字密码、人脸和PIN码等）。使用callback异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------- | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | -| callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 查询结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | --------------------------- | ---- | -------------- | +| name | string | 是 | 应用帐号名称。 | +| credentialType | string | 是 | 获取此应用帐号的凭据的类型。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取此应用帐号的凭据成功时，err为undefined，data返回此应用帐号的凭据对象；否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo", (err, data) => { - console.log("getAuthenticatorInfo err: " + JSON.stringify(err)); - console.log('getAuthenticatorInfo data: ' + JSON.stringify(data)); + appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { + console.log("getAccountCredential err: " + JSON.stringify(err)); + console.log('getAccountCredential result: ' + result); }); ``` -### getAuthenticatorInfo(deprecated) +### getAccountCredential(deprecated) -getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> +getAccountCredential(name: string, credentialType: string): Promise<string> -获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。 +获取此应用程序帐号的凭据。使用Promise异步回调。 -> **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9-1)替代。 +> **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9-1)替代。 > -> 从 API version 8开始支持。 +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ------ | ---- | ----------- | -| owner | string | 是 | 应用帐号的所有者包名。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------------- | ------ | ---- | ---------- | +| name | string | 是 | 应用帐号名称。 | +| credentialType | string | 是 | 要获取的凭据的类型。 | **返回值：** -| 类型 | 说明 | -| -------------------------------- | --------------------- | -| Promise<[AuthenticatorInfo](#authenticatorinfo8)> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :-------------------- | :-------------------- | +| Promise<string> | Promise对象。返回此应用程序帐号的凭据对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => { - console.log('getAuthenticatorInfo: ' + JSON.stringify(data)); + appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { + console.log('getAccountCredential, result: ' + data); }).catch((err) => { - console.log("getAuthenticatorInfo err: " + JSON.stringify(err)); + console.log("getAccountCredential err: " + JSON.stringify(err)); }); ``` -### checkAccountLabels9+ +### getAccountExtraInfo(deprecated) -checkAccountLabels(name: string, owner: string, labels: Array<string>, callback: AsyncCallback<boolean>): void; +getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void + +获取此应用帐号的额外信息（能转换成string类型的其它信息）。使用callback异步回调。 -检查指定帐户是否具有特定的标签集合，使用callback回调异步返回结果。 +> **说明：** 从API version 9开始废弃。 +> +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------------------------- | ----- | --------------- | -| name | string | 是 | 应用帐户的名称。 | -| owner | string | 是 | 应用帐户的所有者。| -| labels | Array<string> | 是 | 标签数组。 | -| callback | AsyncCallback<boolean> | 是 | 检查结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | --------------- | +| name | string | 是 | 应用帐号名称。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取此应用帐号的额外信息成功时，err为undefined，data返回此应用帐号的额外信息对象；否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - var 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)); - }); - } catch (err) { - console.log("checkAccountLabels err: " + JSON.stringify(err)); - } + appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { + console.log("getAccountExtraInfo err: " + JSON.stringify(err)); + console.log('getAccountExtraInfo result: ' + result); + }); ``` -### checkAccountLabels9+ +### getAccountExtraInfo(deprecated) -checkAccountLabels(name: string, owner: string, labels: Array<string>): Promise<boolean> +getAccountExtraInfo(name: string): Promise<string> -检查指定帐户是否具有特定的标签集合，使用Promise方式异步返回结果。 +获取此应用程序帐号的额外信息。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃。 +> +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------------------------- | ----- | --------------- | -| name | string | 是 | 应用帐户的名称。 | -| owner | string | 是 | 应用帐户的所有者。| -| labels | Array<string> | 是 | 标签数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | ------- | +| name | string | 是 | 应用帐号名称。 | **返回值：** -| 类型 | 说明 | -| ------------------- | -------------------------------- | -| Promise<boolean> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :-------------------- | :-------------------- | +| Promise<string> | Promise对象。返回此应用程序帐号的额外信息对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - var 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)); - }); - } catch (err) { - console.log("checkAccountLabels err: " + JSON.stringify(err)); - } + appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { + console.log('getAccountExtraInfo, result: ' + data); + }).catch((err) => { + console.log("getAccountExtraInfo err: " + JSON.stringify(err)); + }); ``` -### deleteAccountCredential9+ +### getAssociatedData(deprecated) + +getAssociatedData(name: string, key: string, callback: AsyncCallback<string>): void -deleteAccountCredential(name: string, credentialType: string, callback: AsyncCallback<void>): void +获取与此应用程序帐号关联的数据。使用callback异步回调。 -删除指定应用帐户的指定类型的凭据信息，使用callback回调异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9)替代。 +> +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------------------------- | ----- | -------------- | -| name | string | 是 | 应用帐户的名称。 | -| credentialType | string | 是 | 凭据类型。 | -| callback | AsyncCallback<void> | 是 | 删除结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ----------------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要获取的数据的键。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取与此应用程序帐号关联的数据成功时，err为undefined，data返回与此应用程序帐号关联的数据对象；否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.deleteAccountCredential("zhangsan", "pin", (err, data) => { - console.log('deleteAccountCredential: ' + JSON.stringify(data)); - console.log("deleteAccountCredential err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("deleteAccountCredential err: " + JSON.stringify(err)); - } + appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { + console.log("getAssociatedData err: " + JSON.stringify(err)); + console.log('getAssociatedData result: ' + result); + }); ``` -### deleteAccountCredential9+ +### getAssociatedData(deprecated) + +getAssociatedData(name: string, key: string): Promise<string> -deleteAccountCredential(name: string, credentialType: string): Promise<void> +获取与此应用程序帐号关联的数据。使用Promise异步回调。 -删除指定应用帐户的指定类型的凭据信息，使用Promise方式异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9-1)替代。 +> +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------ | ----- | --------------- | -| name | string | 是 | 应用帐户的名称。 | -| credentialType | string | 是 | 凭据类型。 | +| 参数名 | 类型 | 必填 | 说明 | +| ---- | ------ | ---- | --------- | +| name | string | 是 | 应用帐号名称。 | +| key | string | 是 | 要获取的数据的键。 | **返回值：** -| 类型 | 说明 | -| ------------------- | -------------------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| :-------------------- | :-------------------- | +| Promise<string> | Promise对象。返回与此应用程序帐号关联的数据对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.deleteAccountCredential("zhangsan", "pin").then((data) => { - console.log('deleteAccountCredential: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("deleteAccountCredential err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("deleteAccountCredential err: " + JSON.stringify(err)); - } + appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { + console.log('getAssociatedData: ' + data); + }).catch((err) => { + console.log("getAssociatedData err: " + JSON.stringify(err)); + }); ``` -### selectAccountsByOptions9+ +### on('change')(deprecated) -selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback<Array<AppAccountInfo>>); +on(type: 'change', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void + +订阅指定帐号所有者的帐户变更事件。使用callback异步回调。 -根据选项选择请求方可访问的帐号列表，使用callback回调异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[on('accountChange')](#onaccountchange9)替代。 +> +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ----------------------------------- | ----- | --------------- | -| options | SelectAccountsOptions | 是 | 选择帐户的选项。 | -| callback | AsyncCallback<[AppAccountInfo](#appaccountinfo)> | 是 | 选择结果的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------ | +| type | 'change' | 是 | 事件回调类型，支持的事件为'change'，当帐号所有者更新帐号时，触发该事件。 | +| owners | Array<string> | 是 | 指示帐号的所有者。 | +| callback | Callback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 回调函数。返回指定帐号所有者更新的帐号信息数组。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - var options = { - allowedOwners: ["com.example.ohos.accountjsdemo"] - }; - try { - appAccountManager.selectAccountsByOptions(options, (err, data) => { - console.log('selectAccountsByOptions: ' + JSON.stringify(data)); - console.log("selectAccountsByOptions err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("selectAccountsByOptions err: " + JSON.stringify(err)); + function changeOnCallback(data){ + console.debug("receive change data:" + JSON.stringify(data)); + } + try{ + appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback); + } + catch(err){ + console.error("on accountOnOffDemo err:" + JSON.stringify(err)); } ``` -### selectAccountsByOptions9+ +### off('change')(deprecated) -selectAccountsByOptions(options: SelectAccountsOptions): Promise<Array<AppAccountInfo>> +off(type: 'change', callback?: Callback>): void + +取消订阅帐号事件。使用callback异步回调。 -根据选项选择请求方可访问的帐户列表，使用Promise方式异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[off('accountChange')](#offaccountchange9)替代。 +> +> 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------------- | ------------------------- | ----- | --------------- | -| options | [SelectAccountsOptions](#selectaccountsoptions9) | 是 | 选择帐户的选项。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------- | -------------------------------- | -| Promise<[AppAccountInfo](#appaccountinfo)> | Promise实例，用于获取异步返回结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ------------ | +| type | 'change' | 是 | 事件回调类型，支持的事件为'change'，当帐号所有者更新帐号时，触发该事件。 | +| callback | Callback> | 否 | 回调函数，返回指定帐号所有者更新的帐号信息数组。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - var options = { - allowedOwners: ["com.example.ohos.accountjsdemo"] - }; - try { - appAccountManager.selectAccountsByOptions(options).then((data) => { - console.log('selectAccountsByOptions: ' + JSON.stringify(data)); - }).catch((err) => { - console.log("selectAccountsByOptions err: " + JSON.stringify(err)); - }); - } catch (err) { - console.log("selectAccountsByOptions err: " + JSON.stringify(err)); + function changeOnCallback(data){ + console.debug("receive change data:" + JSON.stringify(data)); + appAccountManager.off('change', function(){ + console.debug("off finish"); + }) + } + try{ + appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback); + } + catch(err){ + console.error("on accountOnOffDemo err:" + JSON.stringify(err)); } ``` -### verifyCredential9+ +### authenticate(deprecated) -verifyCredential(name: string, owner: string, callback: AuthenticatorCallback): void; +authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void + +对应用帐户进行鉴权以获取OAuth令牌。使用callback异步回调。 -验证用户凭据，使用callback回调异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[auth](#auth9)替代。 +> +> 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ----- | ----------------------- | -| name | string | 是 | 应用帐户的名称。 | -| owner | string | 是 | 应用帐户的所有者。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，返回验证结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | --------------- | +| name | string | 是 | 要鉴权的应用帐号名称。 | +| owner | string | 是 | 要鉴权的应用帐号所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| options | {[key: string]: any} | 是 | 鉴权所需的可选项。 | +| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 回调函数。返回鉴权结果对象。 | **示例：** ```js - const appAccountManager = account_appAccount.createAppAccountManager(); - try { - appAccountManager.verifyCredential("zhangsan", "com.example.ohos.accountjsdemo", { - onResult: (resultCode, result) => { - console.log("verifyCredential onResult, resultCode:" + JSON.stringify(resultCode)); - console.log("verifyCredential onResult, result:" + JSON.stringify(result)); - }, - onRequestRedirected: (request) => { - console.log("verifyCredential onRequestRedirected, request:" + JSON.stringify(request)); - } + import featureAbility from '@ohos.ability.featureAbility'; + + function onResultCallback(code, result) { + console.log("resultCode: " + code); + console.log("result: " + JSON.stringify(result)); + } + + function onRequestRedirectedCallback(request) { + let abilityStartSetting = {want: request}; + featureAbility.startAbility(abilityStartSetting, (err)=>{ + console.log("startAbility err: " + JSON.stringify(err)); }); - } catch (err) { - console.log("verifyCredential err: " + JSON.stringify(err)); } + + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.authenticate("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { + onResult: onResultCallback, + onRequestRedirected: onRequestRedirectedCallback + }); ``` -### verifyCredential9+ +### getOAuthToken(deprecated) -verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback): void; +getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void -验证用户凭据，使用callback回调异步返回结果。 +获取指定应用帐号和鉴权类型的OAuth令牌。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9)替代。 +> +> 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ----- | ----------------------- | -| name | string | 是 | 应用帐户的名称。 | -| owner | string | 是 | 应用帐户的所有者。 | -| options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的选项。 | -| callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，返回验证结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| callback | AsyncCallback<string> | 是 | 回调函数。当获取指定应用帐号和鉴权类型的Auth令牌成功时，err为undefined，data返回Auth令牌对象；否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - var 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)); - } - }); - } catch (err) { - console.log("verifyCredential err: " + JSON.stringify(err)); - } + appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { + console.log('getOAuthToken err: ' + JSON.stringify(err)); + console.log('getOAuthToken token: ' + data); + }); ``` -### setAuthenticatorProperties9+ +### getOAuthToken(deprecated) -setAuthenticatorProperties(owner: string, callback: AuthCallback): void; +getOAuthToken(name: string, owner: string, authType: string): Promise<string> + +获取指定应用帐户和鉴权类型的OAuth令牌。使用Promise异步回调。 -设置认证器属性，使用callback回调异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9-1)替代。 +> +> 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ----- | ----------------------- | -| owner | string | 是 | 认证器的所有者。 | -| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置结果。 | - -**示例：** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| authType | string | 是 | 鉴权类型。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | --------------------- | +| Promise<string> | Promise对象。返回指定应用帐户和鉴权类型的OAuth令牌对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData").then((data) => { + console.log('getOAuthToken token: ' + data); + }).catch((err) => { + console.log("getOAuthToken err: " + JSON.stringify(err)); + }); + ``` + +### setOAuthToken(deprecated) + +setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void + +设置指定应用帐号和鉴权类型的OAuth令牌。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| token | string | 是 | OAuth令牌。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定应用帐号和鉴权类型的OAuth令牌成功时，err为undefined；否则为错误对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx", (err) => { + console.log('setOAuthToken err: ' + JSON.stringify(err)); + }); + ``` + +### setOAuthToken(deprecated) + +setOAuthToken(name: string, authType: string, token: string): Promise<void> + +设置指定应用帐户和鉴权类型的OAuth令牌。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | -------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| token | string | 是 | OAuth令牌。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------- | --------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx").then(() => { + console.log('setOAuthToken successfully'); + }).catch((err) => { + console.log('setOAuthToken err: ' + JSON.stringify(err)); + }); + ``` + +### deleteOAuthToken(deprecated) + +deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void + +删除指定应用帐户和鉴权类型的OAuth令牌。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[deleteAuthToken](#deleteauthtoken9)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------ | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| token | string | 是 | 要删除的OAuth令牌。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当删除指定应用帐户和鉴权类型的OAuth令牌成功时，err为undefined；否则为错误对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => { + console.log('deleteOAuthToken err: ' + JSON.stringify(err)); + }); + ``` + +### deleteOAuthToken(deprecated) + +deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise<void> + +删除指定应用帐户和鉴权类型的OAuth令牌。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[setAuthToken](#setauthtoken9-1)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------ | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| authType | string | 是 | 鉴权类型。 | +| token | string | 是 | 要删除的OAuth令牌。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------- | --------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx").then(() => { + console.log('deleteOAuthToken successfully'); + }).catch((err) => { + console.log("deleteOAuthToken err: " + JSON.stringify(err)); + }); + ``` + +### setOAuthTokenVisibility(deprecated) + +setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void + +设置指定鉴权类型的Auth令牌对特定应用的可见性。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------- | ---- | ------------------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 被设置可见性的应用包名。 | +| isVisible | boolean | 是 | 是否可见。当设置成true可见，false不可见。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置指定鉴权类型的Auth令牌对特定应用的可见性成功时，err为undefined；否则为错误对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => { + console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); + }); + ``` + +### setOAuthTokenVisibility(deprecated) + +setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void> + +设置指定鉴权类型的OAuth令牌对特定应用的可见性。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[setAuthTokenVisibility](#setauthtokenvisibility9-1)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------- | ---- | ------------ | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 被设置可见性的应用包名。 | +| isVisible | boolean | 是 | 是否可见。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------- | --------------------- | +| Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { + console.log('setOAuthTokenVisibility successfully'); + }).catch((err) => { + console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); + }); + ``` + +### checkOAuthTokenVisibility(deprecated) + +checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void + +检查指定鉴权类型的OAuth令牌对特定应用的可见性。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ---------------------------- | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 检查可见性的应用包名。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。检查指定鉴权类型的OAuth令牌对特定应用的可见性时，err为undefined，data为true表示可见，data为false表示不可见；否则为错误对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", (err, data) => { + console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); + console.log('checkOAuthTokenVisibility isVisible: ' + data); + }); + ``` + +### checkOAuthTokenVisibility(deprecated) + +checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean> + +检查指定鉴权类型的OAuth令牌对特定应用的可见性。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[checkAuthTokenVisibility](#checkauthtokenvisibility9-1)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------ | ---- | ------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 鉴权类型。 | +| bundleName | string | 是 | 用于检查可见性的应用包名。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------- | --------------------- | +| Promise<boolean> | Promise对象。返回true表示指定鉴权类型的OAuth令牌对特定应用的可见，返回false表示不可见。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo").then((data) => { + console.log('checkOAuthTokenVisibility isVisible: ' + data); + }).catch((err) => { + console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); + }); + ``` + +### getAllOAuthTokens(deprecated) + +getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void + +获取指定应用对调用方全部可见的OAuth令牌。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | +| callback | AsyncCallback<Array< [OAuthTokenInfo](#oauthtokeninfodeprecated)>> | 是 | 回调函数。当获取指定应用对调用方全部可见的OAuth令牌成功时，err为undefined，data为全部可见的OAuth令牌数组；否则为错误对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo", (err, data) => { + console.log("getAllOAuthTokens err: " + JSON.stringify(err)); + console.log('getAllOAuthTokens data: ' + JSON.stringify(data)); + }); + ``` + +### getAllOAuthTokens(deprecated) + +getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenInfo>> + +获取指定应用帐户对调用方可见的全部OAuth令牌。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[getAllAuthTokens](#getallauthtokens9-1)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------- | +| name | string | 是 | 应用帐号的名称。 | +| owner | string | 是 | 应用帐号的所有者包名。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise<Array< [OAuthTokenInfo](#oauthtokeninfodeprecated)>> | Promise对象。返回指定应用帐户对调用方可见的全部OAuth令牌对象。 | + +**示例：** ```js const 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.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => { + console.log('getAllOAuthTokens data: ' + JSON.stringify(data)); + }).catch((err) => { + console.log("getAllOAuthTokens err: " + JSON.stringify(err)); + }); + ``` + +### getOAuthList(deprecated) + +getOAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void + +获取指定应用帐户和鉴权类型的OAuth令牌的授权列表。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ----------------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表。 | +| callback | AsyncCallback<Array<string>> | 是 | 回调函数。当获取指定应用帐户和鉴权类型的OAuth令牌的授权列表成功时，err为undefined，data为OAuth令牌的授权列表；否则为错误对象。 | + +**示例：** + + ```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)); + }); + ``` + +### getOAuthList(deprecated) + +getOAuthList(name: string, authType: string): Promise<Array<string>> + +获取指定应用帐户和鉴权类型的OAuth令牌的授权列表。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[getAuthList](#getauthlist9-1)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ----------------------- | +| name | string | 是 | 应用帐号的名称。 | +| authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------------------- | --------------------- | +| Promise<Array<string>> | Promise对象。返回指定应用帐户和鉴权类型的OAuth令牌的授权列表对象。 | + +**示例：** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => { + console.log('getOAuthList data: ' + JSON.stringify(data)); + }).catch((err) => { + console.log("getOAuthList err: " + JSON.stringify(err)); + }); + ``` + +### getAuthenticatorCallback(deprecated) + +getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<AuthenticatorCallback>): void + +获取鉴权会话的认证器回调。使用callback异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[getAuthCallback](#getauthcallback9)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------------------- | ---- | -------- | +| sessionId | string | 是 | 鉴权会话的标识。 | +| callback | AsyncCallback<[AuthenticatorCallback](#authenticatorcallbackdeprecated)> | 是 | 回调函数。当获取鉴权会话的认证器回调函数成功时，err为undefined，data为认证器回调函数；否则为错误对象。 | + +**示例：** + + ```js + import featureAbility from '@ohos.ability.featureAbility'; + const appAccountManager = account_appAccount.createAppAccountManager(); + featureAbility.getWant((err, want) => { + var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; + appAccountManager.getAuthenticatorCallback(sessionId, (err, callback) => { + if (err.code != account_appAccount.ResultCode.SUCCESS) { + console.log("getAuthenticatorCallback 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); + }); + }); + ``` + +### getAuthenticatorCallback(deprecated) + +getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback> + +获取鉴权会话的认证器回调。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[getAuthCallback](#getauthcallback9-1)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | -------- | +| sessionId | string | 是 | 鉴权会话的标识。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------ | --------------------- | +| Promise<[AuthenticatorCallback](#authenticatorcallbackdeprecated)> | Promise对象。返回鉴权会话的认证器回调对象。 | + +**示例：** + + ```js + import featureAbility from '@ohos.ability.featureAbility'; + + const appAccountManager = account_appAccount.createAppAccountManager(); + featureAbility.getWant().then((want) => { + var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; + 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_AUTH_TYPE]: "getSocialData", + [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); + }).catch((err) => { + console.log("getAuthenticatorCallback err: " + JSON.stringify(err)); }); - } catch (err) { - console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); - } + }).catch((err) => { + console.log("getWant err: " + JSON.stringify(err)); + }); ``` -### setAuthenticatorProperties9+ +### getAuthenticatorInfo(deprecated) -setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthCallback): void; +getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void + +获取指定应用帐号的认证器信息。使用callback异步回调。 -设置认证器属性，使用callback回调异步返回结果。 +> **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9)替代。 +> +> 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ----- | ----------------------- | -| owner | string | 是 | 认证器的所有者。 | -| options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的选项。 | -| callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置结果。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ----------- | +| owner | string | 是 | 应用帐号的所有者包名。 | +| callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 回调函数。当获取指定应用帐号的认证器信息成功时，err为undefined，data为认证器信息对象；否则为错误对象。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); - var 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)); - } - }); - } catch (err) { - console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); - } + appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo", (err, data) => { + console.log("getAuthenticatorInfo err: " + JSON.stringify(err)); + console.log('getAuthenticatorInfo data: ' + JSON.stringify(data)); + }); + ``` + +### getAuthenticatorInfo(deprecated) + +getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> + +获取指定应用帐户的认证器信息。使用Promise异步回调。 + +> **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9-1)替代。 +> +> 从 API version 8开始支持。 + +**系统能力：** SystemCapability.Account.AppAccount + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------- | +| owner | string | 是 | 应用帐号的所有者包名。 | + +**返回值：** + +| 类型 | 说明 | +| -------------------------------- | --------------------- | +| Promise<[AuthenticatorInfo](#authenticatorinfo8)> | Promise对象。返回指定应用帐户的认证器信息对象。 | + +**示例：** + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => { + console.log('getAuthenticatorInfo: ' + JSON.stringify(data)); + }).catch((err) => { + console.log("getAuthenticatorInfo err: " + JSON.stringify(err)); + }); ``` ## AppAccountInfo 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 d9e03d2412..5d62db3f11 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 @@ -7,7 +7,7 @@ ## 导入模块 - + ```js import account_distributedAccount from '@ohos.account.distributedAccount'; ``` @@ -40,7 +40,7 @@ getDistributedAccountAbility(): DistributedAccountAbility getOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): void -获取分布式帐号信息，使用callback回调异步返回结果。 +获取分布式帐号信息，使用callback异步回调。 **系统能力：** SystemCapability.Account.OsAccount @@ -50,7 +50,15 @@ getOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): voi | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[DistributedInfo](#distributedinfo)> | 是 | 获取分布式帐号信息的回调。 | + | callback | AsyncCallback<[DistributedInfo](#distributedinfo)> | 是 | 回调参数。当获取分布式帐号信息成功，err为undefined，data为获取到的分布式帐号信息对象；否则为错误对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 201 | permission denied. | + | 401 | the parameter check failed. | + | 12300001 | system service exception. | **示例：** ```js @@ -70,7 +78,7 @@ getOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): voi getOsAccountDistributedInfo(): Promise<DistributedInfo> -获取分布式帐号信息，使用Promise方式异步返回结果。 +获取分布式帐号信息。使用Promise异步回调。 **系统能力：** SystemCapability.Account.OsAccount @@ -80,7 +88,15 @@ getOsAccountDistributedInfo(): Promise<DistributedInfo> | 类型 | 说明 | | -------- | -------- | - | Promise<[DistributedInfo](#distributedinfo)> | Promise实例，用于获取异步返回结果。 | + | Promise<[DistributedInfo](#distributedinfo)> | Promise对象。返回分布式帐号信息对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 201 | permission denied. | + | 401 | the parameter check failed. | + | 12300001 | system service exception. | **示例：** ```js @@ -100,7 +116,7 @@ getOsAccountDistributedInfo(): Promise<DistributedInfo> queryOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): void -获取分布式帐号信息，使用callback回调异步返回结果。 +获取分布式帐号信息。使用callback异步回调。 > **说明：** 从API version 9开始废弃，建议使用[getOsAccountDistributedInfo](#getosaccountdistributedinfo9) > > 从 API version 7开始支持。 @@ -113,7 +129,7 @@ queryOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): v | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[DistributedInfo](#distributedinfo)> | 是 | 获取分布式帐号信息的回调。 | + | callback | AsyncCallback<[DistributedInfo](#distributedinfo)> | 是 | 回调函数。当获取分布式帐号信息成功，err为undefined，data为获取到的分布式帐号信息对象；否则为错误对象。 | **示例：** ```js @@ -129,7 +145,7 @@ queryOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): v queryOsAccountDistributedInfo(): Promise<DistributedInfo> -获取分布式帐号信息，使用Promise方式异步返回结果。 +获取分布式帐号信息。使用Promise异步回调。 > **说明：** 从API version 9开始废弃，建议使用[getOsAccountDistributedInfo](#getosaccountdistributedinfo9-1) > > 从 API version 7开始支持。 @@ -142,7 +158,7 @@ queryOsAccountDistributedInfo(): Promise<DistributedInfo> | 类型 | 说明 | | -------- | -------- | - | Promise<[DistributedInfo](#distributedinfo)> | Promise实例，用于获取异步返回结果。 | + | Promise<[DistributedInfo](#distributedinfo)> | Promise对象。返回分布式帐号信息对象。 | **示例：** ```js @@ -159,7 +175,7 @@ queryOsAccountDistributedInfo(): Promise<DistributedInfo> setOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback<void>): void -更新分布式帐号信息，使用callback回调异步返回结果。 +更新分布式帐号信息。使用callback异步回调。 **系统能力：** SystemCapability.Account.OsAccount @@ -170,7 +186,16 @@ setOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallbac | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | accountInfo | [DistributedInfo](#distributedinfo) | 是 | 分布式帐号信息。 | - | callback | AsyncCallback<void> | 是 | 更新分布式帐号信息的回调。 | + | callback | AsyncCallback<void> | 是 | 回调函数。当更新分布式帐号信息成功时，err为undefined，否则为错误对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 201 | permission denied. | + | 401 | the parameter check failed. | + | 12300001 | system service exception. | + | 12300002 | invalid accountInfo. | **示例：** ```js @@ -189,7 +214,7 @@ setOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallbac setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void> -更新分布式帐号信息，使用Promise方式异步返回结果。 +更新分布式帐号信息。使用Promise异步回调。 **系统能力：** SystemCapability.Account.OsAccount @@ -205,7 +230,16 @@ setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void> | 类型 | 说明 | | -------- | -------- | - | Promise<void> | Promise实例，用于获取异步返回结果。 | + | Promise<void> | Promise对象。无返回结果的Promise对象。 | + +**错误码：** + + | 错误码ID | 错误信息| + | ------- | -------| + | 201 | permission denied. | + | 401 | the parameter check failed. | + | 12300001 | system service exception. | + | 12300002 | invalid accountInfo. | **示例：** ```js @@ -225,7 +259,7 @@ setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void> updateOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback<void>): void -更新分布式帐号信息，使用callback回调异步返回结果。 +更新分布式帐号信息。使用callback异步回调。 > **说明：** 从API version 9开始废弃，建议使用[setOsAccountDistributedInfo](#setosaccountdistributedinfo9) > > 从 API version 7开始支持。 @@ -239,7 +273,7 @@ updateOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCall | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | accountInfo | [DistributedInfo](#distributedinfo) | 是 | 分布式帐号信息。 | - | callback | AsyncCallback<void> | 是 | 更新分布式帐号信息的回调。 | + | callback | AsyncCallback<void> | 是 | 回调函数。当更新分布式帐号信息成功时，err为undefined，否则为错误对象。 | **示例：** ```js @@ -254,7 +288,7 @@ updateOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCall updateOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void> -更新分布式帐号信息，使用Promise方式异步返回结果。 +更新分布式帐号信息。使用Promise异步回调。 > **说明：** 从API version 9开始废弃，建议使用[setOsAccountDistributedInfo](#setosaccountdistributedinfo9-1) > > 从 API version 7开始支持。 @@ -272,7 +306,7 @@ updateOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void> | 类型 | 说明 | | -------- | -------- | - | Promise<void> | Promise实例，用于获取异步返回结果。 | + | Promise<void> | Promise对象。无返回结果的Promise对象。 | **示例：** ```js 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 45c3e9c87a..c13f884ac9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-osAccount.md +++ b/zh-cn/application-dev/reference/apis/js-apis-osAccount.md @@ -662,7 +662,7 @@ isVerified(callback: AsyncCallback<boolean>): void ### isVerified9+ -isOsAccountVerified(localId: number, callback: AsyncCallback<boolean>): void +isVerified(localId: number, callback: AsyncCallback<boolean>): void 检查指定系统帐号是否已验证，使用callback回调异步返回结果。 @@ -693,7 +693,7 @@ isOsAccountVerified(localId: number, callback: AsyncCallback<boolean>): vo ### isVerified9+ -isOsAccountVerified(localId?: number): Promise<boolean> +isVerified(localId?: number): Promise<boolean> 检查指定系统帐号是否已验证，使用Promise方式异步返回结果。 @@ -1423,7 +1423,7 @@ getOsAccountLocalIdFromUid(uid: number): Promise<number> ### queryOsAccountLocalIdFromDomain9+ -getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void +queryOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void 根据域帐号信息，获取与其关联的系统帐号的帐号ID。 -- GitLab