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

FriendEvent

@BaseEvent

interface FriendEvent : UserEvent, FriendInfoContainer

一个与好友相关的事件。

Types

Key

object Key : BaseEventKey<FriendEvent>

Functions

friend

abstract suspend override fun friend(): Friend

这个好友

user

abstract suspend override fun user(): Friend

这个好友

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。

timestamp

abstract val timestamp: Timestamp

此时间发生的时间戳。

Inheritors

FriendChangedEvent

FriendMessageEvent

Extensions

inFriend

inline suspend fun <R> FriendEvent.inFriend(block: Friend.() -> R): R

inFriendInfo

inline suspend fun <R> FriendInfoContainer.inFriendInfo(block: FriendInfo.() -> R): R

将 FriendInfoContainer 中的 friend 作为 block 中的接收者使用。

inUser

inline suspend fun <R> UserEvent.inUser(block: User.() -> R): R

inUserInfo

inline suspend fun <R> UserInfoContainer.inUserInfo(block: UserInfo.() -> R): R

将 UserInfoContainer 中的 user 作为 block 中的接收者使用。

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 是否一致。

useFriend

inline suspend fun <R> FriendEvent.useFriend(block: (Friend) -> R): R

useFriendInfo

inline suspend fun <R> FriendInfoContainer.useFriendInfo(block: (FriendInfo) -> R): R

将 FriendInfoContainer 中的 friend 作为 block 中的参数使用。

useUser

inline suspend fun <R> UserEvent.useUser(block: (User) -> R): R

useUserInfo

inline suspend fun <R> UserInfoContainer.useUserInfo(block: (UserInfo) -> R): R

将 UserInfoContainer 中的 user 作为 block 中的参数使用。