# 应用帐号管理 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 ``` import account_appAccount from '@ohos.account.appAccount'; ``` ## account_appAccount.createAppAccountManager createAppAccountManager(): AppAccountManager 应用帐号管理：获取应用帐号模块对象。 **系统能力：** SystemCapability.Account.AppAccount **返回值：** | 类型 | 说明 | | ----------------- | ------------ | | AppAccountManager | 获取应用帐号模块的实例。 | **示例：** ``` var appAccountManager = account.createAppAccountManager(); ``` ## AppAccountManager 管理应用帐号模块的实例。 ### addAccount addAccount(name: string, callback: AsyncCallback<void>): void 将此应用的帐号名添加到帐号管理服务中，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | --------------------- | | name | string | 是 | 要添加的应用帐户的名称。 | | callback | AsyncCallback<void> | 是 | 将此应用的帐号名添加到帐号管理服务的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.addAccount("WangWu", (err) => { console.log("addAccount err: " + JSON.stringify(err)); }); ``` ### addAccount addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>): void 将此应用程序的帐号名和额外信息添加到帐号管理服务中，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | ---------------------------------------- | | name | string | 是 | 要添加的应用帐户的名称。 | | extraInfo | string | 是 | 要添加的应用帐户的额外信息(例如token等)，额外的信息不能是应用帐号的敏感信息。 | | callback | AsyncCallback<void> | 是 | 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.addAccount("LiSi", "token101", (err) => { console.log("addAccount err: " + JSON.stringify(err)); }); ``` ### addAccount addAccount(name: string, extraInfo?: string): Promise<void> 将此应用的帐号名或额外信息添加到帐号管理服务中，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | -------------------------------- | | name | string | 是 | 要添加的应用帐户的名称。 | | extraInfo | string | 是 | 要添加的应用帐户的额外信息，额外的信息不能是应用帐号的敏感信息。 | **返回值：** | 类型 | 说明 | | ------------------- | --------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.addAccount("LiSi", "token101").then(()=> { console.log('addAccount Success'); }).catch((err) => { console.log("addAccount err: " + JSON.stringify(err)); }); ``` ### addAccountImplicitly8+ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void 根据指定的帐号所有者、鉴权类型和可选项，隐式地添加应用帐号，并使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | --------------- | | owner | string | 是 | 要添加的应用帐户的所有者包名。 | | authType | string | 是 | 要添加的应用帐户的鉴权类型。 | | options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 | | callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 | **示例：** ``` 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("LiSi", "readAge", {}, { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); ``` ### deleteAccount deleteAccount(name: string, callback: AsyncCallback<void>): void 从帐号管理服务中删除应用帐号，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ----------------- | | name | string | 是 | 要删除的应用帐户的名称。 | | callback | AsyncCallback<void> | 是 | 帐号管理服务中删除应用帐号的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.deleteAccount("ZhaoLiu", (err) => { console.log("deleteAccount err: " + JSON.stringify(err)); }); ``` ### deleteAccount deleteAccount(name: string): Promise<void> 从帐号管理服务中删除应用帐号，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------------ | | name | string | 是 | 要删除的应用帐户的名称。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.deleteAccount("ZhaoLiu").then(() => { console.log('deleteAccount Success'); }).catch((err) => { console.log("deleteAccount err: " + JSON.stringify(err)); }); ``` ### disableAppAccess disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------------------------- | | name | string | 是 | 要禁用访问的第三方应用帐户的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | | callback | AsyncCallback<void> | 是 | 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.disableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { console.log("disableAppAccess err: " + JSON.stringify(err)); }); ``` ### disableAppAccess disableAppAccess(name: string, bundleName: string): Promise<void> 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ----------------- | | name | string | 是 | 要禁用访问的第三方应用帐户的名称。 | | bundleName | string | 是 | 第三方应用的包名。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` 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 enableAppAccess(name: string, bundleName: string, callback: AsyncCallback<void>): void 允许指定第三方应用帐户的名称访问指定包名称的第三方应用，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------------------------- | | name | string | 是 | 应用帐号名称。 | | bundleName | string | 是 | 第三方应用的包名。 | | callback | AsyncCallback<void> | 是 | 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo", (err) => { console.log("enableAppAccess: " + JSON.stringify(err)); }); ``` ### enableAppAccess enableAppAccess(name: string, bundleName: string): Promise<void> 允许指定第三方应用帐户的名称访问指定包名称的第三方应用，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | --------- | | name | string | 是 | 应用帐号名称。 | | bundleName | string | 是 | 第三方应用的包名。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` app_account_instance.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { console.log('enableAppAccess Success'); }).catch((err) => { console.log("enableAppAccess err: " + JSON.stringify(err)); }); ``` ### checkAppAccountSyncEnable checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): void 检查指定应用帐号是否允许应用数据同步，使用callback回调异步返回结果。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------- | ---- | ---------------------- | | name | string | 是 | 应用帐号名称。 | | callback | AsyncCallback<boolean> | 是 | 检查指定应用帐号是否允许应用数据同步的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.checkAppAccountSyncEnable("ZhangSan", (err, result) => { console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err)); console.log('checkAppAccountSyncEnable result: ' + result); }); ``` ### checkAppAccountSyncEnable checkAppAccountSyncEnable(name: string): Promise<boolean> 检查指定应用帐号是否允许应用数据同步，使用Promise方式异步返回结果。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------- | | name | string | 是 | 应用帐号名称。 | **返回值：** | 类型 | 说明 | | :--------------------- | :-------------------- | | Promise<boolean> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.checkAppAccountSyncEnable("ZhangSan").then((data) => { console.log('checkAppAccountSyncEnable, result: ' + data); }).catch((err) => { console.log("checkAppAccountSyncEnable err: " + JSON.stringify(err)); }); ``` ### setAccountCredential setAccountCredential(name: string, credentialType: string, credential: string,callback: AsyncCallback<void>): void 设置此应用程序帐号的凭据，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------- | ---- | -------------- | | name | string | 是 | 应用程序帐户的名称。 | | credentialType | string | 是 | 要设置的凭据的类型。 | | credential | string | 是 | 要设置的凭据。 | | callback | AsyncCallback<void> | 是 | 设置此应用帐号的凭据的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountCredential("ZhangSan", "credentialType001", "credential001", (err) => { console.log("setAccountCredential err: " + JSON.stringify(err)); }); ``` ### setAccountCredential setAccountCredential(name: string, credentialType: string, credential: string): Promise<void> 设置此应用程序帐号的凭据，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------- | | name | string | 是 | 应用帐户的名称。 | | credentialType | string | 是 | 要设置的凭据的类型。 | | credential | string | 是 | 要设置的凭据。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` 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 setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<void>): void 设置此应用程序帐号的额外信息，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------- | ---- | ---------------- | | name | string | 是 | 应用帐户的名称。 | | extraInfo | string | 是 | 要设置的额外信息。 | | callback | AsyncCallback<void> | 是 | 设置此应用帐号的额外信息的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002", (err) => { console.log("setAccountExtraInfo err: " + JSON.stringify(err)); }); ``` ### setAccountExtraInfo setAccountExtraInfo(name: string, extraInfo: string): Promise<void> 设置此应用程序帐号的额外信息，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | --------- | | name | string | 是 | 应用帐户的名称。 | | extraInfo | string | 是 | 要设置的额外信息。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAccountExtraInfo("ZhangSan", "Tk002").then(() => { console.log('setAccountExtraInfo Success'); }).catch((err) => { console.log("setAccountExtraInfo err: " + JSON.stringify(err)); }); ``` ### setAppAccountSyncEnable setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback<void>): void 设置指定的应用程序帐号是否允许应用程序数据同步，使用callback回调异步返回结果。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------- | | name | string | 是 | 应用帐户的名称。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 | | callback | AsyncCallback<void> | 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAppAccountSyncEnable("ZhangSan", true, (err) => { console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); }); ``` ### setAppAccountSyncEnable setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> 设置指定的应用程序帐号是否允许应用程序数据同步，使用Promise方式异步返回结果。 **需要权限：** ohos.permission.DISTRIBUTED_DATASYNC，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------- | ---- | ----------- | | name | string | 是 | 应用帐户的名称。 | | isEnable | boolean | 是 | 是否允许应用数据同步。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager .setAppAccountSyncEnable("ZhangSan", true).then(() => { console.log('setAppAccountSyncEnable Success'); }).catch((err) => { console.log("setAppAccountSyncEnable err: " + JSON.stringify(err)); }); ``` ### setAssociatedData setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback<void>): void 设置与此应用程序帐号关联的数据，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ----------------- | | name | string | 是 | 应用帐户的名称。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | value | string | 是 | 要设置的数据的值。 | | callback | AsyncCallback<void> | 是 | 设置与此应用帐号关联的数据的回调。 | **示例：** ``` app_account_instance.setAssociatedData("ZhangSan", "k001", "v001", (err) => { console.log("setAssociatedData err: " + JSON.stringify(err)); }); ``` ### setAssociatedData setAssociatedData(name: string, key: string, value: string): Promise<void> 设置与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------- | | name | string | 是 | 应用帐户的名称。 | | key | string | 是 | 要设置的数据的键，密钥可以自定义。 | | value | string | 是 | 要设置的数据的值。 | **返回值：** | 类型 | 说明 | | :------------------ | :-------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setAssociatedData("ZhangSan", "k001", "v001").then(() => { console.log('setAssociatedData Success'); }).catch((err) => { console.log("setAssociatedData err: " + JSON.stringify(err)); }); ``` ### getAccountCredential getAccountCredential(name: string, credentialType: string, callback: AsyncCallback<string>): void 获取此应用帐号的凭据，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | --------------------------- | ---- | -------------- | | name | string | 是 | 应用帐号名称。 | | credentialType | string | 是 | 要获取的凭据的类型。 | | callback | AsyncCallback<string> | 是 | 获取此应用帐号的凭据的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountCredential("ZhangSan", "credentialType001", (err, result) => { console.log("getAccountCredential err: " + JSON.stringify(err)); console.log('getAccountCredential result: ' + result); }); ``` ### getAccountCredential getAccountCredential(name: string, credentialType: string): Promise<string> 获取此应用程序帐号的凭据，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------------- | ------ | ---- | ---------- | | name | string | 是 | 应用帐号名称。 | | credentialType | string | 是 | 要获取的凭据的类型。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ``` 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 getAccountExtraInfo(name: string, callback: AsyncCallback<string>): void 获取此应用帐号的额外信息，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ---------------- | | name | string | 是 | 应用帐号名称。 | | callback | AsyncCallback<string> | 是 | 获取此应用帐号的额外信息的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountExtraInfo("ZhangSan", (err, result) => { console.log("getAccountExtraInfo err: " + JSON.stringify(err)); console.log('getAccountExtraInfo result: ' + result); }); ``` ### getAccountExtraInfo getAccountExtraInfo(name: string): Promise<string> 获取此应用程序帐号的额外信息，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ------- | | name | string | 是 | 应用帐号名称。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAccountExtraInfo("ZhangSan").then((data) => { console.log('getAccountExtraInfo, result: ' + data); }).catch((err) => { console.log("getAccountExtraInfo err: " + JSON.stringify(err)); }); ``` ### getAssociatedData getAssociatedData(name: string, key: string, callback: AsyncCallback<string>): void 获取与此应用程序帐号关联的数据，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要获取的数据的key。 | | callback | AsyncCallback<string> | 是 | 获取与此应用帐号关联的数据的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAssociatedData("ZhangSan", "k001", (err, result) => { console.log("getAssociatedData err: " + JSON.stringify(err)); console.log('getAssociatedData result: ' + result); }); ``` ### getAssociatedData getAssociatedData(name: string, key: string): Promise<string> 获取与此应用程序帐号关联的数据，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | ----------- | | name | string | 是 | 应用帐号名称。 | | key | string | 是 | 要获取的数据的key。 | **返回值：** | 类型 | 说明 | | :-------------------- | :-------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAssociatedData("ZhangSan", "k001").then((data) => { console.log('getAssociatedData: ' + data); }).catch((err) => { console.log("getAssociatedData err: " + JSON.stringify(err)); }); ``` ### getAllAccessibleAccounts getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void 获取全部应用已授权帐号信息。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | -------- | | callback | AsyncCallback<Array<AppAccountInfo>> | 是 | 应用帐号信息列表 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAllAccessibleAccounts((err, data)=>{ console.debug("getAllAccessibleAccounts err:" + JSON.stringify(err)); console.debug("getAllAccessibleAccounts data:" + JSON.stringify(data)); }); ``` ### getAllAccessibleAccounts getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>> 获取全部应用已授权帐号信息。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array<AppAccountInfo>> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAllAccessibleAccounts().then((data) => { console.log('getAllAccessibleAccounts: ' + data); }).catch((err) => { console.log("getAllAccessibleAccounts err: " + JSON.stringify(err)); }); ``` ### getAllAccounts getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo>>): void 获取指定应用全部帐号信息。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | -------- | | owner | string | 是 | 应用包名称 | | callback | AsyncCallback<Array<AppAccountInfo>> | 是 | 应用帐号信息列表 | **示例：** ``` const appAccountManager = account.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 getAllAccounts(owner: string): Promise<Array<AppAccountInfo>> 获取指定应用全部帐号信息。 **需要权限：** ohos.permission.GET_ALL_APP_ACCOUNTS，仅系统应用可用。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----- | | owner | string | 是 | 应用包名称 | **参数：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array<AppAccountInfo>> | Promise实例，用于获取异步返回结果。 | **示例：** ``` 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)); }); ``` ### on('change') on(type: 'change', owners: Array<string>, callback: Callback<Array<AppAccountInfo>>): void 订阅指定帐号所有者的帐户变更事件，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------------------ | | type | 'change' | 是 | 关于帐户更改事件，当帐户所有者更新帐户时，订阅者将收到通知。 | | owners | Array<string> | 是 | 指示帐户的所有者。 | | callback | Callback<Array<AppAccountInfo>> | 是 | 订阅指定帐号所有者的帐户变更事件的回调。 | **示例：** ``` const appAccountManager = account.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('change') off(type: 'change', callback?: Callback>): void 取消订阅帐号事件，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------- | ---- | ------------ | | type | 'change' | 是 | 关于帐户更改事件。 | | callback | Callback> | 否 | 取消订阅帐号事件的回调。 | **示例：** ``` const appAccountManager = account.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)); } ``` ### authenticate8+ authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void 鉴权应用帐户以获取OAuth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | --------------- | | name | string | 是 | 要鉴权的应用帐户的名称。 | | owner | string | 是 | 要鉴权的应用帐户的所有者包名。 | | authType | string | 是 | 鉴权类型。 | | options | {[key: string]: any} | 是 | 鉴权所需的可选项。 | | callback | AuthenticatorCallback | 是 | 认证器回调，用于返回鉴权结果。 | **示例：** ``` 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", "readAge", {}, { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); ``` ### getOAuthToken8+ getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback<string>): void 获取指定应用帐户和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者包名。 | | authType | string | 是 | 鉴权类型。 | | callback | AsyncCallback<string> | 是 | 查询结果的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", (err, data) => { console.log('getOAuthToken err: ' + JSON.stringify(err)); console.log('getOAuthToken token: ' + data); }); ``` ### getOAuthToken8+ getOAuthToken(name: string, owner: string, authType: string): Promise<string> 获取指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ----------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者包名。 | | authType | string | 是 | 鉴权类型。 | **参数：** | 类型 | 说明 | | --------------------- | --------------------- | | Promise<string> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge").then((data) => { console.log('getOAuthToken token: ' + data); }).catch((err) => { console.log("getOAuthToken err: " + JSON.stringify(err)); }); ``` ### setOAuthToken8+ setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback<void>): void 设置指定应用帐户和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | -------- | | name | string | 是 | 应用帐户的名称。 | | authType | string | 是 | 鉴权类型。 | | token | string | 是 | OAuth令牌。 | | callback | AsyncCallback<void> | 是 | 设置结果的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setOAuthToken("LiSi", "readAge", "xxxx", (err) => { console.log('setOAuthToken err: ' + JSON.stringify(err)); }); ``` ### setOAuthToken8+ setOAuthToken(name: string, authType: string, token: string): Promise<void> 设置指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | -------- | | name | string | 是 | 应用帐户的名称。 | | authType | string | 是 | 鉴权类型。 | | token | string | 是 | OAuth令牌。 | **参数：** | 类型 | 说明 | | ------------------- | --------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setOAuthToken("LiSi", "readAge", "xxxx").then(() => { console.log('setOAuthToken successfully'); }).catch((err) => { console.log('setOAuthToken err: ' + JSON.stringify(err)); }); ``` ### deleteOAuthToken8+ deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback<void>): void 删除指定应用帐户和鉴权类型的OAuth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------ | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者包名。 | | authType | string | 是 | 鉴权类型。 | | token | string | 是 | 要删除的OAuth令牌。 | | callback | AsyncCallback<void> | 是 | 删除结果的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", "xxxxx", (err) => { console.log('deleteOAuthToken err: ' + JSON.stringify(err)); }); ``` ### deleteOAuthToken8+ deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise<void> 删除指定应用帐户和鉴权类型的OAuth令牌，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------ | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者包名。 | | authType | string | 是 | 鉴权类型。 | | token | string | 是 | 要删除的OAuth令牌。 | **参数：** | 类型 | 说明 | | ------------------- | --------------------- | | Promise<void> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", "xxxxx").then(() => { console.log('deleteOAuthToken successfully'); }).catch((err) => { console.log("deleteOAuthToken err: " + JSON.stringify(err)); }); ``` ### setOAuthTokenVisibility8+ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback<void>): void 设置指定鉴权类型的OAuth令牌对特定应用的可见性，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------------- | ---- | ------------ | | name | string | 是 | 应用帐户的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 被设置可见性的应用包名。 | | isVisible | boolean | 是 | 是否可见。 | | callback | AsyncCallback<void> | 是 | 设置结果的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true, (err) => { console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); }); ``` ### setOAuthTokenVisibility8+ setOAuthTokenVisibility(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实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then(() => { console.log('setOAuthTokenVisibility successfully'); }).catch((err) => { console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); }); ``` ### checkOAuthTokenVisibility8+ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback<boolean>): void 检查指定鉴权类型的OAuth令牌对特定应用的可见性，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ---------------------------- | ---- | ------------- | | name | string | 是 | 应用帐户的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 用于检查可见性的应用包名。 | | callback | AsyncCallback<boolean> | 是 | 检查结果的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.checkOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true, (err, data) => { console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); console.log('checkOAuthTokenVisibility isVisible: ' + data); }); ``` ### checkOAuthTokenVisibility8+ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise<boolean> 检查指定鉴权类型的OAuth令牌对特定应用的可见性，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------ | ---- | ------------- | | name | string | 是 | 应用帐户的名称。 | | authType | string | 是 | 鉴权类型。 | | bundleName | string | 是 | 用于检查可见性的应用包名。 | **参数：** | 类型 | 说明 | | ---------------------- | --------------------- | | Promise<boolean> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.checkOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then((data) => { console.log('checkOAuthTokenVisibility isVisible: ' + data); }).catch((err) => { console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); }); ``` ### getAllOAuthTokens8+ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array<OAuthTokenInfo>>): void 获取指定应用对调用方全部可见的OAuth令牌，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者包名。 | | callback | AsyncCallback<Array<OAuthTokenInfo>> | 是 | 查询结果的回调。 | **示例：** ``` 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)); }); ``` ### getAllOAuthTokens8+ getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenInfo>> 获取指定应用帐户对调用方可见的全部OAuth令牌，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者包名。 | **参数：** | 类型 | 说明 | | ---------------------------------------- | --------------------- | | Promise<Array<OAuthTokenInfo>> | Promise实例，用于获取异步返回结果。 | **示例：** ``` 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)); }); ``` ### getOAuthList8+ getOAuthList(name: string, authType: string, callback: AsyncCallback<Array<string>>): void 获取指定应用帐户和鉴权类型的OAuth令牌的授权列表，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ----------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者包名。 | | callback | AsyncCallback<Array<string>> | 是 | 查询结果的回调。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "readAge", (err, data) => { console.log('getOAuthList err: ' + JSON.stringify(err)); console.log('getOAuthList data: ' + JSON.stringify(data)); }); ``` ### getOAuthList8+ getOAuthList(name: string, authType: string): Promise<Array<string>> 获取指定应用帐户和鉴权类型的OAuth令牌的授权列表，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | name | string | 是 | 应用帐户的名称。 | | owner | string | 是 | 应用帐户的所有者包名。 | **参数：** | 类型 | 说明 | | ---------------------------------- | --------------------- | | Promise<Array<string>> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "readAge").then((data) => { console.log('getOAuthList data: ' + JSON.stringify(data)); }).catch((err) => { console.log("getOAuthList err: " + JSON.stringify(err)); }); ``` ### getAuthenticatorCallback8+ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<AuthenticatorCallback>): void 获取鉴权会话的认证器回调，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ---------------------------------------- | ---- | -------- | | sessionId | string | 是 | 鉴权会话的标识。 | | callback | AsyncCallback<AuthenticatorCallback> | 是 | 查询结果的回调。 | **示例：** ``` 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]: "readAge", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; callback.OnResult(account_appAccount.ResultCode.SUCCESS, result); }); }); ``` ### getAuthenticatorCallback8+ getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback> 获取鉴权会话的认证器回调，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | -------- | | sessionId | string | 是 | 鉴权会话的标识。 | **参数：** | 类型 | 说明 | | ------------------------------------ | --------------------- | | Promise<AuthenticatorCallback> | Promise实例，用于获取异步返回结果。 | **示例：** ``` 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]: "readAge", [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)); }); ``` ### getAuthenticatorInfo8+ getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo>): void 获取指定应用帐户的认证器信息，使用callback回调异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ----------- | | owner | string | 是 | 应用帐户的所有者包名。 | | callback | AsyncCallback<AuthenticatorInfo> | 是 | 查询结果的回调。 | **示例：** ``` 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)); }); ``` ### getAuthenticatorInfo8+ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo> 获取指定应用帐户的认证器信息，使用Promise方式异步返回结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | owner | string | 是 | 应用帐户的所有者包名。 | **参数：** | 类型 | 说明 | | -------------------------------- | --------------------- | | Promise<AuthenticatorInfo> | Promise实例，用于获取异步返回结果。 | **示例：** ``` const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAuthenticatorInfo("com.example.ohos.accountjsdemo").then((data) => { console.log('getAuthenticatorInfo: ' + JSON.stringify(data)); }).catch((err) => { console.log("getAuthenticatorInfo err: " + JSON.stringify(err)); }); ``` ## AppAccountInfo 表示应用帐号信息。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------- | | owner | string | 是 | 应用帐户的所有者包名。 | | name | string | 是 | 应用帐户的名称。 | ## OAuthTokenInfo8+ 表示OAuth令牌信息。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | -------- | | authType | string | 是 | 令牌的鉴权类型。 | | token | string | 是 | 令牌的取值。 | ## AuthenticatorInfo8+ 表示OAuth认证器信息。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ---------- | | owner | string | 是 | 认证器的所有者包名。 | | iconId | string | 是 | 认证器的图标标识。 | | labelId | string | 是 | 认证器的标签标识。 | ## Constants8+ 表示常量的枚举。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.AppAccount。 | 名称 | 默认值 | 描述 | | ----------------------------- | ---------------------- | ------------- | | ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作_隐式添加帐号。 | | ACTION_AUTHENTICATE | "authenticate" | 表示操作_鉴权。 | | 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" | 表示键名_调用方包名。 | ## 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 | 表示权限不足。 | ## AuthenticatorCallback8+ OAuth认证器回调接口。 ### onResult8+ onResult: (code: number, result: {[key: string]: any}) => void 通知鉴权结果。 **系统能力：** SystemCapability.Account.AppAccount **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------- | ---- | ------ | | code | number | 是 | 鉴权结果码。 | | result | {[key: string]: any} | 是 | 鉴权结果。 | **示例：** ``` 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]: "readAge", [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 | 是 | 用于跳转的请求信息。 | **示例：** ``` 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); } } ``` ## Authenticator8+ OAuth认证器基类。 ### 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 | 是 | 认证器回调，用于返回鉴权结果。 | ### 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 | 是 | 认证器回调，用于返回鉴权结果。 | **示例：** ``` 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); } } export default { onConnect(want) { return new MyAuthenticator(); } } ```