Skip to main content

DiscordInvite

Documentation

Documentation / @discordeno/types / DiscordInvite

Interface: DiscordInvite

Defined in: discord/invite.ts:11

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

Extended by​

Properties​

approximate_member_count?​

optional approximate_member_count?: number

Defined in: discord/invite.ts:31

Approximate count of total members

approximate_presence_count?​

optional approximate_presence_count?: number

Defined in: discord/invite.ts:29

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

channel​

channel: Partial<DiscordChannel> | null

Defined in: discord/invite.ts:19

The channel this invite is for

code​

code: string

Defined in: discord/invite.ts:15

The invite code (unique Id)

expires_at​

expires_at: string | null

Defined in: discord/invite.ts:33

The expiration date of this invite

flags?​

optional flags?: number

Defined in: discord/invite.ts:41

Guild invite flags for guild invites.

See​

DiscordGuildInviteFlags

guild?​

optional guild?: Partial<DiscordGuild>

Defined in: discord/invite.ts:17

The guild this invite is for

guild_scheduled_event?​

optional guild_scheduled_event?: DiscordScheduledEvent

Defined in: discord/invite.ts:35

guild scheduled event data

inviter?​

optional inviter?: DiscordUser

Defined in: discord/invite.ts:21

The user who created the invite

roles?​

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

Defined in: discord/invite.ts:45

The roles assigned to the user upon accepting the invite

target_application?​

optional target_application?: Partial<DiscordApplication>

Defined in: discord/invite.ts:27

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

target_type?​

optional target_type?: TargetTypes

Defined in: discord/invite.ts:23

The type of target for this voice channel invite

target_user?​

optional target_user?: DiscordUser

Defined in: discord/invite.ts:25

The target user for this invite

type​

type: DiscordInviteType

Defined in: discord/invite.ts:13

The type of invite