simbot-component-kook-core/love.forte.simbot.component.kook.event/KookMessagePinEvent

KookMessagePinEvent

@BaseEvent

abstract class KookMessagePinEvent<Body : ChannelEventExtraBody> : KookChannelChangedEvent<Body> , ChangedEvent, ChannelInfoContainer

与频道消息置顶相关的事件。涉及的原始事件有：

此事件为 ChangedEvent, 事件源为发生事件的频道服务器，变动主体为被设置为置顶消息 的ID。由于事件无法确定变更前的消息，因此此事件的实现子事件中，before 和 after 只可能有一个不为null。

如果你只关心相关消息的ID，可以直接使用 msgId 属性获取。

Constructors

KookMessagePinEvent

fun KookMessagePinEvent()

Types

Key

object Key : BaseEventKey<KookMessagePinEvent<*>>

Functions

after

abstract suspend override fun after(): ID?

变更后ID。如果此事件是 KookUnpinnedMessageEvent, 则有值，否则为null。有值时同 msgId.

before

abstract suspend override fun before(): ID?

变更前ID。如果此事件是 KookUnpinnedMessageEvent, 则有值，否则为null。有值时同 msgId.

channel

abstract suspend override fun channel(): KookChannel

此事件涉及的频道信息。

queryMsg

suspend fun queryMsg(): MessageContent

通过 msgId 查询这条被置顶的消息。

source

abstract suspend override fun source(): KookGuild

此事件涉及的频道所属的频道服务器。

toString

open override fun toString(): String

Properties

after

open val after: Any?

afterAsync

open val afterAsync: CompletableFuture<out Any?>

before

open val before: Any?

beforeAsync

open val beforeAsync: CompletableFuture<out Any?>

bot

abstract override val bot: KookComponentBot

此事件对应的bot示例。

changedTime

open override val changedTime: Timestamp

channel

open val channel: ChannelInfo

channelAsync

open val channelAsync: CompletableFuture<out ChannelInfo>

channelId

abstract val channelId: ID

涉及频道ID

component

open override val component: Component

open override val id: ID

key

open override val key: Event.Key<out KookMessagePinEvent<*>>

msgId

abstract val msgId: ID

涉及消息的ID

operator

abstract val operator: KookGuildMember?

此事件涉及的操作者。会通过 operatorId 获取。

operatorId

abstract val operatorId: ID

操作人ID

source

open val source: Any

sourceAsync

open val sourceAsync: CompletableFuture<out Any>

sourceBody

open val sourceBody: Body

sourceEvent 中的 extra.body 信息。

sourceEvent

abstract val sourceEvent: Event<Event.Extra.Sys<Body>>

当前事件内部对应的原始事件实体。

timestamp

abstract val timestamp: Timestamp

visibleScope

open val ~~visibleScope~~: Event.VisibleScope

Inheritors

KookPinnedMessageEvent

KookUnpinnedMessageEvent