@ohos.account.distributedAccount (分布式账号管理)

本模块提供管理分布式账号的一些基础功能，主要包括查询和更新账号登录状态。

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { distributedAccount } from '@kit.BasicServicesKit';

distributedAccount.getDistributedAccountAbility

getDistributedAccountAbility(): DistributedAccountAbility

获取分布式账号单实例对象。

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();

DistributedAccountAbility

提供查询和更新分布式账号登录状态方法(需要先获取分布式账号的单实例对象)。

getOsAccountDistributedInfo⁹⁺

getOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): void

获取分布式账号信息，使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS（仅系统应用可申请） 或 ohos.permission.GET_DISTRIBUTED_ACCOUNTS（仅系统应用可申请） 或 ohos.permission.DISTRIBUTED_DATASYNC

参数：

错误码：

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
  try {
    accountAbility.getOsAccountDistributedInfo(
      (err: BusinessError, data: distributedAccount.DistributedInfo) => {
        if (err) {
          console.error('getOsAccountDistributedInfo exception: ' + JSON.stringify(err));
        } else {
          console.log('distributed information: ' + JSON.stringify(data));
        }
      });
  } catch (err) {
    console.error('getOsAccountDistributedInfo exception: ' + JSON.stringify(err));
  }

getOsAccountDistributedInfo⁹⁺

getOsAccountDistributedInfo(): Promise<DistributedInfo>

获取分布式账号信息。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS（仅系统应用可申请） 或 ohos.permission.GET_DISTRIBUTED_ACCOUNTS（仅系统应用可申请） 或 ohos.permission.DISTRIBUTED_DATASYNC

返回值：

错误码：

示例：

  import { BusinessError } from '@kit.BasicServicesKit';

  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
  try {
    accountAbility.getOsAccountDistributedInfo().then((data: distributedAccount.DistributedInfo) => {
        console.log('distributed information: ' + JSON.stringify(data));
    }).catch((err: BusinessError) => {
        console.error('getOsAccountDistributedInfo exception: '  + JSON.stringify(err));
    });
  } catch (err) {
    console.error('getOsAccountDistributedInfo exception: ' + JSON.stringify(err));
  }

queryOsAccountDistributedInfo^(deprecated)

queryOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): void

获取分布式账号信息。使用callback异步回调。 > 说明： > > 从 API version 7开始支持，从API version 9开始废弃。建议使用getOsAccountDistributedInfo。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS（仅系统应用可申请）或 ohos.permission.DISTRIBUTED_DATASYNC

参数：

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  
  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
  accountAbility.queryOsAccountDistributedInfo(
    (err: BusinessError, data: distributedAccount.DistributedInfo) => {
      if (err) {
        console.error('queryOsAccountDistributedInfo exception: ' + JSON.stringify(err));
      } else {
        console.log('distributed information: ' + JSON.stringify(data));
      }
    });

queryOsAccountDistributedInfo^(deprecated)

queryOsAccountDistributedInfo(): Promise<DistributedInfo>

获取分布式账号信息。使用Promise异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃。建议使用getOsAccountDistributedInfo。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS（仅系统应用可申请）或 ohos.permission.DISTRIBUTED_DATASYNC

返回值：

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  
  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
  accountAbility.queryOsAccountDistributedInfo().then((data: distributedAccount.DistributedInfo) => {
      console.log('distributed information: ' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
      console.error('queryOsAccountDistributedInfo exception: '  + JSON.stringify(err));
  });

setOsAccountDistributedInfo⁹⁺

setOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback<void>): void

更新分布式账号信息。使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS，该权限仅系统应用可申请。

参数：

错误码：

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  
  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
  let accountInfo: distributedAccount.DistributedInfo =
    {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
  try {
    accountAbility.setOsAccountDistributedInfo(accountInfo, (err: BusinessError) => {
      if (err) {
        console.error('setOsAccountDistributedInfo exception: ' + JSON.stringify(err));
      } else {
        console.log('setOsAccountDistributedInfo successfully');
      }
    });
  } catch (err) {
      console.error('setOsAccountDistributedInfo exception: ' + JSON.stringify(err));
  }

setOsAccountDistributedInfo⁹⁺

setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>

更新分布式账号信息。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS，该权限仅系统应用可申请。

参数：

返回值：

错误码：

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  
  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
  let accountInfo: distributedAccount.DistributedInfo =
    {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
  try {
    accountAbility.setOsAccountDistributedInfo(accountInfo).then(() => {
        console.log('setOsAccountDistributedInfo successfully');
    }).catch((err: BusinessError) => {
        console.error('setOsAccountDistributedInfo exception: '  + JSON.stringify(err));
    });
  } catch (err) {
      console.error('setOsAccountDistributedInfo exception: ' + JSON.stringify(err));
  }

updateOsAccountDistributedInfo^(deprecated)

updateOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback<void>): void

更新分布式账号信息。使用callback异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃。建议使用setOsAccountDistributedInfo。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS，该权限仅系统应用可申请。

参数：

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  
  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
  let accountInfo: distributedAccount.DistributedInfo =
    {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
  accountAbility.updateOsAccountDistributedInfo(accountInfo, (err: BusinessError) => {
    if (err) {
      console.error('queryOsAccountDistributedInfo exception: ' + JSON.stringify(err));
    } else {
      console.log('queryOsAccountDistributedInfo successfully');
    }
  });

updateOsAccountDistributedInfo^(deprecated)

updateOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>

更新分布式账号信息。使用Promise异步回调。 > 说明： > > 从 API version 7开始支持，从API version 9开始废弃。建议使用setOsAccountDistributedInfo。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS，该权限仅系统应用可申请。

参数：

返回值：

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  
  const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
  let accountInfo: distributedAccount.DistributedInfo =
    {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
  accountAbility.updateOsAccountDistributedInfo(accountInfo).then(() => {
      console.log('updateOsAccountDistributedInfo successfully');
   }).catch((err: BusinessError) => {
      console.error('updateOsAccountDistributedInfo exception: '  + JSON.stringify(err));
  });

DistributedInfo

提供操作系统账号的分布式信息。

系统能力： SystemCapability.Account.OsAccount

DistributedAccountStatus¹⁰⁺

表示分布式账号状态枚举。

系统能力： 以下各项对应的系统能力均为SystemCapability.Account.OsAccount

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Basic Services Kit（基础服务）

harmony 鸿蒙DeviceInfo

harmony 鸿蒙OH_Print

harmony 鸿蒙Print_Margin

harmony 鸿蒙Print_PageSize

harmony 鸿蒙Print_PrintAttributes

harmony 鸿蒙Print_PrintDocCallback

harmony 鸿蒙Print_Range

harmony 鸿蒙TimeService

harmony 鸿蒙ohscan.h