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

接口 MemberApi

public interface MemberApi

成员Api

方法概要

修饰符和类型	方法	说明
boolean	deleteMemberByUserId(String bot_id, String guild_id, String user_id, boolean add_black, int delete_history_msg_days)	将指定成员从频道内移除
Tuple<Member,String>	getMemberInfo(String bot_id, String guild_id, String user_id)	获取成员详情
Tuple<List<Member>,String>	getMemberList(String bot_id, String guild_id, String after, int limit)	获取频道成员列表
Tuple<MemberQueryLimit,String>	getMemberListByRoleId(String bot_id, String guild_id, String role_id, String start_index, int limit)	获取拥有此身份组的成员列表

方法详细资料

getMemberList

Tuple<List<Member>,String> getMemberList(String bot_id,
 String guild_id,
 String after,
 int limit)

获取频道成员列表

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

after - 上一次回包中最后一个member的user id， 如果是第一次请求填 0，默认为 0

limit - 查询条数

返回:

返回成员列表 分页大小，1-400，默认是 1。成员较多的频道尽量使用较大的limit值，以减少请求数

getMemberInfo

Tuple<Member,String> getMemberInfo(String bot_id,
 String guild_id,
 String user_id)

获取成员详情

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

user_id - 用户ID

返回:

返回成员对象

getMemberListByRoleId

Tuple<MemberQueryLimit,String> getMemberListByRoleId(String bot_id,
 String guild_id,
 String role_id,
 String start_index,
 int limit)

获取拥有此身份组的成员列表

参数:

bot_id - 传入机器人ID

guild_id - 频道ID

role_id - 身份组ID

start_index - 上一次返回包中的next，第一次请求填0，默认0

返回:

返回持有指定身份组ID的成员列表

deleteMemberByUserId

boolean deleteMemberByUserId(String bot_id,
 String guild_id,
 String user_id,
 boolean add_black,
 int delete_history_msg_days)

将指定成员从频道内移除

参数:

bot_id - 传入机器人ID

user_id - 用户ID

guild_id - 频道ID

add_black - 添加到黑名单

delete_history_msg_days - 撤回消息的天数

返回:

移除结果