Preview environment

class InviteGuild

export class InviteGuild extends AnonymousGuild

Represents a guild received from an invite, includes welcome screen data if available.

The hash of the guild banner

Inherited from: AnonymousGuild

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date

The time this guild was created at

Inherited from: BaseGuild

readonly
createdTimestamp : number

The timestamp this guild was created at

Inherited from: BaseGuild

description : string | null

The description of the guild, if any

Inherited from: AnonymousGuild

features : `${GuildFeature}`[]

An array of features available to this guild

Inherited from: BaseGuild

icon : string | null

The icon hash of this guild

Inherited from: BaseGuild

id : Snowflake

The guild's id

Inherited from: BaseGuild

name : string

The name of this guild

Inherited from: BaseGuild

readonly
nameAcronym : string

The acronym that shows up in place of a guild icon

Inherited from: BaseGuild

nsfwLevel : GuildNSFWLevel

The NSFW level of this guild

Inherited from: AnonymousGuild

readonly
partnered : boolean

Whether this guild is partnered

Inherited from: BaseGuild

premiumSubscriptionCount : number | null

The total number of boosts for this server

Inherited from: AnonymousGuild

splash : string | null

The hash of the guild invite splash image

Inherited from: AnonymousGuild

vanityURLCode : string | null

The vanity invite code of the guild, if any

Inherited from: AnonymousGuild

verificationLevel : GuildVerificationLevel

The verification level of the guild

Inherited from: AnonymousGuild

readonly
verified : boolean

Whether this guild is verified

Inherited from: BaseGuild

welcomeScreen : WelcomeScreen | null

The welcome screen for this invite guild

bannerURL(
options?: ImageURLOptions
) : string | null

The URL to this guild's banner.

Inherited from: AnonymousGuild

fetch() : Promise<Guild>

Fetches this guild.

Inherited from: BaseGuild

iconURL(
options?: ImageURLOptions
) : string | null

The URL to this guild's icon.

Inherited from: BaseGuild

splashURL(
options?: ImageURLOptions
) : string | null

The URL to this guild's invite splash image.

Inherited from: AnonymousGuild

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

toString() : string

When concatenated with a string, this automatically returns the guild's name instead of the Guild object.

Inherited from: BaseGuild

valueOf() : string

Inherited from: Base