813ae469创建于 2025年10月23日历史提交

@ohos.account.distributedAccount (Distributed Account Management)

The distributedAccount module provides APIs for managing distributed accounts, including querying and updating account login states.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

distributedAccount.getDistributedAccountAbility

getDistributedAccountAbility(): DistributedAccountAbility

Obtains a DistributedAccountAbility instance.

System capability: SystemCapability.Account.OsAccount

Return value

Type	Description
DistributedAccountAbility	DistributedAccountAbility instance obtained. This instance provides APIs for querying and updating the login state of a distributed account.

Example

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

DistributedAccountAbility

Provides APIs for querying and updating the login state of a distributed account. You must obtain a DistributedAccountAbility instance first.

getOsAccountDistributedInfo⁹⁺

getOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): void

Obtains the distributed account information. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS (for system applications only), ohos.permission.GET_DISTRIBUTED_ACCOUNTS (for system applications only), or ohos.permission.DISTRIBUTED_DATASYNC

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<DistributedInfo>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is the distributed account information obtained. Otherwise, err is an error object.

Error codes

For details about the error codes, see Account Management Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
12300001	System service exception.

Example

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: code is ${err.code}, message is ${err.message}`);
      } else {
        console.info('distributed information: ' + JSON.stringify(data));
      }
    });
} catch (e) {
  const err = e as BusinessError;
  console.error(`getOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
}

getOsAccountDistributedInfo⁹⁺

getOsAccountDistributedInfo(): Promise<DistributedInfo>

Obtains the distributed account information. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Type	Description
Promise<DistributedInfo>	Promise used to return the distributed account information obtained.

Error codes

For details about the error codes, see Account Management Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
12300001	System service exception.

Example

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

const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
try {
  accountAbility.getOsAccountDistributedInfo().then((data: distributedAccount.DistributedInfo) => {
    console.info('distributed information: ' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error(`getOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
  });
} catch (e) {
  const err = e as BusinessError;
  console.error(`getOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
}

queryOsAccountDistributedInfo^(deprecated)

queryOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): void

Queries the distributed account information. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. Use getOsAccountDistributedInfo instead.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS (for system applications only) or ohos.permission.DISTRIBUTED_DATASYNC

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<DistributedInfo>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is the distributed account information obtained. Otherwise, err is an error object.

Example

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

const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
accountAbility.queryOsAccountDistributedInfo(
  (err: BusinessError, data: distributedAccount.DistributedInfo) => {
    if (err) {
      console.error(`queryOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
    } else {
      console.info('distributed information: ' + JSON.stringify(data));
    }
  });

queryOsAccountDistributedInfo^(deprecated)

queryOsAccountDistributedInfo(): Promise<DistributedInfo>

Queries the distributed account information. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. Use getOsAccountDistributedInfo instead.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS (for system applications only) or ohos.permission.DISTRIBUTED_DATASYNC

Return value

Type	Description
Promise<DistributedInfo>	Promise used to return the distributed account information obtained.

Example

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

const accountAbility: distributedAccount.DistributedAccountAbility = distributedAccount.getDistributedAccountAbility();
accountAbility.queryOsAccountDistributedInfo().then((data: distributedAccount.DistributedInfo) => {
  console.info('distributed information: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error(`queryOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
});

setOsAccountDistributedInfo⁹⁺

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

Sets the distributed account information. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS (available only for system applications)

Parameters

Name	Type	Mandatory	Description
accountInfo	DistributedInfo	Yes	Distributed account information to set.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the distributed account information is set successfully, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Account Management Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
12300001	System service exception.
12300002	Invalid accountInfo.
12300003	Account not found.

Example

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: code is ${err.code}, message is ${err.message}`);
    } else {
      console.info('setOsAccountDistributedInfo successfully');
    }
  });
} catch (e) {
  const err = e as BusinessError;
  console.error(`setOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
}

setOsAccountDistributedInfo⁹⁺

setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>

Sets the distributed account information. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS (available only for system applications)

Parameters

Name	Type	Mandatory	Description
accountInfo	DistributedInfo	Yes	Distributed account information to set.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Account Management Error Codes and Universal Error Codes.

ID	Error Message
201	Permission denied.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
12300001	System service exception.
12300002	Invalid accountInfo.
12300003	Account not found.

Example

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.info('setOsAccountDistributedInfo successfully');
  }).catch((err: BusinessError) => {
    console.error(`setOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
  });
} catch (e) {
  const err = e as BusinessError;
  console.error(`setOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
}

updateOsAccountDistributedInfo^(deprecated)

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

Updates the distributed account information. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. Use setOsAccountDistributedInfo instead.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS (available only for system applications)

Parameters

Name	Type	Mandatory	Description
accountInfo	DistributedInfo	Yes	Distributed account information to update.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the distributed account information is updated successfully, err is undefined. Otherwise, err is an error object.

Example

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(`updateOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
  } else {
    console.info('updateOsAccountDistributedInfo successfully');
  }
});

updateOsAccountDistributedInfo^(deprecated)

updateOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>

Updates the distributed account information. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. Use setOsAccountDistributedInfo instead.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS (available only for system applications)

Parameters

Name	Type	Mandatory	Description
accountInfo	DistributedInfo	Yes	Distributed account information to update.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

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.info('updateOsAccountDistributedInfo successfully');
}).catch((err: BusinessError) => {
  console.error(`updateOsAccountDistributedInfo exception: code is ${err.code}, message is ${err.message}`);
});

DistributedInfo

Represents the distributed information about a system account.

System capability: SystemCapability.Account.OsAccount

Name	Type	Read-Only	Optional	Description
name	string	No	No	Name of the distributed account. It must be a non-null string.
id	string	No	No	UID of the distributed account. It must be a non-null string.
event	string	No	No	Login state of the distributed account. The state can be login, logout, token invalid, or logoff, which correspond to the following strings respectively: - Ohos.account.event.LOGIN - Ohos.account.event.LOGOUT - Ohos.account.event.TOKEN_INVALID - Ohos.account.event.LOGOFF
nickname⁹⁺	string	No	Yes	Nickname of the distributed account. By default, no value is passed in.
avatar⁹⁺	string	No	Yes	Avatar of the distributed account. By default, no value is passed in.
status¹⁰⁺	DistributedAccountStatus	Yes	Yes	Status of the distributed account. The value is of the enumerated type. The default status is unlogged.
scalableData⁸⁺	object	No	Yes	Additional information about the distributed account, in the form of KV pairs. This parameter is left empty by default.

DistributedAccountStatus¹⁰⁺

Enumerates the statuses of a distributed account.

System capability: SystemCapability.Account.OsAccount

Name	Value	Description
NOT_LOGGED_IN	0	The account has not logged in.
LOGGED_IN	1	The account has logged in.

@ohos.account.distributedAccount (Distributed Account Management)

Modules to Import

distributedAccount.getDistributedAccountAbility

DistributedAccountAbility

getOsAccountDistributedInfo9+

getOsAccountDistributedInfo9+

queryOsAccountDistributedInfo(deprecated)

queryOsAccountDistributedInfo(deprecated)

setOsAccountDistributedInfo9+

setOsAccountDistributedInfo9+

updateOsAccountDistributedInfo(deprecated)

updateOsAccountDistributedInfo(deprecated)

DistributedInfo

DistributedAccountStatus10+

getOsAccountDistributedInfo⁹⁺

getOsAccountDistributedInfo⁹⁺

queryOsAccountDistributedInfo^(deprecated)

queryOsAccountDistributedInfo^(deprecated)

setOsAccountDistributedInfo⁹⁺

setOsAccountDistributedInfo⁹⁺

updateOsAccountDistributedInfo^(deprecated)

updateOsAccountDistributedInfo^(deprecated)

DistributedAccountStatus¹⁰⁺