BanAddEvent

class BanAddEvent(val user: User, val guildId: Snowflake, val shard: Int, val customContext: Any?, val supplier: EntitySupplier = user.kord.defaultSupplier) : Event, Strategizable(source)

Constructors

Link copied to clipboard
constructor(user: User, guildId: Snowflake, shard: Int, customContext: Any?, supplier: EntitySupplier = user.kord.defaultSupplier)

Properties

Link copied to clipboard
open override val customContext: Any?

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

Link copied to clipboard
open val gateway: Gateway

The Gateway that spawned this event.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val kord: Kord

The kord instance that created this object.

Link copied to clipboard
open override val shard: Int

The shard number of the gateway that spawned this event.

Link copied to clipboard
open override val supplier: EntitySupplier

The supplier used to request entities.

Link copied to clipboard
val user: User

Functions

Link copied to clipboard
suspend fun getBan(): Ban

Requests to get the Ban entity this event represents.

Link copied to clipboard
suspend fun getBanOrNull(): Ban?

Requests to get the Ban entity this event represents.

Link copied to clipboard
suspend fun getGuild(): Guild

Requests to get the Guild this ban happened in.

Link copied to clipboard
suspend fun getGuildOrNull(): Guild?

Requests to get the Guild this ban happened in, returns null if the guild isn't present.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun withStrategy(strategy: EntitySupplyStrategy<*>): BanAddEvent

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