Sswg3156201044修复文档问题
3c7fbfa8创建于 2025年3月14日历史提交

管理系统账号(仅对系统应用开放)

系统提供了用于管理系统账号的接口。系统应用开发者在申请对应的权限后,可以创建、激活、修改和删除系统账号,实现对系统账号的生命周期管理;三方应用开发者可以查询系统账号的基本信息,以完成与系统账号相关的业务逻辑开发。

基本概念

账号类型

当前,系统仅允许创建以下预定义类型的系统账号:

名称 说明
ADMIN 0 管理员账号。
NORMAL 1 普通账号。
GUEST 2 访客账号。
PRIVATE12+ 1024 隐私账号。

账号完整信息

系统账号的完整信息请参考OsAccountInfo定义。

开发准备

  1. 申请权限:ohos.permission.MANAGE_LOCAL_ACCOUNTS。申请流程请参考:申请应用权限

  2. 导入系统账号模块。

    import { osAccount, BusinessError } from '@kit.BasicServicesKit';
    
  3. 获取账号管理单实例对象。

    let accountManager = osAccount.getAccountManager();
    

创建系统账号

系统初始化阶段,会创建默认系统账号。此外,可以创建多个系统账号,以满足用户不同诉求。

具体开发实例如下:

调用createOsAccount接口,指定昵称和类型信息来创建系统账号。

let name: string = 'Bob';
let type: osAccount.OsAccountType = osAccount.OsAccountType.NORMAL;

accountManager.createOsAccount(name, type, (err: BusinessError, osAccountInfo: osAccount.OsAccountInfo)=>{
  console.log('createOsAccount err:' + JSON.stringify(err));
  console.log('createOsAccount osAccountInfo:' + JSON.stringify(osAccountInfo));
});

查询所有已创建的系统账号

账号管理界面通常需要获取所有账号信息时,以方便用户操作不同账号。

具体开发实例如下:

调用queryAllCreatedOsAccounts接口查询全量账号。

accountManager.queryAllCreatedOsAccounts((err: BusinessError, accountArr: osAccount.OsAccountInfo[])=>{
  console.log('queryAllCreatedOsAccounts err:' + JSON.stringify(err));
  console.log('queryAllCreatedOsAccounts accountArr:' + JSON.stringify(accountArr));
});

查询指定系统账号信息

除了查询所有账号信息,还可以根据账号标识查询指定系统账号的详细信息。

具体开发实例如下:

调用queryOsAccountById接口查询指定账号的详细信息。

let localId: number = 100;
accountManager.queryOsAccountById(localId, (err: BusinessError, accountInfo: osAccount.OsAccountInfo)=>{
  console.log('queryOsAccountById err:' + JSON.stringify(err));
  console.log('queryOsAccountById accountInfo:' + JSON.stringify(accountInfo));
});

修改系统账号头像和昵称

可以修改系统账号的头像、昵称,以满足用户的个性化需求。

具体开发实例如下:

  1. 调用setOsAccountProfilePhoto接口修改系统账号头像。

    let localId: number = 100;
    let newPhoto: string = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+
    'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+
    'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+
    '+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg=='
    
    accountManager.setOsAccountProfilePhoto(localId, newPhoto, (err: BusinessError)=>{
      console.log('setOsAccountProfilePhoto err:' + JSON.stringify(err));
    });
    
  2. 调用setOsAccountName接口修改系统账号名称。

    let localId: number = 100;
    let newName: string = 'Tom';
    accountManager.setOsAccountName(localId, newName, (err: BusinessError) => {
      if (err) {
        console.log('setOsAccountName failed, error: ' + JSON.stringify(err));
      } else {
        console.log('setOsAccountName successfully');
      }
    });
    

激活系统账号

系统账号默认处于未激活状态,需要激活后才能使用。开发者可以使用activateOsAccount接口完成此操作。

具体开发实例如下:

调用activateOsAccount接口激活指定系统账号。

let localId: number = 101;
accountManager.activateOsAccount(localId, (err: BusinessError)=>{
  if (err) {
    console.error(`activateOsAccount failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.log('activateOsAccount successfully');
  }
});

删除系统账号

不再使用某个系统账号时,可以将该系统账号删除。

具体开发实例如下:

调用removeOsAccount接口删除指定的账号。

let localId: number = 101;
accountManager.removeOsAccount(localId, (err: BusinessError)=>{
  if (err) {
      console.log('removeOsAccount failed, error: ' + JSON.stringify(err));
  } else {
      console.log('removeOsAccount successfully');
  }
});