Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface APIExtendedInvite

Hierarchy

Index

Properties

approximate_member_count?: number

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

approximate_presence_count?: number

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

channel: null | Required<APIPartialChannel>
code: string

The invite code (unique ID)

created_at: string

When this invite was created

expires_at?: null | string

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

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

inviter?: APIUser
max_age: number

Duration (in seconds) after which the invite expires

max_uses: number

Max number of times this invite can be used

stage_instance?: APIInviteStageInstance

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

deprecated
target_application?: Partial<APIApplication>

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

target_type?: InviteTargetType
target_user?: APIUser

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

temporary: boolean

Whether this invite only grants temporary membership

uses: number

Number of times this invite has been used

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:16 AM