Interface Manager

interface Manager {
    create: ((ro) => string);
    getByID: ((id) => Role);
    getByName: ((name) => Role);
    getList: ((qo?) => Role[]);
    remove: ((id) => void);
    update: ((role) => void);
}

Properties

create getByID getByName getList remove update

Properties

create

create: ((ro) => string)

创建角色

Type declaration

Example

import * as r from "role"
let mgr = r.newManager()
let id = mgr.create({ name: "test", label: "test" })
let testRole = mgr.getByID(id)

@param ro 角色创建参数 - 必选字段label、name，可选字段reportTo、description。
@return 角色ID

getByID

getByID: ((id) => Role)

获取角色

Type declaration

    • (id): Role

    • Parameters

      • id: string

        角色ID

      Returns Role

Returns

返回Role对象

getByName

getByName: ((name) => Role)

获取角色

Type declaration

    • (name): Role

    • Parameters

      • name: string

        角色名称

      Returns Role

Returns

返回Role对象

getList

getList: ((qo?) => Role[])

获取角色列表

Type declaration

Returns

角色列表（不返回用户列表、管理者列表）

remove

remove: ((id) => void)

删除角色

不能删除被 用户、其他角色、组或者分享规则 所引用的角色。

Type declaration

    • (id): void

    • Parameters

      • id: string

        角色ID

      Returns void

update

update: ((role) => void)

更新角色元数据

仅修改角色的元数据，不会修改用户的角色身份

Type declaration

    • (role): void

    • Parameters

      • role: Role

        RoleOptions接口，必须包含id。

      Returns void

Settings

Member Visibility

Theme

On This Page

creategetByIDgetByNamegetListremoveupdate