com.forte.qqrobot.sender

Class MsgSender

java.lang.Object

com.forte.qqrobot.sender.MsgSender

Direct Known Subclasses:

BotSender, DefaultBotSender, MsgSender.NoListenerMsgSender

public class MsgSender
extends Object

送信器

Since:

JDK1.8

Author:

ForteScarlet <[163邮箱地址]ForteScarlet@163.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsgSender.NoListenerMsgSender Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_APPEND 阻断中，是否替换的默认值-false
SenderGetList	GETTER 消息发送器-get
SenderSendList	SENDER 消息发送器-send
SenderSetList	SETTER 消息发送器-set

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MsgSender(SenderSendList sender, SenderSetList setter, SenderGetList getter, ListenerMethod listenerMethod, BotRuntime runtime) 构造
protected	MsgSender(SenderSendList sender, SenderSetList setter, SenderGetList getter, ListenerMethod listenerMethod, BotRuntime runtime, boolean interceptSend, boolean interceptSet, boolean interceptGet) 构造

Method Summary

Modifier and Type	Method and Description
BotInfo	bot() 获取一个默认的Bot对象
BotInfo	bot(String botCode) 获取一个指定的Bot对象
BotSender	botSender() 获取默认的Bot送信器
BotSender	botSender(String botCode) 获取一个指定bot的送信器
static MsgSender	build(SenderList senderList, ListenerMethod listenerMethod, BotRuntime runtime) 是所有工厂方法的汇总方法之一
static MsgSender	build(SenderSendList sender, SenderSetList setter, SenderGetList getter, BotRuntime runtime)
static MsgSender	build(SenderSendList sender, SenderSetList setter, SenderGetList getter, ListenerMethod listenerMethod, BotRuntime runtime) 是所有工厂方法的汇总方法之一
static MsgSender	buildEmpty(BotRuntime runtime)
GroupInfo	getGroupInfo(GroupCodeAble groupCodeAble) 通过携带群号的对象获取群详细信息
GroupInfo	getGroupInfoByCode(String groupCode) 通过群号获取群详细信息
LoginQQInfo	getLoginInfo() 获取酷q上的qq信息
String	getOnGlobalBlockName() 获取当前处于全局阻断状态下的阻断组名
String[]	getOnNormalBlockNameArray() 获取当前处于普通阻断状态下的阻断组名列表
StrangerInfo	getPersonInfo(QQCodeAble codeAble) 通过携带QQ号信息的对象来获取信息
StrangerInfo	getPersonInfoByCode(String code) 通过QQ号获取陌生人信息
boolean	hasMethod() 是否存在监听器函数
boolean	isAllOnBlockByName() 根据组名判断自己所在的组是否全部在阻断状态中
boolean	isAnyOnBlockByName() 根据组名判断自己所在的组是否有任意在阻断状态中
boolean	isGetAble() 是否存在Get消息器
boolean	isNoneOnBlockByName() 根据组名判断自己所在的组是否全部没有在阻断状态中
boolean	isOnBlock() 判断自己是否存在于阻断队列
boolean	isOnlyThisOnBlock() 判断自己是否作为单独的阻断被阻断了
boolean	isSendAble() 是否存在send消息器
boolean	isSetAble() 是否存在set消息器
void	onBlockByName(String name) 根据组名来使某个分组进入阻断状态 默认替换
void	onBlockByName(String name, boolean append) 根据组名来使某个分组进入阻断状态 此方法当前执行的监听函数没有关联
void	onBlockByThisName() 开启阻塞-普通阻塞 根据当前函数的阻塞名称添加全部同名函数 默认替换
void	onBlockByThisName(boolean append) 开启阻塞-普通阻塞 根据当前函数的阻塞名称添加全部同名函数
void	onBlockOnlyThis() 开启阻塞-普通阻塞 仅仅添加这一个，不根据名称关联其他 默认替换
void	onBlockOnlyThis(boolean append) 开启阻塞-普通阻塞 仅仅添加这一个，不根据名称关联其他
void	onGlobalBlockByFirstName() 根据第一个阻断名称来更新全剧阻塞
void	onGlobalBlockByName(String name) 根据一个名称更新全局阻塞
void	onGlobalBlockByNameIndex(int index) 根据阻断名称的索引来更新全局阻塞
void	reply(MsgGet msg, String reply, boolean at) 快速回复，根据传入的类型判断。 只支持PrivateMsg、GroupMsg、DiscussMsg三种类型。
static void	setSenderGetIntercepts(SenderGetIntercept... senderGetIntercepts) 设置get送信器拦截
static void	setSenderSendIntercepts(SenderSendIntercept... senderSendIntercepts) 设置send送信器拦截
static void	setSenderSetIntercepts(SenderSetIntercept... senderSetIntercepts) 设置set送信器拦截
void	unAllBlock() 取消全部阻塞 此方法使用真实的阻断器
void	unBlock() 取消普通阻塞-即清空阻塞函数容器 此方法使用真实的阻断器
void	unGlobalBlock() 移除全局阻塞

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SENDER

public final SenderSendList SENDER

消息发送器-send

SETTER

public final SenderSetList SETTER

消息发送器-set

GETTER

public final SenderGetList GETTER

消息发送器-get

DEFAULT_APPEND

public static final boolean DEFAULT_APPEND

阻断中，是否替换的默认值-false

See Also:

Constant Field Values

Constructor Detail

MsgSender

protected MsgSender(SenderSendList sender,
                    SenderSetList setter,
                    SenderGetList getter,
                    ListenerMethod listenerMethod,
                    BotRuntime runtime)

构造

MsgSender

protected MsgSender(SenderSendList sender,
                    SenderSetList setter,
                    SenderGetList getter,
                    ListenerMethod listenerMethod,
                    BotRuntime runtime,
                    boolean interceptSend,
                    boolean interceptSet,
                    boolean interceptGet)

构造

Method Detail

setSenderSendIntercepts

public static void setSenderSendIntercepts(SenderSendIntercept... senderSendIntercepts)

设置send送信器拦截

setSenderSetIntercepts

public static void setSenderSetIntercepts(SenderSetIntercept... senderSetIntercepts)

设置set送信器拦截

setSenderGetIntercepts

public static void setSenderGetIntercepts(SenderGetIntercept... senderGetIntercepts)

设置get送信器拦截

bot

public BotInfo bot(String botCode)

获取一个指定的Bot对象

Parameters:

botCode - botCode

Returns:

BotInfo bot信息

bot

public BotInfo bot()

获取一个默认的Bot对象

Returns:

BotInfo bot信息

botSender

public BotSender botSender(String botCode)

获取一个指定bot的送信器

Parameters:

botCode - bot账号

Returns:

bot送信器

botSender

public BotSender botSender()

获取默认的Bot送信器

Returns:

bot送信器

hasMethod

public boolean hasMethod()

是否存在监听器函数

isSendAble

public boolean isSendAble()

是否存在send消息器

isSetAble

public boolean isSetAble()

是否存在set消息器

isGetAble

public boolean isGetAble()

是否存在Get消息器

Returns:

getPersonInfoByCode

public StrangerInfo getPersonInfoByCode(String code)

通过QQ号获取陌生人信息

Parameters:

code - qq号

Returns:

qq号的信息

getPersonInfo

public StrangerInfo getPersonInfo(QQCodeAble codeAble)

通过携带QQ号信息的对象来获取信息

Parameters:

codeAble - 携带QQ号信息的对象

Returns:

getGroupInfoByCode

public GroupInfo getGroupInfoByCode(String groupCode)

通过群号获取群详细信息

Parameters:

groupCode - 群号

Returns:

群详细信息

getGroupInfo

public GroupInfo getGroupInfo(GroupCodeAble groupCodeAble)

通过携带群号的对象获取群详细信息

Parameters:

groupCodeAble - 携带群号的对象

Returns:

群详细信息

getLoginInfo

public LoginQQInfo getLoginInfo()

获取酷q上的qq信息

Returns:

qq信息

reply

public void reply(MsgGet msg,
                  String reply,
                  boolean at)

快速回复，根据传入的类型判断。 只支持PrivateMsg、GroupMsg、DiscussMsg三种类型。

Parameters:

msg - 接收到的消息

reply - 回复的正文

at - 是否要at他，默认为true，只有群消息和私信消息生效

build

public static MsgSender build(SenderList senderList,
                              ListenerMethod listenerMethod,
                              BotRuntime runtime)

是所有工厂方法的汇总方法之一

build

public static MsgSender build(SenderSendList sender,
                              SenderSetList setter,
                              SenderGetList getter,
                              ListenerMethod listenerMethod,
                              BotRuntime runtime)

是所有工厂方法的汇总方法之一

build

public static MsgSender build(SenderSendList sender,
                              SenderSetList setter,
                              SenderGetList getter,
                              BotRuntime runtime)

buildEmpty

public static MsgSender buildEmpty(BotRuntime runtime)

onBlockOnlyThis

public void onBlockOnlyThis(boolean append)

开启阻塞-普通阻塞 仅仅添加这一个，不根据名称关联其他

onBlockOnlyThis

public void onBlockOnlyThis()

开启阻塞-普通阻塞 仅仅添加这一个，不根据名称关联其他 默认替换

onBlockByThisName

public void onBlockByThisName(boolean append)

开启阻塞-普通阻塞 根据当前函数的阻塞名称添加全部同名函数

onBlockByThisName

public void onBlockByThisName()

开启阻塞-普通阻塞 根据当前函数的阻塞名称添加全部同名函数 默认替换

onBlockByName

public void onBlockByName(String name,
                          boolean append)

根据组名来使某个分组进入阻断状态 此方法当前执行的监听函数没有关联

onBlockByName

public void onBlockByName(String name)

根据组名来使某个分组进入阻断状态 默认替换

unBlock

public void unBlock()

取消普通阻塞-即清空阻塞函数容器 此方法使用真实的阻断器

unGlobalBlock

public void unGlobalBlock()

移除全局阻塞

unAllBlock

public void unAllBlock()

取消全部阻塞 此方法使用真实的阻断器

onGlobalBlockByName

public void onGlobalBlockByName(String name)

根据一个名称更新全局阻塞

onGlobalBlockByNameIndex

public void onGlobalBlockByNameIndex(int index)
                              throws NoSuchBlockNameException

根据阻断名称的索引来更新全局阻塞

Throws:

NoSuchBlockNameException

onGlobalBlockByFirstName

public void onGlobalBlockByFirstName()

根据第一个阻断名称来更新全剧阻塞

isAllOnBlockByName

public boolean isAllOnBlockByName()

根据组名判断自己所在的组是否全部在阻断状态中

isAnyOnBlockByName

public boolean isAnyOnBlockByName()

根据组名判断自己所在的组是否有任意在阻断状态中

isNoneOnBlockByName

public boolean isNoneOnBlockByName()

根据组名判断自己所在的组是否全部没有在阻断状态中

isOnBlock

public boolean isOnBlock()

判断自己是否存在于阻断队列

isOnlyThisOnBlock

public boolean isOnlyThisOnBlock()

判断自己是否作为单独的阻断被阻断了

getOnGlobalBlockName

public String getOnGlobalBlockName()

获取当前处于全局阻断状态下的阻断组名

Returns:

阻断组名

getOnNormalBlockNameArray

public String[] getOnNormalBlockNameArray()

获取当前处于普通阻断状态下的阻断组名列表

Returns:

处于普通阻断状态下的阻断组名列表