Skip to main content

Invite

Documentation

Documentation / @discordeno/bot / Invite

Interface: Invite

Defined in: bot/src/transformers/types.ts:1047

Properties​

approximateMemberCount​

approximateMemberCount: number

Defined in: bot/src/transformers/types.ts:1075

Approximate count of online members (only present when target_user is set)

approximatePresenceCount?​

optional approximatePresenceCount: number

Defined in: bot/src/transformers/types.ts:1083

Approximate count of online members (only present when target_user is set)

channelId​

channelId: bigint

Defined in: bot/src/transformers/types.ts:1051

The channel the invite is for

code​

code: string

Defined in: bot/src/transformers/types.ts:1053

The unique invite code

createdAt​

createdAt: number

Defined in: bot/src/transformers/types.ts:1055

The time at which the invite was created

expiresAt?​

optional expiresAt: number

Defined in: bot/src/transformers/types.ts:1079

The expiration date of this invite, returned from the GET /invites/code endpoint when with_expiration is true

guildId?​

optional guildId: bigint

Defined in: bot/src/transformers/types.ts:1057

The guild of the invite

guildScheduledEvent?​

optional guildScheduledEvent: ScheduledEvent

Defined in: bot/src/transformers/types.ts:1081

guild scheduled event data

inviter?​

optional inviter: User

Defined in: bot/src/transformers/types.ts:1059

The user that created the invite

maxAge​

maxAge: number

Defined in: bot/src/transformers/types.ts:1061

How long the invite is valid for (in seconds)

maxUses​

maxUses: number

Defined in: bot/src/transformers/types.ts:1063

The maximum number of times the invite can be used

stageInstance?​

optional stageInstance: InviteStageInstance

Defined in: bot/src/transformers/types.ts:1077

Stage instance data if there is a public Stage instance in the Stage channel this invite is for

targetApplication?​

optional targetApplication: Application

Defined in: bot/src/transformers/types.ts:1069

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

targetType​

targetType: number

Defined in: bot/src/transformers/types.ts:1065

The type of target for this voice channel invite

targetUser​

targetUser: User

Defined in: bot/src/transformers/types.ts:1067

The target user for this invite

temporary​

temporary: boolean

Defined in: bot/src/transformers/types.ts:1071

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

type​

type: DiscordInviteType

Defined in: bot/src/transformers/types.ts:1049

The type of invite

uses​

uses: number

Defined in: bot/src/transformers/types.ts:1073

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