群组角色 (GuildRole)
类型定义
GuildRole
字段 | 类型 | 描述 |
---|---|---|
id | string | 角色 ID |
name | string? | 角色名称 |
API
设置群组成员角色
POST/guild.member.role.set
字段 | 类型 | 描述 |
---|---|---|
guild_id | string | 群组 ID |
user_id | string | 用户 ID |
role_id | string | 角色 ID |
设置群组内用户的角色。
取消群组成员角色
POST/guild.member.role.unset
字段 | 类型 | 描述 |
---|---|---|
guild_id | string | 群组 ID |
user_id | string | 用户 ID |
role_id | string | 角色 ID |
取消群组内用户的角色。
获取群组角色列表
POST/guild.role.list
字段 | 类型 | 描述 |
---|---|---|
guild_id | string | 群组 ID |
next | string? | 分页令牌 |
获取群组角色列表。返回一个 GuildRole 的 分页列表。
创建群组角色
POST/guild.role.create
字段 | 类型 | 描述 |
---|---|---|
guild_id | string | 群组 ID |
role | GuildRole | 角色数据 |
创建群组角色。返回一个 GuildRole 对象。
修改群组角色
POST/guild.role.update
字段 | 类型 | 描述 |
---|---|---|
guild_id | string | 群组 ID |
role_id | string | 角色 ID |
role | GuildRole | 角色数据 |
修改群组角色。
删除群组角色
POST/guild.role.delete
字段 | 类型 | 描述 |
---|---|---|
guild_id | string | 群组 ID |
role_id | string | 角色 ID |
删除群组角色。
事件
guild-role-created
群组角色被创建时触发。必需资源:guild
,role
。
guild-role-updated
群组角色被修改时触发。必需资源:guild
,role
。
guild-role-deleted
群组角色被删除时触发。必需资源:guild
,role
。