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

RequestEvent

interface RequestEvent : Event, UserInfoContainer(source)

与请求有关的事件。

常见情况下，一个请求可能有两种情况：

外界向当前bot为某种目的而发出的申请。比如一个入群申请、好友添加申请。
外界向当前bot所发出的一种邀请。比如对BOT的入群邀请。

一个请求可能会有一些附加信息, 例如一些属性或者文本消息。目前提供了一个 message 来代表一次申请中可能存在的 文本消息。如果实现实现不支持此属性或者属性为空，将得到null。

Author

ForteScarlet

See also

JoinRequestEvent

Inheritors

JoinRequestEvent

GuildRequestEvent

GroupRequestEvent

ChannelRequestEvent

UserRequestEvent

Types

object Key : BaseEventKey<RequestEvent>

enum Type : Enum<RequestEvent.Type>

RequestEvent 的类型。

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

同意/接受此次请求。

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

abstract suspend override fun user(): UserInfo

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

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

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