Preview environment

interface APIExtendedInvite

extends

APIInvite
external
export interface APIExtendedInvite extends APIInvite

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

optionalexternal
approximate_member_count? : number

Approximate count of total members, returned from the GET /invites/<code> endpoint when with_counts is true

Inherited from: APIInvite

optionalexternal
approximate_presence_count? : number

Approximate count of online members, returned from the GET /invites/<code> endpoint when with_counts is true

Inherited from: APIInvite

external
channel : APIInviteChannel | null

The channel this invite is for

Inherited from: APIInvite

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

external
code : string

The invite code (unique ID)

Inherited from: APIInvite

external
created_at : string

When this invite was created

external
expires_at : string | null

The expiration date of this invite

Inherited from: APIInvite

optionalexternal
flags? : InviteFlags

The flags of the invite

Inherited from: APIInvite

optionalexternal
guild_scheduled_event? : APIGuildScheduledEvent

The guild scheduled event data, returned from the GET /invites/<code> endpoint when guild_scheduled_event_id is a valid guild scheduled event id

Inherited from: APIInvite

optionalexternal
guild? : APIInviteGuild

The guild this invite is for

Inherited from: APIInvite

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

optionalexternal
inviter? : APIUser

The user who created the invite

Inherited from: APIInvite

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

external
max_age : number

Duration (in seconds) after which the invite expires

external
max_uses : number

Max number of times this invite can be used

deprecatedoptionalexternal
stage_instance? : never

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

Inherited from: APIInvite

optionalexternal
target_application? : Partial<APIApplication>

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

Inherited from: APIInvite

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

optionalexternal
target_type? : InviteTargetType

The type of target for this voice channel invite

Inherited from: APIInvite

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

optionalexternal
target_user? : APIUser

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

Inherited from: APIInvite

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

external
temporary : boolean

Whether this invite only grants temporary membership

external
type : InviteType

The invite type

Inherited from: APIInvite

external
uses : number

Number of times this invite has been used