@ohos.account.osAccount (系统帐号管理)

本模块提供管理系统帐号的基础能力，包括系统帐号的添加、删除、查询、设置、订阅、启动等功能。

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

导入模块

import account_osAccount from '@ohos.account.osAccount';

account_osAccount.getAccountManager

getAccountManager(): AccountManager

获取系统帐号管理对象。

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();

OsAccountType

表示系统帐号类型的枚举。

系统能力： SystemCapability.Account.OsAccount。

AccountManager

系统帐号管理类。

activateOsAccount

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

激活指定系统帐号。使用callback异步回调。

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

需要权限： ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 激活ID为100的系统帐号

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.activateOsAccount(localId, (err)=>{
    if (err) {
      console.log("activateOsAccount failed, error:" + JSON.stringify(err));
    } else {
      console.log("activateOsAccount successfully");
    }
  });
} catch (err) {
  console.log("activateOsAccount exception:" + JSON.stringify(err));
}

activateOsAccount

activateOsAccount(localId: number): Promise<void>

激活指定系统帐号。使用Promise异步回调。

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

需要权限： ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 激活ID为100的系统帐号

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.activateOsAccount(localId).then(() => {
    console.log('activateOsAccount successfully');
  }).catch((err) => {
    console.log('activateOsAccount failed, err:' + JSON.stringify(err));
  });
} catch (e) {
  console.log('activateOsAccount exception:' + JSON.stringify(e));
}

checkMultiOsAccountEnabled⁹⁺

checkMultiOsAccountEnabled(callback: AsyncCallback<boolean>): void

判断是否支持多系统帐号。使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkMultiOsAccountEnabled((err, isEnabled) => {
    if (err) {
      console.log("checkMultiOsAccountEnabled failed, error: " + JSON.stringify(err));
    } else {
    console.log("checkMultiOsAccountEnabled successfully, isEnabled: " + isEnabled);
    }
  });
} catch (err) {
  console.log("checkMultiOsAccountEnabled exception: " + JSON.stringify(err));
}

checkMultiOsAccountEnabled⁹⁺

checkMultiOsAccountEnabled(): Promise<boolean>

判断是否支持多系统帐号。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

try {
  let accountManager = account_osAccount.getAccountManager();
  accountManager.checkMultiOsAccountEnabled().then((isEnabled) => {
    console.log('checkMultiOsAccountEnabled successfully, isEnabled: ' + isEnabled);
  }).catch((err) => {
    console.log('checkMultiOsAccountEnabled failed, error: '  + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkMultiOsAccountEnabled exception: ' + JSON.stringify(err));
}

checkOsAccountActivated⁹⁺

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

判断指定系统帐号是否处于激活状态。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 判断ID为100的系统帐号是否处于激活状态

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.checkOsAccountActivated(localId, (err, isActivated) => {
    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>

判断指定系统帐号是否处于激活状态。使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 判断ID为100的系统帐号是否处于激活状态

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.checkOsAccountActivated(localId).then((isActivated) => {
    console.log('checkOsAccountActivated successfully, isActivated: ' + isActivated);
  }).catch((err) => {
    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

判断指定系统帐号是否具有指定约束。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
try {
  accountManager.checkOsAccountConstraintEnabled(localId, constraint, (err, isEnabled)=>{
    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>

判断指定系统帐号是否具有指定约束。使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
try {
  accountManager.checkOsAccountConstraintEnabled(localId, constraint).then((isEnabled) => {
    console.log("checkOsAccountConstraintEnabled successfully, isEnabled: " + isEnabled);
  }).catch((err) => {
    console.log("checkOsAccountConstraintEnabled failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("checkOsAccountConstraintEnabled exception: " + JSON.stringify(err));
}

checkOsAccountTestable⁹⁺

checkOsAccountTestable(callback: AsyncCallback<boolean>): void

检查当前系统帐号是否为测试帐号。使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountTestable((err, isTestable) => {
    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>

检查当前系统帐号是否为测试帐号。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountTestable().then((isTestable) => {
    console.log("checkOsAccountTestable successfully, isTestable: " + isTestable);
  }).catch((err) => {
    console.log("checkOsAccountTestable failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log('checkOsAccountTestable exception: ' + JSON.stringify(err));
}

checkOsAccountVerified⁹⁺

checkOsAccountVerified(callback: AsyncCallback<boolean>): void

检查当前系统帐号是否已验证。使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.checkOsAccountVerified((err, isVerified) => {
    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(localId: number, callback: AsyncCallback<boolean>): void

检查指定系统帐号是否已验证。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.checkOsAccountVerified(localId, (err, isVerified) => {
    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>

检查指定系统帐号是否已验证。使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.checkOsAccountVerified(localId).then((isVerified) => {
    console.log("checkOsAccountVerified successfully, isVerified: " + isVerified);
  }).catch((err) => {
    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

删除指定系统帐号。使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
let accountName = "testAccountName";
try {
  accountManager.createOsAccount(accountName, account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo) => {
    accountManager.removeOsAccount(osAccountInfo.localId, (err)=>{
      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>

删除指定系统帐号。使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
let accountName = "testAccountName";
try {
  accountManager.createOsAccount(accountName, account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{
    accountManager.removeOsAccount(osAccountInfo.localId).then(() => {
      console.log("removeOsAccount successfully");
    }).catch((err) => {
        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

为指定系统帐号设置/删除约束。使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 给ID为100的系统帐号设置禁止使用Wi-Fi的约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
try {
  accountManager.setOsAccountConstraints(localId, [constraint], true, (err) => {
    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>

为指定系统帐号设置/删除约束。使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 删除ID为100的系统帐号的禁止使用Wi-Fi的约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.setOsAccountConstraints(localId, ['constraint.location.set'], false).then(() => {
    console.log('setOsAccountConstraints succsuccessfully');
  }).catch((err) => {
    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

设置指定系统帐号的帐号名。使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 将ID为100的系统帐号的帐号名设置成demoName

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let name = "demoName";
try {
  accountManager.setOsAccountName(localId, name, (err) => {
    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>

设置指定系统帐号的帐号名。使用Promise异步调用。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 将ID为100的系统帐号的帐号名设置成demoName

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let name = 'testName';
try {
  accountManager.setOsAccountName(localId, name).then(() => {
    console.log('setOsAccountName successfully');
  }).catch((err) => {
    console.log('setOsAccountName failed, error: '  + JSON.stringify(err));
  });
} catch (err) {
  console.log('setOsAccountName exception:' + JSON.stringify(err));
}

getOsAccountCount⁹⁺

getOsAccountCount(callback: AsyncCallback<number>): void

获取已创建的系统帐号数量。使用callback异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountCount((err, count) => {
    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>

获取已创建的系统帐号数量。使用Promise异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountCount().then((count) => {
    console.log("getOsAccountCount successfully, count: " + count);
  }).catch((err) => {
    console.log("getOsAccountCount failed, error: " + JSON.stringify(err));
  });
} catch(err) {
  console.log('getOsAccountCount exception:' + JSON.stringify(err));
}

getOsAccountLocalId⁹⁺

getOsAccountLocalId(callback: AsyncCallback<number>): void

获取当前进程所属的系统帐号ID，使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalId((err, localId) => {
    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>

获取当前进程所属的系统帐号ID，使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalId().then((localId) => {
    console.log("getOsAccountLocalId successfully, localId: " + localId);
  }).catch((err) => {
    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

根据uid查询对应的系统帐号ID，使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 查询值为12345678的uid所属的系统帐号的帐号ID

let accountManager = account_osAccount.getAccountManager();
let uid = 12345678;
try {
  accountManager.getOsAccountLocalIdForUid(uid, (err, localId) => {
    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>

根据uid查询对应的系统帐号ID，使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 查询值为12345678的uid所属的系统帐号ID

let accountManager = account_osAccount.getAccountManager();
let uid = 12345678;
try {
  accountManager.getOsAccountLocalIdForUid(uid).then((localId) => {
    console.log("getOsAccountLocalIdForUid successfully, localId: " + localId);
  }).catch((err) => {
    console.log("getOsAccountLocalIdForUid failed, error: " + JSON.stringify(err));
  });
} catch (err) {
  console.log('getOsAccountLocalIdForUid exception: ' + JSON.stringify(err));
}

getOsAccountLocalIdForDomain⁹⁺

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

根据域帐号信息，获取与其关联的系统帐号ID。使用callback异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountLocalIdForDomain(domainInfo, (err, localId) => {
    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>

根据域帐号信息，获取与其关联的系统帐号的帐号ID。使用Promise异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
try {
  accountManager.getOsAccountLocalIdForDomain(domainInfo).then((localId) => {
    console.log("getOsAccountLocalIdForDomain successfully, localId: " + localId);
  }).catch((err) => {
    console.log("getOsAccountLocalIdForDomain failed, error: "  + JSON.stringify(err));
  });
} catch (err) {
  console.log("getOsAccountLocalIdForDomain exception: " + JSON.stringify(err));
}

queryMaxOsAccountNumber

queryMaxOsAccountNumber(callback: AsyncCallback<number>): void

查询允许创建的系统帐号的最大数量。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryMaxOsAccountNumber((err, maxCnt) => {
    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>

查询允许创建的系统帐号的最大数量。使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryMaxOsAccountNumber().then((maxCnt) => {
    console.log('queryMaxOsAccountNumber successfully, maxCnt: ' + maxCnt);
  }).catch((err) => {
    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

获取指定系统帐号的全部约束。使用callback异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 获取ID为100的系统帐号的全部约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getOsAccountConstraints(localId, (err, constraints) => {
    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>>

获取指定系统帐号的全部约束。使用Promise异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 获取ID为100的系统帐号的全部约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getOsAccountConstraints(localId).then((constraints) => {
    console.log('getOsAccountConstraints, constraints: ' + constraints);
  }).catch((err) => {
    console.log('getOsAccountConstraints err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountConstraints exception:' + JSON.stringify(e));
}

queryAllCreatedOsAccounts

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

查询已创建的所有系统帐号的信息列表。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryAllCreatedOsAccounts((err, accountArr)=>{
    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>>

查询已创建的所有系统帐号的信息列表。使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryAllCreatedOsAccounts().then((accountArr) => {
    console.log('queryAllCreatedOsAccounts, accountArr: ' + JSON.stringify(accountArr));
  }).catch((err) => {
    console.log('queryAllCreatedOsAccounts err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryAllCreatedOsAccounts exception:' + JSON.stringify(e));
}

getActivatedOsAccountLocalIds⁹⁺

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

查询当前处于激活状态的系统帐号的ID列表。使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getActivatedOsAccountLocalIds((err, idArray)=>{
    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>>

查询当前处于激活状态的系统帐号的ID列表。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getActivatedOsAccountLocalIds().then((idArray) => {
    console.log('getActivatedOsAccountLocalIds, idArray: ' + idArray);
  }).catch((err) => {
    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

创建一个系统帐号。使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.createOsAccount('testName', account_osAccount.OsAccountType.NORMAL, (err, 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>

创建一个系统帐号。使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL).then((accountInfo) => {
    console.log('createOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
  }).catch((err) => {
    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

根据域帐号信息，创建一个系统帐号并将其与域帐号关联。使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
try {
  accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo, (err, 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>

根据传入的域帐号信息，创建与其关联的系统帐号。使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例：

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

getCurrentOsAccount⁹⁺

getCurrentOsAccount(callback: AsyncCallback<OsAccountInfo>): void

查询当前进程所属的系统帐号的信息。使用callback异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getCurrentOsAccount((err, curAccountInfo)=>{
    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>

查询当前进程所属的系统帐号的信息。使用Promise异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getCurrentOsAccount().then((accountInfo) => {
    console.log('getCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
  }).catch((err) => {
    console.log('getCurrentOsAccount err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getCurrentOsAccount exception:' + JSON.stringify(e));
}

queryOsAccountById

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

查询指定系统帐号的信息。使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 查询ID为100的系统帐号信息

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.queryOsAccountById(localId, (err, accountInfo)=>{
    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>

查询指定系统帐号的信息。使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS 或 ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 查询ID为100的系统帐号信息

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.queryOsAccountById(localId).then((accountInfo) => {
    console.log('queryOsAccountById, accountInfo: ' + JSON.stringify(accountInfo));
  }).catch((err) => {
    console.log('queryOsAccountById err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryOsAccountById exception:' + JSON.stringify(e));
}

getOsAccountType⁹⁺

getOsAccountType(callback: AsyncCallback<OsAccountType>): void

查询当前进程所属的系统帐号的帐号类型。使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountType((err, accountType) => {
    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>

查询当前进程所属的系统帐号的帐号类型。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountType().then((accountType) => {
    console.log('getOsAccountType, accountType: ' + accountType);
  }).catch((err) => {
    console.log('getOsAccountType err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountType exception: ' + JSON.stringify(e));
}

queryDistributedVirtualDeviceId⁹⁺

queryDistributedVirtualDeviceId(callback: AsyncCallback<string>): void

获取分布式虚拟设备ID。使用callback异步回调。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryDistributedVirtualDeviceId((err, virtualID) => {
    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>

获取分布式虚拟设备ID。使用Promise异步回调。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC or ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.queryDistributedVirtualDeviceId().then((virtualID) => {
    console.log('queryDistributedVirtualDeviceId, virtualID: ' + virtualID);
  }).catch((err) => {
    console.log('queryDistributedVirtualDeviceId err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('queryDistributedVirtualDeviceId exception: ' + JSON.stringify(e));
}

getOsAccountProfilePhoto

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

获取指定系统帐号的头像信息。使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 获取ID为100的系统帐号的头像

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getOsAccountProfilePhoto(localId, (err, photo)=>{
    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>

获取指定系统帐号的头像信息。使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 获取ID为100的系统帐号的头像

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getOsAccountProfilePhoto(localId).then((photo) => {
    console.log('getOsAccountProfilePhoto: ' + photo);
  }).catch((err) => {
    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

为指定系统帐号设置头像信息。使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 给ID为100的系统帐号设置头像

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

setOsAccountProfilePhoto

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

为指定系统帐号设置头像信息。使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 给ID为100的系统帐号设置头像

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let photo = '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) => {
    console.log('setOsAccountProfilePhoto err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('setOsAccountProfilePhoto exception:' + JSON.stringify(e));
}

getOsAccountLocalIdForSerialNumber⁹⁺

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

通过SN码查询与其关联的系统帐号的帐号ID。使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 查询与SN码12345关联的系统帐号的ID

let accountManager = account_osAccount.getAccountManager();
let serialNumber = 12345;
try {
  accountManager.getOsAccountLocalIdForSerialNumber(serialNumber, (err, localId)=>{
    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>

通过SN码查询与其关联的系统帐号的帐号ID。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 查询与SN码12345关联的系统帐号的ID

let accountManager = account_osAccount.getAccountManager();
let serialNumber = 12345;
try {
  accountManager.getOsAccountLocalIdForSerialNumber(serialNumber).then((localId) => {
    console.log('getOsAccountLocalIdForSerialNumber localId: ' + localId);
  }).catch((err) => {
    console.log('getOsAccountLocalIdForSerialNumber err: '  + JSON.stringify(err));
  });
} catch (e) {
  console.log('getOsAccountLocalIdForSerialNumber exception: '  + JSON.stringify(e));
}

getSerialNumberForOsAccountLocalId⁹⁺

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

通过系统帐号ID获取与该系统帐号关联的SN码。使用callback异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例： 获取ID为100的系统帐号关联的SN码

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getSerialNumberForOsAccountLocalId(localId, (err, serialNumber)=>{
    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>

通过系统帐号ID获取与该系统帐号关联的SN码。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例： 获取ID为100的系统帐号关联的SN码

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
try {
  accountManager.getSerialNumberForOsAccountLocalId(localId).then((serialNumber) => {
    console.log('getSerialNumberForOsAccountLocalId serialNumber: ' + serialNumber);
  }).catch((err) => {
    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

订阅系统帐号的激活完成与激活中的事件。使用callback异步回调。

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

需要权限： ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
function onCallback(receiveLocalId){
  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

取消订阅系统帐号的激活完成与激活中的事件。使用callback异步回调。

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

需要权限： ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let 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;

通过uid查询对应的bundleId，使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
let testUid = 1000000;
try {
  accountManager.getBundleIdForUid(testUid, (err, bundleId) => {
    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>;

通过uid查询对应的bundleId，使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
let testUid = 1000000;
try {
  accountManager.getBundleIdForUid(testUid).then((result) => {
    console.info('getBundleIdForUid bundleId:' + JSON.stringify(result));
  }).catch((err)=>{
    console.info('getBundleIdForUid errInfo:' + JSON.stringify(err));
  });
} catch (e) {
  console.info('getBundleIdForUid exception:' + JSON.stringify(e));
}

isMainOsAccount⁹⁺

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

查询当前进程是否处于主用户，使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.isMainOsAccount((err,result)=>{
    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>;

查询当前进程是否处于主用户，使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.isMainOsAccount().then((result) => {
    console.info('isMainOsAccount result:' + JSON.stringify(result));
  }).catch((err)=>{
    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;

查询指定系统帐号的指定约束来源信息，使用callback异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountConstraintSourceTypes(100, 'constraint.wifi',(err,sourceTypeInfos)=>{
    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>>;

查询指定系统帐号的指定约束来源信息，使用Promise异步回调。

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

错误码：

示例：

let accountManager = account_osAccount.getAccountManager();
try {
  accountManager.getOsAccountConstraintSourceTypes(100, 'constraint.wifi').then((result) => {
    console.info('getOsAccountConstraintSourceTypes sourceTypeInfos:' + JSON.stringify(result));
  }).catch((err)=>{
    console.info('getOsAccountConstraintSourceTypes errInfo:' + JSON.stringify(err));
  });
} catch (e) {
  console.info('getOsAccountConstraintSourceTypes exception:' + JSON.stringify(e));
}

isMultiOsAccountEnable^(deprecated)

isMultiOsAccountEnable(callback: AsyncCallback<boolean>): void

判断是否支持多系统帐号。使用callback异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.isMultiOsAccountEnable((err, isEnabled) => {
  if (err) {
    console.log("isMultiOsAccountEnable failed, error: " + JSON.stringify(err));
  } else {
  console.log("isMultiOsAccountEnable successfully, isEnabled: " + isEnabled);
  }
});

isMultiOsAccountEnable^(deprecated)

isMultiOsAccountEnable(): Promise<boolean>

判断是否支持多系统帐号。使用Promise异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.isMultiOsAccountEnable().then((isEnabled) => {
  console.log('isMultiOsAccountEnable successfully, isEnabled: ' + isEnabled);
}).catch((err) => {
  console.log('isMultiOsAccountEnable failed, error: '  + JSON.stringify(err));
});

isOsAccountActived^(deprecated)

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

判断指定系统帐号是否处于激活状态。使用callback异步回调。

说明：

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

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例： 判断ID为100的系统帐号是否处于激活状态

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.isOsAccountActived(localId, (err, isActived) => {
  if (err) {
    console.log('isOsAccountActived failed, err:' + JSON.stringify(err));
  } else {
    console.log('isOsAccountActived successfully, isActived:' + isActived);
  }
});

isOsAccountActived^(deprecated)

isOsAccountActived(localId: number): Promise<boolean>

判断指定系统帐号是否处于激活状态。使用Promise异步回调。

说明：

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

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

示例： 判断ID为100的系统帐号是否处于激活状态

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.isOsAccountActived(localId).then((isActived) => {
  console.log('isOsAccountActived successfully, isActived: ' + isActived);
}).catch((err) => {
  console.log('isOsAccountActived failed, error: '  + JSON.stringify(err));
});

isOsAccountConstraintEnable^(deprecated)

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

判断指定系统帐号是否具有指定约束。使用callback异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

示例： 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
accountManager.isOsAccountConstraintEnable(localId, constraint, (err, isEnabled) => {
  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>

判断指定系统帐号是否具有指定约束。使用Promise异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

示例： 判断ID为100的系统帐号是否有禁止使用Wi-Fi的约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
let constraint = "constraint.wifi";
accountManager.isOsAccountConstraintEnable(localId, constraint).then((isEnabled) => {
  console.log("isOsAccountConstraintEnable successfully, isEnabled: " + isEnabled);
}).catch((err) => {
  console.log("isOsAccountConstraintEnable err: "  + JSON.stringify(err));
});

isTestOsAccount^(deprecated)

isTestOsAccount(callback: AsyncCallback<boolean>): void

检查当前系统帐号是否为测试帐号。使用callback异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.isTestOsAccount((err, isTestable) => {
  if (err) {
    console.log("isTestOsAccount failed, error: " + JSON.stringify(err));
  } else {
    console.log("isTestOsAccount successfully, isTestable: " + isTestable);
  }
});

isTestOsAccount^(deprecated)

isTestOsAccount(): Promise<boolean>

检查当前系统帐号是否为测试帐号。使用Promise异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.isTestOsAccount().then((isTestable) => {
    console.log("isTestOsAccount successfully, isTestable: " + isTestable);
}).catch((err) => {
    console.log("isTestOsAccount failed, error: " + JSON.stringify(err));
});

isOsAccountVerified^(deprecated)

isOsAccountVerified(callback: AsyncCallback<boolean>): void

检查当前系统帐号是否已验证。使用callback异步回调。

说明：

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

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.isOsAccountVerified((err, isVerified) => {
  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

检查指定系统帐号是否已验证。使用callback异步回调。

说明：

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

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.isOsAccountVerified(localId, (err, isVerified) => {
  if (err) {
    console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
  } else {
    console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
  }
});

isOsAccountVerified^(deprecated)

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

检查指定系统帐号是否已验证。使用Promise异步回调。

说明：

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

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.isOsAccountVerified(localId).then((isVerified) => {
  console.log("isOsAccountVerified successfully, isVerified: " + isVerified);
}).catch((err) => {
  console.log("isOsAccountVerified failed, error: " + JSON.stringify(err));
});

getCreatedOsAccountsCount^(deprecated)

getCreatedOsAccountsCount(callback: AsyncCallback<number>): void

获取已创建的系统帐号数量。使用callback异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.getCreatedOsAccountsCount((err, count)=>{
  if (err) {
    console.log("getCreatedOsAccountsCount failed, error: " + JSON.stringify(err));
  } else {
    console.log("getCreatedOsAccountsCount successfully, count: " + count);
  }
});

getCreatedOsAccountsCount^(deprecated)

getCreatedOsAccountsCount(): Promise<number>

获取已创建的系统帐号数量，使用Promise异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.getCreatedOsAccountsCount().then((count) => {
  console.log("getCreatedOsAccountsCount successfully, count: " + count);
}).catch((err) => {
  console.log("getCreatedOsAccountsCount failed, error: "  + JSON.stringify(err));
});

getOsAccountLocalIdFromProcess^(deprecated)

getOsAccountLocalIdFromProcess(callback: AsyncCallback<number>): void

获取当前进程所属的系统帐号ID，使用callback异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromProcess((err, localId) => {
  if (err) {
    console.log("getOsAccountLocalIdFromProcess failed, error: " + JSON.stringify(err));
  } else {
    console.log("getOsAccountLocalIdFromProcess successfully, localId: " + localId);
  }
});

getOsAccountLocalIdFromProcess^(deprecated)

getOsAccountLocalIdFromProcess(): Promise<number>

获取当前进程所属的系统帐号ID，使用Promise异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromProcess().then((localId) => {
  console.log('getOsAccountLocalIdFromProcess successfully, localId: ' + localId);
}).catch((err) => {
  console.log('getOsAccountLocalIdFromProcess failed, error: '  + JSON.stringify(err));
});

getOsAccountLocalIdFromUid^(deprecated)

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

根据uid查询对应的系统帐号ID。使用callback异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例： 查询值为12345678的uid所属的系统帐号ID

let accountManager = account_osAccount.getAccountManager();
let uid = 12345678;
accountManager.getOsAccountLocalIdFromUid(uid, (err, localId) => {
  if (err) {
    console.log("getOsAccountLocalIdFromUid failed, error: " + JSON.stringify(err));
  } else {
    console.log("getOsAccountLocalIdFromUid successfully, localId: " + localId);
  }
});

getOsAccountLocalIdFromUid^(deprecated)

getOsAccountLocalIdFromUid(uid: number): Promise<number>

根据uid查询对应的系统帐号ID，使用Promise异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

示例： 查询值为12345678的uid所属的系统帐号ID

let accountManager = account_osAccount.getAccountManager();
let uid = 12345678;
accountManager.getOsAccountLocalIdFromUid(uid).then((localId) => {
  console.log("getOsAccountLocalIdFromUid successfully, localId: " + localId);
}).catch((err) => {
  console.log("getOsAccountLocalIdFromUid failed, error: "  + JSON.stringify(err));
});

getOsAccountLocalIdFromDomain^(deprecated)

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

根据域帐号信息，获取与其关联的系统帐号的帐号ID。使用callback异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountLocalIdFromDomain(domainInfo, (err, localId) => {
  if (err) {
    console.log("getOsAccountLocalIdFromDomain failed, error: " + JSON.stringify(err));
  } else {
    console.log("getOsAccountLocalIdFromDomain successfully, localId: " + localId);
  }
});

getOsAccountLocalIdFromDomain^(deprecated)

getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise<number>

根据域帐号信息，获取与其关联的系统帐号的帐号ID。使用Promise异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'};
accountManager.getOsAccountLocalIdFromDomain(domainInfo).then((localId) => {
  console.log('getOsAccountLocalIdFromDomain successfully, localId: ' + localId);
}).catch((err) => {
  console.log('getOsAccountLocalIdFromDomain failed, error: '  + JSON.stringify(err));
});

getOsAccountAllConstraints^(deprecated)

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

获取指定系统帐号的全部约束。使用callback异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

示例： 获取ID为100的系统帐号的全部约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.getOsAccountAllConstraints(localId, (err, constraints)=>{
  console.log('getOsAccountAllConstraints err:' + JSON.stringify(err));
  console.log('getOsAccountAllConstraints:' + JSON.stringify(constraints));
});

getOsAccountAllConstraints^(deprecated)

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

说明：

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

获取指定系统帐号的全部约束。使用Promise异步回调。

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

示例： 获取ID为100的系统帐号的全部约束

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.getOsAccountAllConstraints(localId).then((constraints) => {
  console.log('getOsAccountAllConstraints, constraints: ' + constraints);
}).catch((err) => {
  console.log('getOsAccountAllConstraints err: '  + JSON.stringify(err));
});

queryActivatedOsAccountIds^(deprecated)

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

查询当前处于激活状态的系统帐号的ID列表。使用callback异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.queryActivatedOsAccountIds((err, idArray)=>{
  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>>

说明：

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

查询当前处于激活状态的系统帐号的ID列表。使用Promise异步回调。

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.queryActivatedOsAccountIds().then((idArray) => {
  console.log('queryActivatedOsAccountIds, idArray: ' + idArray);
}).catch((err) => {
  console.log('queryActivatedOsAccountIds err: '  + JSON.stringify(err));
});

queryCurrentOsAccount^(deprecated)

queryCurrentOsAccount(callback: AsyncCallback<OsAccountInfo>): void

查询当前进程所属的系统帐号的信息。使用callback异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.queryCurrentOsAccount((err, curAccountInfo)=>{
  console.log('queryCurrentOsAccount err:' + JSON.stringify(err));
  console.log('queryCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo));
});

queryCurrentOsAccount^(deprecated)

queryCurrentOsAccount(): Promise<OsAccountInfo>

查询当前进程所属的系统帐号的信息。使用Promise异步回调。

说明：

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

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.queryCurrentOsAccount().then((accountInfo) => {
  console.log('queryCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo));
}).catch((err) => {
  console.log('queryCurrentOsAccount err: '  + JSON.stringify(err));
});

getOsAccountTypeFromProcess^(deprecated)

getOsAccountTypeFromProcess(callback: AsyncCallback<OsAccountType>): void

查询当前进程所属的系统帐号的帐号类型。使用callback异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountTypeFromProcess((err, accountType) => {
  console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err));
  console.log('getOsAccountTypeFromProcess accountType: ' + accountType);
});

getOsAccountTypeFromProcess^(deprecated)

getOsAccountTypeFromProcess(): Promise<OsAccountType>

查询当前进程所属的系统帐号的帐号类型。使用Promise异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.getOsAccountTypeFromProcess().then((accountType) => {
  console.log('getOsAccountTypeFromProcess, accountType: ' + accountType);
}).catch((err) => {
  console.log('getOsAccountTypeFromProcess err: '  + JSON.stringify(err));
});

getDistributedVirtualDeviceId^(deprecated)

getDistributedVirtualDeviceId(callback: AsyncCallback<string>): void

获取分布式虚拟设备ID。使用callback异步回调。

说明：

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

需要权限： ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.getDistributedVirtualDeviceId((err, virtualID) => {
  console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err));
  console.log('getDistributedVirtualDeviceId virtualID: ' + virtualID);
});

getDistributedVirtualDeviceId^(deprecated)

getDistributedVirtualDeviceId(): Promise<string>

获取分布式虚拟设备ID。使用Promise异步回调。

说明：

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

需要权限： ohos.permission.DISTRIBUTED_DATASYNC 或 ohos.permission.MANAGE_LOCAL_ACCOUNTS

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

let accountManager = account_osAccount.getAccountManager();
accountManager.getDistributedVirtualDeviceId().then((virtualID) => {
  console.log('getDistributedVirtualDeviceId, virtualID: ' + virtualID);
}).catch((err) => {
  console.log('getDistributedVirtualDeviceId err: '  + JSON.stringify(err));
});

getOsAccountLocalIdBySerialNumber^(deprecated)

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

通过SN码查询与其关联的系统帐号的帐号ID。使用callback异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例： 查询与SN码12345关联的系统帐号的ID

let accountManager = account_osAccount.getAccountManager();
let serialNumber = 12345;
accountManager.getOsAccountLocalIdBySerialNumber(serialNumber, (err, localId)=>{
  console.log('ger localId err:' + JSON.stringify(err));
  console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber);
});

getOsAccountLocalIdBySerialNumber^(deprecated)

getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise<number>

通过SN码查询与其关联的系统帐号的帐号ID。使用Promise异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

示例： 查询与SN码12345关联的系统帐号的ID

let accountManager = account_osAccount.getAccountManager();
let serialNumber = 12345;
accountManager.getOsAccountLocalIdBySerialNumber(serialNumber).then((localId) => {
  console.log('getOsAccountLocalIdBySerialNumber localId: ' + localId);
}).catch((err) => {
  console.log('getOsAccountLocalIdBySerialNumber err: '  + JSON.stringify(err));
});

getSerialNumberByOsAccountLocalId^(deprecated)

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

通过系统帐号ID获取与该系统帐号关联的SN码。使用callback异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例： 获取ID为100的系统帐号关联的SN码

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.getSerialNumberByOsAccountLocalId(localId, (err, serialNumber)=>{
  console.log('ger serialNumber err:' + JSON.stringify(err));
  console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId);
});

getSerialNumberByOsAccountLocalId^(deprecated)

getSerialNumberByOsAccountLocalId(localId: number): Promise<number>

通过系统帐号ID获取与该系统帐号关联的SN码。使用Promise异步回调。

说明：

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

系统能力： SystemCapability.Account.OsAccount

参数：

返回值：

示例： 获取ID为100的系统帐号关联的SN码

let accountManager = account_osAccount.getAccountManager();
let localId = 100;
accountManager.getSerialNumberByOsAccountLocalId(localId).then((serialNumber) => {
  console.log('getSerialNumberByOsAccountLocalId serialNumber: ' + serialNumber);
}).catch((err) => {
  console.log('getSerialNumberByOsAccountLocalId err: '  + JSON.stringify(err));
});

UserAuth⁸⁺

用户认证类。

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

constructor⁸⁺

constructor()

创建用户认证的实例。

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

系统能力：SystemCapability.Account.OsAccount

示例：

let userAuth = new account_osAccount.UserAuth();

getVersion⁸⁺

getVersion(): number;

返回版本信息。

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

系统能力： SystemCapability.Account.OsAccount

返回值：

示例：

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

getAvailableStatus⁸⁺

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

获取指定认证类型和认证可信等级的认证能力的可用状态。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_USER_AUTH_INTERNAL

参数：

返回值：

错误码：

示例：

let userAuth = new account_osAccount.UserAuth();
let authType = account_osAccount.AuthType.PIN;
let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
try {
  let status = 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;

基于指定的请求信息获取属性。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_USER_AUTH_INTERNAL

参数：

错误码：

示例：

let userAuth = new account_osAccount.UserAuth();
let keys = [
  account_osAccount.GetPropertyType.AUTH_SUB_TYPE, 
  account_osAccount.GetPropertyType.REMAIN_TIMES,
  account_osAccount.GetPropertyType.FREEZING_TIME
];
let request = {
  authType: account_osAccount.AuthType.PIN,
  keys: keys
};
try {
  userAuth.getProperty(request, (err, result) => {
    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>;

基于指定的请求信息获取属性。使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_USER_AUTH_INTERNAL

参数：

返回值：

错误码：

示例：

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

setProperty⁸⁺

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

设置可用于初始化算法的属性。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_USER_AUTH_INTERNAL

参数：

错误码：

示例：

let userAuth = new account_osAccount.UserAuth();
let request = {
  authType: account_osAccount.AuthType.PIN,
  key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
  setInfo: new Uint8Array([0])
};
try {
  userAuth.setProperty(request, (err) => {
    if (err) {
      console.log('setProperty failed, error = ' + JSON.stringify(err));
    } else {
      console.log('setProperty successfully');
    }
  });
} catch (e) {
  console.log('setProperty exception = ' + JSON.stringify(e));
}

setProperty⁸⁺

setProperty(request: SetPropertyRequest): Promise<void>;

设置可用于初始化算法的属性。使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_USER_AUTH_INTERNAL

参数：

返回值：

错误码：

示例：

let userAuth = new account_osAccount.UserAuth();
let request = {
  authType: account_osAccount.AuthType.PIN,
  key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
  setInfo: new Uint8Array([0])
};
try {
  userAuth.setProperty(request).then(() => {
    console.log('setProperty successfully');
  }).catch((err) => {
    console.log('setProperty failed, error = ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('setProperty exception = ' + JSON.stringify(e));
}

auth⁸⁺

auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

认证当前用户。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_USER_AUTH_INTERNAL

参数：

返回值：

错误码：

示例：

let userAuth = new account_osAccount.UserAuth();
let challenge = new Uint8Array([0]);
let authType = account_osAccount.AuthType.PIN;
let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
try {
  userAuth.auth(challenge, authType, authTrustLevel, {
    onResult: function(result,extraInfo){
        console.log('auth result = ' + result);
        console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
    }
  });
} catch (e) {
  console.log('auth exception = ' + JSON.stringify(e));
}

authUser⁸⁺

authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;

认证指定用户。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_USER_AUTH_INTERNAL

参数：

返回值：

错误码：

示例：

let userAuth = new account_osAccount.UserAuth();
let userID = 100;
let challenge = new Uint8Array([0]);
let authType = account_osAccount.AuthType.PIN;
let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
try {
  userAuth.authUser(userID, challenge, authType, authTrustLevel, {
    onResult: function(result,extraInfo){
      console.log('authUser result = ' + result);
      console.log('authUser extraInfo = ' + JSON.stringify(extraInfo));
    }
  });
} catch (e) {
  console.log('authUser exception = ' + JSON.stringify(e));
}

cancelAuth⁸⁺

cancelAuth(contextID: Uint8Array): void;

取消指定的认证操作。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_USER_AUTH_INTERNAL

参数：

错误码：

示例：

let userAuth = new account_osAccount.UserAuth();
let pinAuth = new account_osAccount.PINAuth();
let challenge = new Uint8Array([0]);
let contextId = userAuth.auth(challenge, account_osAccount.AuthType.PIN, account_osAccount.AuthTrustLevel.ATL1, {
  onResult: (result, extraInfo) => {
    console.log('auth result = ' + result);
    console.log('auth extraInfo = ' + JSON.stringify(extraInfo));
  }
});
try {
  userAuth.cancelAuth(contextId);
} catch (e) {
  console.log('cancelAuth exception = ' + JSON.stringify(e));
}

PINAuth⁸⁺

Pin码认证功能基类。

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

constructor⁸⁺

constructor()

创建Pin码认证的实例。

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

系统能力：SystemCapability.Account.OsAccount

示例：

let pinAuth = new account_osAccount.PINAuth();

registerInputer⁸⁺

registerInputer(inputer: IInputer): void;

注册PIN码输入器。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_PIN_AUTH

参数：

返回值：

错误码：

示例：

let pinAuth = new account_osAccount.PINAuth();
let password = new Uint8Array([0, 0, 0, 0, 0]);
try {
  let result = pinAuth.registerInputer({
      onGetData: (pinSubType, callback) => {
        callback.onSetData(pinSubType, password);
      }
  });
  console.log('registerInputer result = ' + result);
} catch (e) {
  console.log('registerInputer exception = ' + JSON.stringify(e));
}

unregisterInputer⁸⁺

unregisterInputer(): void;

解注册PIN码输入器。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.ACCESS_PIN_AUTH

示例：

let pinAuth = new account_osAccount.PINAuth();
pinAuth.unregisterInputer();

DomainPlugin⁹⁺

域插件，提供域帐号认证功能。

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

auth⁹⁺

auth(domainAccountInfo: DomainAccountInfo, credential: Uint8Array, callback: IUserAuthCallback): void

认证指定的域帐号。

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

系统能力： SystemCapability.Account.OsAccount

参数：

示例：

let plugin = {
  auth: (domainAccountInfo, credential, callback) => {
    // mock authentication
    // notify authentication result
    callback.onResult(0, {
      token: new Uint8Array([0]),
      remainTimes: 5,
      freezingTime: 0
    });
  }
}
account_osAccount.DomainAccountManager.registerPlugin(plugin);
let userAuth = new account_osAccount.UserAuth();
let challenge = new Uint8Array([0]);
let authType = account_osAccount.AuthType.DOMAIN;
let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1;
try {
  userAuth.auth(challenge, authType, authTrustLevel, {
    onResult: (resultCode, authResult) => {
        console.log('auth resultCode = ' + resultCode);
        console.log('auth authResult = ' + JSON.stringify(authResult));
    }
  });
} catch (err) {
  console.log('auth exception = ' + JSON.stringify(err));
}

DomainAccountManager ⁹⁺

域帐号管理器类。

registerPlugin⁹⁺

static registerPlugin(plugin: DomainPlugin): void

注册域插件。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

参数：

错误码：

示例：

let plugin = {
  auth: (domainAccountInfo, credential, callback) => {}
}
try {
  account_osAccount.DomainAccountManager.registerPlugin(plugin);
  console.log('registerPlugin success.');
} catch(err) {
  console.log("registerPlugin err:" + JSON.stringify(err));
}

unregisterPlugin⁹⁺

static unregisterPlugin(): void

注销域插件。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_LOCAL_ACCOUNTS

示例：

try {
  account_osAccount.DomainAccountManager.unregisterPlugin();
  console.log('unregisterPlugin success.');
} catch(err) {
  console.log("unregisterPlugin err:" + JSON.stringify(err));
}

UserIdentityManager⁸⁺

获取用户身份管理类。

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

constructor⁸⁺

constructor()

用户身份管理类的默认构造函数。

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

系统能力：SystemCapability.Account.OsAccount

示例：

let userIDM = new account_osAccount.UserIdentityManager();

openSession⁸⁺

openSession(callback: AsyncCallback<Uint8Array>): void;

打开会话，获取挑战值。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_USER_IDM

参数：

错误码：

示例：

let userIDM = new account_osAccount.UserIdentityManager();
try {
  userIDM.openSession((err, challenge) => {
      console.log('openSession error = ' + JSON.stringify(err));
      console.log('openSession challenge = ' + JSON.stringify(challenge));
  });
} catch (e) {
  console.log('openSession exception = ' + JSON.stringify(e));
}

openSession⁸⁺

openSession(): Promise<Uint8Array>;

打开会话，获取挑战值。使用Promise异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_USER_IDM

返回值：

错误码：

示例：

let userIDM = new account_osAccount.UserIdentityManager();
try {
  userIDM.openSession().then((challenge) => {
      console.info('openSession challenge = ' + JSON.stringify(challenge));
  }).catch((err) => {
      console.info('openSession error = ' + JSON.stringify(err));
  });
} catch (e) {
  console.log('openSession exception = ' + JSON.stringify(e));
}

addCredential⁸⁺

addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

添加凭据，添加用户凭据信息，传入凭据添加方法和凭据信息（凭据类型，子类，如果添加用户的非密码凭据，则传入密码身份验证令牌），并获取结果/获取信息。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_USER_IDM

参数：

错误码：

示例：

let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
let pinAuth = new account_osAccount.PINAuth();
pinAuth.registerInputer({
  onGetData: (pinSubType, callback) => {
    callback.onSetData(pinSubType, password);
  }
});
let credentialInfo = {
  credType: account_osAccount.AuthType.PIN,
  credSubType: account_osAccount.AuthSubType.PIN_SIX,
  token: null
};
let userIDM = new account_osAccount.UserIdentityManager();
userIDM.openSession((err, challenge) => {
  try {
  userIDM.addCredential(credentialInfo, {
    onResult: (result, extraInfo) => {
      console.log('updateCredential result = ' + result);
      console.log('updateCredential extraInfo = ' + extraInfo);
    }
  });
  } catch (e) {
    console.log('updateCredential exception = ' + JSON.stringify(e));
  }
});

updateCredential⁸⁺

updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;

更新凭据。使用callback异步回调。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_USER_IDM

参数：

错误码：

示例：

let userIDM = new account_osAccount.UserIdentityManager();
let userAuth = new account_osAccount.UserAuth();
let pinAuth = new account_osAccount.PINAuth();
let password = new Uint8Array([0, 0, 0, 0, 0, 0]);
let credentialInfo = {
  credType: account_osAccount.AuthType.PIN,
  credSubType: account_osAccount.AuthSubType.PIN_SIX,
  token: null
};
pinAuth.registerInputer({
  onGetData: (pinSubType, callback) => {
    callback.onSetData(pinSubType, password);
  }
});
userIDM.openSession((err, challenge) => {
  userAuth.auth(challenge, credentialInfo.credType, account_osAccount.AuthTrustLevel.ATL1, {
    onResult: (result, extraInfo) => {
      if (result != account_osAccount.ResultCode.SUCCESS) {
        return;
      }
      credentialInfo.token = extraInfo.token;
      try {
        userIDM.updateCredential(credentialInfo, {
          onResult: (result, extraInfo) => {
              console.log('updateCredential result = ' + result);
              console.log('updateCredential extraInfo = ' + extraInfo);
          }
        });
      } catch (e) {
        console.log('updateCredential exception = ' + JSON.stringify(e));
      }
    }
  });
});

closeSession⁸⁺

closeSession(): void;

关闭会话，结束IDM操作。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_USER_IDM

示例：

let userIDM = new account_osAccount.UserIdentityManager();
userIDM.closeSession();

cancel⁸⁺

cancel(challenge: Uint8Array): void;

根据挑战值取消条目。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_USER_IDM

参数：

错误码：

示例：

let userIDM = new account_osAccount.UserIdentityManager();
let challenge = new Uint8Array([0]);
try {
  userIDM.cancel(challenge);
} catch(err) {
  console.log("cancel err:" + JSON.stringify(err));
}

delUser⁸⁺

delUser(token: Uint8Array, callback: IIdmCallback): void;

删除具有身份验证令牌的用户，使用callback方式异步返回结果。

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

系统能力： SystemCapability.Account.OsAccount

需要权限： ohos.permission.MANAGE_USER_IDM

参数：

错误码：