annotation class EventHandler(val priority: EventPriority = EventPriority.NORMAL, val ignoreCancelled: Boolean = true, val concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT)

标注一个函数为事件监听器.

EventPriority

enum EventPriority : Enum<EventPriority>

事件优先级.

ExceptionInEventChannelFilterException

class ExceptionInEventChannelFilterException(val event: Event, val eventChannel: EventChannel<*>, val message: String = "Exception in EventHandler", val cause: Throwable) : IllegalStateException

包装 EventChannel.filter 的 filter lambda 抛出的异常并重新抛出.

ExceptionInEventHandlerException

class ExceptionInEventHandlerException(val event: Event, val message: String = "Exception in EventHandler", val cause: Throwable) : IllegalStateException

EventHandler 标记的函数在处理事件时产生异常时包装异常并重新抛出

FriendMessageSubscribersBuilder

typealias FriendMessageSubscribersBuilder = MessageSubscribersBuilder<FriendMessageEvent, Listener<FriendMessageEvent>, Unit, Unit>

GlobalEventChannel

object GlobalEventChannel : EventChannel<Event>

全局事件通道. 此通道包含来自所有 Bot 的所有类型的事件. 可通过 EventChannel.filter 过滤得到范围更小的 EventChannel.

GroupMessageSubscribersBuilder

typealias GroupMessageSubscribersBuilder = MessageSubscribersBuilder<GroupMessageEvent, Listener<GroupMessageEvent>, Unit, Unit>

GroupTempMessageSubscribersBuilder

typealias GroupTempMessageSubscribersBuilder = MessageSubscribersBuilder<GroupTempMessageEvent, Listener<GroupTempMessageEvent>, Unit, Unit>

InternalGlobalEventChannelProvider

@MiraiInternalApi

interface InternalGlobalEventChannelProvider

Listener

@NotStableForInheritance

interface Listener<in E : Event> : CompletableJob

事件监听器. 由 EventChannel.subscribe 等方法返回.

ListenerHost

interface ListenerHost

实现这个接口的对象可以通过 EventHandler 标注事件监听函数, 并通过 registerTo 注册.

ListeningStatus

enum ListeningStatus : Enum<ListeningStatus>

订阅者的状态

MessageDsl

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS, AnnotationTarget.TYPE])

@DslMarker

annotation class MessageDsl

DSL 标记. 将能让 IDE 阻止一些错误的方法调用.

MessageEventSubscribersBuilder

typealias MessageEventSubscribersBuilder = MessageSubscribersBuilder<MessageEvent, Listener<MessageEvent>, Unit, Unit>

MessageListener

typealias MessageListener<T, R> = suspend T.(String) -> R

消息事件的处理器.

注: 接受者 T 为 MessageEvent 参数 String 为转为字符串了的消息 (Message.toString)

MessageSelectBuilder

abstract class MessageSelectBuilder<M : MessageEvent, R> : MessageSelectBuilderUnit<M, R>

selectMessages 时的 DSL 构建器.

MessageSelectBuilderUnit

expect abstract class MessageSelectBuilderUnit<M : MessageEvent, R> : CommonMessageSelectBuilderUnit<M, R>

selectMessagesUnit 或 selectMessages 时的 DSL 构建器.

actual abstract class MessageSelectBuilderUnit<M : MessageEvent, R> : CommonMessageSelectBuilderUnit<M, R>

selectMessagesUnit 或 selectMessages 时的 DSL 构建器.

actual abstract class MessageSelectBuilderUnit<M : MessageEvent, R> : CommonMessageSelectBuilderUnit<M, R>

selectMessagesUnit 或 selectMessages 时的 DSL 构建器.

MessageSelectionTimeoutChecker

@JvmInline

value class MessageSelectionTimeoutChecker

MessageSelectionTimeoutException

class MessageSelectionTimeoutException : RuntimeException

MessageSubscribersBuilder

open class MessageSubscribersBuilder<M : MessageEvent, out Ret, R : RR, RR>

消息订阅构造器

OtherClientMessageSubscribersBuilder

typealias OtherClientMessageSubscribersBuilder = MessageSubscribersBuilder<OtherClientMessageEvent, Listener<OtherClientMessageEvent>, Unit, Unit>

SimpleListenerHost

abstract class SimpleListenerHost @JvmOverloads constructor(coroutineContext: CoroutineContext = EmptyCoroutineContext) : ListenerHost

携带一个异常处理器的 ListenerHost.

StrangerMessageSubscribersBuilder

typealias StrangerMessageSubscribersBuilder = MessageSubscribersBuilder<StrangerMessageEvent, Listener<StrangerMessageEvent>, Unit, Unit>

UserMessageSubscribersBuilder

typealias UserMessageSubscribersBuilder = MessageSubscribersBuilder<UserMessageEvent, Listener<UserMessageEvent>, Unit, Unit>

Functions

broadcast

suspend fun <E : Event> E.broadcast(): E

广播一个事件的唯一途径.

globalEventChannel

fun CoroutineScope.globalEventChannel(coroutineContext: CoroutineContext = EmptyCoroutineContext): EventChannel<Event>

在此 CoroutineScope 下创建一个监听所有事件的 EventChannel. 相当于 GlobalEventChannel.parentScope(this).context(coroutineContext).

nextEvent

inline suspend fun <E : Event> EventChannel<*>.nextEvent(priority: EventPriority = EventPriority.NORMAL, noinline filter: suspend (E) -> Boolean = { true }): E

inline suspend fun <E : Event> EventChannel<*>.nextEvent(priority: EventPriority = EventPriority.NORMAL, intercept: Boolean = false, noinline filter: suspend (E) -> Boolean = { true }): E

挂起当前协程, 直到监听到事件 E 的广播并通过 filter, 返回这个事件实例.

registerTo

inline fun <T : ListenerHost> T.registerTo(eventChannel: EventChannel<*>)

反射得到所有标注了 EventHandler 的函数 (Java 为方法), 并注册为事件监听器

selectMessages

inline suspend fun <T : MessageEvent, R> T.selectMessages(timeoutMillis: Long = -1, filterContext: Boolean = true, priority: EventPriority = EventPriority.MONITOR, crossinline selectBuilder: MessageSelectBuilder<T, R>.() -> Unit): R

挂起当前协程, 等待任意一个事件监听器触发后返回其返回值.

selectMessagesUnit

@MiraiExperimentalApi

@JvmName(name = "selectMessages1")

inline suspend fun <T : MessageEvent> T.selectMessagesUnit(timeoutMillis: Long = -1, filterContext: Boolean = true, priority: EventPriority = EventPriority.MONITOR, crossinline selectBuilder: MessageSelectBuilderUnit<T, Unit>.() -> Unit)

selectMessages 的 Unit 返回值捷径 (由于 Kotlin 无法推断 Unit 类型)

inline fun <BaseEvent : Event, E : Event> EventChannel<BaseEvent>.subscribe(crossinline handler: (E) -> ListeningStatus, priority: EventPriority = EventPriority.NORMAL, concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT, coroutineContext: CoroutineContext = EmptyCoroutineContext): Listener<E>

inline fun <BaseEvent : Event, E : Event> EventChannel<BaseEvent>.subscribe(crossinline handler: suspend E.(E) -> ListeningStatus, priority: EventPriority = EventPriority.NORMAL, concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT, coroutineContext: CoroutineContext = EmptyCoroutineContext): Listener<E>

支持 Kotlin 带接收者的挂起函数的函数引用的监听方式.

inline fun <BaseEvent : Event, E : Event> EventChannel<BaseEvent>.subscribe(crossinline handler: E.(E) -> ListeningStatus, priority: EventPriority = EventPriority.NORMAL, concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT, coroutineContext: CoroutineContext = EmptyCoroutineContext): Listener<E>

支持 Kotlin 带接收者的函数的函数引用的监听方式.

@JvmName(name = "subscribe1")

inline fun <BaseEvent : Event, E : Event> EventChannel<BaseEvent>.subscribe(crossinline handler: suspend (E) -> ListeningStatus, priority: EventPriority = EventPriority.NORMAL, concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT, coroutineContext: CoroutineContext = EmptyCoroutineContext): Listener<E>

支持 Kotlin 挂起函数的函数引用的监听方式.

subscribeAlways

inline fun <BaseEvent : Event, E : Event> EventChannel<BaseEvent>.subscribeAlways(crossinline handler: (E) -> Unit, priority: EventPriority = EventPriority.NORMAL, concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT, coroutineContext: CoroutineContext = EmptyCoroutineContext): Listener<E>

inline fun <BaseEvent : Event, E : Event> EventChannel<BaseEvent>.subscribeAlways(crossinline handler: suspend E.(E) -> Unit, priority: EventPriority = EventPriority.NORMAL, concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT, coroutineContext: CoroutineContext = EmptyCoroutineContext): Listener<E>

支持 Kotlin 带接收者的挂起函数的函数引用的监听方式.

inline fun <BaseEvent : Event, E : Event> EventChannel<BaseEvent>.subscribeAlways(crossinline handler: E.(E) -> Unit, priority: EventPriority = EventPriority.NORMAL, concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT, coroutineContext: CoroutineContext = EmptyCoroutineContext): Listener<E>

支持 Kotlin 带接收者的函数的函数引用的监听方式.

@JvmName(name = "subscribeAlways1")

inline fun <BaseEvent : Event, E : Event> EventChannel<BaseEvent>.subscribeAlways(crossinline handler: suspend (E) -> Unit, priority: EventPriority = EventPriority.NORMAL, concurrency: ConcurrencyKind = ConcurrencyKind.CONCURRENT, coroutineContext: CoroutineContext = EmptyCoroutineContext): Listener<E>

支持 Kotlin 挂起函数的函数引用的监听方式.

subscribeFriendMessages

fun <R> EventChannel<*>.subscribeFriendMessages(coroutineContext: CoroutineContext = EmptyCoroutineContext, concurrencyKind: ConcurrencyKind = CONCURRENT, priority: EventPriority = EventPriority.MONITOR, listeners: FriendMessageSubscribersBuilder.() -> R): R

通过 DSL 订阅来自所有 Bot 的所有好友消息事件. DSL 语法查看 subscribeMessages.

subscribeGroupMessages

fun <R> EventChannel<*>.subscribeGroupMessages(coroutineContext: CoroutineContext = EmptyCoroutineContext, concurrencyKind: ConcurrencyKind = CONCURRENT, priority: EventPriority = EventPriority.MONITOR, listeners: GroupMessageSubscribersBuilder.() -> R): R

通过 DSL 订阅来自所有 Bot 的所有群会话消息事件. DSL 语法查看 subscribeMessages.

subscribeGroupTempMessages

fun <R> EventChannel<*>.subscribeGroupTempMessages(coroutineContext: CoroutineContext = EmptyCoroutineContext, concurrencyKind: ConcurrencyKind = CONCURRENT, priority: EventPriority = EventPriority.MONITOR, listeners: GroupTempMessageSubscribersBuilder.() -> R): R

通过 DSL 订阅来自所有 Bot 的所有 GroupTempMessageEvent. DSL 语法查看 subscribeMessages.

subscribeMessages

fun <R> EventChannel<*>.subscribeMessages(coroutineContext: CoroutineContext = EmptyCoroutineContext, concurrencyKind: ConcurrencyKind = CONCURRENT, priority: EventPriority = EventPriority.MONITOR, listeners: MessageEventSubscribersBuilder.() -> R): R

通过 DSL 订阅来自所有 Bot 的所有联系人的消息事件.

subscribeOtherClientMessages

fun <R> EventChannel<*>.subscribeOtherClientMessages(coroutineContext: CoroutineContext = EmptyCoroutineContext, concurrencyKind: ConcurrencyKind = CONCURRENT, priority: EventPriority = EventPriority.MONITOR, listeners: OtherClientMessageSubscribersBuilder.() -> R): R

通过 DSL 订阅来自所有 Bot 的所有 OtherClient 消息事件. DSL 语法查看 subscribeMessages.

subscribeStrangerMessages

fun <R> EventChannel<*>.subscribeStrangerMessages(coroutineContext: CoroutineContext = EmptyCoroutineContext, concurrencyKind: ConcurrencyKind = CONCURRENT, priority: EventPriority = EventPriority.MONITOR, listeners: StrangerMessageSubscribersBuilder.() -> R): R

通过 DSL 订阅来自所有 Bot 的所有 Stranger 消息事件. DSL 语法查看 subscribeMessages.

subscribeUserMessages

fun <R> EventChannel<*>.subscribeUserMessages(coroutineContext: CoroutineContext = EmptyCoroutineContext, concurrencyKind: ConcurrencyKind = CONCURRENT, priority: EventPriority = EventPriority.MONITOR, listeners: UserMessageSubscribersBuilder.() -> R): R

通过 DSL 订阅来自所有 Bot 的所 User 消息事件. DSL 语法查看 subscribeMessages.

syncFromEvent

inline suspend fun <E : Event, R : Any> EventChannel<*>.syncFromEvent(priority: EventPriority = EventPriority.NORMAL, noinline mapper: suspend (E) -> R?): R

挂起当前协程, 监听事件 E, 并尝试从这个事件中获取一个值, 在超时时抛出 TimeoutCancellationException

whileSelectMessages

inline suspend fun <T : MessageEvent> T.whileSelectMessages(timeoutMillis: Long = -1, filterContext: Boolean = true, priority: EventPriority = EventPriority.MONITOR, crossinline selectBuilder: MessageSelectBuilder<T, Boolean>.() -> Unit)

挂起当前协程, 等待任意一个事件监听器返回 false 后返回.