kord-core/dev.kord.core.event.channel/TypingStartEvent

TypingStartEvent

class TypingStartEvent(val data: TypingStartEventData, val kord: Kord, val shard: Int, val customContext: Any?, val supplier: EntitySupplier = kord.defaultSupplier) : Event, Strategizable(source)

Constructors

TypingStartEvent

constructor(data: TypingStartEventData, kord: Kord, shard: Int, customContext: Any?, supplier: EntitySupplier = kord.defaultSupplier)

Properties

channel

val channel: MessageChannelBehavior

channelId

val channelId: Snowflake

customContext

open override val customContext: Any?

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

data

val data: TypingStartEventData

gateway

open val gateway: Gateway

The Gateway that spawned this event.

guild

val guild: GuildBehavior?

guildId

val guildId: Snowflake?

kord

open override val kord: Kord

The kord instance that created this object.

shard

open override val shard: Int

The shard number of the gateway that spawned this event.

started

val started: Instant

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

user

val user: UserBehavior

userId

val userId: Snowflake

Functions

getChannel

suspend fun getChannel(): MessageChannel

Requests to get the channel triggering the event.

getChannelOrNull

suspend fun getChannelOrNull(): MessageChannel?

Requests to get the channel triggering the event, returns null if the MessageChannel isn't present.

getGuildOrNull

suspend fun getGuildOrNull(): Guild?

Requests to get the guild this event was triggered in, returns null if the Guild isn't present.

getUser

suspend fun getUser(): User

Requests to get the user triggering the event.

getUserOrNull

suspend fun getUserOrNull(): User?

Requests to get the user triggering the event, returns null if the User isn't present.

toString

open override fun toString(): String

withStrategy

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

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