# 应用帐号管理 本模块不仅用于对应用帐号的添加、删除、查询、修改和授权，且提供帐号将数据写入磁盘和数据同步的能力。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 ```js import account_appAccount from '@ohos.account.appAccount'; ``` ## account_appAccount.createAppAccountManager createAppAccountManager(): AppAccountManager 获取应用帐号模块的对象。 **系统能力：** SystemCapability.Account.AppAccount **返回值：** | 类型 | 说明 | | ----------------- | ------------ | | AppAccountManager | 获取应用帐号模块的实例。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); ``` ## AppAccountManager 管理应用帐号模块的实例。 ### createAccount9+ createAccount(name: string, callback: AsyncCallback<void>): void; 将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | -------------------- | | name | string | 是 | 要添加的应用帐号名称。 | | callback | AsyncCallback<void> | 是 | 将此应用的帐号名添加到帐号管理服务回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.createAccount("WangWu", (err) => { console.log("createAccount err: " + JSON.stringify(err)); }); } catch (err) { console.log("createAccount err: " + JSON.stringify(err)); } ``` ### createAccount9+ createAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void 将此应用程序的帐号名和额外信息（能转换string类型的其它信息，如token）添加到帐号管理服务中，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | ---------------------------------------- | | name | string | 是 | 要添加的应用帐号名称。 | | extraInfo | string | 是 | 要添加的应用帐号的额外信息(能转换string类型的其它信息，如token等)，额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | | callback | AsyncCallback<void> | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.createAccount("LiSi", "token101", (err) => { console.log("createAccount err: " + JSON.stringify(err)); }); } catch (err) { console.log("createAccount err: " + JSON.stringify(err)); } ``` ### createAccount9+ createAccount(name: string, extraInfo?: string): Promise<void> 将此应用的帐号名或额外信息（能转换成string类型的其它信息）添加到帐号管理服务中，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------------------------------------- | | name | string | 是 | 要添加的应用帐号名称。 | | extraInfo | string | 否 | 要添加的应用帐号的额外信息（能转换成string类型的其它信息），额外信息不能是应用帐号的敏感信息（如应用账号密码）。 | **返回值：** | 类型 | 说明 | | ------------------- | --------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.createAccount("LiSi", "token101").then(()=> { console.log('createAccount Success'); }).catch((err) => { console.log("createAccount err: " + JSON.stringify(err)); }); } catch (err) { console.log("createAccount err: " + JSON.stringify(err)); } ``` ### addAccount(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 根据指定的帐号所有者隐式地添加应用帐号，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ----------------------- | | owner | string | 是 | 要添加的应用帐号所有者包名。 | | callback | [AuthCallback](#authcallback9) | 是 | 认证回调，用于返回鉴权结果。 | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; function onResultCallback(code, result) { console.log("resultCode: " + code); console.log("result: " + JSON.stringify(result)); } function onRequestRedirectedCallback(request) { let abilityStartSetting = {want: request}; featureAbility.startAbility(abilityStartSetting, (err)=>{ console.log("startAbility err: " + JSON.stringify(err)); }); } const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.createAccountImplicitly("com.example.ohos.accountjsdemo", { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); } catch (err) { console.log("createAccountImplicitly err: " + JSON.stringify(err)); } ``` ### createAccountImplicitly9+ createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, callback: AuthCallback): void 根据指定的帐号所有者和可选项隐式地添加应用帐号，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ----------------------- | | owner | string | 是 | 要添加的应用帐号所有者包名。 | | options | [CreateAccountImplicitlyOptions](#createaccountimplicitlyoptions9) | 是 | 隐式创建账号的选项。 | | callback | [AuthCallback](#authcallback9) | 是 | 认证回调，用于返回鉴权结果。 | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; function onResultCallback(code, result) { console.log("resultCode: " + code); console.log("result: " + JSON.stringify(result)); } function onRequestRedirectedCallback(request) { let abilityStartSetting = {want: request}; featureAbility.startAbility(abilityStartSetting, (err)=>{ console.log("startAbility err: " + JSON.stringify(err)); }); } const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.createAccountImplicitly("com.example.ohos.accountjsdemo", { requiredLabels: ["student"], authType: "getSocialData"}, { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); } catch (err) { console.log("createAccountImplicitly err: " + JSON.stringify(err)); } ``` ### addAccountImplicitly(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回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------- | | name | string | 是 | 要删除的应用帐号名称。 | | callback | AsyncCallback<void> | 是 | 帐号管理服务中移除应用帐号的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.removeAccount("ZhaoLiu", (err) => { console.log("removeAccount err: " + JSON.stringify(err)); }); } catch (err) { console.log("removeAccount err: " + JSON.stringify(err)); } ``` ### removeAccount9+ deleteAccount(name: string): Promise<void> 从帐号管理服务中移除应用帐号，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----------- | | name | string | 是 | 要移除的应用帐号名称。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.deleteAccount("ZhaoLiu").then(() => { console.log('removeAccount Success'); }).catch((err) => { console.log("removeAccount err: " + JSON.stringify(err)); }); } catch (err) { console.log("removeAccount err: " + JSON.stringify(err)); } ``` ### deleteAccount(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 设置指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，由isAccessible指明是允许访问还是禁止访问，callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | --------------------------------- | | name | string | 是 | 应用帐号名称。 | | bundleName | string | 是 | 第三方应用的包名。 | | isAccessible | boolean | 是 | 访问控制，允许访问或禁止访问。 | | callback | AsyncCallback<void> | 是 | 访问权限设置的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", true, (err) => { console.log("enableAppAccess: " + JSON.stringify(err)); }); } catch (err) { console.log("enableAppAccess: " + JSON.stringify(err)); } ``` ### setAppAccess9+ setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise<void> 设置指定第三方应用帐号名称对指定包名称的第三方应用的访问权限，由isAccessible指明是允许访问还是禁止访问，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | --------- | | name | string | 是 | 应用帐号名称。 | | bundleName | string | 是 | 第三方应用的包名。 | | isAccessible | boolean | 是 | 访问控制，允许访问或禁止访问。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", true).then(() => { console.log('setAppAccess Success'); }).catch((err) => { console.log("setAppAccess err: " + JSON.stringify(err)); }); } catch (err) { console.log("setAppAccess err: " + JSON.stringify(err)); } ``` ### disableAppAccess(deprecated) disableAppAccess(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.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { console.log("disableAppAccess err: " + JSON.stringify(err)); }); ``` ### disableAppAccess(deprecated) disableAppAccess(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.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实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.checkAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { console.log('checkAppAccess Success'); }).catch((err) => { console.log("checkAppAccess err: " + JSON.stringify(err)); }); } catch (err) { console.log("checkAppAccess err: " + JSON.stringify(err)); } ``` ### checkDataSyncEnabled9+ checkDataSyncEnabled(name: string, callback: AsyncCallback<boolean>): void 检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------- | ---- | --------------------- | | name | string | 是 | 应用帐号名称。 | | callback | AsyncCallback<boolean> | 是 | 检查指定应用帐号是否允许应用数据同步回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.checkDataSyncEnabled("ZhangSan", (err, result) => { console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); console.log('checkDataSyncEnabled result: ' + result); }); } catch (err) { console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); } ``` ### checkDataSyncEnabled9+ checkDataSyncEnabled(name: string): Promise<boolean> 检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------- | | name | string | 是 | 应用帐号名称。 | **返回值：** | 类型 | 说明 | | :--------------------- | :-------------------- | | Promise<boolean> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.checkDataSyncEnabled("ZhangSan").then((data) => { console.log('checkDataSyncEnabled, result: ' + data); }).catch((err) => { console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); }); } catch (err) { console.log("checkDataSyncEnabled err: " + JSON.stringify(err)); } ``` ### checkAppAccountSyncEnable(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回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ---- | ------------- | | name | string | 是 | 应用程序帐号名称。 | | credentialType | string | 是 | 要设置的凭据类型。 | | credential | string | 是 | 要设置的凭据。 | | callback | AsyncCallback<void> | 是 | 设置此应用帐号的凭据回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setCredential("ZhangSan", "credentialType001", "credential001", (err) => { console.log("setCredential err: " + JSON.stringify(err)); }); } catch (err) { console.log("setCredential err: " + JSON.stringify(err)); } ``` ### setCredential9+ setCredential(name: string, credentialType: string, credential: string): Promise<void> 设置此应用程序帐号的凭据，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------- | | name | string | 是 | 应用帐号的名称。 | | credentialType | string | 是 | 要设置的凭据的类型。 | | credential | string | 是 | 要设置的凭据。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setCredential("ZhangSan", "credentialType001", "credential001").then(() => { console.log('setCredential Success'); }).catch((err) => { console.log("setCredential err: " + JSON.stringify(err)); }); } catch (err) { console.log("setCredential err: " + JSON.stringify(err)); } ``` ### setAccountCredential(deprecated) setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void 设置此应用程序帐号的凭据，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ---- | ------------- | | name | string | 是 | 应用程序帐号名称。 | | credentialType | string | 是 | 要设置的凭据类型。 | | credential | string | 是 | 要设置的凭据。 | | callback | AsyncCallback<void> | 是 | 设置此应用帐号的凭据回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { console.log("setAccountCredential err: " + JSON.stringify(err)); }); ``` ### setAccountCredential(deprecated) setAccountCredential(name: string, credentialType: string, credential: string): Promise<void> 设置此应用程序帐号的凭据，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃，建议使用[setCredential](#setcredential9-1)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------- | | name | string | 是 | 应用帐号的名称。 | | credentialType | string | 是 | 要设置的凭据的类型。 | | credential | string | 是 | 要设置的凭据。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```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)); }); ``` ### setAccountExtraInfo(deprecated) setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<void>): void 设置此应用程序帐号的额外信息，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | --------------- | | name | string | 是 | 应用帐号名称。 | | extraInfo | string | 是 | 要设置的额外信息。 | | callback | AsyncCallback<void> | 是 | 设置此应用帐号的额外信息回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { console.log("setAccountExtraInfo err: " + JSON.stringify(err)); }); ``` ### setAccountExtraInfo(deprecated) setAccountExtraInfo(name: string, extraInfo: string): Promise<void> 设置此应用程序帐号的额外信息，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | --------- | | name | string | 是 | 应用帐号名称。 | | extraInfo | string | 是 | 要设置的额外信息。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { console.log('setAccountExtraInfo Success'); }).catch((err) => { console.log("setAccountExtraInfo err: " + JSON.stringify(err)); }); ``` ### setDataSyncEnabled9+ setDataSyncEnabled(name: string, isEnable: boolean, callback: AsyncCallback<void>): void 设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------- | | name | string | 是 | 应用帐号名称。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 | | callback | AsyncCallback<void> | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setDataSyncEnabled("ZhangSan", true, (err) => { console.log("setDataSyncEnabled err: " + JSON.stringify(err)); }); } catch (err) { console.log("setDataSyncEnabled err: " + JSON.stringify(err)); } ``` ### setDataSyncEnabled9+ setDataSyncEnabled(name: string, isEnable: boolean): Promise<void> 设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------- | ---- | ----------- | | name | string | 是 | 应用帐号名称。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager .setDataSyncEnabled("ZhangSan", true).then(() => { console.log('setDataSyncEnabled Success'); }).catch((err) => { console.log("setDataSyncEnabled err: " + JSON.stringify(err)); }); } catch (err) { console.log("setDataSyncEnabled err: " + JSON.stringify(err)); } ``` ### setAppAccountSyncEnable(deprecated) setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback<void>): void 设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9)替代。 > > 从 API version 7开始支持。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------- | | name | string | 是 | 应用帐号名称。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 | | callback | AsyncCallback<void> | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); }); ``` ### setAppAccountSyncEnable(deprecated) setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> 设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[setDataSyncEnabled](#setdatasyncenabled9-1)替代。 > > 从 API version 7开始支持。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------- | ---- | ----------- | | name | string | 是 | 应用帐号名称。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { console.log('setAppAccountSyncEnable Success'); }).catch((err) => { console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); }); ``` ### setCustomData9+ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void 设置与此应用程序帐号关联的数据，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ----------------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | value | string | 是 | 要设置的数据的值。 | | callback | AsyncCallback<void> | 是 | 设置与此应用帐号关联的数据的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setCustomData("ZhangSan", "k001", "v001", (err) => { console.log("setCustomData err: " + JSON.stringify(err)); }); } catch (err) { console.log("setCustomData err: " + JSON.stringify(err)); } ``` ### setCustomData9+ setAssociatedData(name: string, key: string, value: string): Promise<void> 设置与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | value | string | 是 | 要设置的数据的值。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); 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)); } ``` ### setAssociatedData(deprecated) setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void 设置与此应用程序帐号关联的数据，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ----------------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | value | string | 是 | 要设置的数据的值。 | | callback | AsyncCallback<void> | 是 | 设置与此应用帐号关联的数据的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { console.log("setAssociatedData err: " + JSON.stringify(err)); }); ``` ### setAssociatedData(deprecated) setAssociatedData(name: string, key: string, value: string): Promise<void> 设置与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[setCustomData](#setcustomdata9-1)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | value | 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 **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | | callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | **示例：** ```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)); }); } catch (err) { console.debug("getAllAccounts err:" + JSON.stringify(err)); } ``` ### getAllAccounts9+ getAllAccounts(): Promise<Array<AppAccountInfo>> 获取全部应用已授权帐号信息。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **返回值：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.getAllAccounts().then((data) => { console.log('getAllAccounts: ' + data); }).catch((err) => { console.log("getAllAccounts err: " + JSON.stringify(err)); }); } catch (err) { console.log("getAllAccounts err: " + JSON.stringify(err)); } ``` ### getAllAccessibleAccounts(deprecated) getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void 获取全部应用已授权帐号信息。 > **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9)替代。 > > 从 API version 7开始支持。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | | callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAllAccessibleAccounts((err, data)=>{ console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err)); console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data)); }); ``` ### getAllAccessibleAccounts(deprecated) getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>> 获取全部应用已授权帐号信息。 > **说明：** 从API version 9开始废弃, 建议使用[getAllAccounts](#getallaccounts9-1)替代。 > > 从 API version 7开始支持。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **返回值：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAllAccessibleAccounts().then((data) => { console.log('getAllAccessibleAccounts: ' + data); }).catch((err) => { console.log("getAllAccessibleAccounts err: " + JSON.stringify(err)); }); ``` ### getAccountsByOwner9+ getAccountsByOwner(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void 获取指定应用全部帐号信息。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | | owner | string | 是 | 应用包名称。 | | callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | **示例：** ```js 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)); }); } catch (err) { console.debug("getAccountsByOwner err:" + JSON.stringify(err)); } ``` ### getAccountsByOwner9+ getAccountsByOwner(owner: string): Promise<Array<AppAccountInfo>> 获取指定应用全部帐号信息。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ------ | | owner | string | 是 | 应用包名称。 | **返回值：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise实例，用于获取异步返回结果。 | **示例：** ```js 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)); }); } catch (err) { console.log("getAccountsByOwner err: " + JSON.stringify(err)); } ``` ### getAllAccounts(deprecated) getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void 获取指定应用全部帐号信息。 > **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner]替代。 > > 从 API version 7开始支持。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | --------- | | owner | string | 是 | 应用包名称。 | | callback | AsyncCallback<Array<[AppAccountInfo](#appaccountinfo)>> | 是 | 应用帐号信息列表。 | **示例：** ```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)); }); ``` ### getAllAccounts(deprecated) getAllAccounts(owner: string): Promise<Array<AppAccountInfo>> 获取指定应用全部帐号信息。 > **说明：** 从API version 9开始废弃, 建议使用[getAccountsByOwner](#getaccountsbyowner9-1)替代。 > > 从 API version 7开始支持。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ------ | | owner | string | 是 | 应用包名称。 | **返回值：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array<[AppAccountInfo](#appaccountinfo)>> | Promise实例，用于获取异步返回结果。 | **示例：** ```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)); }); ``` ### getCredential9+ getCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void 获取此应用帐号的凭据（如数字密码、人脸和PIN码等），使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | --------------------------- | ---- | -------------- | | name | string | 是 | 应用帐号名称。 | | credentialType | string | 是 | 获取此应用帐号的凭据的类型。 | | callback | AsyncCallback<string> | 是 | 获取此应用帐号的凭据的回调。 | **示例：** ```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); }); } catch (err) { console.log("getCredential err: " + JSON.stringify(err)); } ``` ### getCredential9+ getCredential(name: string, credentialType: string): Promise<string> 获取此应用程序帐号的凭据，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------- | | name | string | 是 | 应用帐号名称。 | | credentialType | string | 是 | 要获取的凭据的类型。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.getCredential("ZhangSan", "credentialType001").then((data) => { console.log('getCredential, result: ' + data); }).catch((err) => { console.log("getCredential err: " + JSON.stringify(err)); }); } catch (err) { console.log("getCredential err: " + JSON.stringify(err)); } ``` ### getAccountCredential(deprecated) getAccountCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void 获取此应用帐号的凭据（如数字密码、人脸和PIN码等），使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | --------------------------- | ---- | -------------- | | name | string | 是 | 应用帐号名称。 | | credentialType | string | 是 | 获取此应用帐号的凭据的类型。 | | callback | AsyncCallback<string> | 是 | 获取此应用帐号的凭据的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { console.log("getAccountCredential err: " + JSON.stringify(err)); console.log('getAccountCredential result: ' + result); }); ``` ### getAccountCredential(deprecated) getAccountCredential(name: string, credentialType: string): Promise<string> 获取此应用程序帐号的凭据，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[getCredential](#getcredential9-1)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------- | | name | string | 是 | 应用帐号名称。 | | credentialType | string | 是 | 要获取的凭据的类型。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountCredential("ZhangSan", "credentialType001").then((data) => { console.log('getAccountCredential, result: ' + data); }).catch((err) => { console.log("getAccountCredential err: " + JSON.stringify(err)); }); ``` ### getAccountExtraInfo(deprecated) getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void 获取此应用帐号的额外信息（能转换成string类型的其它信息），使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | --------------- | | name | string | 是 | 应用帐号名称。 | | callback | AsyncCallback<string> | 是 | 获取此应用帐号的额外信息回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { console.log("getAccountExtraInfo err: " + JSON.stringify(err)); console.log('getAccountExtraInfo result: ' + result); }); ``` ### getAccountExtraInfo(deprecated) getAccountExtraInfo(name: string): Promise<string> 获取此应用程序帐号的额外信息，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------- | | name | string | 是 | 应用帐号名称。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { console.log('getAccountExtraInfo, result: ' + data); }).catch((err) => { console.log("getAccountExtraInfo err: " + JSON.stringify(err)); }); ``` ### getCustomData9+ getCustomData(name: string, key: string, callback: AsyncCallback<string>): void 获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要获取的数据的键。 | | callback | AsyncCallback<string> | 是 | 获取与此应用帐号关联的数据的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.getCustomData("ZhangSan", "k001", (err, result) => { console.log("getCustomData err: " + JSON.stringify(err)); console.log('getCustomData result: ' + result); }); } catch (err) { console.log("getCustomData err: " + JSON.stringify(err)); } ``` ### getCustomData9+ getCustomData(name: string, key: string): Promise<string> 获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | --------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要获取的数据的键。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.getCustomData("ZhangSan", "k001").then((data) => { console.log('getCustomData: ' + data); }).catch((err) => { console.log("getCustomData err: " + JSON.stringify(err)); }); } catch (err) { console.log("getCustomData err: " + JSON.stringify(err)); } ``` ### getAssociatedData(deprecated) getAssociatedData(name: string, key: string, callback: AsyncCallback<string>): void 获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要获取的数据的键。 | | callback | AsyncCallback<string> | 是 | 获取与此应用帐号关联的数据的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { console.log("getAssociatedData err: " + JSON.stringify(err)); console.log('getAssociatedData result: ' + result); }); ``` ### getAssociatedData(deprecated) getAssociatedData(name: string, key: string): Promise<string> 获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[getCustomData](#getcustomdata9-1)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | --------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要获取的数据的键。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { console.log('getAssociatedData: ' + data); }).catch((err) => { console.log("getAssociatedData err: " + JSON.stringify(err)); }); ``` ### getAssociatedDataSync9+ getAssociatedDataSync(name: string, key: string): string; 获取与此应用程序帐号关联的数据，使用同步方式返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | --------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要获取的数据的键。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | string | 目标关联数据的取值。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { var backData = appAccountManager.getAssociatedDataSync("ZhangSan", "k001"); console.info("getAssociatedDataSync backData:" + JSON.stringify(backData)); } catch (err) { console.error(`getAssociatedDataSync err, code is ${e.code}, message is ${e.message}`); } ``` ### on('accountChange')9+ on(type: 'accountChange', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void 订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。 **系统能力：** 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回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[on('accountChange')](#onaccountchange9)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | | type | 'change' | 是 | 关于帐号更改事件，当帐号所有者更新帐号时，订阅者将收到通知。 | | 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('change', ["com.example.actsaccounttest"], changeOnCallback); } catch(err){ console.error("on accountOnOffDemo err:" + JSON.stringify(err)); } ``` ### off('accountChange')9+ off(type: 'accountChange', callback?: Callback>): void 取消订阅帐号事件，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------- | ---- | ------------ | | type | 'accountChange' | 是 | 关于帐号更改事件。 | | callback | Callback> | 否 | 取消订阅帐号事件的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); function changeOnCallback(data){ console.debug("receive change data:" + JSON.stringify(data)); appAccountManager.off('accountChange', function(){ console.debug("off finish"); }) } try{ appAccountManager.on('accountChange', ["com.example.actsaccounttest"], changeOnCallback); } catch(err){ console.error("on accountOnOffDemo err:" + JSON.stringify(err)); } ``` ### off('change')(deprecated) off(type: 'change', callback?: Callback>): void 取消订阅帐号事件，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[off('accountChange')](#offaccountchange9)替代。 > > 从 API version 7开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------- | ---- | ------------ | | type | 'change' | 是 | 关于帐号更改事件。 | | callback | Callback> | 否 | 取消订阅帐号事件的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); function changeOnCallback(data){ console.debug("receive change data:" + JSON.stringify(data)); appAccountManager.off('change', function(){ console.debug("off finish"); }) } try{ appAccountManager.on('change', ["com.example.actsaccounttest"], changeOnCallback); } catch(err){ console.error("on accountOnOffDemo err:" + JSON.stringify(err)); } ``` ### auth9+ auth(name: string, owner: string, authType: string, callback: AuthCallback): void 对应用帐户进行鉴权以获取Auth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | --------------- | | name | string | 是 | 要鉴权的应用帐号名称。 | | owner | string | 是 | 要鉴权的应用帐号所有者包名。 | | authType | string | 是 | 鉴权类型。 | | callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回鉴权结果。 | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; function onResultCallback(code, result) { console.log("resultCode: " + code); console.log("result: " + JSON.stringify(result)); } function onRequestRedirectedCallback(request) { let abilityStartSetting = {want: request}; featureAbility.startAbility(abilityStartSetting, (err)=>{ console.log("startAbility err: " + JSON.stringify(err)); }); } const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); } catch (err) { console.log("auth err: " + JSON.stringify(err)); } ``` ### auth9+ auth(name: string, owner: string, authType: string, options: {[key: string]: Object}, callback: AuthCallback): void 对应用帐户进行鉴权以获取OAuth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | --------------- | | name | string | 是 | 要鉴权的应用帐号名称。 | | owner | string | 是 | 要鉴权的应用帐号所有者包名。 | | authType | string | 是 | 鉴权类型。 | | options | {[key: string]: Object} | 是 | 鉴权所需的可选项。 | | callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，用于返回鉴权结果。 | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; function onResultCallback(code, result) { console.log("resultCode: " + code); console.log("result: " + JSON.stringify(result)); } function onRequestRedirectedCallback(request) { let abilityStartSetting = {want: request}; featureAbility.startAbility(abilityStartSetting, (err)=>{ console.log("startAbility err: " + JSON.stringify(err)); }); } const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.auth("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); } catch (err) { console.log("auth err: " + JSON.stringify(err)); } ``` ### authenticate(deprecated) authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void 对应用帐户进行鉴权以获取OAuth令牌，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[auth](#auth9)替代。 > > 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | --------------- | | name | string | 是 | 要鉴权的应用帐号名称。 | | owner | string | 是 | 要鉴权的应用帐号所有者包名。 | | authType | string | 是 | 鉴权类型。 | | options | {[key: string]: any} | 是 | 鉴权所需的可选项。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; function onResultCallback(code, result) { console.log("resultCode: " + code); console.log("result: " + JSON.stringify(result)); } function onRequestRedirectedCallback(request) { let abilityStartSetting = {want: request}; featureAbility.startAbility(abilityStartSetting, (err)=>{ console.log("startAbility err: " + JSON.stringify(err)); }); } const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.authenticate("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); ``` ### getAuthToken9+ getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void 获取指定应用帐号和鉴权类型的Auth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | | owner | string | 是 | 应用帐号的所有者包名。 | | authType | string | 是 | 鉴权类型。 | | callback | AsyncCallback<string> | 是 | 查询结果的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.getAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { console.log('getAuthToken err: ' + JSON.stringify(err)); console.log('getAuthToken token: ' + data); }); } catch (err) { console.log('getAuthToken err: ' + JSON.stringify(err)); } ``` ### getAuthToken9+ getAuthToken(name: string, owner: string, authType: string): Promise<string> 获取指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | | owner | string | 是 | 应用帐号的所有者包名。 | | authType | string | 是 | 鉴权类型。 | **返回值：** | 类型 | 说明 | | --------------------- | --------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ```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)); }); } catch (err) { console.log("getAuthToken err: " + JSON.stringify(err)); } ``` ### getOAuthToken(deprecated) getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void 获取指定应用帐号和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9)替代。 > > 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | | owner | string | 是 | 应用帐号的所有者包名。 | | authType | string | 是 | 鉴权类型。 | | callback | AsyncCallback<string> | 是 | 查询结果的回调。 | **示例：** ```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); }); ``` ### getOAuthToken(deprecated) getOAuthToken(name: string, owner: string, authType: string): Promise<string> 获取指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[getAuthToken](#getauthtoken9-1)替代。 > > 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | | owner | string | 是 | 应用帐号的所有者包名。 | | authType | string | 是 | 鉴权类型。 | **返回值：** | 类型 | 说明 | | --------------------- | --------------------- | | 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> | 是 | 设置结果的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx", (err) => { console.log('setAuthToken err: ' + JSON.stringify(err)); }); } catch (err) { console.log('setAuthToken err: ' + JSON.stringify(err)); } ``` ### setAuthToken9+ setAuthToken(name: string, authType: string, token: string): Promise<void> 设置指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | -------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | token | string | 是 | Auth令牌。 | **返回值：** | 类型 | 说明 | | ------------------- | --------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setAuthToken("LiSi", "getSocialData", "xxxx").then(() => { console.log('setAuthToken successfully'); }).catch((err) => { console.log('setAuthToken err: ' + JSON.stringify(err)); }); } catch (err) { console.log('setAuthToken err: ' + JSON.stringify(err)); } ``` ### setOAuthToken(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> | 是 | 设置结果的回调。 | **示例：** ```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实例，用于获取异步返回结果。 | **示例：** ```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)); }); ``` ### deleteAuthToken9+ deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void 删除指定应用帐户和鉴权类型的Auth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------ | | name | string | 是 | 应用帐号的名称。 | | owner | string | 是 | 应用帐号的所有者包名。 | | authType | string | 是 | 鉴权类型。 | | token | string | 是 | 要删除的Auth令牌。 | | callback | AsyncCallback<void> | 是 | 删除结果的回调。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => { console.log('deleteAuthToken err: ' + JSON.stringify(err)); }); } catch (err) { console.log('deleteAuthToken err: ' + JSON.stringify(err)); } ``` ### deleteAuthToken9+ deleteAuthToken(name: string, owner: string, authType: string, token: string): Promise<void> 删除指定应用帐户和鉴权类型的Auth令牌，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------ | | name | string | 是 | 应用帐号的名称。 | | owner | string | 是 | 应用帐号的所有者包名。 | | authType | string | 是 | 鉴权类型。 | | token | string | 是 | 要删除的Auth令牌。 | **返回值：** | 类型 | 说明 | | ------------------- | --------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.deleteAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx").then(() => { console.log('deleteAuthToken successfully'); }).catch((err) => { console.log("deleteAuthToken err: " + JSON.stringify(err)); }); } catch (err) { console.log("deleteAuthToken err: " + JSON.stringify(err)); } ``` ### deleteOAuthToken(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> | 是 | 删除结果的回调。 | **示例：** ```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实例，用于获取异步返回结果。 | **示例：** ```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)); }); ``` ### setAuthTokenVisibility9+ setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void 设置指定鉴权类型的Auth令牌对特定应用的可见性，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------------------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 被设置可见性的应用包名。 | | isVisible | boolean | 是 | 是否可见。当设置成true可见，false不可见。 | | callback | AsyncCallback<void> | 是 | 设置结果的回调。 | **示例：** ```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)); } ``` ### setAuthTokenVisibility9+ setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise<void> 设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------- | ---- | ------------ | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 被设置可见性的应用包名。 | | isVisible | boolean | 是 | 是否可见。 | **返回值：** | 类型 | 说明 | | ------------------- | --------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.setAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { console.log('setAuthTokenVisibility successfully'); }).catch((err) => { console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); }); } catch (err) { console.log('setAuthTokenVisibility err: ' + JSON.stringify(err)); } ``` ### setOAuthTokenVisibility(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> | 是 | 设置结果的回调。 | **示例：** ```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实例，用于获取异步返回结果。 | **示例：** ```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)); }); ``` ### checkAuthTokenVisibility9+ checkAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void 检查指定鉴权类型的Auth令牌对特定应用的可见性，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------------- | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 检查可见性的应用包名。 | | callback | AsyncCallback<boolean> | 是 | 检查结果的回调。 | **示例：** ```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)); } ``` ### checkAuthTokenVisibility9+ checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean> 检查指定鉴权类型的Auth令牌对特定应用的可见性，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ------------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 用于检查可见性的应用包名。 | **返回值：** | 类型 | 说明 | | ---------------------- | --------------------- | | Promise<boolean> | 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)); } ``` ### 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> | 是 | 检查结果的回调。 | **示例：** ```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实例，用于获取异步返回结果。 | **示例：** ```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)); }); ``` ### getAllAuthTokens9+ getAllAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void 获取指定应用对调用方全部可见的Auth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | | owner | string | 是 | 应用帐号的所有者包名。 | | callback | AsyncCallback<Array< [AuthTokenInfo](#authtokeninfo9)>> | 是 | 查询结果的回调。 | **示例：** ```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)); } ``` ### getAllAuthTokens9+ getAllAuthTokens(name: string, owner: string): Promise<Array<AuthTokenInfo>> 获取指定应用帐户对调用方可见的全部Auth令牌，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | name | string | 是 | 应用帐号的名称。 | | owner | string | 是 | 应用帐号的所有者包名。 | **返回值：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array< [AuthTokenInfo](#authtokeninfo9)>> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.getAllAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => { console.log('getAllAuthTokens data: ' + JSON.stringify(data)); }).catch((err) => { console.log("getAllAuthTokens err: " + JSON.stringify(err)); }); } catch (err) { console.log("getAllAuthTokens err: " + JSON.stringify(err)); } ``` ### getAllOAuthTokens(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)>> | 是 | 查询结果的回调。 | **示例：** ```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实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); 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)); }); ``` ### getAuthList9+ getAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void 获取指定应用帐户和鉴权类型的Auth令牌的授权列表，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------------------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 | | callback | AsyncCallback<Array<string>> | 是 | 查询结果的回调。 | **示例：** ```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)); } ``` ### getAuthList9+ getAuthList(name: string, authType: string): Promise<Array<string>> 获取指定应用帐户和鉴权类型的Auth令牌的授权列表，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ----------------------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 应用帐号的鉴权类型的Auth令牌的授权列表。 | **返回值：** | 类型 | 说明 | | ---------------------------------- | --------------------- | | Promise<Array<string>> | Promise实例，用于获取异步返回结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); try { appAccountManager.getAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => { console.log('getAuthList data: ' + JSON.stringify(data)); }).catch((err) => { console.log("getAuthList err: " + JSON.stringify(err)); }); } catch (err) { console.log("getAuthList err: " + JSON.stringify(err)); } ``` ### getOAuthList(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>> | 是 | 查询结果的回调。 | **示例：** ```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实例，用于获取异步返回结果。 | **示例：** ```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)); }); ``` ### getAuthCallback9+ getAuthCallback(sessionId: string, callback: AsyncCallback<AuthCallback>): void 获取鉴权会话的认证器回调，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------- | | sessionId | string | 是 | 鉴权会话的标识。 | | callback | AsyncCallback<[AuthCallback](#authcallback9)> | 是 | 查询结果的回调。 | **示例：** ```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)); } }); ``` ### getAuthCallback9+ getAuthCallback(sessionId: string): Promise<AuthCallback> 获取鉴权会话的认证器回调，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | -------- | | sessionId | string | 是 | 鉴权会话的标识。 | **返回值：** | 类型 | 说明 | | ------------------------------------ | --------------------- | | Promise<[AuthCallback](#authcallback9)> | Promise实例，用于获取异步返回结果。 | **示例：** ```js import featureAbility from '@ohos.ability.featureAbility'; const appAccountManager = account_appAccount.createAppAccountManager(); featureAbility.getWant().then((want) => { var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; try { appAccountManager.getAuthCallback(sessionId).then((callback) => { var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); }).catch((err) => { console.log("getAuthCallback err: " + JSON.stringify(err)); }); } }).catch((err) => { console.log("getWant err: " + JSON.stringify(err)); }); ``` ### getAuthenticatorCallback(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)> | 是 | 查询结果的回调。 | **示例：** ```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("getWant err: " + JSON.stringify(err)); }); ``` ### queryAuthenticatorInfo9+ queryAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void 获取指定应用帐号的认证器信息，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ----------- | | owner | string | 是 | 应用帐号的所有者包名。 | | callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 查询结果的回调。 | **示例：** ```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)); } ``` ### queryAuthenticatorInfo9+ queryAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> 获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | owner | string | 是 | 应用帐号的所有者包名。 | **返回值：** | 类型 | 说明 | | -------------------------------- | --------------------- | | Promise<[AuthenticatorInfo](#authenticatorinfo8)> | 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)); } ``` ### getAuthenticatorInfo(deprecated) getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void 获取指定应用帐号的认证器信息，使用callback回调异步返回结果。 > **说明：** 从API version 9开始废弃, 建议使用[queryAuthenticatorInfo](#queryauthenticatorinfo9)替代。 > > 从 API version 8开始支持。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ----------- | | owner | string | 是 | 应用帐号的所有者包名。 | | callback | AsyncCallback<[AuthenticatorInfo](#authenticatorinfo8)> | 是 | 查询结果的回调。 | **示例：** ```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)); }); ``` ### 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)); }); ``` ### checkAccountLabels9+ checkAccountLabels(name: string, owner: string, labels: Array<string>, callback: AsyncCallback<boolean>): void; 检查指定帐户是否具有特定的标签集合，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ----- | --------------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者。| | labels | Array<string> | 是 | 标签数组。 | | callback | AsyncCallback<boolean> | 是 | 检查结果的回调。 | **示例：** ```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)); } ``` ### checkAccountLabels9+ checkAccountLabels(name: string, owner: string, labels: Array<string>): Promise<boolean> 检查指定帐户是否具有特定的标签集合，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ----- | --------------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者。| | labels | Array<string> | 是 | 标签数组。 | **返回值：** | 类型 | 说明 | | ------------------- | -------------------------------- | | Promise<boolean> | 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)); } ``` ### deleteAccountCredential9+ deleteAccountCredential(name: string, credentialType: string, callback: AsyncCallback<void>): void 删除指定应用帐户的指定类型的凭据信息，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ----- | -------------- | | name | string | 是 | 应用帐户的名称。 | | credentialType | string | 是 | 凭据类型。 | | callback | AsyncCallback<void> | 是 | 删除结果的回调。 | **示例：** ```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)); } ``` ### deleteAccountCredential9+ deleteAccountCredential(name: string, credentialType: string): Promise<void> 删除指定应用帐户的指定类型的凭据信息，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ----- | --------------- | | name | string | 是 | 应用帐户的名称。 | | credentialType | string | 是 | 凭据类型。 | **返回值：** | 类型 | 说明 | | ------------------- | -------------------------------- | | Promise<void> | 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)); } ``` ### selectAccountsByOptions9+ selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback<Array<AppAccountInfo>>); 根据选项选择请求方可访问的帐号列表，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ----------------------------------- | ----- | --------------- | | options | SelectAccountsOptions | 是 | 选择帐户的选项。 | | callback | AsyncCallback<[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)); } ``` ### selectAccountsByOptions9+ selectAccountsByOptions(options: SelectAccountsOptions): Promise<Array<AppAccountInfo>> 根据选项选择请求方可访问的帐户列表，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ----- | --------------- | | options | [SelectAccountsOptions](#selectaccountsoptions9) | 是 | 选择帐户的选项。 | **返回值：** | 类型 | 说明 | | ------------------- | -------------------------------- | | Promise<[AppAccountInfo](#appaccountinfo)> | Promise实例，用于获取异步返回结果。 | **示例：** ```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)); } ``` ### verifyCredential9+ verifyCredential(name: string, owner: string, callback: AuthenticatorCallback): void; 验证用户凭据，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ----- | ----------------------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者。 | | 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)); } }); } catch (err) { console.log("verifyCredential err: " + JSON.stringify(err)); } ``` ### verifyCredential9+ verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback): void; 验证用户凭据，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ----- | ----------------------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者。 | | options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的选项。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，返回验证结果。 | **示例：** ```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)); } ``` ### setAuthenticatorProperties9+ setAuthenticatorProperties(owner: string, callback: AuthCallback): void; 设置认证器属性，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ----- | ----------------------- | | owner | string | 是 | 认证器的所有者。 | | callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置结果。 | **示例：** ```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)); } }); } catch (err) { console.log("setAuthenticatorProperties err: " + JSON.stringify(err)); } ``` ### setAuthenticatorProperties9+ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthCallback): void; 设置认证器属性，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ----- | ----------------------- | | owner | string | 是 | 认证器的所有者。 | | options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的选项。 | | callback | [AuthCallback](#authcallback9) | 是 | 认证器回调，返回设置结果。 | **示例：** ```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)); } ``` ## AppAccountInfo 表示应用帐号信息。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | owner | string | 是 | 应用帐号的所有者包名。 | | name | string | 是 | 应用帐号的名称。 | ## AuthTokenInfo9+ 表示Auth令牌信息。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | -------------------- | -------------- | ----- | ---------------- | | authType9+ | string | 是 | 令牌的鉴权类型。 | | token9+ | string | 是 | 令牌的取值。 | | account9+ | [AppAccountInfo](#appaccountinfo) | 否 | 令牌所属的帐号信息。| ## OAuthTokenInfo(deprecated) 表示OAuth令牌信息。 > **说明：** 从API version 9开始废弃, 建议使用[AuthTokenInfo](#authtokeninfo9)替代。 > > 从 API version 8开始支持。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | -------------------- | -------------- | ----- | ---------------- | | authType | string | 是 | 令牌的鉴权类型。 | | token | string | 是 | 令牌的取值。 | | account9+ | [AppAccountInfo](#appaccountinfo) | 否 | 令牌所属的帐号信息。| ## AuthenticatorInfo8+ 表示OAuth认证器信息。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ---------- | | owner | string | 是 | 认证器的所有者包名。 | | iconId | number | 是 | 认证器的图标标识。 | | labelId | number | 是 | 认证器的标签标识。 | ## AuthResult9+ 表示认证结果信息。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ---------- | | account | [AppAccountInfo](#appaccountinfo) | 否 | 令牌所属的帐号信息。 | | tokenInfo | [AuthTokenInfo](#authtokeninfo9) | 否 | 令牌信息。 | ## AuthOptions9+ 表示认证的选项。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ---------- | | parameters | {[key:string]: Object} | 否 | 自定义参数对象。 | ## CreateAccountOptions9+ 表示创建账号的选项。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ---------- | | customData | {[key:string]: Object} | 否 | 自定义数据。 | ## CreateAccountImplicitlyOptions9+ 表示隐式创建账号的选项。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ---------- | | requiredLabels | {[key:string]: Object} | 否 | 必须的标签。 | | authType | string | 否 | 鉴权类型。 | | parameters | {[key:string]: Object} | 否 | 自定义参数对象。 | ## SelectAccountsOptions9+ 表示用于选择帐号的选项。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | --------------- | --------------------------- | ----- | ------------------- | | allowedAccounts | Array<[AppAccountInfo](#appaccountinfo)> | 否 | 允许的帐号数组。 | | allowedOwners | Array<string> | 否 | 允许的帐号所有者数组。 | | requiredLabels | Array<string> | 否 | 认证器的标签标识。 | ## VerifyCredentialOptions9+ 表示用于验证凭据的选项。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | -------------- | ---------------------- | ----- | -------------- | | credentialType | string | 否 | 凭据类型。 | | credential | string | 否 | 凭据取值。 | | parameters | {[key:string]: Object} | 否 | 自定义参数对象。 | ## SetPropertiesOptions9+ 表示用于设置属性的选项。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------- | ----- | -------------- | | properties | {[key:string]: Object} | 否 | 属性对象。 | | parameters | {[key:string]: Object} | 否 | 自定义参数对象。 | ## Constants8+ 表示常量的枚举。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 名称 | 默认值 | 说明 | | -------------------------------- | ---------------------- | ----------------------- | | ACTION_ADD_ACCOUNT_IMPLICITLY(deprecated) | "addAccountImplicitly" | 表示操作，隐式添加帐号。 | | ACTION_AUTHENTICATE(deprecated) | "authenticate" | 表示操作，鉴权。 | | ACTION_CREATE_ACCOUNT_IMPLICITLY9+ | "createAccountImplicitly" | 表示操作，隐式创建帐号。 | | ACTION_AUTH9+ | "auth" | 表示操作，鉴权。 | | KEY_NAME | "name" | 表示键名，应用帐号名称。 | | KEY_OWNER | "owner" | 表示键名，应用帐号所有者。| | KEY_TOKEN | "token" | 表示键名，令牌。 | | KEY_ACTION | "action" | 表示键名，操作。 | | KEY_AUTH_TYPE | "authType" | 表示键名，鉴权类型。 | | KEY_SESSION_ID | "sessionId" | 表示键名，会话标识。 | | KEY_CALLER_PID | "callerPid" | 表示键名，调用方PID。 | | KEY_CALLER_UID | "callerUid" | 表示键名，调用方UID。 | | KEY_CALLER_BUNDLE_NAME | "callerBundleName" | 表示键名，调用方包名。 | | KEY_REQUIRED_LABELS9+ | "requiredLabels" | 表示键名，必需的标签。 | | KEY_BOOLEAN_RESULT9+ | "booleanResult" | 表示键名，布尔返回值。 | ## ResultCode8+ 表示返回码的枚举。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 名称 | 默认值 | 说明 | | ----------------------------------- | ----- | ------------ | | SUCCESS | 0 | 表示操作成功。 | | ERROR_ACCOUNT_NOT_EXIST | 10001 | 表示应用帐号不存在。 | | ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002 | 表示应用帐号服务异常。 | | ERROR_INVALID_PASSWORD | 10003 | 表示密码无效。 | | ERROR_INVALID_REQUEST | 10004 | 表示请求无效。 | | ERROR_INVALID_RESPONSE | 10005 | 表示响应无效。 | | ERROR_NETWORK_EXCEPTION | 10006 | 表示网络异常。 | | ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST | 10007 | 表示认证器不存在。 | | ERROR_OAUTH_CANCELED | 10008 | 表示鉴权取消。 | | ERROR_OAUTH_LIST_TOO_LARGE | 10009 | 表示开放授权列表过大。 | | ERROR_OAUTH_SERVICE_BUSY | 10010 | 表示开放授权服务忙碌。 | | ERROR_OAUTH_SERVICE_EXCEPTION | 10011 | 表示开放授权服务异常。 | | ERROR_OAUTH_SESSION_NOT_EXIST | 10012 | 表示鉴权会话不存在。 | | ERROR_OAUTH_TIMEOUT | 10013 | 表示鉴权超时。 | | ERROR_OAUTH_TOKEN_NOT_EXIST | 10014 | 表示开放授权令牌不存在。 | | ERROR_OAUTH_TOKEN_TOO_MANY | 10015 | 表示开放授权令牌过多。 | | ERROR_OAUTH_UNSUPPORT_ACTION | 10016 | 表示不支持的鉴权操作。 | | ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017 | 表示不支持的鉴权类型。 | | ERROR_PERMISSION_DENIED | 10018 | 表示权限不足。 | ## AuthCallback9+ 认证回调接口。 ### onResult9+ onResult: (code: number, result: {[key: string]: any}) => void 通知请求结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------- | ---- | ------ | | code | number | 是 | 鉴权结果码。 | | result | {[key: string]: any} | 否 | 鉴权结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthCallback(sessionId).then((callback) => { var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); }).catch((err) => { console.log("getAuthCallback err: " + JSON.stringify(err)); }); ``` ### onRequestRedirected9+ onRequestRedirected: (request: Want) => void 通知请求被跳转。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------- | ---- | ---- | ---------- | | request | Want | 是 | 用于跳转的请求信息。 | **示例：** ```js class MyAuthenticator extends account_appAccount.Authenticator { createAccountImplicitly(options, callback) { callback.onRequestRedirected({ bundleName: "com.example.ohos.accountjsdemo", abilityName: "com.example.ohos.accountjsdemo.LoginAbility", }); } auth(name, authType, options, callback) { var result = {[account_appAccount.Constants.KEY_NAME]: name, [account_appAccount.Constants.KEY_AUTH_TYPE]: authType, [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); } } ``` ### onRequestContinued9+ onRequestContinued?: () => void 通知请求被继续处理。 **系统能力：** SystemCapability.Account.AppAccount **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthCallback(sessionId).then((callback) => { callback.onRequestContinued(); }).catch((err) => { console.log("getAuthCallback err: " + JSON.stringify(err)); }); ``` ## AuthenticatorCallback(deprecated) OAuth认证器回调接口。 > **说明：** 从API version 9开始废弃。 > > 从 API version 8开始支持, 建议使用[AuthCallback](#authcallback9)替代。 ### onResult8+ onResult: (code: number, result: {[key: string]: any}) => void 通知请求结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------- | ---- | ------ | | code | number | 是 | 鉴权结果码。 | | result | {[key: string]: any} | 是 | 鉴权结果。 | **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => { var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", [account_appAccount.Constants.KEY_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)); }); ``` ### onRequestRedirected8+ onRequestRedirected: (request: Want) => void 通知请求被跳转。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------- | ---- | ---- | ---------- | | request | Want | 是 | 用于跳转的请求信息。 | **示例：** ```js class MyAuthenticator extends account_appAccount.Authenticator { addAccountImplicitly(authType, callerBundleName, options, callback) { callback.onRequestRedirected({ bundleName: "com.example.ohos.accountjsdemo", abilityName: "com.example.ohos.accountjsdemo.LoginAbility", }); } authenticate(name, authType, callerBundleName, options, callback) { var result = {[account_appAccount.Constants.KEY_NAME]: name, [account_appAccount.Constants.KEY_AUTH_TYPE]: authType, [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); } } ``` ### onRequestContinued9+ onRequestContinued?: () => void 通知请求被继续处理。 **系统能力：** SystemCapability.Account.AppAccount **示例：** ```js const appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => { callback.onRequestContinued(); }).catch((err) => { console.log("getAuthenticatorCallback err: " + JSON.stringify(err)); }); ``` ## Authenticator8+ 认证器基类。 ### addAccountImplicitly8+ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void 根据指定的鉴权类型和可选项，隐式地添加应用帐户，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------------- | --------------------- | ---- | --------------- | | authType | string | 是 | 应用帐号的鉴权类型。 | | callerBundleName | string | 是 | 鉴权请求方的包名。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 | ### authenticate8+ authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void 对应用帐户进行鉴权，获取OAuth令牌，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 接口名 | 类型 | 必填 | 说明 | | ---------------- | --------------------- | ---- | --------------- | | name | string | 是 | 应用帐号的名称。 | | authType | string | 是 | 应用帐号的鉴权类型。 | | callerBundleName | string | 是 | 鉴权请求方的包名。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回鉴权结果。 | ### verifyCredential9+ verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback): void; 验证应用帐户的凭据，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 接口名 | 类型 | 必填 | 说明 | | ---------------- | --------------------- | ---- | --------------- | | name | string | 是 | 应用帐号的名称。 | | options | [VerifyCredentialOptions](#verifycredentialoptions9) | 是 | 验证凭据的可选项。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回验证结果。 | ### setProperties9+ setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback): void; 设置认证器属性，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 接口名 | 类型 | 必填 | 说明 | | ---------------- | --------------------- | ---- | --------------- | | options | [SetPropertiesOptions](#setpropertiesoptions9) | 是 | 设置属性的可选项。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回设置结果。 | ### checkAccountLabels9+ checkAccountLabels(name: string, labels: Array<string>, callback: AuthenticatorCallback): void; 检查帐号标签，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 接口名 | 类型 | 必填 | 说明 | | ---------------- | --------------------- | ---- | --------------- | | name | string | 是 | 应用帐号的名称。 | | labels | Array<string> | 是 | 标签数组。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回检查结果。 | ### isAccountRemovable9+ isAccountRemovable(name: string, callback: AuthenticatorCallback): void; 判断帐号是否可以删除，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 接口名 | 类型 | 必填 | 说明 | | ---------------- | --------------------- | ---- | --------------- | | name | string | 是 | 应用帐号的名称。 | | callback | [AuthenticatorCallback](#authenticatorcallbackdeprecated) | 是 | 认证器回调，用于返回判断结果。 | ### getRemoteObject9+ getRemoteObject(): rpc.RemoteObject; 获取认证器的远程对象，不可以重载实现。 **系统能力：** SystemCapability.Account.AppAccount **示例：** ```js class MyAuthenticator extends account_appAccount.Authenticator { addAccountImplicitly(authType, callerBundleName, options, callback) { callback.onRequestRedirected({ bundleName: "com.example.ohos.accountjsdemo", abilityName: "com.example.ohos.accountjsdemo.LoginAbility", }); } authenticate(name, authType, callerBundleName, options, callback) { var result = {[account_appAccount.Constants.KEY_NAME]: name, [account_appAccount.Constants.KEY_AUTH_TYPE]: authType, [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); } verifyCredential(name, options, callback) { callback.onRequestRedirected({ bundleName: "com.example.ohos.accountjsdemo", abilityName: "com.example.ohos.accountjsdemo.VerifyAbility", parameters: { name: name } }); } setProperties(options, callback) { callback.onResult(account_appAccount.ResultCode.SUCCESS, {}); } checkAccountLabels(name, labels, callback) { var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: false}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); } isAccountRemovable(name, callback) { var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: true}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); } } var authenticator = null; export default { onConnect(want) { authenticator = new MyAuthenticator(); return authenticator.getRemoteObject(); } } ```