Skip to main content

Invite

Documentation

Documentation / @discordeno/bot / Invite

Interface: Invite

Defined in: transformers/types.ts:1108

Properties​

approximateMemberCount​

approximateMemberCount: number

Defined in: transformers/types.ts:1136

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

approximatePresenceCount?​

optional approximatePresenceCount: number

Defined in: transformers/types.ts:1142

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

channelId​

channelId: bigint

Defined in: transformers/types.ts:1112

The channel the invite is for

code​

code: string

Defined in: transformers/types.ts:1114

The unique invite code

createdAt​

createdAt: number

Defined in: transformers/types.ts:1116

The time at which the invite was created

expiresAt?​

optional expiresAt: number

Defined in: transformers/types.ts:1138

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

flags?​

optional flags: ToggleBitfield

Defined in: transformers/types.ts:1144

Guild invite flags for guild invites.

guildId?​

optional guildId: bigint

Defined in: transformers/types.ts:1118

The guild of the invite

guildScheduledEvent?​

optional guildScheduledEvent: ScheduledEvent

Defined in: transformers/types.ts:1140

guild scheduled event data

inviter?​

optional inviter: User

Defined in: transformers/types.ts:1120

The user that created the invite

maxAge​

maxAge: number

Defined in: transformers/types.ts:1122

How long the invite is valid for (in seconds)

maxUses​

maxUses: number

Defined in: transformers/types.ts:1124

The maximum number of times the invite can be used

roles?​

optional roles: Role[]

Defined in: transformers/types.ts:1148

The roles assigned to the user upon accepting the invite

targetApplication?​

optional targetApplication: Application

Defined in: transformers/types.ts:1130

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

targetType​

targetType: number

Defined in: transformers/types.ts:1126

The type of target for this voice channel invite

targetUser​

targetUser: User

Defined in: transformers/types.ts:1128

The target user for this invite

temporary​

temporary: boolean

Defined in: transformers/types.ts:1132

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: transformers/types.ts:1110

The type of invite

uses​

uses: number

Defined in: transformers/types.ts:1134

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