KookUserOnlineStatusChangedEvent

Kook 用户在线状态变更相关事件的抽象父类。

涉及到的原始事件有:

此事件及相关事件属于 ChangedEvent 事件,变化主体 为相对应的基础用户信息,变更 为其上下线的状态。 其中变更前后的值满足 before == !after, 且 after 永远代表此事件发生后此用户的在线状态。 也因此而满足 after == isOnline.

after == true 时,代表此人由离线状态变为在线状态,反之同理。

变化主体

因为用户在线/离线事件所提供的用户并未一个具体的频道用户,因此事件主体是一个基础的 用户信息

子类型

此事件是密封的,如果你只想监听某人的上线或下线中的其中一种事件,则考虑监听此事件类的具体子类型。

Author

forte

See also

Types

Link copied to clipboard
object Key : BaseEventKey<KookUserOnlineStatusChangedEvent>
Link copied to clipboard

KookUserOnlineStatusChangedEvent 对于用户离线的事件子类型。

Link copied to clipboard

KookUserOnlineStatusChangedEvent 对于用户上线的事件子类型。

Functions

Link copied to clipboard
open suspend override fun after(): Boolean

变更后的在线状态。同 isOnline.

Link copied to clipboard
open suspend override fun before(): Boolean

变更前的在线状态。相当于 !isOnline.

Link copied to clipboard
abstract suspend override fun source(): UserInfo

发生变化的用户信息。

Link copied to clipboard
open override fun toString(): String

Properties

Link copied to clipboard
open val after: Any?
Link copied to clipboard
Link copied to clipboard
open val before: Any?
Link copied to clipboard
Link copied to clipboard
abstract override val bot: KookComponentBot

此事件对应的bot示例。

Link copied to clipboard
open override val changedTime: Timestamp

变更时间。

Link copied to clipboard
open override val component: Component
Link copied to clipboard
abstract val guildIds: List<ID>

此用户与当前bot所同处的频道服务器的id列表。

Link copied to clipboard
abstract val guilds: Sequence<KookGuild?>

通过 guildIds 信息获取各个ID对应的 KookGuild 实例。

Link copied to clipboard
@Api4J
@get:JvmName(name = "getGuilds")
val guildStream: Stream<KookGuild?>

通过 guildIds 信息获取各个ID对应的 KookGuild 实例。

Link copied to clipboard
open override val id: ID
Link copied to clipboard
abstract val isOnline: Boolean

状态变化后,此用户是否为_在线_状态。

Link copied to clipboard
open override val key: Event.Key<out KookUserOnlineStatusChangedEvent>
Link copied to clipboard
open val source: Any
Link copied to clipboard
Link copied to clipboard

sourceEvent 中的 extra.body 信息。

Link copied to clipboard

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

Link copied to clipboard
abstract val timestamp: Timestamp
Link copied to clipboard
open val visibleScope: Event.VisibleScope

Inheritors

Link copied to clipboard
Link copied to clipboard