mirai-core-api/net.mamoe.mirai.event/Listener

Listener

@NotStableForInheritance

interface Listener<in E : Event> : CompletableJob

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

取消监听: complete

Functions

attachChild

abstract fun attachChild(child: ChildJob): ChildHandle

cancel

~~open~~ ~~fun~~ ~~cancel~~()

~~abstract~~ ~~fun~~ ~~cancel~~(~~cause~~: Throwable?): Boolean

abstract fun cancel(cause: CancellationException?)

complete

abstract fun complete(): Boolean

completeExceptionally

abstract fun completeExceptionally(exception: Throwable): Boolean

fold

open override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R

get

open operator override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E?

getCancellationException

abstract fun getCancellationException(): CancellationException

invokeOnCompletion

abstract fun invokeOnCompletion(handler: CompletionHandler): DisposableHandle

abstract fun invokeOnCompletion(onCancelling: Boolean, invokeImmediately: Boolean, handler: CompletionHandler): DisposableHandle

join

abstract suspend fun join()

minusKey

open override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext

onEvent

abstract suspend fun onEvent(event: E): ListeningStatus

这个方法将会调用 EventChannel.subscribe 时提供的参数 noinline handler: suspend E.(E) -> ListeningStatus.

plus

open operator fun plus(context: CoroutineContext): CoroutineContext

~~open~~ ~~operator~~ ~~fun~~ ~~plus~~(~~other~~: Job): Job

start

abstract fun start(): Boolean

Properties

children

abstract val children: Sequence<Job>

concurrencyKind

abstract val concurrencyKind: ConcurrencyKind

并发类型

isActive

abstract val isActive: Boolean

isCancelled

abstract val isCancelled: Boolean

isCompleted

abstract val isCompleted: Boolean

key

abstract val key: CoroutineContext.Key<*>

onJoin

abstract val onJoin: SelectClause0

priority

open val priority: EventPriority

事件优先级