@ohos.account.osAccount (System Account Management)

The osAccount module provides basic capabilities for managing system (OS) accounts, including adding, deleting, querying, setting, subscribing to, and enabling a system account.

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 account_osAccount from '@ohos.account.osAccount';

account_osAccount.getAccountManager

getAccountManager(): AccountManager

Obtains an AccountManager instance.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();

OsAccountType

Enumerates the system account types.

System capability: SystemCapability.Account.OsAccount

AccountManager

Provides APIs for managing system accounts.

activateOsAccount

activateOsAccount(localId: number, callback: AsyncCallback<void>): void

Activates a system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Activate system account 100.

import { BusinessError } from '@ohos.base';
let localId: number = 100;
try {
  accountManager.activateOsAccount(localId, (err: BusinessError)=>{
    if (err) {
      console.error(`activateOsAccount failed, code is ${err.code}, message is ${err.message}`);
    } else {
      console.log('activateOsAccount successfully');
    }
  });
} catch (err) {
  console.log('activateOsAccount failed, error:' + JSON.stringify(err));
}

activateOsAccount

activateOsAccount(localId: number): Promise<void>

Activates a system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Activate system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.activateOsAccount(localId).then(() => {
    console.log('activateOsAccount successfully');
  }).catch((err: BusinessError) => {
    console.log('activateOsAccount failed, err:' + JSON.stringify(err));
  });
} catch (e) {
  console.log('activateOsAccount exception: ' + JSON.stringify(e));
}

checkMultiOsAccountEnabled⁹⁺

checkMultiOsAccountEnabled(callback: AsyncCallback<boolean>): void

Checks whether multiple system accounts are supported. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkMultiOsAccountEnabled((err: BusinessError, isEnabled: boolean) => {
    if (err) {
      console.error(`checkMultiOsAccountEnabled failed, code is ${err.code}, message is ${err.message}`);
    } else {
    console.log('checkMultiOsAccountEnabled successfully, isEnabled: ' + isEnabled);
    }
  });
} catch (err) {
  console.log('checkMultiOsAccountEnabled failed, error:' + JSON.stringify(err));
}

checkMultiOsAccountEnabled⁹⁺

checkMultiOsAccountEnabled(): Promise<boolean>

Checks whether multiple system accounts are supported. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
try {
  let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
  accountManager.checkMultiOsAccountEnabled().then((isEnabled: boolean) => {
    console.log('checkMultiOsAccountEnabled successfully, isEnabled: ' + isEnabled);
  }).catch((err: BusinessError) => {
    console.error(`checkMultiOsAccountEnabled failed, code is ${err.code}, message is ${err.message}`);
  });
} catch (err) {
  console.log('checkMultiOsAccountEnabled failed, error:' + JSON.stringify(err));
}

checkOsAccountActivated⁹⁺

checkOsAccountActivated(localId: number, callback: AsyncCallback<boolean>): void

Checks whether a system account is activated. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Check whether system account 100 is activated.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.checkOsAccountActivated(localId, (err: BusinessError, isActivated: boolean) => {
    if (err) {
      console.log('checkOsAccountActivated failed, error:' + JSON.stringify(err));
    } else {
      console.log('checkOsAccountActivated successfully, isActivated:' + isActivated);
    }
  });
} catch (err) {
  console.log('checkOsAccountActivated exception: ' + JSON.stringify(err));
}

checkOsAccountActivated⁹⁺

checkOsAccountActivated(localId: number): Promise<boolean>

Checks whether a system account is activated. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Check whether system account 100 is activated.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.checkOsAccountActivated(localId).then((isActivated: boolean) => {
    console.log('checkOsAccountActivated successfully, isActivated: ' + isActivated);
  }).catch((err: BusinessError) => {
    console.log('checkOsAccountActivated failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountActivated exception: ' + JSON.stringify(err));
}

checkOsAccountConstraintEnabled⁹⁺

checkOsAccountConstraintEnabled(localId: number, constraint: string, callback: AsyncCallback<boolean>): void

Checks whether the specified constraint is enabled for a system account. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Check whether system account 100 is forbidden to use Wi-Fi.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let constraint: string = 'constraint.wifi';
try {
  accountManager.checkOsAccountConstraintEnabled(localId, constraint, (err: BusinessError, isEnabled: boolean)=>{
    if (err) {
      console.log('checkOsAccountConstraintEnabled failed, error: ' + JSON.stringify(err));
    } else {
      console.log('checkOsAccountConstraintEnabled successfully, isEnabled: ' + isEnabled);
    }
  });
} catch (err) {
  console.log('checkOsAccountConstraintEnabled exception: ' + JSON.stringify(err));
}

checkOsAccountConstraintEnabled⁹⁺

checkOsAccountConstraintEnabled(localId: number, constraint: string): Promise<boolean>

Checks whether the specified constraint is enabled for a system account. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Check whether system account 100 is forbidden to use Wi-Fi.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let constraint: string = 'constraint.wifi';
try {
  accountManager.checkOsAccountConstraintEnabled(localId, constraint).then((isEnabled: boolean) => {
    console.log('checkOsAccountConstraintEnabled successfully, isEnabled: ' + isEnabled);
  }).catch((err: BusinessError) => {
    console.log('checkOsAccountConstraintEnabled failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountConstraintEnabled exception: ' + JSON.stringify(err));
}

checkOsAccountTestable⁹⁺

checkOsAccountTestable(callback: AsyncCallback<boolean>): void

Checks whether this system account is a test account. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountTestable((err: BusinessError, isTestable: boolean) => {
    if (err) {
      console.log('checkOsAccountTestable failed, error: ' + JSON.stringify(err));
    } else {
      console.log('checkOsAccountTestable successfully, isTestable: ' + isTestable);
    }
  });
} catch (err) {
  console.log('checkOsAccountTestable error: ' + JSON.stringify(err));
}

checkOsAccountTestable⁹⁺

checkOsAccountTestable(): Promise<boolean>

Checks whether this system account is a test account. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountTestable().then((isTestable: boolean) => {
    console.log('checkOsAccountTestable successfully, isTestable: ' + isTestable);
  }).catch((err: BusinessError) => {
    console.log('checkOsAccountTestable failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountTestable exception: ' + JSON.stringify(err));
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(callback: AsyncCallback<boolean>): void

Checks whether this system account has been verified. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountVerified((err: BusinessError, isVerified: boolean) => {
    if (err) {
      console.log('checkOsAccountVerified failed, error: ' + JSON.stringify(err));
    } else {
      console.log('checkOsAccountVerified successfully, isVerified: ' + isVerified);
    }
  });
} catch (err) {
  console.log('checkOsAccountVerified exception: ' + JSON.stringify(err));
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(): Promise<boolean>

Checks whether this system account has been verified. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountVerified().then((isVerified: boolean) => {
    console.log('checkOsAccountVerified successfully, isVerified: ' + isVerified);
  }).catch((err: BusinessError) => {
    console.log('checkOsAccountVerified failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountVerified exception: ' + JSON.stringify(err));
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(localId: number, callback: AsyncCallback<boolean>): void

Checks whether a system account has been verified. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.checkOsAccountVerified(localId, (err: BusinessError, isVerified: boolean) => {
    if (err) {
      console.log('checkOsAccountVerified failed, error: ' + JSON.stringify(err));
    } else {
      console.log('checkOsAccountVerified successfully, isVerified: ' + isVerified);
    }
  });
} catch (err) {
  console.log('checkOsAccountVerified exception: ' + err);
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(localId: number): Promise<boolean>

Checks whether a system account has been verified. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.checkOsAccountVerified(localId).then((isVerified: boolean) => {
    console.log('checkOsAccountVerified successfully, isVerified: ' + isVerified);
  }).catch((err: BusinessError) => {
    console.log('checkOsAccountVerified failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountVerified exception: ' + JSON.stringify(err));
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(): Promise<boolean>

Checks whether this system account has been verified. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountVerified().then((isVerified: boolean) => {
    console.log('checkOsAccountVerified successfully, isVerified: ' + isVerified);
  }).catch((err: BusinessError) => {
    console.log('checkOsAccountVerified failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountVerified exception: ' + JSON.stringify(err));
}

removeOsAccount

removeOsAccount(localId: number, callback: AsyncCallback<void>): void

Removes a system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let accountName: string = 'testAccountName';
try {
  accountManager.createOsAccount(accountName, account_osAccount.OsAccountType.NORMAL,
    (err: BusinessError, osAccountInfo: account_osAccount.OsAccountInfo) => {
      accountManager.removeOsAccount(osAccountInfo.localId, (err: BusinessError)=>{
        if (err) {
          console.log('removeOsAccount failed, error: ' + JSON.stringify(err));
        } else {
          console.log('removeOsAccount successfully');
        }
    });
  });
} catch (err) {
  console.log('removeOsAccount exception: ' + JSON.stringify(err));
}

removeOsAccount

removeOsAccount(localId: number): Promise<void>

Removes a system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let accountName: string = 'testAccountName';
try {
  accountManager.createOsAccount(accountName, account_osAccount.OsAccountType.NORMAL,
    (err: BusinessError, osAccountInfo: account_osAccount.OsAccountInfo)=>{
      accountManager.removeOsAccount(osAccountInfo.localId).then(() => {
        console.log('removeOsAccount successfully');
      }).catch((err: BusinessError) => {
          console.log('removeOsAccount failed, error: ' + JSON.stringify(err));
      });
  });
} catch (err) {
  console.log('removeOsAccount exception: ' + JSON.stringify(err));
}

setOsAccountConstraints

setOsAccountConstraints(localId: number, constraints: Array<string>, enable: boolean,callback: AsyncCallback<void>): void

Sets or removes constraints for a system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Disable Wi-Fi for system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let constraint: string = 'constraint.wifi';
try {
  accountManager.setOsAccountConstraints(localId, [constraint], true, (err: BusinessError) => {
    if (err) {
      console.log('setOsAccountConstraints failed, error: ' + JSON.stringify(err));
    } else {
      console.log('setOsAccountConstraints successfully');
    }
  });
} catch (err) {
  console.log('setOsAccountConstraints exception: ' + JSON.stringify(err));
}

setOsAccountConstraints

setOsAccountConstraints(localId: number, constraints: Array<string>, enable: boolean): Promise<void>

Sets or removes constraints for a system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Remove the constraint on the use of Wi-Fi for system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.setOsAccountConstraints(localId, ['constraint.location.set'], false).then(() => {
    console.log('setOsAccountConstraints succsuccessfully');
  }).catch((err: BusinessError) => {
    console.log('setOsAccountConstraints failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('setOsAccountConstraints exception: ' + JSON.stringify(err));
}

setOsAccountName

setOsAccountName(localId: number, localName: string, callback: AsyncCallback<void>): void

Sets a name for a system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Set the name of system account 100 to demoName.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let name: string = 'demoName';
try {
  accountManager.setOsAccountName(localId, name, (err: BusinessError) => {
    if (err) {
      console.log('setOsAccountName failed, error: ' + JSON.stringify(err));
    } else {
      console.log('setOsAccountName successfully');
    }
  });
} catch (err) {
  console.log('setOsAccountName exception: ' + JSON.stringify(err));
}

setOsAccountName

setOsAccountName(localId: number, localName: string): Promise<void>

Sets a name for a system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Set the name of system account 100 to demoName.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let name: string = 'testName';
try {
  accountManager.setOsAccountName(localId, name).then(() => {
    console.log('setOsAccountName successfully');
  }).catch((err: BusinessError) => {
    console.log('setOsAccountName failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('setOsAccountName exception: ' + JSON.stringify(err));
}

getOsAccountCount⁹⁺

getOsAccountCount(callback: AsyncCallback<number>): void

Obtains the number of system accounts created. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountCount((err: BusinessError, count: number) => {
    if (err) {
      console.log('getOsAccountCount failed, error: ' + JSON.stringify(err));
    } else {
      console.log('getOsAccountCount successfully, count: ' + count);
    }
  });
} catch (err) {
  console.log('getOsAccountCount exception: ' + JSON.stringify(err));
}

getOsAccountCount⁹⁺

getOsAccountCount(): Promise<number>

Obtains the number of system accounts created. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountCount().then((count: number) => {
    console.log('getOsAccountCount successfully, count: ' + count);
  }).catch((err: BusinessError) => {
    console.log('getOsAccountCount failed, error: ' + JSON.stringify(err));
  });
} catch(err) {
  console.log('getOsAccountCount exception: ' + JSON.stringify(err));
}

getOsAccountLocalId⁹⁺

getOsAccountLocalId(callback: AsyncCallback<number>): void

Obtains the ID of the system account to which the current process belongs. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalId((err: BusinessError, localId: number) => {
    if (err) {
      console.log('getOsAccountLocalId failed, error: ' + JSON.stringify(err));
    } else {
      console.log('getOsAccountLocalId successfully, localId: ' + localId);
    }
  });
} catch (err) {
  console.log('getOsAccountLocalId exception: ' + JSON.stringify(err));
}

getOsAccountLocalId⁹⁺

getOsAccountLocalId(): Promise<number>

Obtains the ID of the system account to which the current process belongs. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalId().then((localId: number) => {
    console.log('getOsAccountLocalId successfully, localId: ' + localId);
  }).catch((err: BusinessError) => {
    console.log('getOsAccountLocalId failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('getOsAccountLocalId exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForUid⁹⁺

getOsAccountLocalIdForUid(uid: number, callback: AsyncCallback<number>): void

Obtains the system account ID based on the process UID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Obtain the ID of the system account whose process UID is 12345678.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let uid: number = 12345678;
try {
  accountManager.getOsAccountLocalIdForUid(uid, (err: BusinessError, localId: number) => {
    if (err) {
      console.log('getOsAccountLocalIdForUid failed, error: ' + JSON.stringify(err));
    }
    console.log('getOsAccountLocalIdForUid successfully, localId: ' + localId);
  });
} catch (err) {
  console.log('getOsAccountLocalIdForUid exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForUid⁹⁺

getOsAccountLocalIdForUid(uid: number): Promise<number>

Obtains the system account ID based on the process UID. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Obtain the ID of the system account whose process UID is 12345678.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let uid: number = 12345678;
try {
  accountManager.getOsAccountLocalIdForUid(uid).then((localId: number) => {
    console.log('getOsAccountLocalIdForUid successfully, localId: ' + localId);
  }).catch((err: BusinessError) => {
    console.log('getOsAccountLocalIdForUid failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('getOsAccountLocalIdForUid exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForUidSync¹⁰⁺

getOsAccountLocalIdForUidSync(uid: number): number

Obtains the system account ID based on the process UID. The API returns the result synchronously.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Obtain the ID of the system account whose process UID is 12345678.

let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let uid: number = 12345678;
try {
  let localId : number = accountManager.getOsAccountLocalIdForUidSync(uid);
  console.log('getOsAccountLocalIdForUidSync successfully, localId: ' + localId);
} catch (err) {
  console.log('getOsAccountLocalIdForUidSync exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForDomain⁹⁺

getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void

Obtains the system account ID based on the domain account information. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let domainInfo: account_osAccount.DomainAccountInfo = {domain: 'testDomain', accountName: 'testAccountName'};
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalIdForDomain(domainInfo, (err: BusinessError, localId: number) => {
    if (err) {
      console.log('getOsAccountLocalIdForDomain failed, error: ' + JSON.stringify(err));
    } else {
      console.log('getOsAccountLocalIdForDomain successfully, localId: ' + localId);
    }
  });
} catch (err) {
  console.log('getOsAccountLocalIdForDomain exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForDomain⁹⁺

getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo): Promise<number>

Obtains the system account ID based on the domain account information. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let domainInfo: account_osAccount.DomainAccountInfo = {domain: 'testDomain', accountName: 'testAccountName'};
try {
  accountManager.getOsAccountLocalIdForDomain(domainInfo).then((localId: number) => {
    console.log('getOsAccountLocalIdForDomain successfully, localId: ' + localId);
  }).catch((err: BusinessError) => {
    console.log('getOsAccountLocalIdForDomain failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('getOsAccountLocalIdForDomain exception: ' + JSON.stringify(err));
}

queryMaxOsAccountNumber

queryMaxOsAccountNumber(callback: AsyncCallback<number>): void

Queries the maximum number of system accounts that can be created. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryMaxOsAccountNumber((err: BusinessError, maxCnt: number) => {
    if (err) {
      console.log('queryMaxOsAccountNumber failed, error:' + JSON.stringify(err));
    } else {
      console.log('queryMaxOsAccountNumber successfully, maxCnt:' + maxCnt);
    }
  });
} catch (err) {
  console.log('queryMaxOsAccountNumber exception: ' + JSON.stringify(err));
}

queryMaxOsAccountNumber

queryMaxOsAccountNumber(): Promise<number>

Queries the maximum number of system accounts that can be created. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryMaxOsAccountNumber().then((maxCnt: number) => {
    console.log('queryMaxOsAccountNumber successfully, maxCnt: ' + maxCnt);
  }).catch((err: BusinessError) => {
    console.log('queryMaxOsAccountNumber failed, error: ' + JSON.stringify(err));
  });
} catch (err) {
  console.log('queryMaxOsAccountNumber exception: ' + JSON.stringify(err));
}

getOsAccountConstraints⁹⁺

getOsAccountConstraints(localId: number, callback: AsyncCallback<Array<string>>): void

Obtains all constraints enabled for a system account. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Obtain all constraints of system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.getOsAccountConstraints(localId, (err: BusinessError, constraints: string[]) => {
    if (err) {
      console.log('getOsAccountConstraints failed, err: ' + JSON.stringify(err));
    } else {
      console.log('getOsAccountConstraints successfully, constraints: ' + JSON.stringify(constraints));
    }
  });
} catch (err) {
  console.log('getOsAccountConstraints exception: ' + JSON.stringify(err));
}

getOsAccountConstraints⁹⁺

getOsAccountConstraints(localId: number): Promise<Array<string>>

Obtains all constraints enabled for a system account. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Obtain all constraints of system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.getOsAccountConstraints(localId).then((constraints: string[]) => {
    console.log('getOsAccountConstraints, constraints: ' + constraints);
  }).catch((err: BusinessError) => {
    console.log('getOsAccountConstraints err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountConstraints exception: ' + JSON.stringify(e));
}

queryAllCreatedOsAccounts

queryAllCreatedOsAccounts(callback: AsyncCallback<Array<OsAccountInfo>>): void

Queries information about all the system accounts created. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryAllCreatedOsAccounts((err: BusinessError, accountArr: account_osAccount.OsAccountInfo[])=>{
    console.log('queryAllCreatedOsAccounts err:' + JSON.stringify(err));
    console.log('queryAllCreatedOsAccounts accountArr:' + JSON.stringify(accountArr));
  });
} catch (e) {
  console.log('queryAllCreatedOsAccounts exception: ' + JSON.stringify(e));
}

queryAllCreatedOsAccounts

queryAllCreatedOsAccounts(): Promise<Array<OsAccountInfo>>

Queries information about all the system accounts created. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryAllCreatedOsAccounts().then((accountArr: account_osAccount.OsAccountInfo[]) => {
    console.log('queryAllCreatedOsAccounts, accountArr: ' + JSON.stringify(accountArr));
  }).catch((err: BusinessError) => {
    console.log('queryAllCreatedOsAccounts err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryAllCreatedOsAccounts exception: ' + JSON.stringify(e));
}

getActivatedOsAccountLocalIds⁹⁺

getActivatedOsAccountLocalIds(callback: AsyncCallback<Array<number>>): void

Obtains information about all activated system accounts. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getActivatedOsAccountLocalIds((err: BusinessError, idArray: number[])=>{
    console.log('getActivatedOsAccountLocalIds err:' + JSON.stringify(err));
    console.log('getActivatedOsAccountLocalIds idArray length:' + idArray.length);
    for(let i=0;i<idArray.length;i++) {
      console.info('activated os account id: ' + idArray[i]);
    }
  });
} catch (e) {
  console.log('getActivatedOsAccountLocalIds exception: ' + JSON.stringify(e));
}

getActivatedOsAccountLocalIds⁹⁺

getActivatedOsAccountLocalIds(): Promise<Array<number>>

Obtains information about all activated system accounts. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getActivatedOsAccountLocalIds().then((idArray: number[]) => {
    console.log('getActivatedOsAccountLocalIds, idArray: ' + idArray);
  }).catch((err: BusinessError) => {
    console.log('getActivatedOsAccountLocalIds err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getActivatedOsAccountLocalIds exception: ' + JSON.stringify(e));
}

createOsAccount

createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback<OsAccountInfo>): void

Creates a system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.createOsAccount('testName', account_osAccount.OsAccountType.NORMAL,
    (err: BusinessError, osAccountInfo: account_osAccount.OsAccountInfo)=>{
    console.log('createOsAccount err:' + JSON.stringify(err));
    console.log('createOsAccount osAccountInfo:' + JSON.stringify(osAccountInfo));
  });
} catch (e) {
  console.log('createOsAccount exception: ' + JSON.stringify(e));
}

createOsAccount

createOsAccount(localName: string, type: OsAccountType): Promise<OsAccountInfo>

Creates a system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL).then(
    (accountInfo: account_osAccount.OsAccountInfo) => {
    console.log('createOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
  }).catch((err: BusinessError) => {
    console.log('createOsAccount err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('createOsAccount exception: ' + JSON.stringify(e));
}

createOsAccountForDomain⁸⁺

createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, callback: AsyncCallback<OsAccountInfo>): void

Creates a system account and associates it with the specified domain account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let domainInfo: account_osAccount.DomainAccountInfo =
  {domain: 'testDomain', accountName: 'testAccountName'};
try {
  accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo,
    (err: BusinessError, osAccountInfo: account_osAccount.OsAccountInfo)=>{
    console.log('createOsAccountForDomain err:' + JSON.stringify(err));
    console.log('createOsAccountForDomain osAccountInfo:' + JSON.stringify(osAccountInfo));
  });
} catch (e) {
  console.log('createOsAccountForDomain exception: ' + JSON.stringify(e));
}

createOsAccountForDomain⁸⁺

createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo): Promise<OsAccountInfo>

Creates a system account and associates it with the specified domain account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let domainInfo: account_osAccount.DomainAccountInfo =
  {domain: 'testDomain', accountName: 'testAccountName'};
try {
  accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo).then(
    (accountInfo: account_osAccount.OsAccountInfo) => {
    console.log('createOsAccountForDomain, account info: ' + JSON.stringify(accountInfo));
  }).catch((err: BusinessError) => {
    console.log('createOsAccountForDomain err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('createOsAccountForDomain exception: ' + JSON.stringify(e));
}

getCurrentOsAccount⁹⁺

getCurrentOsAccount(callback: AsyncCallback<OsAccountInfo>): void

Obtains information about the system account to which the current process belongs. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.GET_LOCAL_ACCOUNTS¹⁰⁺

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getCurrentOsAccount((err: BusinessError, curAccountInfo: account_osAccount.OsAccountInfo)=>{
    console.log('getCurrentOsAccount err:' + JSON.stringify(err));
    console.log('getCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
  });
} catch (e) {
  console.log('getCurrentOsAccount exception: ' + JSON.stringify(e));
}

getCurrentOsAccount⁹⁺

getCurrentOsAccount(): Promise<OsAccountInfo>

Obtains information about the system account to which the current process belongs. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.GET_LOCAL_ACCOUNTS¹⁰⁺

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getCurrentOsAccount().then((accountInfo: account_osAccount.OsAccountInfo) => {
    console.log('getCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
  }).catch((err: BusinessError) => {
    console.log('getCurrentOsAccount err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getCurrentOsAccount exception: ' + JSON.stringify(e));
}

queryOsAccountById

queryOsAccountById(localId: number, callback: AsyncCallback<OsAccountInfo>): void

Queries information about the system account of the given ID. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Query information about system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.queryOsAccountById(localId, (err: BusinessError, accountInfo: account_osAccount.OsAccountInfo)=>{
    console.log('queryOsAccountById err:' + JSON.stringify(err));
    console.log('queryOsAccountById accountInfo:' + JSON.stringify(accountInfo));
  });
} catch (e) {
  console.log('queryOsAccountById exception: ' + JSON.stringify(e));
}

queryOsAccountById

queryOsAccountById(localId: number): Promise<OsAccountInfo>

Queries information about the system account of the given ID. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Query information about system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.queryOsAccountById(localId).then((accountInfo: account_osAccount.OsAccountInfo) => {
    console.log('queryOsAccountById, accountInfo: ' + JSON.stringify(accountInfo));
  }).catch((err: BusinessError) => {
    console.log('queryOsAccountById err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryOsAccountById exception: ' + JSON.stringify(e));
}

getOsAccountType⁹⁺

getOsAccountType(callback: AsyncCallback<OsAccountType>): void

Obtains the type of the account to which the current process belongs. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountType((err: BusinessError, accountType: account_osAccount.OsAccountType) => {
    console.log('getOsAccountType err: ' + JSON.stringify(err));
    console.log('getOsAccountType accountType: ' + accountType);
  });
} catch (e) {
  console.log('getOsAccountType exception: ' + JSON.stringify(e));
}

getOsAccountType⁹⁺

getOsAccountType(): Promise<OsAccountType>

Obtains the type of the account to which the current process belongs. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountType().then((accountType: account_osAccount.OsAccountType) => {
    console.log('getOsAccountType, accountType: ' + accountType);
  }).catch((err: BusinessError) => {
    console.log('getOsAccountType err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountType exception: ' + JSON.stringify(e));
}

queryDistributedVirtualDeviceId⁹⁺

queryDistributedVirtualDeviceId(callback: AsyncCallback<string>): void

Queries the ID of this distributed virtual device. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryDistributedVirtualDeviceId((err: BusinessError, virtualID: string) => {
    console.log('queryDistributedVirtualDeviceId err: ' + JSON.stringify(err));
    console.log('queryDistributedVirtualDeviceId virtualID: ' + virtualID);
  });
} catch (e) {
  console.log('queryDistributedVirtualDeviceId exception: ' + JSON.stringify(e));
}

queryDistributedVirtualDeviceId⁹⁺

queryDistributedVirtualDeviceId(): Promise<string>

Queries the ID of this distributed virtual device. This API uses a promise to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryDistributedVirtualDeviceId().then((virtualID: string) => {
    console.log('queryDistributedVirtualDeviceId, virtualID: ' + virtualID);
  }).catch((err: BusinessError) => {
    console.log('queryDistributedVirtualDeviceId err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryDistributedVirtualDeviceId exception: ' + JSON.stringify(e));
}

getOsAccountProfilePhoto

getOsAccountProfilePhoto(localId: number, callback: AsyncCallback<string>): void

Obtains the profile photo of a system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Obtain the profile photo of system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.getOsAccountProfilePhoto(localId, (err: BusinessError, photo: string)=>{
    console.log('getOsAccountProfilePhoto err:' + JSON.stringify(err));
    console.log('get photo:' + photo + ' by localId: ' + localId);
  });
} catch (e) {
  console.log('getOsAccountProfilePhoto exception: ' + JSON.stringify(e));
}

getOsAccountProfilePhoto

getOsAccountProfilePhoto(localId: number): Promise<string>

Obtains the profile photo of a system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Obtain the profile photo of system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.getOsAccountProfilePhoto(localId).then((photo: string) => {
    console.log('getOsAccountProfilePhoto: ' + photo);
  }).catch((err: BusinessError) => {
    console.log('getOsAccountProfilePhoto err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountProfilePhoto exception: ' + JSON.stringify(e));
}

setOsAccountProfilePhoto

setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback<void>): void

Sets a profile photo for a system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Set a profile photo for system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let photo: string = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
'+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
try {
  accountManager.setOsAccountProfilePhoto(localId, photo, (err: BusinessError)=>{
    console.log('setOsAccountProfilePhoto err:' + JSON.stringify(err));
  });
} catch (e) {
  console.log('setOsAccountProfilePhoto exception: ' + JSON.stringify(e));
}

setOsAccountProfilePhoto

setOsAccountProfilePhoto(localId: number, photo: string): Promise<void>

Sets a profile photo for a system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Set a profile photo for system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let photo: string = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
'+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
try {
  accountManager.setOsAccountProfilePhoto(localId, photo).then(() => {
    console.log('setOsAccountProfilePhoto success');
  }).catch((err: BusinessError) => {
    console.log('setOsAccountProfilePhoto err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('setOsAccountProfilePhoto exception: ' + JSON.stringify(e));
}

getOsAccountLocalIdForSerialNumber⁹⁺

getOsAccountLocalIdForSerialNumber(serialNumber: number, callback: AsyncCallback<number>): void

Obtains the system account ID based on the SN. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Obtain the ID of the system account whose SN is 12345.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let serialNumber: number = 12345;
try {
  accountManager.getOsAccountLocalIdForSerialNumber(serialNumber, (err: BusinessError, localId: number)=>{
    console.log('ger localId err:' + JSON.stringify(err));
    console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
  });
} catch (e) {
  console.log('ger localId exception: ' + JSON.stringify(e));
}

getOsAccountLocalIdForSerialNumber⁹⁺

getOsAccountLocalIdForSerialNumber(serialNumber: number): Promise<number>

Obtains the system account ID based on the SN. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Obtain the ID of the system account whose SN is 12345.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let serialNumber: number = 12345;
try {
  accountManager.getOsAccountLocalIdForSerialNumber(serialNumber).then((localId: number) => {
    console.log('getOsAccountLocalIdForSerialNumber localId: ' + localId);
  }).catch((err: BusinessError) => {
    console.log('getOsAccountLocalIdForSerialNumber err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountLocalIdForSerialNumber exception: ' + JSON.stringify(e));
}

getSerialNumberForOsAccountLocalId⁹⁺

getSerialNumberForOsAccountLocalId(localId: number, callback: AsyncCallback<number>): void

Obtains the SN of a system account based on the account ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example: Obtain the SN of the system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.getSerialNumberForOsAccountLocalId(localId, (err: BusinessError, serialNumber: number)=>{
    console.log('ger serialNumber err:' + JSON.stringify(err));
    console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
  });
} catch (e) {
  console.log('ger serialNumber exception: ' + JSON.stringify(e));
}

getSerialNumberForOsAccountLocalId⁹⁺

getSerialNumberForOsAccountLocalId(localId: number): Promise<number>

Obtains the SN of a system account based on the account ID. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example: Obtain the SN of the system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
try {
  accountManager.getSerialNumberForOsAccountLocalId(localId).then((serialNumber: number) => {
    console.log('getSerialNumberForOsAccountLocalId serialNumber: ' + serialNumber);
  }).catch((err: BusinessError) => {
    console.log('getSerialNumberForOsAccountLocalId err: ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getSerialNumberForOsAccountLocalId exception: ' + JSON.stringify(e));
}

on

on(type: 'activate' | 'activating', name: string, callback: Callback<number>): void

Subscribes to the system account activation states, including the states of the account being activated and the account with activation completed. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
function onCallback(receiveLocalId: number){
  console.log('receive localId:' + receiveLocalId);
}
try {
  accountManager.on('activating', 'osAccountOnOffNameA', onCallback);
} catch (e) {
  console.log('receive localId exception: ' + JSON.stringify(e));
}

off

off(type: 'activate' | 'activating', name: string, callback?: Callback<number>): void

Unsubscribes from the system account activation states, including the states of the account being activated and the account with activation completed. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
function offCallback(){
  console.log('off enter')
}
try {
  accountManager.off('activating', 'osAccountOnOffNameA', offCallback);
} catch (e) {
  console.log('off exception: ' + JSON.stringify(e));
}

getBundleIdForUid⁹⁺

getBundleIdForUid(uid: number, callback: AsyncCallback<number>): void

Obtains the bundle ID based on the UID. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let testUid: number = 1000000;
try {
  accountManager.getBundleIdForUid(testUid, (err: BusinessError, bundleId: number) => {
    console.info('getBundleIdForUid errInfo:' + JSON.stringify(err));
    console.info('getBundleIdForUid bundleId:' + JSON.stringify(bundleId));
  });
} catch (e) {
  console.info('getBundleIdForUid exception: ' + JSON.stringify(e));
}

getBundleIdForUid⁹⁺

getBundleIdForUid(uid: number): Promise<number>

Obtains the bundle ID based on the UID. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let testUid: number = 1000000;
try {
  accountManager.getBundleIdForUid(testUid).then((result: number) => {
    console.info('getBundleIdForUid bundleId:' + JSON.stringify(result));
  }).catch((err: BusinessError) => {
    console.info('getBundleIdForUid errInfo:' + JSON.stringify(err));
  });
} catch (e) {
  console.info('getBundleIdForUid exception: ' + JSON.stringify(e));
}

getBundleIdForUidSync¹⁰⁺

getBundleIdForUidSync(uid: number): number

Obtains the bundle ID based on the specified UID. The API returns the result synchronously.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let testUid: number = 1000000;
try {
  let bundleId : number = accountManager.getBundleIdForUidSync(testUid);
  console.info('getBundleIdForUidSync bundleId:' + bundleId);
} catch (e) {
  console.info('getBundleIdForUidSync exception: ' + JSON.stringify(e));
}

isMainOsAccount⁹⁺

isMainOsAccount(callback: AsyncCallback<boolean>): void;

Checks whether the current process belongs to the main system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.isMainOsAccount((err: BusinessError,result: boolean)=>{
    console.info('isMainOsAccount errInfo:' + JSON.stringify(err));
    console.info('isMainOsAccount result:' + JSON.stringify(result));
  });
} catch (e) {
  console.info('isMainOsAccount exception: ' + JSON.stringify(e));
}

isMainOsAccount⁹⁺

isMainOsAccount(): Promise<boolean>;

Checks whether the current process belongs to the main system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.isMainOsAccount().then((result: boolean) => {
    console.info('isMainOsAccount result:' + JSON.stringify(result));
  }).catch((err: BusinessError) => {
    console.info('isMainOsAccount errInfo:' + JSON.stringify(err));
  });
} catch (e) {
  console.info('isMainOsAccount exception: ' + JSON.stringify(e));
}

getOsAccountConstraintSourceTypes⁹⁺

getOsAccountConstraintSourceTypes(localId: number, constraint: string, callback: AsyncCallback<Array<ConstraintSourceTypeInfo>>): void;

Obtains the constraint source information of a system account. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountConstraintSourceTypes(100, 'constraint.wifi',
    (err: BusinessError,sourceTypeInfos: account_osAccount.ConstraintSourceTypeInfo[])=>{
    console.info('getOsAccountConstraintSourceTypes errInfo:' + JSON.stringify(err));
    console.info('getOsAccountConstraintSourceTypes sourceTypeInfos:' + JSON.stringify(sourceTypeInfos));
  });
} catch (e) {
  console.info('getOsAccountConstraintSourceTypes exception: ' + JSON.stringify(e));
}

getOsAccountConstraintSourceTypes⁹⁺

getOsAccountConstraintSourceTypes(localId: number, constraint: string): Promise<Array<ConstraintSourceTypeInfo>>;

Obtains the constraint source information of a system account. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountConstraintSourceTypes(100, 'constraint.wifi').then(
    (result: account_osAccount.ConstraintSourceTypeInfo[]) => {
    console.info('getOsAccountConstraintSourceTypes sourceTypeInfos:' + JSON.stringify(result));
  }).catch((err: BusinessError) => {
    console.info('getOsAccountConstraintSourceTypes errInfo:' + JSON.stringify(err));
  });
} catch (e) {
  console.info('getOsAccountConstraintSourceTypes exception: ' + JSON.stringify(e));
}

isMultiOsAccountEnable^(deprecated)

isMultiOsAccountEnable(callback: AsyncCallback<boolean>): void

Checks whether multiple system accounts are supported. 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 checkMultiOsAccountEnabled instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.isMultiOsAccountEnable((err: BusinessError, isEnabled: boolean) => {
  if (err) {
    console.log('isMultiOsAccountEnable failed, error: ' + JSON.stringify(err));
  } else {
  console.log('isMultiOsAccountEnable successfully, isEnabled: ' + isEnabled);
  }
});

isMultiOsAccountEnable^(deprecated)

isMultiOsAccountEnable(): Promise<boolean>

Checks whether multiple system accounts are supported. 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 checkMultiOsAccountEnabled instead.

System capability: SystemCapability.Account.OsAccount

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.isMultiOsAccountEnable().then((isEnabled: boolean) => {
  console.log('isMultiOsAccountEnable successfully, isEnabled: ' + isEnabled);
}).catch((err: BusinessError) => {
  console.log('isMultiOsAccountEnable failed, error: ' + JSON.stringify(err));
});

isOsAccountActived^(deprecated)

isOsAccountActived(localId: number, callback: AsyncCallback<boolean>): void

Checks whether a system account is activated. 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 checkOsAccountActivated instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Check whether system account 100 is activated.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
accountManager.isOsAccountActived(localId, (err: BusinessError, isActived: boolean) => {
  if (err) {
    console.log('isOsAccountActived failed, err:' + JSON.stringify(err));
  } else {
    console.log('isOsAccountActived successfully, isActived:' + isActived);
  }
});

isOsAccountActived^(deprecated)

isOsAccountActived(localId: number): Promise<boolean>

Checks whether a system account is activated. 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 checkOsAccountActivated instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Check whether system account 100 is activated.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
accountManager.isOsAccountActived(localId).then((isActived: boolean) => {
  console.log('isOsAccountActived successfully, isActived: ' + isActived);
}).catch((err: BusinessError) => {
  console.log('isOsAccountActived failed, error: ' + JSON.stringify(err));
});

isOsAccountConstraintEnable^(deprecated)

isOsAccountConstraintEnable(localId: number, constraint: string, callback: AsyncCallback<boolean>): void

Checks whether the specified constraint is enabled for a system account. 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 checkOsAccountConstraintEnabled instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Check whether system account 100 is forbidden to use Wi-Fi.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let constraint: string = 'constraint.wifi';
accountManager.isOsAccountConstraintEnable(localId, constraint, (err: BusinessError, isEnabled: boolean) => {
  if (err) {
    console.log('isOsAccountConstraintEnable failed, error: ' + JSON.stringify(err));
  } else {
    console.log('isOsAccountConstraintEnable successfully, isEnabled: ' + isEnabled);
  }
});

isOsAccountConstraintEnable^(deprecated)

isOsAccountConstraintEnable(localId: number, constraint: string): Promise<boolean>

Checks whether the specified constraint is enabled for a system account. 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 checkOsAccountConstraintEnabled instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Check whether system account 100 is forbidden to use Wi-Fi.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
let constraint: string = 'constraint.wifi';
accountManager.isOsAccountConstraintEnable(localId, constraint).then((isEnabled: boolean) => {
  console.log('isOsAccountConstraintEnable successfully, isEnabled: ' + isEnabled);
}).catch((err: BusinessError) => {
  console.log('isOsAccountConstraintEnable err: ' + JSON.stringify(err));
});

isTestOsAccount^(deprecated)

isTestOsAccount(callback: AsyncCallback<boolean>): void

Checks whether this system account is a test account. 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 checkOsAccountTestable instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.isTestOsAccount((err: BusinessError, isTestable: boolean) => {
  if (err) {
    console.log('isTestOsAccount failed, error: ' + JSON.stringify(err));
  } else {
    console.log('isTestOsAccount successfully, isTestable: ' + isTestable);
  }
});

isTestOsAccount^(deprecated)

isTestOsAccount(): Promise<boolean>

Checks whether this system account is a test account. 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 checkOsAccountTestable instead.

System capability: SystemCapability.Account.OsAccount

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
  accountManager.isTestOsAccount().then((isTestable: boolean) => {
    console.log('isTestOsAccount successfully, isTestable: ' + isTestable);
  }).catch((err: BusinessError) => {
    console.log('isTestOsAccount failed, error: ' + JSON.stringify(err));
});

isOsAccountVerified^(deprecated)

isOsAccountVerified(callback: AsyncCallback<boolean>): void

Checks whether this system account has been verified. 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 checkOsAccountVerified instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.isOsAccountVerified((err: BusinessError, isVerified: boolean) => {
  if (err) {
    console.log('isOsAccountVerified failed, error: ' + JSON.stringify(err));
  } else {
    console.log('isOsAccountVerified successfully, isVerified: ' + isVerified);
  }
});

isOsAccountVerified^(deprecated)

isOsAccountVerified(localId: number, callback: AsyncCallback<boolean>): void

Checks whether a system account has been verified. 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 checkOsAccountVerified instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
accountManager.isOsAccountVerified(localId, (err: BusinessError, isVerified: boolean) => {
  if (err) {
    console.log('isOsAccountVerified failed, error: ' + JSON.stringify(err));
  } else {
    console.log('isOsAccountVerified successfully, isVerified: ' + isVerified);
  }
});

isOsAccountVerified^(deprecated)

isOsAccountVerified(localId?: number): Promise<boolean>

Checks whether a system account has been verified. 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 checkOsAccountVerified instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.isOsAccountVerified().then((isVerified: boolean) => {
  console.log('isOsAccountVerified successfully, isVerified: ' + isVerified);
}).catch((err: BusinessError) => {
  console.log('isOsAccountVerified failed, error: ' + JSON.stringify(err));
});

getCreatedOsAccountsCount^(deprecated)

getCreatedOsAccountsCount(callback: AsyncCallback<number>): void

Obtains the number of system accounts created. 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 getOsAccountCount instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getCreatedOsAccountsCount((err: BusinessError, count: number)=>{
  if (err) {
    console.log('getCreatedOsAccountsCount failed, error: ' + JSON.stringify(err));
  } else {
    console.log('getCreatedOsAccountsCount successfully, count: ' + count);
  }
});

getCreatedOsAccountsCount^(deprecated)

getCreatedOsAccountsCount(): Promise<number>

Obtains the number of system accounts created. 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 getOsAccountCount instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getCreatedOsAccountsCount().then((count: number) => {
  console.log('getCreatedOsAccountsCount successfully, count: ' + count);
}).catch((err: BusinessError) => {
  console.log('getCreatedOsAccountsCount failed, error: ' + JSON.stringify(err));
});

getOsAccountLocalIdFromProcess^(deprecated)

getOsAccountLocalIdFromProcess(callback: AsyncCallback<number>): void

Obtains the ID of the system account to which the current process belongs. 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 getOsAccountLocalId instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromProcess((err: BusinessError, localId: number) => {
  if (err) {
    console.log('getOsAccountLocalIdFromProcess failed, error: ' + JSON.stringify(err));
  } else {
    console.log('getOsAccountLocalIdFromProcess failed, error: ' + localId);
  }
});

getOsAccountLocalIdFromProcess^(deprecated)

getOsAccountLocalIdFromProcess(): Promise<number>

Obtains the ID of the system account to which the current process belongs. 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 getOsAccountLocalId instead.

System capability: SystemCapability.Account.OsAccount

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromProcess().then((localId: number) => {
  console.log('getOsAccountLocalIdFromProcess successfully, localId: ' + localId);
}).catch((err: BusinessError) => {
  console.log('getOsAccountLocalIdFromProcess failed, error: ' + JSON.stringify(err));
});

getOsAccountLocalIdFromUid^(deprecated)

getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback<number>): void

Obtains the system account ID based on the process UID. 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 getOsAccountLocalIdForUid instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Obtain the ID of the system account whose process UID is 12345678.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let uid: number = 12345678;
accountManager.getOsAccountLocalIdFromUid(uid, (err: BusinessError, localId: number) => {
  if (err) {
    console.log('getOsAccountLocalIdFromUid failed, error: ' + JSON.stringify(err));
  } else {
    console.log('getOsAccountLocalIdFromUid successfully, localId: ' + localId);
  }
});

getOsAccountLocalIdFromUid^(deprecated)

getOsAccountLocalIdFromUid(uid: number): Promise<number>

Obtains the system account ID based on the process UID. 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 getOsAccountLocalIdForUid instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Obtain the ID of the system account whose process UID is 12345678.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let uid: number = 12345678;
accountManager.getOsAccountLocalIdFromUid(uid).then((localId: number) => {
  console.log('getOsAccountLocalIdFromUid successfully, localId: ' + localId);
}).catch((err: BusinessError) => {
  console.log('getOsAccountLocalIdFromUid failed, error: ' + JSON.stringify(err));
});

getOsAccountLocalIdFromDomain^(deprecated)

getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback<number>): void

Obtains the system account ID based on the domain account information. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. Use getOsAccountLocalIdForDomain instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let domainInfo: account_osAccount.DomainAccountInfo = {domain: 'testDomain', accountName: 'testAccountName'};
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromDomain(domainInfo, (err: BusinessError, localId: number) => {
  if (err) {
    console.log('getOsAccountLocalIdFromDomain failed, error: ' + JSON.stringify(err));
  } else {
    console.log('getOsAccountLocalIdFromDomain successfully, localId: ' + localId);
  }
});

getOsAccountLocalIdFromDomain^(deprecated)

getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise<number>

Obtains the system account ID based on the domain account information. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. Use getOsAccountLocalIdForDomain instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let domainInfo: account_osAccount.DomainAccountInfo = {domain: 'testDomain', accountName: 'testAccountName'};
accountManager.getOsAccountLocalIdFromDomain(domainInfo).then((localId: number) => {
  console.log('getOsAccountLocalIdFromDomain successfully, localId: ' + localId);
}).catch((err: BusinessError) => {
  console.log('getOsAccountLocalIdFromDomain failed, error: ' + JSON.stringify(err));
});

getOsAccountAllConstraints^(deprecated)

getOsAccountAllConstraints(localId: number, callback: AsyncCallback<Array<string>>): void

Obtains all constraints enabled for a system account. 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 getOsAccountConstraints instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Obtain all constraints of system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
accountManager.getOsAccountAllConstraints(localId, (err: BusinessError, constraints: string[])=>{
  console.log('getOsAccountAllConstraints err:' + JSON.stringify(err));
  console.log('getOsAccountAllConstraints:' + JSON.stringify(constraints));
});

getOsAccountAllConstraints^(deprecated)

getOsAccountAllConstraints(localId: number): Promise<Array<string>>

NOTE

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

Obtains all constraints enabled for a system account. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Obtain all constraints of system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
accountManager.getOsAccountAllConstraints(localId).then((constraints: string[]) => {
  console.log('getOsAccountAllConstraints, constraints: ' + constraints);
}).catch((err: BusinessError) => {
  console.log('getOsAccountAllConstraints err: ' + JSON.stringify(err));
});

queryActivatedOsAccountIds^(deprecated)

queryActivatedOsAccountIds(callback: AsyncCallback<Array<number>>): void

Queries information about all activated system accounts. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. Use getActivatedOsAccountLocalIds instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.queryActivatedOsAccountIds((err: BusinessError, idArray: number[])=>{
  console.log('queryActivatedOsAccountIds err:' + JSON.stringify(err));
  console.log('queryActivatedOsAccountIds idArray length:' + idArray.length);
  for(let i=0;i<idArray.length;i++) {
    console.info('activated os account id: ' + idArray[i]);
  }
});

queryActivatedOsAccountIds^(deprecated)

queryActivatedOsAccountIds(): Promise<Array<number>>

NOTE

This API is supported since API version 8 and deprecated since API version 9. Use getActivatedOsAccountLocalIds instead.

Obtains information about all activated system accounts. This API uses a promise to return the result.

System capability: SystemCapability.Account.OsAccount

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.queryActivatedOsAccountIds().then((idArray: number[]) => {
  console.log('queryActivatedOsAccountIds, idArray: ' + idArray);
}).catch((err: BusinessError) => {
  console.log('queryActivatedOsAccountIds err: ' + JSON.stringify(err));
});

queryCurrentOsAccount^(deprecated)

queryCurrentOsAccount(callback: AsyncCallback<OsAccountInfo>): void

Queries information about the system account to which the current process belongs. 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 getCurrentOsAccount instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.queryCurrentOsAccount((err: BusinessError, curAccountInfo: account_osAccount.OsAccountInfo)=>{
  console.log('queryCurrentOsAccount err:' + JSON.stringify(err));
  console.log('queryCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
});

queryCurrentOsAccount^(deprecated)

queryCurrentOsAccount(): Promise<OsAccountInfo>

Queries information about the system account to which the current process belongs. 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 getCurrentOsAccount instead.

Required permissions: ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.queryCurrentOsAccount().then((accountInfo: account_osAccount.OsAccountInfo) => {
  console.log('queryCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
}).catch((err: BusinessError) => {
  console.log('queryCurrentOsAccount err: ' + JSON.stringify(err));
});

getOsAccountTypeFromProcess^(deprecated)

getOsAccountTypeFromProcess(callback: AsyncCallback<OsAccountType>): void

Obtains the type of the account to which the current process belongs. 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 getOsAccountType instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountTypeFromProcess((err: BusinessError, accountType: account_osAccount.OsAccountType) => {
  console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err));
  console.log('getOsAccountTypeFromProcess accountType: ' + accountType);
});

getOsAccountTypeFromProcess^(deprecated)

getOsAccountTypeFromProcess(): Promise<OsAccountType>

Obtains the type of the account to which the current process belongs. 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 getOsAccountType instead.

System capability: SystemCapability.Account.OsAccount

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountTypeFromProcess().then((accountType: account_osAccount.OsAccountType) => {
  console.log('getOsAccountTypeFromProcess, accountType: ' + accountType);
}).catch((err: BusinessError) => {
  console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err));
});

getDistributedVirtualDeviceId^(deprecated)

getDistributedVirtualDeviceId(callback: AsyncCallback<string>): void

Obtains the ID of this distributed virtual device. 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 queryDistributedVirtualDeviceId instead.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Parameters

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getDistributedVirtualDeviceId((err: BusinessError, virtualID: string) => {
  console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err));
  console.log('getDistributedVirtualDeviceId virtualID: ' + virtualID);
});

getDistributedVirtualDeviceId^(deprecated)

getDistributedVirtualDeviceId(): Promise<string>

Obtains the ID of this distributed virtual device. 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 queryDistributedVirtualDeviceId instead.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS

System capability: SystemCapability.Account.OsAccount

Return value

Example

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
accountManager.getDistributedVirtualDeviceId().then((virtualID: string) => {
  console.log('getDistributedVirtualDeviceId, virtualID: ' + virtualID);
}).catch((err: BusinessError) => {
  console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err));
});

getOsAccountLocalIdBySerialNumber^(deprecated)

getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback<number>): void

Obtains the system account ID based on the SN. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. Use getOsAccountLocalIdForSerialNumber instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Obtain the ID of the system account whose SN is 12345.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let serialNumber: number = 12345;
accountManager.getOsAccountLocalIdBySerialNumber(serialNumber, (err: BusinessError, localId: number)=>{
  console.log('ger localId err:' + JSON.stringify(err));
  console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
});

getOsAccountLocalIdBySerialNumber^(deprecated)

getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise<number>

Obtains the system account ID based on the SN. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. Use getOsAccountLocalIdForSerialNumber instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Obtain the ID of the system account whose SN is 12345.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let serialNumber: number = 12345;
accountManager.getOsAccountLocalIdBySerialNumber(serialNumber).then((localId: number) => {
  console.log('getOsAccountLocalIdBySerialNumber localId: ' + localId);
}).catch((err: BusinessError) => {
  console.log('getOsAccountLocalIdBySerialNumber err: ' + JSON.stringify(err));
});

getSerialNumberByOsAccountLocalId^(deprecated)

getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback<number>): void

Obtains the SN of a system account based on the account ID. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. Use getSerialNumberForOsAccountLocalId instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Example: Obtain the SN of the system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
accountManager.getSerialNumberByOsAccountLocalId(localId, (err: BusinessError, serialNumber: number)=>{
  console.log('ger serialNumber err:' + JSON.stringify(err));
  console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
});

getSerialNumberByOsAccountLocalId^(deprecated)

getSerialNumberByOsAccountLocalId(localId: number): Promise<number>

Obtains the SN of a system account based on the account ID. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. Use getSerialNumberForOsAccountLocalId instead.

System capability: SystemCapability.Account.OsAccount

Parameters

Return value

Example: Obtain the SN of the system account 100.

import { BusinessError } from '@ohos.base';
let accountManager: account_osAccount.AccountManager = account_osAccount.getAccountManager();
let localId: number = 100;
accountManager.getSerialNumberByOsAccountLocalId(localId).then((serialNumber: number) => {
  console.log('getSerialNumberByOsAccountLocalId serialNumber: ' + serialNumber);
}).catch((err: BusinessError) => {
  console.log('getSerialNumberByOsAccountLocalId err: ' + JSON.stringify(err));
});

UserAuth⁸⁺

Provides APIs for user authentication.

System API: This is a system API.

constructor⁸⁺

constructor()

A constructor used to create an instance for user authentication.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Example

let userAuth = new account_osAccount.UserAuth();

getVersion⁸⁺

getVersion(): number;

Obtains version information.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Return value

Example

let userAuth = new account_osAccount.UserAuth();
let version: number = userAuth.getVersion();
console.log('getVersion version = ' + version);

getAvailableStatus⁸⁺

getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;

Obtains the available status of the authentication capability corresponding to the specified authentication type and trust level.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Return value

Error codes

let userAuth = new account_osAccount.UserAuth();
let authType: account_osAccount.AuthType = account_osAccount.AuthType.PIN;
let authTrustLevel: account_osAccount.AuthTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
try {
  let status: number = userAuth.getAvailableStatus(authType, authTrustLevel);
  console.log('getAvailableStatus status = ' + status);
} catch (e) {
  console.log('getAvailableStatus exception = ' + JSON.stringify(e));
}

getProperty⁸⁺

getProperty(request: GetPropertyRequest, callback: AsyncCallback<ExecutorProperty>): void;

Obtains the executor property based on the request. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Error codes

Example

import { BusinessError } from '@ohos.base';
let userAuth = new account_osAccount.UserAuth();
let keys: Array<account_osAccount.GetPropertyType>  = [
  account_osAccount.GetPropertyType.AUTH_SUB_TYPE,
  account_osAccount.GetPropertyType.REMAIN_TIMES,
  account_osAccount.GetPropertyType.FREEZING_TIME
];
let request: account_osAccount.GetPropertyRequest = {
  authType: account_osAccount.AuthType.PIN,
  keys: keys
};
try {
  userAuth.getProperty(request, (err: BusinessError, result: account_osAccount.ExecutorProperty) => {
    console.log('getProperty err = ' + JSON.stringify(err));
    console.log('getProperty result = ' + JSON.stringify(result));
  });
} catch (e) {
  console.log('getProperty exception = ' + JSON.stringify(e));
}

getProperty⁸⁺

getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>;

Obtains the executor property based on the request. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Return value

Error codes

Example

import { BusinessError } from '@ohos.base';
let userAuth = new account_osAccount.UserAuth();
let keys: Array<account_osAccount.GetPropertyType> = [
  account_osAccount.GetPropertyType.AUTH_SUB_TYPE, 
  account_osAccount.GetPropertyType.REMAIN_TIMES,
  account_osAccount.GetPropertyType.FREEZING_TIME
];
let request: account_osAccount.GetPropertyRequest = {
  authType: account_osAccount.AuthType.PIN,
  keys: keys
};
try {
  userAuth.getProperty(request).then((result: account_osAccount.ExecutorProperty) => {
    console.log('getProperty result = ' + JSON.stringify(result));
  }).catch((err: BusinessError) => {
    console.log('getProperty error = ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('getProperty exception = ' + JSON.stringify(e));
}

setProperty⁸⁺

setProperty(request: SetPropertyRequest, callback: AsyncCallback<void>): void;

Sets the property for the initialization algorithm. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Account.OsAccount

Required permissions: ohos.permission.ACCESS_USER_AUTH_INTERNAL

Parameters

Error codes