simbot-api/love.forte.simbot.event/GroupMessageEvent

GroupMessageEvent

interface GroupMessageEvent : ChatRoomMessageEvent, GroupEvent

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

Types

Key

object Key : BaseEventKey<GroupMessageEvent>

Functions

author

abstract suspend fun author(): Member

这个消息的发送者.

group

abstract suspend override fun group(): Group

这个群

organization

abstract suspend fun organization(): Organization

这个组织

open suspend fun reply(text: String): MessageReceipt

open suspend fun reply(message: MessageContent): MessageReceipt

回复当前目标，并得到一个回复回执

abstract suspend override fun reply(message: Message): MessageReceipt

回复此事件。

source

abstract suspend override fun source(): Group

消息来自的群。

Properties

bot

abstract override val bot: Bot

与这个事件有关系的 Bot.

component

open override val component: Component

一个事件所属的组件。通常与 bot 的组件所属一致。

abstract override val id: ID

事件的唯一标识。

key

abstract val key: Event.Key<out Event>

得到当前事件所对应的类型key。

messageContent

abstract override val messageContent: ReceivedMessageContent

当前消息事件的消息正文。

timestamp

abstract val timestamp: Timestamp

此时间发生的时间戳。

Extensions

inAuthor

inline suspend fun <R> ChatRoomMessageEvent.inAuthor(block: Member.() -> R): R

inGroup

inline suspend fun <R> GroupEvent.inGroup(block: Group.() -> R): R

inGroupInfo

inline suspend fun <R> GroupInfoContainer.inGroupInfo(block: GroupInfo.() -> R): R

将 GroupInfoContainer 中的 group 作为 block 中的接收者使用。

inOrganization

inline suspend fun <R> OrganizationEvent.inOrganization(block: Organization.() -> R): R

replyIfSupport

suspend fun Event.replyIfSupport(message: Message): MessageReceipt?

suspend fun Event.replyIfSupport(message: () -> Message): MessageReceipt?

suspend fun Event.replyIfSupport(message: MessageContent): MessageReceipt?

suspend fun Event.replyIfSupport(message: String): MessageReceipt?

如果此事件允许回复消息，发送，否则得到null。

sameIdWith

infix fun IDContainer.sameIdWith(other: IDContainer): Boolean

比较两个 IDContainer 的 IDContainer.id 是否一致。

useAuthor

inline suspend fun <R> ChatRoomMessageEvent.useAuthor(block: (Member) -> R): R

useGroup

inline suspend fun <R> GroupEvent.useGroup(block: (Group) -> R): R

useGroupInfo

inline suspend fun <R> GroupInfoContainer.useGroupInfo(block: (GroupInfo) -> R): R

将 GroupInfoContainer 中的 group 作为 block 中的参数使用。

useOrganization

inline suspend fun <R> OrganizationEvent.useOrganization(block: (Organization) -> R): R