Preview environment

interface GatewayInviteCreateDispatchData

export interface GatewayInviteCreateDispatchData

See also: https://discord.com/developers/docs/topics/gateway-events#invite-create

channel_id : Snowflake

The channel the invite is for

code : string

The unique invite code

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

created_at : number

The time at which the invite was created

optional
guild_id? : Snowflake

The guild of the invite

optional
inviter? : APIUser

The user that created the invite

See also: https://discord.com/developers/docs/resources/user#user-object

max_age : number

How long the invite is valid for (in seconds)

max_uses : number

The maximum number of times the invite can be used

optional
target_application? : Partial<APIApplication>

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

optional
target_type? : InviteTargetType

The type of target for this voice channel invite

See also: https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types

optional
target_user? : APIUser

The user whose stream to display for this voice channel stream invite

See also: https://discord.com/developers/docs/resources/user#user-object

temporary : boolean

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

uses : 0

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