Skip to main content

DiscordInviteMetadata

@discordeno/bot

Documentation / @discordeno/bot / DiscordInviteMetadata

Interface: DiscordInviteMetadata

Defined in: packages/types/dist/types/discord/invite.d.ts:48

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

Extends​

Properties​

approximate_member_count?​

optional approximate_member_count: number

Defined in: packages/types/dist/types/discord/invite.d.ts:28

Approximate count of total members

Inherited from​

DiscordInvite.approximate_member_count

approximate_presence_count?​

optional approximate_presence_count: number

Defined in: packages/types/dist/types/discord/invite.d.ts:26

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

Inherited from​

DiscordInvite.approximate_presence_count

channel​

channel: null | Partial<DiscordChannel>

Defined in: packages/types/dist/types/discord/invite.d.ts:16

The channel this invite is for

Inherited from​

DiscordInvite.channel

code​

code: string

Defined in: packages/types/dist/types/discord/invite.d.ts:12

The invite code (unique Id)

Inherited from​

DiscordInvite.code

created_at​

created_at: string

Defined in: packages/types/dist/types/discord/invite.d.ts:58

When this invite was created

expires_at?​

optional expires_at: null | string

Defined in: packages/types/dist/types/discord/invite.d.ts:30

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

Inherited from​

DiscordInvite.expires_at

guild?​

optional guild: Partial<DiscordGuild>

Defined in: packages/types/dist/types/discord/invite.d.ts:14

The guild this invite is for

Inherited from​

DiscordInvite.guild

guild_scheduled_event?​

optional guild_scheduled_event: DiscordScheduledEvent

Defined in: packages/types/dist/types/discord/invite.d.ts:34

guild scheduled event data

Inherited from​

DiscordInvite.guild_scheduled_event

inviter?​

optional inviter: DiscordUser

Defined in: packages/types/dist/types/discord/invite.d.ts:18

The user who created the invite

Inherited from​

DiscordInvite.inviter

max_age​

max_age: number

Defined in: packages/types/dist/types/discord/invite.d.ts:54

Duration (in seconds) after which the invite expires

max_uses​

max_uses: number

Defined in: packages/types/dist/types/discord/invite.d.ts:52

Max number of times this invite can be used

stage_instance?​

optional stage_instance: DiscordInviteStageInstance

Defined in: packages/types/dist/types/discord/invite.d.ts:32

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

Inherited from​

DiscordInvite.stage_instance

target_application?​

optional target_application: Partial<DiscordApplication>

Defined in: packages/types/dist/types/discord/invite.d.ts:24

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

Inherited from​

DiscordInvite.target_application

target_type?​

optional target_type: TargetTypes

Defined in: packages/types/dist/types/discord/invite.d.ts:20

The type of target for this voice channel invite

Inherited from​

DiscordInvite.target_type

target_user?​

optional target_user: DiscordUser

Defined in: packages/types/dist/types/discord/invite.d.ts:22

The target user for this invite

Inherited from​

DiscordInvite.target_user

temporary​

temporary: boolean

Defined in: packages/types/dist/types/discord/invite.d.ts:56

Whether this invite only grants temporary membership

type​

type: DiscordInviteType

Defined in: packages/types/dist/types/discord/invite.d.ts:10

The type of invite

Inherited from​

DiscordInvite.type

uses​

uses: number

Defined in: packages/types/dist/types/discord/invite.d.ts:50

Number of times this invite has been used