Skip to main content

DiscordInviteMetadata

Documentation

Documentation / @discordeno/types / DiscordInviteMetadata

Interface: DiscordInviteMetadata

Defined in: discord/invite.ts:68

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

Extends​

Properties​

approximate_member_count?​

optional approximate_member_count?: number

Defined in: discord/invite.ts:31

Approximate count of total members

Inherited from​

DiscordInvite.approximate_member_count

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)

Inherited from​

DiscordInvite.approximate_presence_count

channel​

channel: Partial<DiscordChannel> | null

Defined in: discord/invite.ts:19

The channel this invite is for

Inherited from​

DiscordInvite.channel

code​

code: string

Defined in: discord/invite.ts:15

The invite code (unique Id)

Inherited from​

DiscordInvite.code

created_at​

created_at: string

Defined in: discord/invite.ts:78

When this invite was created

expires_at​

expires_at: string | null

Defined in: discord/invite.ts:33

The expiration date of this invite

Inherited from​

DiscordInvite.expires_at

flags?​

optional flags?: number

Defined in: discord/invite.ts:41

Guild invite flags for guild invites.

See​

DiscordGuildInviteFlags

Inherited from​

DiscordInvite.flags

guild?​

optional guild?: Partial<DiscordGuild>

Defined in: discord/invite.ts:17

The guild this invite is for

Inherited from​

DiscordInvite.guild

guild_scheduled_event?​

optional guild_scheduled_event?: DiscordScheduledEvent

Defined in: discord/invite.ts:35

guild scheduled event data

Inherited from​

DiscordInvite.guild_scheduled_event

inviter?​

optional inviter?: DiscordUser

Defined in: discord/invite.ts:21

The user who created the invite

Inherited from​

DiscordInvite.inviter

max_age​

max_age: number

Defined in: discord/invite.ts:74

Duration (in seconds) after which the invite expires

max_uses​

max_uses: number

Defined in: discord/invite.ts:72

Max number of times this invite can be used

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

Inherited from​

DiscordInvite.roles

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

Inherited from​

DiscordInvite.target_application

target_type?​

optional target_type?: TargetTypes

Defined in: discord/invite.ts:23

The type of target for this voice channel invite

Inherited from​

DiscordInvite.target_type

target_user?​

optional target_user?: DiscordUser

Defined in: discord/invite.ts:25

The target user for this invite

Inherited from​

DiscordInvite.target_user

temporary​

temporary: boolean

Defined in: discord/invite.ts:76

Whether this invite only grants temporary membership

type​

type: DiscordInviteType

Defined in: discord/invite.ts:13

The type of invite

Inherited from​

DiscordInvite.type

uses​

uses: number

Defined in: discord/invite.ts:70

Number of times this invite has been used