Skip to main content
Latest
interface Invite
Re-export
import { type Invite } from "https://deno.land/x/discordeno_cache_plugin@0.0.21/deps.ts";

Properties

code: string

The invite code (unique Id)

optional
guild: Partial<Guild>

The guild this invite is for

channel: Partial<Channel> | null

The channel this invite is for

optional
inviter: User

The user who created the invite

optional
targetType: TargetTypes

The type of target for this voice channel invite

optional
targetUser: User

The target user for this invite

optional
targetApplication: Partial<Application>

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

optional
approximatePresenceCount: number

Approximate count of online members (only present when target_user is set)

optional
approximateMemberCount: number

Approximate count of total members

optional
expiresAt: string | null

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

optional
stageInstance: InviteStageInstance

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

optional
guildScheduledEvent: ScheduledEvent

guild scheduled event data