Skip to main content

DiscordInviteMetadata

@discordeno/bot • Docs

Documentation / @discordeno/bot / DiscordInviteMetadata

Interface: DiscordInviteMetadata

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

Extends​

Properties​

approximate_member_count?​

optional approximate_member_count: number

Approximate count of total members

Inherited from​

DiscordInvite.approximate_member_count

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)

Inherited from​

DiscordInvite.approximate_presence_count

Defined in​

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

channel​

channel: null | Partial<DiscordChannel>

The channel this invite is for

Inherited from​

DiscordInvite.channel

Defined in​

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

code​

code: string

The invite code (unique Id)

Inherited from​

DiscordInvite.code

Defined in​

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

created_at​

created_at: string

When this invite was created

Defined in​

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

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

Inherited from​

DiscordInvite.expires_at

Defined in​

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

guild?​

optional guild: Partial<DiscordGuild>

The guild this invite is for

Inherited from​

DiscordInvite.guild

Defined in​

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

guild_scheduled_event?​

optional guild_scheduled_event: DiscordScheduledEvent

guild scheduled event data

Inherited from​

DiscordInvite.guild_scheduled_event

Defined in​

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

inviter?​

optional inviter: DiscordUser

The user who created the invite

Inherited from​

DiscordInvite.inviter

Defined in​

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

max_age​

max_age: number

Duration (in seconds) after which the invite expires

Defined in​

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

max_uses​

max_uses: number

Max number of times this invite can be used

Defined in​

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

stage_instance?​

optional stage_instance: DiscordInviteStageInstance

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

Inherited from​

DiscordInvite.stage_instance

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

Inherited from​

DiscordInvite.target_application

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

Inherited from​

DiscordInvite.target_type

Defined in​

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

target_user?​

optional target_user: DiscordUser

The target user for this invite

Inherited from​

DiscordInvite.target_user

Defined in​

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

temporary​

temporary: boolean

Whether this invite only grants temporary membership

Defined in​

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

type​

type: DiscordInviteType

The type of invite

Inherited from​

DiscordInvite.type

Defined in​

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

uses​

uses: number

Number of times this invite has been used

Defined in​

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