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

InviteCreateEvent

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

Sent when a new invite to a channel is created.

Constructors

InviteCreateEvent

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

Properties

val channel: ChannelBehavior

The behavior of the Channel the invite is for.

val channelId: Snowflake

The id of the Channel the invite is for.

val code: String

The unique invite code.

val createdAt: Instant

The time at which the invite was created.

open override val customContext: Any?

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

val data: InviteCreateData

open val gateway: Gateway

The Gateway that spawned this event.

val guild: GuildBehavior?

The behavior of the Guild of the invite.

val guildId: Snowflake?

The id of the Guild of the invite.

val inviter: UserBehavior?

The behavior of the User that created the invite.

val inviterId: Snowflake?

The id of the User that created the invite.

val inviterMember: MemberBehavior?

The behavior of the Member that created the invite.

val isTemporary: Boolean

Whether the invite is temporary (invited users will be kicked on disconnect unless they're assigned a role).

open override val kord: Kord

The kord instance that created this object.

val maxAge: Duration

How long the invite is valid for.

val maxUses: Int

The maximum number of times the invite can be used.

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.

targetApplication

val targetApplication: PartialApplication?

The embedded application to open for this voice channel embedded application invite.

val targetMember: MemberBehavior?

The behavior of the Member whose stream to display for this voice channel stream invite.

val targetType: InviteTargetType?

The type of target for this voice channel invite.

val targetUser: UserBehavior?

The behavior of the User whose stream to display for this voice channel stream invite.

val targetUserId: Snowflake?

The id of the User whose stream to display for this voice channel stream invite.

How many times the invite has been used (always will be 0).

Functions

suspend fun delete(reason: String? = null): Invite

Requests to delete this invite.

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.

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.

getInviterAsMemberOrNull

suspend fun getInviterAsMemberOrNull(): Member?

Requests to get the User that created the invite as a Member of the Guild, returns null if the user isn't present, the invite did not target a guild, or no inviter created the event.

getInviterOrNull

suspend fun getInviterOrNull(): User?

Requests to get the User that created the invite, returns null if the user isn't present or no inviter created this invite.

getTargetUserAsMemberOrNull

suspend fun getTargetUserAsMemberOrNull(): Member?

Requests to get the target User of this invite as a Member of the Guild, returns null if the user isn't present, the invite did not target a guild, or the invite did not target a user.

getTargetUserOrNull

suspend fun getTargetUserOrNull(): User?

Requests to get the target User of this invite, returns null if the user isn't present or the invite did not target a user.

open override fun toString(): String

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

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