harmony 鸿蒙@ohos.account.distributedAccount (分布式帐号管理)

  • 2022-08-09
  • 浏览 (857)

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

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

说明：

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

导入模块

import account_distributedAccount from '@ohos.account.distributedAccount';

account_distributedAccount.getDistributedAccountAbility

getDistributedAccountAbility(): DistributedAccountAbility

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

系统能力： SystemCapability.Account.OsAccount

返回值：

类型 说明
DistributedAccountAbility 返回一个实例，实例提供查询和更新分布式帐号登录状态方法。

示例：

  const accountAbility = account_distributedAccount.getDistributedAccountAbility();

DistributedAccountAbility

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

getOsAccountDistributedInfo9+

getOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): void

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS 或 ohos.permission.GET_DISTRIBUTED_ACCOUNTS 或 ohos.permission.DISTRIBUTED_DATASYNC

参数：

参数名 类型 必填 说明
callback AsyncCallback<DistributedInfo> 是 回调参数。当获取分布式帐号信息成功，err为undefined，data为获取到的分布式帐号信息对象；否则为错误对象。

错误码：

错误码ID 错误信息
12300001 System service exception.

示例：

  import { BusinessError } from '@ohos.base';

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

getOsAccountDistributedInfo9+

getOsAccountDistributedInfo(): Promise<DistributedInfo>

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS 或 ohos.permission.GET_DISTRIBUTED_ACCOUNTS 或 ohos.permission.DISTRIBUTED_DATASYNC

返回值：

类型 说明
Promise<DistributedInfo> Promise对象，返回分布式帐号信息对象。

错误码：

错误码ID 错误信息
12300001 System service exception.

示例：

  import { BusinessError } from '@ohos.base';

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

getOsAccountDistributedInfoByLocalId10+

getOsAccountDistributedInfoByLocalId(localId: number, callback: AsyncCallback<DistributedInfo>): void

获取指定系统帐号的分布式信息。使用callback异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

参数：

参数名 类型 必填 说明
localId number 是 系统帐号ID。
callback AsyncCallback<DistributedInfo> 是 回调参数。当获取分布式帐号信息成功，err为undefined，data为获取到的分布式帐号信息对象；否则为错误对象。

错误码：

错误码ID 错误信息
12300001 System service exception.
12300003 Account not found.

示例：

  import { BusinessError } from '@ohos.base';
  
  const accountAbility = account_distributedAccount.getDistributedAccountAbility();
  try {
    accountAbility.getOsAccountDistributedInfoByLocalId(100,
      (err: BusinessError, data: account_distributedAccount.DistributedInfo) => {
        if (err) {
          console.log('getOsAccountDistributedInfoByLocalId exception: ' + JSON.stringify(err));
        } else {
          console.log('distributed information: ' + JSON.stringify(data));
        }
      });
  } catch (err) {
    console.log('getOsAccountDistributedInfoByLocalId exception: ' + JSON.stringify(err));
  }

getOsAccountDistributedInfoByLocalId10+

getOsAccountDistributedInfoByLocalId(localId: number): Promise<DistributedInfo>

获取指定系统帐号的分布式信息。使用Promise异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

返回值：

类型 说明
Promise<DistributedInfo> Promise对象，返回分布式帐号信息对象。

错误码：

错误码ID 错误信息
12300001 System service exception.
12300003 Account not found.

示例：

  import { BusinessError } from '@ohos.base';
  
  const accountAbility = account_distributedAccount.getDistributedAccountAbility();
  try {
    accountAbility.getOsAccountDistributedInfoByLocalId(100).then((
      data: account_distributedAccount.DistributedInfo) => {
      console.log('distributed information: ' + JSON.stringify(data));
    }).catch((err: BusinessError) => {
      console.log('getOsAccountDistributedInfoByLocalId exception: '  + JSON.stringify(err));
    });
  } catch (err) {
    console.log('getOsAccountDistributedInfoByLocalId 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

参数：

参数名 类型 必填 说明
callback AsyncCallback<DistributedInfo> 是 回调函数。当获取分布式帐号信息成功，err为undefined，data为获取到的分布式帐号信息对象；否则为错误对象。

示例：

  import { BusinessError } from '@ohos.base';
  
  const accountAbility = account_distributedAccount.getDistributedAccountAbility();
  accountAbility.queryOsAccountDistributedInfo(
    (err: BusinessError, data: account_distributedAccount.DistributedInfo) => {
      if (err) {
        console.log('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

返回值：

类型 说明
Promise<DistributedInfo> Promise对象，返回分布式帐号信息对象。

示例：

  import { BusinessError } from '@ohos.base';
  
  const accountAbility = account_distributedAccount.getDistributedAccountAbility();
  accountAbility.queryOsAccountDistributedInfo().then((data: account_distributedAccount.DistributedInfo) => {
      console.log('distributed information: ' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
      console.log('queryOsAccountDistributedInfo exception: '  + JSON.stringify(err));
  });

setOsAccountDistributedInfo9+

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

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS

参数：

参数名 类型 必填 说明
accountInfo DistributedInfo 是 分布式帐号信息。
callback AsyncCallback<void> 是 回调函数。当更新分布式帐号信息成功时，err为undefined，否则为错误对象。

错误码：

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid accountInfo.
12300003 Account not found.

示例：

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

setOsAccountDistributedInfo9+

setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS

参数：

参数名 类型 必填 说明
accountInfo DistributedInfo 是 分布式帐户信息。

返回值：

类型 说明
Promise<void> Promise对象，无返回结果的Promise对象。

错误码：

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid accountInfo.
12300003 Account not found.

示例：

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

setOsAccountDistributedInfoByLocalId10+

setOsAccountDistributedInfoByLocalId(localId: number, distributedInfo: DistributedInfo, callback: AsyncCallback<void>): void

设置指定系统帐号的分布式信息。使用callback异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS

参数：

参数名 类型 必填 说明
localId number 是 系统帐号ID。
accountInfo DistributedInfo 是 分布式帐号信息。
callback AsyncCallback<void> 是 回调函数。当设置指定系统帐号的分布式信息成功时，err为undefined，否则为错误对象。

错误码：

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid distributedInfo.
12300003 Account identified by localId or by distributedInfo not found.
12300008 Restricted OS account.

示例：

  import { BusinessError } from '@ohos.base';
  
  const accountAbility = account_distributedAccount.getDistributedAccountAbility();
  let accountInfo: account_distributedAccount.DistributedInfo =
    {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
  try {
    accountAbility.setOsAccountDistributedInfoByLocalId(100, accountInfo, (err: BusinessError) => {
      if (err) {
        console.log('setOsAccountDistributedInfoByLocalId exception: ' + JSON.stringify(err));
      } else {
        console.log('setOsAccountDistributedInfoByLocalId successfully');
      }
    });
  } catch (err) {
      console.log('setOsAccountDistributedInfoByLocalId exception: ' + JSON.stringify(err));
  }

setOsAccountDistributedInfoByLocalId10+

setOsAccountDistributedInfoByLocalId(localId: number, distributedInfo: DistributedInfo): Promise<void>

设置指定系统帐号的分布式信息。使用Promise异步回调。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS

参数：

参数名 类型 必填 说明
localId number 是 系统帐号ID。
distributedInfo DistributedInfo 是 分布式帐户信息。

返回值：

类型 说明
Promise<void> Promise对象，无返回结果的Promise对象。

错误码：

错误码ID 错误信息
12300001 System service exception.
12300002 Invalid distributedInfo.
12300003 Account identified by localId or by distributedInfo not found.
12300008 Restricted OS account.

示例：

  import { BusinessError } from '@ohos.base';
  
  const accountAbility = account_distributedAccount.getDistributedAccountAbility();
  let accountInfo: account_distributedAccount.DistributedInfo =
    {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
  try {
    accountAbility.setOsAccountDistributedInfoByLocalId(100, accountInfo).then(() => {
        console.log('setOsAccountDistributedInfoByLocalId successfully');
    }).catch((err: BusinessError) => {
        console.log('setOsAccountDistributedInfoByLocalId exception: '  + JSON.stringify(err));
    });
  } catch (err) {
      console.log('setOsAccountDistributedInfoByLocalId 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

参数：

参数名 类型 必填 说明
accountInfo DistributedInfo 是 分布式帐号信息。
callback AsyncCallback<void> 是 回调函数。当更新分布式帐号信息成功时，err为undefined，否则为错误对象。

示例：

  import { BusinessError } from '@ohos.base';
  
  const accountAbility = account_distributedAccount.getDistributedAccountAbility();
  let accountInfo: account_distributedAccount.DistributedInfo =
    {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'};
  accountAbility.updateOsAccountDistributedInfo(accountInfo, (err: BusinessError) => {
    if (err) {
      console.log('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

参数：

参数名 类型 必填 说明
accountInfo DistributedInfo 是 分布式帐户信息。

返回值：

类型 说明
Promise<void> Promise对象，无返回结果的Promise对象。

示例：

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

DistributedInfo

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

系统能力： SystemCapability.Account.OsAccount

名称 类型 必填 说明
name string 是 分布式帐号名称，非空字符串。
id string 是 分布式帐号UID，非空字符串。
event string 是 分布式帐号登录状态，包括登录、登出、Token失效和注销，分别对应以下字符串：
- Ohos.account.event.LOGIN
- Ohos.account.event.LOGOUT
- Ohos.account.event.TOKEN_INVALID
- Ohos.account.event.LOGOFF
nickname9+ string 否 分布式帐号的昵称，默认为空。
avatar9+ string 否 分布式帐号的头像，默认为空。
status10+ DistributedAccountStatus 否 分布式帐号的状态，枚举类型，默认为未登录状态。
scalableData8+ object 否 分布式帐号扩展信息，根据业务所需，以k-v形式传递定制化信息，默认为空。

DistributedAccountStatus10+

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

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

名称 值 说明
NOT_LOGGED_IN 0 未登录状态。
LOGGED_IN 1 已登录状态。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0  赞
  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/93720890aa024184aac002f967bfada7
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录