cyan.model.role module

class cyan.model.role.DefaultRoleId

基类：object

默认身份组 ID。

ADMINISTRATOR = '2'

管理员。

DEFAULT = '1'

默认。

OPERATOR = '5'

子频道管理员。

OWNER = '4'

所有者。

class cyan.model.role.Role(bot: cyan.bot.Bot, guild: cyan.model.guild.Guild, props: Dict[str, Any])

基类：cyan.model.Model, cyan.model.renovatable.AsyncRenovatable[Role]

身份组。

async add(member: Member) → None

异步添加成员到当前身份组。

参数：

• member: 将要添加到当前身份组的成员

property bot: cyan.bot.Bot

Model 所属机器人。

property capacity: int

身份组容量。

property color: cyan.color.ARGB

身份组颜色。

property guild: cyan.model.guild.Guild

身份组所属频道。

async hide() → None

异步关闭身份组在成员列表中的单独展示。

property identifier: str

Model ID。

property name: str

身份组名称。

async remove(member: Member) → None

异步从当前身份组移除指定成员。

参数：

• member: 将要从当前身份组移除的成员

async renovate() → cyan.model.role.Role

获取更新的实例。

async set_color(color: cyan.color.ARGB) → None

异步修改身份组颜色。

参数：

• color: 目标颜色

async set_name(name: str) → None

异步修改身份组名称。

参数：

• name: 目标名称

async show() → None

异步启用身份组在成员列表中的单独展示。

property shown: bool

身份组是否在成员列表中单独展示。