Package-level declarations

Types

Link copied to clipboard

代表一个异步任务的返回值。

Link copied to clipboard

ContinuousSessionContext 的基础接口。 为 ContinuousSessionContext 提供最基础的核心的函数:waiting.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class BaseEvent

此注解标记一个 Event 类型并将其标记为一个 基础事件类型

Link copied to clipboard
abstract class BaseEventKey<E : Event>(idValue: String, val parents: Set<Event.Key<*>> = emptySet()) : Event.Key<E>

Event.Key 的基础抽象类,当一个事件仅来自于一个父级事件的时候可以使用此抽象类。

Link copied to clipboard

使用于 ContinuousSessionContext.waitingForNext 中的事件匹配器。

Link copied to clipboard

事件过滤器。 为不支持挂起函数(例如Java)的场景而提供的非挂起阻塞过滤器。

Link copied to clipboard

一个事件的事件监听器。

Link copied to clipboard

阻塞实现的 EventListenerFunction, 更适合 Java开发者进行实现。

Link copied to clipboard

为Java提供的阻塞调用的 EventListenerInterceptor 接口方案。

Link copied to clipboard

为Java提供的阻塞调用的 EventProcessingInterceptor 接口方案。

Link copied to clipboard

一个 变更 事件,代表一个已经变更结束的事件。 ChangedEventChangeEvent 事件的 事实 描述, 一般来讲代表了一个已经发生变更的事件。

Link copied to clipboard

一个与 变更 有关的事件。

Link copied to clipboard

一个与 频道 相关的事件。

Link copied to clipboard

代表一个来自频道的消息事件。

Link copied to clipboard

一个与频道相关的请求事件。

Link copied to clipboard

一个来自聊天室的消息事件。

Link copied to clipboard

来自一个联系人消息消息事件。 这通常代表一个私聊消息事件,但对话者不一定是 好友

Link copied to clipboard

持续会话的作用域, 通过此作用域在监听函数监听过程中进行会话嵌套。

Link copied to clipboard

使用于 ContinuousSessionContext.waitingForNext 中的事件匹配器。

Link copied to clipboard

持续会话的结果提供者,通过 ContinuousSessionContext.getReceiver 构建获取,向目标会话推送一个结果。

Link copied to clipboard

持续会话的结果接收器,通过 ContinuousSessionContext.getReceiver 获取, 用于挂起并等待一个结果。

Link copied to clipboard

相当于函数 EventProcessingContext.(ContinuousSessionProvider<T>) -> Unit

Link copied to clipboard

一个 减少 事件,代表某种 事物 (变更前属性) 被从一个 中移除。

Link copied to clipboard

一个 终点 事件。

Link copied to clipboard

所有 事件 的顶层接口。

Link copied to clipboard

事件过滤器。

Link copied to clipboard

与事件有关的拦截器。拦截器是一个包裹在目标前后的一道 “关卡”, 通过拦截器可以自由定义对目标逻辑前后以及异常的处理。

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class EventKey(val id: String, val type: KClass<out Event>, val parents: Array<KClass<out Event>>)

通过注解标记一个 Event 类型所对应的 Event.Key 数据.

Link copied to clipboard

一个事件的事件监听器。 事件监听器监听到实现并进行逻辑处理。此处不包含诸如过滤器等内容。

Link copied to clipboard

一个 EventListener 的标准构建器接口。

Link copied to clipboard

监听函数容器。

Link copied to clipboard

一个监听函数。其代表对于一个 监听器上下文 的处理逻辑。

Link copied to clipboard

被注册后监听函数的句柄.

Link copied to clipboard

事件监听函数拦截器。与 EventProcessingInterceptor 不同,EventListenerInterceptor 则针对一次事件处理流程中的 每一个 监听函数 进行独立拦截。

Link copied to clipboard

事件监听器管理器标准接口。

Link copied to clipboard

每一个 EventListener 在事件处理流程中所对应的上下文类型。

Link copied to clipboard

在监听函数执行过程中出现的异常。

Link copied to clipboard

监听函数注册器

Link copied to clipboard

用于向 EventListenerRegistrar 中注册监听函数的信息描述. 可以在 EventListener 之外提供更多可能有效的附加信息.

EventListenerBuilder 的基础上允许根据一些可能的额外信息构建一个 EventListenerRegistrationDescription 实例.

Link copied to clipboard

整个事件流程中进行传递的上下文。

Link copied to clipboard

在事件处理的流程中可能出现的异常。

Link copied to clipboard

事件处理过程的拦截器。EventProcessingInterceptor 是针对 整个 事件流程的整体拦截,他不关系处理流程中的某个单独的监听函数, 而是对所有被触发的事件流程的整体进行一次拦截。

Link copied to clipboard

事件处理器对整个事件流程执行完毕后得到的最终响应。

Link copied to clipboard
interface EventProcessor

事件处理器,代表一个事件被触发的入口。

Link copied to clipboard
interface EventResult

事件结果, 用于提供有关一次事件处理执行后的响应。

Link copied to clipboard
Link copied to clipboard

一个 Bot好友 发生了变化,比如 增加减少 了。

Link copied to clipboard

一个 好友减少 事件。

Link copied to clipboard

一个与 好友 相关的事件。

Link copied to clipboard

一个 好友增加 事件。

Link copied to clipboard

一个来自于好友的消息事件。这通常代表为一个私聊消息事件。

Link copied to clipboard

一个好友申请。 请求事件不能保证能够得到完整的 Friend 对象,但是应尽可能提供基本的用户信息 FriendInfo.

Link copied to clipboard

全局作用域上下文,代表以事件处理器为作用域唯一实例的上下文类型。

Link copied to clipboard

一个与 相关的事件。

Link copied to clipboard

一个群的加入申请事件。

Link copied to clipboard

MemberDecreaseEvent 的子类型事件,代表为一个发生于 Group 的成员减少事件。

Link copied to clipboard

MemberIncreaseEvent 事件类型的子集,代表为一个发生于 Group 的成员增加事件。

Link copied to clipboard

代表一个来自的消息事件。

Link copied to clipboard

一个与群相关的请求事件。

Link copied to clipboard

一个与 频道服务器 相关的事件。

Link copied to clipboard

一个频道的加入申请事件。

Link copied to clipboard

MemberDecreaseEvent 的子类型事件,代表一个发生在 Guild 中的事件。

Link copied to clipboard

MemberIncreaseEvent 事件类型的子集,代表为一个发生于 Guild 的成员增加事件。

Link copied to clipboard

一个与频道服务器相关的申请事件。

Link copied to clipboard

一个 增加 事件,代表某种 事物 (变更后属性) 被增加到了一个 中。

Link copied to clipboard

瞬时作用域上下文,由 EventProcessingContext 直接实现。

Link copied to clipboard

RequestEvent 事件的子类型,代表一个 加入 申请。

Link copied to clipboard

一个与组织成员变动相关的事件。

Link copied to clipboard

一个 成员减少 事件。 其代表一个组织中减少了某个成员。

Link copied to clipboard

一个与 成员 相关的事件。

Link copied to clipboard

一个 成员增加 事件。 其代表一个组织中增加了某个成员。

Link copied to clipboard

一个存在消息内容的事件

Link copied to clipboard

消息被回应事件。

Link copied to clipboard

无匹配监听函数异常.

Link copied to clipboard

一个与 Objective 相关的事件。 可能是与联系人(好友、成员等)或者与组织(群、频道等)相关的事件。

Link copied to clipboard

一个与 组织 相关的事件。

Link copied to clipboard

代表 content 可能为一个反应式的结果,并且允许其在一个函数结束时进行收集。

Link copied to clipboard

请求 有关的事件。

Link copied to clipboard

作用域上下文,提供部分贯穿事件的作用域参数信息。

Link copied to clipboard
open class SimpleEventResult @JvmOverloads constructor(val content: Any? = null, val isTruncated: Boolean = false) : ReactivelyCollectableEventResult

EventResult 的基础实现类型,是通过 EventResult.of 可能得到的基本结果类型。

Link copied to clipboard

标记性接口, 代表一些在内部具有特殊意义的 EventResult 类型.

Link copied to clipboard

一个 起点 事件。

Link copied to clipboard

一个与 用户 相关的事件。

Link copied to clipboard

一个与用户相关的请求事件. 请求事件不能保证能够得到完整的 User 对象,但是应尽可能提供基本的用户信息 UserInfo.

Functions

Link copied to clipboard
operator fun Event.Key<*>.contains(parentIdMaybe: String): Boolean
operator fun Event.Key<*>.contains(parentIdMaybe: ID): Boolean

判断当前类型是否为提供类型的子类型。

Link copied to clipboard

通过 KClass 获取其对应的 Event.Key.

Link copied to clipboard
inline suspend fun <R> ChatRoomMessageEvent.inAuthor(block: Member.() -> R): R
Link copied to clipboard
inline suspend fun <R> ChannelEvent.inChannel(block: Channel.() -> R): R
Link copied to clipboard
inline suspend fun <R> FriendEvent.inFriend(block: Friend.() -> R): R
Link copied to clipboard
inline suspend fun <R> GroupEvent.inGroup(block: Group.() -> R): R
Link copied to clipboard
inline suspend fun <R> GuildEvent.inGuild(block: Guild.() -> R): R
Link copied to clipboard
inline suspend fun <R> MemberEvent.inMember(block: Member.() -> R): R
Link copied to clipboard
inline suspend fun <R> OrganizationEvent.inOrganization(block: Organization.() -> R): R
Link copied to clipboard
inline suspend fun <R> UserEvent.inUser(block: User.() -> R): R
Link copied to clipboard

进入到 ContinuousSessionContext 上下文中。

Link copied to clipboard
inline suspend fun <E : Event> EventProcessor.pushIfProcessable(block: () -> E): EventProcessingResult?

E 在当前事件处理器中能够被处理时( EventProcessor.isProcessable == true ), 通过 block 计算一个目标事件类型。

inline suspend fun EventProcessor.pushIfProcessable(eventKey: Event.Key<*>, block: () -> Event): EventProcessingResult?

eventKey 在当前事件处理器中能够被处理时( EventProcessor.isProcessable == true ), 通过 block 计算一个目标事件类型。

Link copied to clipboard
inline suspend fun <R> ChatRoomMessageEvent.useAuthor(block: (Member) -> R): R
Link copied to clipboard
inline suspend fun <R> ChannelEvent.useChannel(block: (Channel) -> R): R
Link copied to clipboard
inline suspend fun <R> FriendEvent.useFriend(block: (Friend) -> R): R
Link copied to clipboard
inline suspend fun <R> GroupEvent.useGroup(block: (Group) -> R): R
Link copied to clipboard
inline suspend fun <R> GuildEvent.useGuild(block: (Guild) -> R): R
Link copied to clipboard
inline suspend fun <R> MemberEvent.useMember(block: (Member) -> R): R
Link copied to clipboard
inline suspend fun <R> OrganizationEvent.useOrganization(block: (Organization) -> R): R
Link copied to clipboard
inline suspend fun <R> UserEvent.useUser(block: (User) -> R): R
Link copied to clipboard
suspend fun <E : Event> ContinuousSessionContext.waitingForNext(k: Event.Key<E>, matcher: ContinuousSessionEventMatcher<E> = ContinuousSessionEventMatcher): E

挂起并等待下一个符合 类型条件事件 对象。

Link copied to clipboard

挂起并等待下一个符合条件的 消息事件 中的消息体。