Skip to main content

Invite

Documentation

Documentation / @discordeno/bot / Invite

Interface: Invite

Defined in: transformers/types.ts:1193

Properties​

approximateMemberCount​

approximateMemberCount: number

Defined in: transformers/types.ts:1221

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

approximatePresenceCount?​

optional approximatePresenceCount?: number

Defined in: transformers/types.ts:1227

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

channelId​

channelId: bigint

Defined in: transformers/types.ts:1197

The channel the invite is for

code​

code: string

Defined in: transformers/types.ts:1199

The unique invite code

createdAt​

createdAt: number

Defined in: transformers/types.ts:1201

The time at which the invite was created

expiresAt?​

optional expiresAt?: number

Defined in: transformers/types.ts:1223

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

Guild invite flags for guild invites.

guildId?​

optional guildId?: bigint

Defined in: transformers/types.ts:1203

The guild of the invite

guildScheduledEvent?​

optional guildScheduledEvent?: ScheduledEvent

Defined in: transformers/types.ts:1225

guild scheduled event data

inviter?​

optional inviter?: User

Defined in: transformers/types.ts:1205

The user that created the invite

maxAge​

maxAge: number

Defined in: transformers/types.ts:1207

How long the invite is valid for (in seconds)

maxUses​

maxUses: number

Defined in: transformers/types.ts:1209

The maximum number of times the invite can be used

roles?​

optional roles?: Pick<Role, "id" | "position" | "name" | "icon" | "color" | "colors" | "unicodeEmoji">[]

Defined in: transformers/types.ts:1233

The roles assigned to the user upon accepting the invite

targetApplication?​

optional targetApplication?: Partial<Application>

Defined in: transformers/types.ts:1215

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

targetType?​

optional targetType?: TargetTypes

Defined in: transformers/types.ts:1211

The type of target for this voice channel invite

targetUser?​

optional targetUser?: User

Defined in: transformers/types.ts:1213

The target user for this invite

temporary​

temporary: boolean

Defined in: transformers/types.ts:1217

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

The type of invite

uses​

uses: number

Defined in: transformers/types.ts:1219

How many times the invite has been used