程序包 cn.siriusbot.siriuspro.bot.api

接口 RoleApi

public interface RoleApi

身份组Api

方法概要

修饰符和类型	方法	说明
Tuple<Role,String>	createRole(String bot_id, String guild_id, String name, Integer color, Integer hoist)	创建频道身份组
Boolean	createRoleMemberInGuild(String bot_id, String guild_id, String user_id, String role_id, Channel channel)	将指定成员，加入到指定频道的，指定身份组中
Boolean	deleteRoleForGuild(String bot_id, String guild_id, String role_id)	从指定频道中删除指定身份组
Tuple<GuildRoleList,String>	getRoleListByGuild(String bot_id, String guild_id)	从指定频道中获取所有身份组
Tuple<NewRole,String>	modifyRoleByGuild(String bot_id, String guild_id, String role_id, String name, Integer color, Integer hoist)	修改频道身份组
Boolean	removeRoleMemberForGuild(String bot_id, String guild_id, String role_id, String user_id, Channel channel)	将指定用户，从指定频道的身份组中移除

方法详细资料

createRole

Tuple<Role,String> createRole(String bot_id,
 String guild_id,
 String name,
 Integer color,
 Integer hoist)

创建频道身份组

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

name - 身份组名称

color - 身份组颜色

hoist - 是否在成员列表中单独展示,0:否,1:是

返回:

返回身份组对象

removeRoleMemberForGuild

Boolean removeRoleMemberForGuild(String bot_id,
 String guild_id,
 String role_id,
 String user_id,
 Channel channel)

将指定用户，从指定频道的身份组中移除

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

role_id - 身份组ID

user_id - 用户ID

channel - 只传入子频道ID的子频道对象

返回:

返回操作结果

createRoleMemberInGuild

Boolean createRoleMemberInGuild(String bot_id,
 String guild_id,
 String user_id,
 String role_id,
 Channel channel)

将指定成员，加入到指定频道的，指定身份组中

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

user_id - 用户ID

role_id - 身份组ID

channel - 只传入了子频道ID的子频道对象

返回:

操作结果

modifyRoleByGuild

Tuple<NewRole,String> modifyRoleByGuild(String bot_id,
 String guild_id,
 String role_id,
 String name,
 Integer color,
 Integer hoist)

修改频道身份组

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

role_id - 身份组ID

name - 最新身份组名称

color - 最新颜色

hoist - 是否在成员列表中单独展示,0:否,1:是

返回:

修改后的身份组信息

deleteRoleForGuild

Boolean deleteRoleForGuild(String bot_id,
 String guild_id,
 String role_id)

从指定频道中删除指定身份组

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

role_id - 身份组ID

返回:

操作结果

getRoleListByGuild

Tuple<GuildRoleList,String> getRoleListByGuild(String bot_id,
 String guild_id)

从指定频道中获取所有身份组

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

返回:

身份组列表