kord-core/dev.kord.core.event.guild/InviteDeleteEvent

InviteDeleteEvent

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

Sent when an invite is deleted.

Constructors

InviteDeleteEvent

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

Properties

channel

val channel: ChannelBehavior

The behavior of the Channel the invite is for.

channelId

val channelId: Snowflake

The id of the Channel the invite is for.

code

val code: String

The unique invite code.

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: InviteDeleteData

gateway

open val gateway: Gateway

The Gateway that spawned this event.

guild

val guild: GuildBehavior?

The behavior of the Guild of the invite.

guildId

val guildId: Snowflake?

The id of the Guild of the invite.

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.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

Functions

getChannel

suspend fun getChannel(): Channel

Requests to get the Channel this invite is for.

getChannelOrNull

suspend fun getChannelOrNull(): Channel?

Requests to get the Channel this invite is for, returns null if the channel isn't present.

getGuildOrNull

suspend fun getGuildOrNull(): Guild?

Requests to get the Guild of the invite. returns null if the guild isn't present, or if invite does not target a guild.

toString

open override fun toString(): String

withStrategy

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

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