用户权限

$w.auth.getUserInfo

$w.auth.getUserInfo(): Promise<CurrentUserInfo>

功能描述

获取当前登录用户信息

出参

CurrentUserInfo

属性	类型	说明
name	string	用户名称
nickName	string	用户昵称
avatarUrl	string	用户头像
type	number	类型。0:内部用户; 1:外部用户; 2:匿名用户
email	string	邮箱
phone	string	手机
relatedRoles	array	该用户关联的角色。具体字段见下面解释
openId	string	微信 openid/企业微信 openid
unionId	string	微信 unionId/企业微信 unionId
userId	string	微搭用户 id
mainOrg	object	主岗部门
orgs	array	兼岗部门
userType	string	用户登录状态。anonymousUser:未登录（匿名用户）、externalUser:已登录（外部用户）
userDesc	string	用户描述

object.relatedRoles[i]属性：

属性	类型	说明
id	string	角色 id
envId	string	环境 ID
name	string	角色名称
roleIdentity	string	角色标识

object.mainOrg 属性：

属性	类型	说明
id	string	主岗部门 id
name	string	主岗部门名称

object.orgs[i]属性：

属性	类型	说明
id	string	兼岗部门 id
name	string	兼岗部门名称

示例

const userInfo = await $w.auth.getUserInfo();
console.log('$w.auth.getUserInfo:', userInfo);

console.log('$w.auth.currentUser:', $w.auth.currentUser);
/**
 * {
 *   name: "xxx",
 *   avatarUrl: "xxx",
 *   openId: "xxx",
 *   unionId: "xxx",
 *   relatedRoles: [{envId: "lowcode-xxx", id: "xxx",name: "xxx", roleIdentity: "xxx"}],
 *   type: 1,
 *   phone: "xxx",
 *   email: "",
 *   userId: "xxx",
 *   mainOrg: {id: "xxx", name: "xxx"},
 *   orgs: [{id: "xxx", name: "xxx"}],
 *   userType: "anonymousUser"
 *   userDesc: "xxx"
 * }
 * /

$w.auth.currentUser

功能描述

用户信息引用

属性

$w.auth.currentUser 和 $w.auth.getUserInfo 出参一致，参考 $w.auth.getUserInfo 出参。

示例

console.log('$w.auth.currentUser:', $w.auth.currentUser);
/**
 * {
 *   name: "xxx",
 *   openId: "xxx",
 *   relatedRoles: [{envId: "lowcode-xxx", id: "xxx",name: "xxx", roleIdentity: "xxx"}],
 *   type: 1,
 *   phone: "xxx",
 *   email: "",
 *   userId: "xxx",
 *   mainOrg: {id: "xxx", name: "xxx"},
 *   orgs: [{id: "xxx", name: "xxx"}]
 * }
 * /

$w.auth.signOut

功能描述

用户退出登录

示例

$w.auth?.signOut?.();
setTimeout(() => {
  window.location.reload(); // web端可以刷新当前页面，会自动跳转默认登录页
}, 1000);

$w.auth.loginScope

功能描述

获取用户登录权限范围

出参

Promise<anonymous | undefined>

值	说明
anonymous	匿名用户
undefined	非匿名用户

示例

try {
  const scope = await $w.auth?.loginScope?.();
} catch (e) {
  // 未登录
}
/**
 * anonymous：当前为匿名用户状态，开启了登录访问时，可认为用户未登录
 * undefined：当前为非匿名用户状态，开启了登录访问时，可认为用户已登录
 */