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

FriendRequestEvent

interface FriendRequestEvent : UserRequestEvent, FriendInfoContainer(source)

一个好友申请。请求事件不能保证能够得到完整的 Friend 对象，但是应尽可能提供基本的用户信息 FriendInfo.

Inheritors

FriendAddRequestEvent

Types

object Key : BaseEventKey<FriendRequestEvent>

Properties

abstract override val bot: Bot

当前Bot。

open override val component: Component

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

abstract override val id: ID

事件标识。

abstract val key: Event.Key<out Event>

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

abstract val message: String?

一个申请事件可能会存在附加的文本消息。

abstract val timestamp: Timestamp

此时间发生的时间戳。

abstract val type: RequestEvent.Type

此申请的类型。

Functions

@ExperimentalSimbotApi

abstract suspend fun accept(): Boolean

同意/接受此次请求。

abstract suspend fun friend(): FriendInfo

当前 friend.

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

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

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

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

@ExperimentalSimbotApi

abstract suspend fun reject(): Boolean

拒绝/回绝此次请求。

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

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

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

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

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

abstract suspend fun requester(): UserInfo

这个请求的 申请人。

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

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

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

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

abstract suspend override fun user(): UserInfo

通常情况下, user 等同于 requester.

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

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