Skip to main content

DiscordInviteCreate

Documentation

Documentation / @discordeno/types / DiscordInviteCreate

Interface: DiscordInviteCreate

Defined in: discord/gateway.ts:685

https://docs.discord.com/developers/events/gateway-events#invite-create-invite-create-event-fields

Properties​

channel_id​

channel_id: string

Defined in: discord/gateway.ts:687

The channel the invite is for

code​

code: string

Defined in: discord/gateway.ts:689

The unique invite code

created_at​

created_at: string

Defined in: discord/gateway.ts:691

The time at which the invite was created

expires_at​

expires_at: string

Defined in: discord/gateway.ts:711

The expiration date of this invite.

guild_id?​

optional guild_id?: string

Defined in: discord/gateway.ts:693

The guild of the invite

inviter?​

optional inviter?: DiscordUser

Defined in: discord/gateway.ts:695

The user that created the invite

max_age​

max_age: number

Defined in: discord/gateway.ts:697

How long the invite is valid for (in seconds)

max_uses​

max_uses: number

Defined in: discord/gateway.ts:699

The maximum number of times the invite can be used

role_ids?​

optional role_ids?: string[]

Defined in: discord/gateway.ts:713

the role ID(s) for roles in the guild given to the users that accept this invite

target_application?​

optional target_application?: Partial<DiscordApplication>

Defined in: discord/gateway.ts:705

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

target_type​

target_type: TargetTypes

Defined in: discord/gateway.ts:701

The type of target for this voice channel invite

target_user?​

optional target_user?: DiscordUser

Defined in: discord/gateway.ts:703

The target user for this invite

temporary​

temporary: boolean

Defined in: discord/gateway.ts:707

Whether or not the invite is temporary (invited users will be kicked on disconnect unless they're assigned a role)

uses​

uses: number

Defined in: discord/gateway.ts:709

How many times the invite has been used (always will be 0)