kord-core/dev.kord.core.entity/InviteWithMetadata

InviteWithMetadata

class InviteWithMetadata(val data: InviteWithMetadataData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : Invite(source)

An instance of a Discord Invite with extra information.

Constructors

InviteWithMetadata

constructor(data: InviteWithMetadataData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

approximateMemberCount

val approximateMemberCount: Int?

Approximate count of total members.

approximatePresenceCount

val approximatePresenceCount: Int?

Approximate count of online members.

channel

val channel: ChannelBehavior?

The behavior of the channel this invite is for.

channelId

val channelId: Snowflake?

The id of the channel this invite is for.

code

val code: String

The unique code of this invite.

createdAt

val createdAt: Instant

When this invite was created.

data

open override val data: InviteWithMetadataData

expiresAt

val expiresAt: Instant?

The expiration date of this invite.

guildScheduledEvent

val guildScheduledEvent: GuildScheduledEvent?

The event this invite is for.

inviter

val inviter: UserBehavior?

The user behavior of the user who created this invite, if present.

inviterId

val inviterId: Snowflake?

The id of the user who created this invite, if present.

kord

override val kord: Kord

The kord instance that created this object.

maxAge

val maxAge: Duration

Duration after which the invite expires.

maxUses

val maxUses: Int

Max number of times this invite can be used.

partialGuild

val partialGuild: PartialGuild?

Returns PartialGuild if this invite is for a guild.

supplier

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.

targetType

val targetType: InviteTargetType?

The type of target for this voice channel invite.

targetUser

val targetUser: UserBehavior?

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

targetUserId

val targetUserId: Snowflake?

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

temporary

val temporary: Boolean

Whether this invite only grants temporary membership.

uses

val uses: Int

Number of times this invite has been used.

Functions

delete

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

Requests to delete this invite.

getChannelOrNull

suspend fun getChannelOrNull(): Channel?

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

getInviterOrNull

suspend fun getInviterOrNull(): User?

Requests to get the creator of the invite for, returns null if the User isn't present or inviterId is null.

getTargetUserOrNull

suspend fun getTargetUserOrNull(): User?

Requests to get the user this invite was created for, returns null if the User isn't present or targetUserId is null.

toString

open override fun toString(): String

withStrategy

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

Returns a new InviteWithMetadata with the given strategy.