kord-core/dev.kord.core.event.user/PresenceUpdateEvent

PresenceUpdateEvent

class PresenceUpdateEvent(val oldUser: User?, val user: DiscordPresenceUser, val guildId: Snowflake, val old: Presence?, val presence: Presence, val shard: Int, val customContext: Any?, val supplier: EntitySupplier = presence.kord.defaultSupplier) : Event, Strategizable(source)

Constructors

PresenceUpdateEvent

constructor(oldUser: User?, user: DiscordPresenceUser, guildId: Snowflake, old: Presence?, presence: Presence, shard: Int, customContext: Any?, supplier: EntitySupplier = presence.kord.defaultSupplier)

Properties

open override val customContext: Any?

A custom object that can be inserted when creating events. By default, this is just null.

open val gateway: Gateway

The Gateway that spawned this event.

val guild: GuildBehavior

The behavior of the guild in which the presence was updated.

val guildId: Snowflake

open override val kord: Kord

The kord instance that created this object.

val member: MemberBehavior

The behavior of the member whose presence was updated.

val old: Presence?

val oldUser: User?

val presence: Presence

open override val shard: Int

The shard number of the gateway that spawned this event.

open override val supplier: EntitySupplier

The supplier used to request entities.

val user: DiscordPresenceUser

Functions

suspend fun getGuild(): Guild

Requests to get the guild in which the presence was updated.

suspend fun getGuildOrNull(): Guild?

Requests to get the guild in which the presence was updated, returns null if the guild isn't present.

suspend fun getMember(): Member

Requests to get the member whose presence was updated.

getMemberOrNull

suspend fun getMemberOrNull(): Member?

Requests to get the member whose presence was updated, returns null if the member isn't present.

suspend fun getUser(): User

Requests to get the user whose presence was updated.

suspend fun getUserOrNull(): User?

Requests to get the user whose presence was updated, returns null if the user isn't present.

open override fun toString(): String

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): PresenceUpdateEvent

Returns a copy of this class with a new supplier provided by the strategy.