Class

Invite

Invite to a guild channel, group DM, or emoji/sticker pack. Discriminate with `type` / `isGuild()` / `isGroupDM()` / `isPack()`.

Extends Base

Constructor

new Invite(client: Client, data: APIInvite)

Param	Type	Description
client	`Client`
data	`APIInvite`

channel: APIChannelPartial | null (readonly)

client: Client (readonly)

code: string (readonly)

createdAt: string | null (readonly)

expiresAt: string | null (readonly)

guild: APIGuildPartial | null (readonly)

inviter: User | null (readonly)

maxAge: number | null (readonly)

maxUses: number | null (readonly)

memberCount: number | null (readonly)

pack: APIPackInviteInfo | null (readonly)

presenceCount: number | null (readonly)

temporary: boolean | null (readonly)

type: InviteType (readonly)

url: string (readonly)

Full invite URL (uses this client's instance invite base).

uses: number | null (readonly)

delete(): Promise<void>

Delete this invite. Requires Manage Guild or Create Instant Invite.

fetch(client: Client, codeOrUrl: string): Promise<Invite>

Fetch invite metadata by code or URL (does not join).

Param	Type	Description
client	`Client`
codeOrUrl	`string`

getGuild(): Guild | null

Cached guild for guild invites, else null.

isGroupDM(): boolean

isGuild(): boolean

isPack(): boolean