Package-level declarations

Types

Link copied to clipboard

EventDispatcherConfiguration 的基础抽象类,提供 EventDispatcherConfiguration 中基本能力的部分实现或抽象。

Link copied to clipboard

可以感知到发送消息的 Actor 目标的 MessageEvent 事件类型。

Link copied to clipboard

一个以某 Actor 为中心的事件。

Link copied to clipboard

可以感知到发送消息目标的 MessageEvent 事件类型。

Link copied to clipboard

Bot 相关的事件。

Link copied to clipboard

当一个 Bot 已经在某个 BotManager 中被注册后的事件。

Link copied to clipboard

与 Bot 相关的阶段性事件。 例如bot被注册了、bot被启动了。

Link copied to clipboard

当一个 Bot 首次 启动成功后的事件。

Link copied to clipboard

发生了某种变化的事件。

Link copied to clipboard

一个以某 Channel 为中心的事件。

Link copied to clipboard

一个以某 ChatChannel 为中心的事件。

Link copied to clipboard
Link copied to clipboard

一个以某 ChatGroup 为中心的事件。

Link copied to clipboard
Link copied to clipboard

一个以某 ChatGroup 中的 Member 为中心的事件。

Link copied to clipboard

一个 BotChatGroup 中的 Member 处收到私聊消息的事件。

Link copied to clipboard
Link copied to clipboard

一个以某 ChatRoom 为中心的事件。

Link copied to clipboard

一个 BotChatRoom 处收到消息的事件。

Link copied to clipboard
interface ComponentEvent : Event

一个由某个组件所发起的事件。

Link copied to clipboard

一个以某 Contact 为中心的事件。

Link copied to clipboard

一个 BotContact 处收到私聊消息的事件。

Link copied to clipboard
interface ContentEvent : Event

存在一个 主要事件中心 的事件类型。

Link copied to clipboard
interface Event : IDContainer

一个 事件

Link copied to clipboard

一个在事件处理流程中流转的上下文。 用于承载本次事件处理前后的诸项信息。

Link copied to clipboard

事件调度器。 EventDispatcher 拥有 EventProcessorEventListenerRegistrar 的职责, 是对事件调度、事件监听器管理的统一单元。

Link copied to clipboard

针对 EventDispatcher 的基础配置类信息。 不同的 EventDispatcher 可以对 EventDispatcherConfiguration 进行扩展。

Link copied to clipboard

事件调度拦截器。针对一次完整事件调度链路产生的拦截器。

Link copied to clipboard
fun interface EventInterceptor

事件拦截器。在 EventDispatcher 调度事件的过程中针对各监听器的拦截器。

Link copied to clipboard

注册 EventInterceptor 的额外属性。

Link copied to clipboard
fun interface EventListener

一个事件 Event 的监听器。也可以称之为事件处理器。 EventListener 是针对一个 Event 进行处理的逻辑单元。

Link copied to clipboard

事件监听器的“容器”接口,提供用于获取其中的所有 EventListener 的API。

Link copied to clipboard

一个在每一个事件处理器的独立处理流程中流转的上下文。 用于承载本次事件处理前后的诸项信息。

Link copied to clipboard

事件处理器的注册器。 用于承载注册、管理处理器的职责。

Link copied to clipboard

监听器注册成功后得到的对应的句柄。

Link copied to clipboard

注册事件监听器的额外属性。

Link copied to clipboard
interface EventProcessor

事件流程处理器。推送一个事件 Event 并得到结果。 EventProcessor 在功能上可以认为是一组 EventListener 的统一处理单位。

Link copied to clipboard
interface EventResult

一个事件(处理)结果。

Link copied to clipboard

ChatGroupMember 发生了某种变化时的事件。

Link copied to clipboard

一个以某 Guild 为中心的事件。

Link copied to clipboard

某用户申请加入 Guild 的事件。

Link copied to clipboard

GuildMember 发生了某种变化时的事件。

Link copied to clipboard

一个以某 Guild 中的 Member 为中心的事件。

Link copied to clipboard

一个 BotGuild 中的 Member 处收到私聊消息的事件。

Link copied to clipboard

以异步的方式实现 EventInterceptor.

Link copied to clipboard
fun interface JAsyncEventListener

一个事件 Event 的异步监听器。也可以称之为事件处理器。

Link copied to clipboard

以阻塞的方式实现 EventInterceptor

Link copied to clipboard
fun interface JBlockEventListener

一个事件 Event 的阻塞监听器。也可以称之为事件处理器。

Link copied to clipboard

一个事件 Event 的非阻塞监听器。也可以称之为事件处理器。

Link copied to clipboard

可以感知到发送消息的 Member 目标的 MessageEvent 事件类型。

Link copied to clipboard

Member 发生了某种变化时的事件。

Link copied to clipboard

某组织成员减少事件。

Link copied to clipboard

一个以某 Member 为中心的事件。

Link copied to clipboard

某组织成员增加事件。

Link copied to clipboard

某组织成员增加或减少的事件。

Link copied to clipboard

一个 BotMember 处收到私聊消息的事件。

Link copied to clipboard

一个含有 MessageContent 的事件。

Link copied to clipboard

一个 Bot 收到消息的事件。

Link copied to clipboard

Organization 产生了某种变化的事件,例如发生了 成员变动

Link copied to clipboard

一个以某 Organization 为中心的事件。

Link copied to clipboard

某个用户想要加入目标 Organization 的请求事件。

Link copied to clipboard

Bot 收到的某种与 Organization 相关的请求/申请有关的事件。

Link copied to clipboard

Organization 作为源头、但并非事件主要本体的事件类型。 此类型由一些存在组织信息、但组织信息不是主要信息的事件类型实现。

Link copied to clipboard

Bot 收到的某种与请求/申请有关的事件。

Link copied to clipboard
interface SourceEvent : Event

存在一个 源头 的事件类型。

Link copied to clipboard

EventResult 的标准实现。大部分有用的类型、 具有特殊作用的类型和可扩展的类型都在 StandardEventResult 下。

Link copied to clipboard

一个事件 Event 的异步监听器。也可以称之为事件处理器。

Link copied to clipboard

一个事件 Event 的阻塞监听器。也可以称之为事件处理器。

Link copied to clipboard

一个事件 Event 的非阻塞监听器。也可以称之为事件处理器。

Inherited properties

Link copied to clipboard

Functions

Link copied to clipboard

创建一个基于 CompletionStage 的异步事件处理器。

创建一个基于 CompletionStage 的异步事件处理器, 只处理 type 类型的事件。 其他类型的事件会直接返回 EventResult.invalid

Link copied to clipboard
fun block(dispatcherContext: CoroutineContext = Dispatchers.IO, function: JBlockEventListener): EventListener

创建一个阻塞事件处理器。

fun <E : Event> block(dispatcherContext: CoroutineContext = Dispatchers.IO, type: Class<E>, function: TypedJBlockEventListener<E>): EventListener

创建一个阻塞事件处理器, 只处理 type 类型的事件。 其他类型的事件会直接返回 EventResult.invalid

Link copied to clipboard

创建一个非阻塞事件处理器。

创建一个非阻塞事件处理器, 只处理 type 类型的事件。 其他类型的事件会直接返回 EventResult.invalid

Inherited functions

Link copied to clipboard

收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。

收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。

收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。

收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。

收集 StandardEventResult.CollectableReactivelyResult.content 的结果并返回。 如果结果不可收集或不支持收集,则得到原值。

Link copied to clipboard

Collects the result of a CollectableReactivelyResult by invoking the collectCollectableReactively() method and returning the result as an EventResult.

Link copied to clipboard

Collects the event result. This method is suspending and can be used in a coroutine.

Link copied to clipboard

Filters out any not StandardEventResult.Empty objects from the flow.

Link copied to clipboard

Filters the non-empty EventResult objects from the given flow.

Link copied to clipboard

Filters the Flow of EventResults and removes all StandardEventResult.Error instances.

Link copied to clipboard

Filters out any not StandardEventResult.Invalid objects from the flow.

Link copied to clipboard

从当前流中过滤出 非无效 的类型,即过滤出不是下述类型之一的其他结果:

Link copied to clipboard
Link copied to clipboard
inline fun <E : Event> EventListenerRegistrar.listen(propertiesConsumer: ConfigurerFunction<EventListenerRegistrationProperties>? = null, crossinline typeMismatchResult: EventListenerContext.() -> EventResult = { invalid() }, crossinline listenerFunction: suspend EventListenerContext.(E) -> EventResult): EventListenerRegistrationHandle

为特定事件类型注册事件处理器函数。

Link copied to clipboard

处理当前流中经过的每一个 StandardEventResult.Error 类型的结果。

Link copied to clipboard
inline fun EventListenerRegistrar.process(crossinline defaultResult: () -> EventResult = { EventResult.empty() }, propertiesConsumer: ConfigurerFunction<EventListenerRegistrationProperties>? = null, crossinline listenerFunction: suspend EventListenerContext.() -> Unit): EventListenerRegistrationHandle

listenEventListenerRegistrar.register 的进一步简写形式, 注册一个事件处理器。 通过 process 注册的事件处理器函数不会要求你返回 EventResult, 取而代之的是始终返回默认的 defaultResult,默认为 EventResult.empty

inline fun <E : Event> EventListenerRegistrar.process(propertiesConsumer: ConfigurerFunction<EventListenerRegistrationProperties>? = null, crossinline defaultResult: () -> EventResult = { EventResult.empty() }, crossinline typeMismatchResult: EventListenerContext.() -> EventResult = { invalid() }, crossinline listenerFunction: suspend EventListenerContext.(E) -> Unit): EventListenerRegistrationHandle

listenEventListenerRegistrar.register 的进一步简写形式, 注册一个处理特定类型 E 的事件处理器。 通过 process 注册的事件处理器函数不会要求你返回 EventResult, 取而代之的是始终返回默认的 defaultResult,默认为 EventResult.empty

Link copied to clipboard

推送事件并将结果转化为 Flux. 需要项目环境中存在 kotlinx-coroutines-reactor 依赖。

Link copied to clipboard

推送事件并将结果转化为 Stream 后返回。

Link copied to clipboard
suspend fun EventProcessor.pushAndCollect(event: Event, collector: FlowCollector<EventResult>? = null)

将事件推送并收集处理。

Link copied to clipboard

推送事件并将结果收集为 C 后返回 CompletableFuture.

推送事件并将结果使用 Collector 收集为 R 后返回 CompletableFuture.

Link copied to clipboard

推送事件并将结果收集为 C 后返回。

推送事件并将结果使用 Collector 收集为 R 后返回。

Link copied to clipboard

推送事件并将结果收集为 List 后返回 CompletableFuture.

Link copied to clipboard

推送事件并将结果收集为 List 后返回。

Link copied to clipboard

将事件推送并异步处理。

Link copied to clipboard
inline fun EventProcessor.pushAndLaunchThen(scope: CoroutineScope, event: Event, crossinline useFlow: (Flow<EventResult>) -> Unit): Job

将事件推送并异步处理。

Link copied to clipboard

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.

Link copied to clipboard

Returns a Flow of EventResults which stops emitting elements when it encounters an empty EventResult.

Link copied to clipboard

Returns a new Flow containing elements from the original flow until the first occurrence of an error event.

Link copied to clipboard

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.

Link copied to clipboard

Throws an exception if the event result is of type StandardEventResult.Error. Otherwise, returns the event result unchanged.