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

MessageSubscribersBuilder

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

消息订阅构造器

Parameters

消息类型

消息监听器内部的返回值

Ret

每个 DSL 函数创建监听器之后的返回值

Types

ListeningFilter

inner class ListeningFilter

由 contains, startsWith 等 DSL 创建出的监听条件, 使用 invoke 将其注册给事件

Functions

always

open fun always(onEvent: MessageListener<M, RR>): Ret

无触发条件, 每次收到消息都执行 onEvent

fun at(target: Long): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun at(target: User): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容包含目标为 target 的 At

atAll

fun atAll(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容包含 AtAll

atBot

fun atBot(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容包含目标为 Bot 的 At

fun atBot(onEvent: suspend M.(String) -> R): Ret

消息内容包含目标为 Bot 的 At, 就执行 onEvent

case

fun case( equals: String, ignoreCase: Boolean = false, trim: Boolean = true): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun case( equals: String, ignoreCase: Boolean = false, trim: Boolean = true, onEvent: MessageListener<M, R>): Ret

消息内容==equals

contains

@JvmOverloads

fun contains(sub: String, ignoreCase: Boolean = false): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容包含 sub

fun contains( sub: String, ignoreCase: Boolean = false, trim: Boolean = true, onEvent: MessageListener<M, R>): Ret

消息内容包含 sub 中的任意一个元素

containsAll

@JvmOverloads

fun containsAll( vararg sub: String, ignoreCase: Boolean = false, trim: Boolean = true): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容包含 sub

containsAny

@JvmOverloads

fun containsAny( vararg sub: String, ignoreCase: Boolean = false, trim: Boolean = true): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容包含 sub

containsReply

open infix fun String.containsReply(reply: String): Ret

消息内容包含 this 则回复 reply

open infix fun String.containsReply(replier: suspend M.(String) -> Any?): Ret

消息内容包含 this 则执行 replier 并将其返回值回复给发信对象.

content

fun content(filter: M.(String) -> Boolean): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

如果 filter 返回 true

endsWith

@JvmOverloads

fun endsWith(suffix: String, trim: Boolean = true): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun endsWith( suffix: String, removeSuffix: Boolean = true, trim: Boolean = true, onEvent: suspend M.(String) -> R): Ret

如果消息的结尾是 suffix

endsWithReply

open infix fun String.endsWithReply(replier: suspend M.(String) -> Any?): Ret

不考虑空格, 消息内容以 this 结尾则执行 replier 并将其返回值回复给发信对象.

finding

fun finding(regex: Regex): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容可由正则表达式查找(Regex.find)

@JvmName(name = "findingExtension")

infix fun Regex.finding(block: suspend M.(MatchResult) -> R): Ret

如果消息内容 Regex.find 不为空

fun finding(regex: Regex, onEvent: suspend M.(MatchResult) -> Unit): Ret

消息内容可由正则表达式查找(Regex.find), 就执行 onEvent

findingReply

open infix fun Regex.findingReply(replier: suspend M.(MatchResult) -> Any?): Ret

消息内容可由正则表达式查找(Regex.find), 则执行 replier 并将其返回值回复给发信对象.

has

inline fun <N : SingleMessage> has(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容包含 N 类型的 Message

inline fun <N : SingleMessage> has(noinline onEvent: suspend M.(N) -> R): Ret

invoke

operator fun String.invoke(block: MessageListener<M, R>): Ret

如果消息内容==equals

mapping

open fun <N : Any> mapping(mapper: M.(String) -> N?, onEvent: suspend M.(N) -> R): Ret

如果 mapper 返回值非空, 就执行 onEvent

matching

fun matching(regex: Regex): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

消息内容可由正则表达式匹配(Regex.matchEntire)

@JvmName(name = "matchingExtension")

infix fun Regex.matching(block: MessageListener<M, R>): Ret

如果消息内容 matches

fun matching(regex: Regex, onEvent: suspend M.(MatchResult) -> Unit): Ret

消息内容可由正则表达式匹配(Regex.matchEntire), 就执行 onEvent

matchingReply

open infix fun Regex.matchingReply(replier: suspend M.(MatchResult) -> Any?): Ret

消息内容可由正则表达式匹配(Regex.matchEntire), 则执行 replier 并将其返回值回复给发信对象.

newListeningFilter

open fun newListeningFilter(filter: M.(String) -> Boolean): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

quoteReply

open infix fun MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>.quoteReply(toReply: String): Ret

open infix fun MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>.quoteReply(toReply: Message): Ret

启动监听器, 在 Bot 未被禁言且消息满足条件 this 时引用回复原消息

open infix fun MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>.quoteReply(replier: suspend M.(String) -> Any?): Ret

启动监听器, 在 Bot 未被禁言且消息满足条件 this 时执行 replier 并以其返回值回复原消息返回值 Unit 将被忽略, Message 将被直接回复, 其他内容将会 Any.toString 后发送

open infix fun String.reply(reply: String): Ret

open infix fun String.reply(reply: Message): Ret

当发送的消息内容为 this 就回复 reply

open infix fun String.reply(replier: suspend M.(String) -> Any?): Ret

当发送的消息内容为 this 就执行并回复 replier 的返回值

open infix fun MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>.reply(toReply: String): Ret

open infix fun MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>.reply(message: Message): Ret

启动监听器, 在 Bot 未被禁言且消息满足条件 this 时回复原消息

open infix fun MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>.reply(replier: suspend M.(String) -> Any?): Ret

启动监听器, 在 Bot 未被禁言且消息满足条件 this 时执行 replier 并以其返回值回复. 返回值 Unit 将被忽略, Message 将被直接回复, 其他内容将会 Any.toString 后发送.

sentBy

fun sentBy(qq: Long): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun sentBy(friend: User): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun sentBy(qq: Long, onEvent: MessageListener<M, R>): Ret

如果是这个人发的消息. 消息可以是好友消息也可以是群消息

fun sentBy(name: String): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

如果是这个人发的消息. 消息目前只会是群消息

sentByAdministrator

fun sentByAdministrator(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

如果是管理员发的消息

sentByFriend

fun sentByFriend(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun sentByFriend(onEvent: MessageListener<FriendMessageEvent, R>): Ret

如果是好友发来的消息

sentByGroupTemp

fun sentByGroupTemp(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

如果是群临时会话消息

sentByOperator

fun sentByOperator(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

如果是管理员或群主发的消息

sentByOwner

fun sentByOwner(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

如果是群主发的消息

sentByStranger

fun sentByStranger(): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun sentByStranger(onEvent: MessageListener<StrangerMessageEvent, R>): Ret

如果是陌生人发来的消息

sentFrom

fun sentFrom(groupId: Long): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun sentFrom(group: Group): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

如果是来自这个群的消息

startsWith

fun startsWith(prefix: String, trim: Boolean = true): MessageSubscribersBuilder.ListeningFilter<M, Ret, R, RR>

fun startsWith( prefix: String, removePrefix: Boolean = true, trim: Boolean = true, onEvent: suspend M.(String) -> R): Ret

如果消息的前缀是 prefix

Properties

subscriber

val subscriber: (M.(String) -> Boolean, MessageListener<M, RR>) -> Ret

invoke 这个 lambda 时, 它将会把消息事件的处理器注册给事件, 并返回注册完成返回的监听器.

Inheritors

CommonMessageSelectBuilderUnit

MessageSubscribersBuilder

See also

Parameters

Types

Functions

Properties

Inheritors