Package-level declarations
Types
EventDispatcherConfiguration 的基础抽象类,提供 EventDispatcherConfiguration 中基本能力的部分实现或抽象。
可以感知到发送消息的 Actor 目标的 MessageEvent 事件类型。
一个以某 Actor 为中心的事件。
可以感知到发送消息目标的 MessageEvent 事件类型。
与 Bot 相关的事件。
当一个 Bot 已经在某个 BotManager 中被注册后的事件。
与 Bot 相关的阶段性事件。 例如bot被注册了、bot被启动了。
当一个 Bot 首次 启动成功后的事件。
发生了某种变化的事件。
一个以某 Channel 为中心的事件。
一个以某 ChatChannel 为中心的事件。
针对 ChatChannel 的内部交互事件。
一个 Bot 从 ChatChannel 处收到消息的事件。
针对 ChatChannelMessageEvent.reply 的内部通知事件。 会在 ChatChannelMessageEvent.reply 执行成功后带着它的相关结果进行异步通知。
针对 ChatChannelMessageEvent.reply 的内部拦截事件。 可以对其中的参数进行修改。
针对 ChatChannel 的内部交互事件, 在 ChatChannel.send 执行后通知。
针对 ChatChannel 的内部交互事件, 在 ChatChannel.send 执行前拦截。
一个以某 ChatGroup 为中心的事件。
针对 ChatGroup 的内部交互事件。
某用户申请加入 ChatGroup 的事件。
某 ChatGroup 成员减少事件。
某 ChatGroup 成员增加事件。
某 ChatGroup 成员变动事件。
针对 ChatGroupMemberMessageEvent.reply 的内部通知事件。 会在 ChatGroupMemberMessageEvent.reply 执行成功后带着它的相关结果进行异步通知。
针对 ChatGroupMemberMessageEvent.reply 的内部拦截事件。 可以对其中的参数进行修改。
针对 ChatGroupMessageEvent.reply 的内部交互事件。
针对 ChatGroupMessageEvent.reply 的内部通知事件。 会在 ChatGroupMessageEvent.reply 执行成功后带着它的相关结果进行异步通知。
针对 ChatGroupMessageEvent.reply 的内部拦截事件。 可以对其中的参数进行修改。
针对 ChatGroup 的内部交互事件, 在 ChatGroup.send 执行后通知。
针对 ChatGroup 的内部交互事件, 在 ChatGroup.send 执行前拦截。
一个以某 ChatRoom 为中心的事件。
针对 ChatRoom 的内部交互事件。
针对 ChatRoomMessageEvent.reply 的内部交互事件。
针对 ChatRoomMessageEvent.reply 的内部通知事件。 会在 ChatRoomMessageEvent.reply 执行成功后带着它的相关结果进行异步通知。
针对 ChatRoomMessageEvent.reply 的内部拦截事件。 可以对其中的参数进行修改。
针对 ChatRoom 的内部交互事件, 在 ChatRoom.send 执行后通知。
针对 ChatRoom 的内部交互事件, 在 ChatRoom.send 执行前拦截。
一个由某个组件所发起的事件。
一个以某 Contact 为中心的事件。
针对 Contact.send 的内部交互事件。
针对 ContactMessageEvent.reply 的内部交互事件。
针对 ContactMessageEvent.reply 的内部通知事件。 会在 ContactMessageEvent.reply 执行成功后带着它的相关结果进行异步通知。
针对 ContactMessageEvent.reply 的内部拦截事件。 可以对其中的参数进行修改。
针对 Member.send 的内部交互事件, 在 Member.send 执行后通知。
针对 Member.send 的内部交互事件, 在 Member.send 执行前拦截。
存在一个 主要事件中心 的事件类型。
一个 事件。
一个在事件处理流程中流转的上下文。 用于承载本次事件处理前后的诸项信息。
事件调度器。 EventDispatcher 拥有 EventProcessor 和 EventListenerRegistrar 的职责, 是对事件调度、事件监听器管理的统一单元。
针对 EventDispatcher 的基础配置类信息。 不同的 EventDispatcher 可以对 EventDispatcherConfiguration 进行扩展。
DSL marker for EventDispatcherConfiguration
事件调度拦截器。针对一次完整事件调度链路产生的拦截器。
注册 EventDispatchInterceptor 的额外属性。
事件拦截器。在 EventDispatcher 调度事件的过程中针对各监听器的拦截器。
注册 EventInterceptor 的额外属性。
一个事件 Event 的监听器。也可以称之为事件处理器。 EventListener 是针对一个 Event 进行处理的逻辑单元。
事件监听器的“容器”接口,提供用于获取其中的所有 EventListener 的API。
一个在每一个事件处理器的独立处理流程中流转的上下文。 用于承载本次事件处理前后的诸项信息。
事件处理器的注册器。 用于承载注册、管理处理器的职责。
监听器注册成功后得到的对应的句柄。
注册事件监听器的额外属性。
事件流程处理器。推送一个事件 Event 并得到结果。 EventProcessor 在功能上可以认为是一组 EventListener 的统一处理单位。
一个事件(处理)结果。
通过 SubclassOptInRequired 标记某个事件类型为一个 “模糊的事件类型”。 这类事件通常拥有更明确的子类型,因此也更推荐实现这些更具体的类型, 而它们的存在主要是为了提供一个更为通用的事件类型或者仅仅提供一些额外能力(例如 XxxAware
之类的事件), 以便于在事件监听或类型判断上发挥作用。
一个以某 Guild 为中心的事件。
某用户申请加入 Guild 的事件。
某 Guild 成员减少事件。
某 Guild 成员增加事件。
某 Guild 成员变动事件。
针对 GuildMemberMessageEvent.reply 的内部交互事件。
针对 GuildMemberMessageEvent.reply 的内部通知事件。 会在 GuildMemberMessageEvent.reply 执行成功后带着它的相关结果进行异步通知。
针对 GuildMemberMessageEvent.reply 的内部拦截事件。 可以对其中的参数进行修改。
拦截或通知中 SendSupport.send 或 ReplySupport.reply 的消息内容。
一个内部事件。 用于表示一个仅在内部流转、与外界无关的事件, 通常用于一些内部的状态通知或功能拦截,例如 BotStageEvent 或 SendSupportInteractionEvent 等。
一个内部拦截事件。 拦截性质的内部事件通常用作“拦截”,即它会对某些行为进行拦截,并有可能会产生影响, 例如改变原本行为的参数、或者通过抛出异常直接阻止某些行为的发生。 例如针对 SendSupport.send 进行拦截,并改变其入参。
InternalInterceptionEvent 中产生的异常的收集与包装。 更多参考 InternalInterceptionEvent 中有关异常的说明。
在内部一个跟 Message 的交互有关的事件。
针对消息发送 (例如 SendSupport.send 或 ReplySupport.reply ) 成功后的内部通知事件。 会在相关API执行成功后带着它的相关结果进行异步通知。
针对消息交互时的内部拦截事件,可以对其中的参数进行修改。
一个内部通知事件。 通知性质的内部事件通常仅用作“通知”,即它不会对某些行为造成影响。
以异步的方式实现 EventInterceptor.
一个事件 Event 的异步监听器。也可以称之为事件处理器。
以阻塞的方式实现 EventInterceptor
一个事件 Event 的阻塞监听器。也可以称之为事件处理器。
一个事件 Event 的非阻塞监听器。也可以称之为事件处理器。
可以感知到发送消息的 Member 目标的 MessageEvent 事件类型。
当 Member 发生了某种变化时的事件。
某组织成员减少事件。
一个以某 Member 为中心的事件。
某组织成员增加事件。
某组织成员增加或减少的事件。
针对 Member 的内部交互事件。
针对 MemberMessageEvent.reply 的内部交互事件。
针对 MemberMessageEvent.reply 的内部通知事件。 会在 MemberMessageEvent.reply 执行成功后带着它的相关结果进行异步通知。
针对 MemberMessageEvent.reply 的内部拦截事件。 可以对其中的参数进行修改。
针对 Member 的内部交互事件, 在 Member.send 执行后通知。
针对 Member 的内部交互事件, 在 Member.send 执行前拦截。
一个含有 MessageContent 的事件。
一个 Bot 收到消息的事件。
针对 MessageEvent.reply 的内部交互事件。
针对 MessageEvent.reply 的内部通知事件。 会在 MessageEvent.reply 执行成功后带着它的相关结果进行异步通知。
针对 MessageEvent.reply 的内部拦截事件。 可以对其中的参数进行修改。
某 Organization 产生了某种变化的事件,例如发生了 成员变动。
一个以某 Organization 为中心的事件。
某个用户想要加入目标 Organization 的请求事件。
Bot 收到的某种与 Organization 相关的请求/申请有关的事件。
Organization 作为源头、但并非事件主要本体的事件类型。 此类型由一些存在组织信息、但组织信息不是主要信息的事件类型实现。
针对 ReplySupport 的内部交互事件,包括送信前的拦截与送信成功后的通知。
针对 ReplySupport.reply 的内部通知事件。 会在 ReplySupport.reply 执行成功后带着它的相关结果进行异步通知。
针对 ReplySupport.reply 的内部拦截事件。 可以对其中的参数进行修改。
Bot 收到的某种与请求/申请有关的事件。
针对 SendSupport 的内部交互事件,包括送信前的拦截与送信成功后的通知。
针对 SendSupport.send 的内部通知事件。 会在 SendSupport.send 执行成功后带着它的相关结果进行异步通知。
针对 SendSupport.send 的内部拦截事件。 可以对其中的参数进行修改。
存在一个 源头 的事件类型。
EventResult 的标准实现。大部分有用的类型、 具有特殊作用的类型和可扩展的类型都在 StandardEventResult 下。
一个事件 Event 的异步监听器。也可以称之为事件处理器。
一个事件 Event 的阻塞监听器。也可以称之为事件处理器。
一个事件 Event 的非阻塞监听器。也可以称之为事件处理器。
Properties
EventResult.content 是否为空。
Functions
构建一个 JAsyncEventInterceptor.
创建一个基于 CompletionStage 的异步事件处理器。
创建一个基于 CompletionStage 的异步事件处理器, 只处理 type 类型的事件。 其他类型的事件会直接返回 EventResult.invalid。
构建一个 JBlockEventInterceptor.
创建一个阻塞事件处理器。
创建一个阻塞事件处理器, 只处理 type 类型的事件。 其他类型的事件会直接返回 EventResult.invalid。
收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。
收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。
收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。
收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。
收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。
Collects the result of a CollectableReactivelyResult
by invoking the collectCollectableReactively()
method and returning the result as an EventResult
.
Collects the event result. This method is suspending and can be used in a coroutine.
Filters out any not StandardEventResult.Empty objects from the flow.
Filters the non-empty EventResult objects from the given flow.
Filters the Flow of EventResults and removes all StandardEventResult.Error instances.
Filters out any not StandardEventResult.Invalid objects from the flow.
从当前流中过滤出 非无效 的类型,即过滤出不是下述类型之一的其他结果:
为特定事件类型注册事件处理器函数。
创建一个非阻塞事件处理器。
创建一个非阻塞事件处理器, 只处理 type 类型的事件。 其他类型的事件会直接返回 EventResult.invalid。
处理当前流中经过的每一个 StandardEventResult.Error 类型的结果。
是 listen 或 EventListenerRegistrar.register 的进一步简写形式, 注册一个事件处理器。 通过 process 注册的事件处理器函数不会要求你返回 EventResult, 取而代之的是始终返回默认的 defaultResult,默认为 EventResult.empty。
是 listen 或 EventListenerRegistrar.register 的进一步简写形式, 注册一个处理特定类型 E 的事件处理器。 通过 process 注册的事件处理器函数不会要求你返回 EventResult, 取而代之的是始终返回默认的 defaultResult,默认为 EventResult.empty。
推送事件并将结果转化为 Flux. 需要项目环境中存在 kotlinx-coroutines-reactor
依赖。
推送事件并将结果转化为 Stream 后返回。
将事件推送并收集处理。
推送事件并将结果收集为 C 后返回 CompletableFuture.
推送事件并将结果使用 Collector 收集为 R 后返回 CompletableFuture.
推送事件并将结果收集为 C 后返回。
推送事件并将结果收集为 List 后返回 CompletableFuture.
推送事件并将结果收集为 List 后返回。
将事件推送并异步处理。
将事件推送并异步处理。
Returns a flow of EventResults that is composed of the events emitted by the original Flow until an event of type StandardEventResult.Empty is encountered.
Returns a Flow of EventResults which stops emitting elements when it encounters an empty EventResult.
Returns a new Flow containing elements from the original flow until the first occurrence of an error event.
Returns a flow of EventResults that is composed of the events emitted by the original Flow until an event of type StandardEventResult.Invalid is encountered.
Throws an exception if the event result is of type StandardEventResult.Error. Otherwise, returns the event result unchanged.