Skip to main content

DiscordInvite

@discordeno/botDocs


Documentation / @discordeno/bot / DiscordInvite

Interface: DiscordInvite

https://discord.com/developers/docs/resources/invite#invite-object

Extended by

Properties

approximate_member_count?

optional approximate_member_count: number

Approximate count of total members

Defined in

packages/types/dist/types/discord.d.ts:2399


approximate_presence_count?

optional approximate_presence_count: number

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

Defined in

packages/types/dist/types/discord.d.ts:2397


channel

channel: null | Partial<DiscordChannel>

The channel this invite is for

Defined in

packages/types/dist/types/discord.d.ts:2387


code

code: string

The invite code (unique Id)

Defined in

packages/types/dist/types/discord.d.ts:2383


expires_at?

optional expires_at: null | string

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

Defined in

packages/types/dist/types/discord.d.ts:2401


guild?

optional guild: Partial<DiscordGuild>

The guild this invite is for

Defined in

packages/types/dist/types/discord.d.ts:2385


guild_scheduled_event?

optional guild_scheduled_event: DiscordScheduledEvent

guild scheduled event data

Defined in

packages/types/dist/types/discord.d.ts:2405


inviter?

optional inviter: DiscordUser

The user who created the invite

Defined in

packages/types/dist/types/discord.d.ts:2389


stage_instance?

optional stage_instance: DiscordInviteStageInstance

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

Defined in

packages/types/dist/types/discord.d.ts:2403


target_application?

optional target_application: Partial<DiscordApplication>

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

Defined in

packages/types/dist/types/discord.d.ts:2395


target_type?

optional target_type: TargetTypes

The type of target for this voice channel invite

Defined in

packages/types/dist/types/discord.d.ts:2391


target_user?

optional target_user: DiscordUser

The target user for this invite

Defined in

packages/types/dist/types/discord.d.ts:2393


type

type: DiscordInviteType

The type of invite

Defined in

packages/types/dist/types/discord.d.ts:2381