Realm - Documentation

Constructor

new Realm(ctx)

Source:

lib/Realm.js, line 14

Parameters:

Name	Type	Description
`ctx`	object	egg's ctx

Members

ctx

Source:

lib/Realm.js, line 24

egg 的 ctx 对象，通过它来调用相关的其他资源

Methods

(static) supports(token)

Source:

lib/Realm.js, line 30

判断当前 Realm 是否支持某种 Token 实例

Parameters:

Name	Type	Description
`token`	AuthenticationToken

(async) authenticate(token) → {object}

Source:

lib/Realm.js, line 40

认证

Parameters:

Name	Type	Description
`token`	AuthenticationToken	认证 token 实例

Throws:

token 非 AuthenticationToken 实例异常

Type

TokenInvalidException
用户找不到异常，可在此处扩展异常类型来明确是账号或是密码不对

Type

AuthenticationException

Returns:

认证成功返回用户信息，包含的字段 id 用于给 token 设置 uuid

Type: object

(async) getPermissions(roleIds) → {array.<string>}

Source:

lib/Realm.js, line 70

通过角色 id 获取权限集合

Parameters:

Name	Type	Description
`roleIds`	array.<(string\|number)>	角色 id 集合

Returns:

权限信息

Type: array.<string>

(async) getRoles(token) → {array.<object>}

Source:

lib/Realm.js, line 57

获取角色

Parameters:

Name	Type	Description
`token`	AuthenticationToken	认证 token 实例

Throws:

TokenInvalidException

Returns:

角色信息，每个角色必须包含结构 {id: xxx, name: yyy}

Type: array.<object>