Guild

Signature

export interface Guild extends ObjectToLower<Omit<APIGuild, 'stickers' | 'emojis' | 'roles'>>, DiscordBase

Properties

shardIdGetter
get shardId(): number;

Shard ID of the guild.

Returns

Shard ID or -1 if the client is not gateway based.

get createdTimestamp(): number;

Create a timestamp for the current object.

get createdAt(): Date;

createdAt gets the creation Date instace of the current object.

shardGetter
get shard(): Shard | undefined;

Shard of the guild.

Returns

Shard or undefined, if the client is not gateway based always undefined.

icon: string | null;
owner?: boolean | undefined;
welcomeScreen?: { description: string | null; welcomeChannels: { channelId: string; description: string; emojiId: string | null; emojiName: string | null; }[]; } | undefined;
iconHash?: string | null | undefined;
preferredLocale: 'id' | 'en-US' | 'en-GB' | 'bg' | 'zh-CN' | 'zh-TW' | 'hr' | 'cs' | 'da' | 'nl' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'no' | 'pl' | 'pt-BR' | 'ro' | 'ru' | 'es-ES' | 'es-419' | 'sv-SE' | 'th' | 'tr' | 'uk' | 'vi';
incidentsData: { invitesDisabledUntil: string | null; dmsDisabledUntil: string | null; dmSpamDetectedAt?: string | null | undefined; raidDetectedAt?: string | null | undefined; } | null;

Methods

toString(): string;

Returns a string representation of an object.

leave(): Promise<void | undefined>;

Leave the guild.