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

JoinRequestEvent

@BaseEvent

interface JoinRequestEvent : RequestEvent

RequestEvent 事件的子类型，代表一个加入申请。

加入申请可能是外人想要进入当前某个组织内，或者由外界的人邀请当前BOT进入他们的某个组织。

假若申请人是当前的bot（例如被邀请加入其他组织），那么理论上来讲应当满足 requester == bot.

对于一个添加请求来讲，申请人不一定是他自己主动发起的，那么就可能存在一个邀请人. inviter 不一定存在，需要参考实现平台是否支持，以及当前申请事件的语境是否真的存在邀请人。

Types

Key

object Key : BaseEventKey<JoinRequestEvent>

Functions

@ExperimentalSimbotApi

abstract suspend fun accept(): Boolean

同意/接受此次请求。

inviter

abstract suspend fun inviter(): UserInfo?

邀请人。当无法获取或不存在时得到null。

reject

@ExperimentalSimbotApi

abstract suspend fun reject(): Boolean

拒绝/回绝此次请求。

requester

abstract suspend override fun requester(): UserInfo

这个添加请求的 申请人。

user

abstract suspend override fun user(): UserInfo

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

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。

message

abstract val message: String?

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

timestamp

abstract val timestamp: Timestamp

此时间发生的时间戳。

type

abstract val type: RequestEvent.Type

此申请的类型。

Inheritors

GuildJoinRequestEvent

GroupJoinRequestEvent

FriendAddRequestEvent

Extensions

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

useUserInfo

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

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