BaseGuild
Base guild class
Signature
export declare class BaseGuild extends DiscordBase<APIPartialGuild>Properties
17Methods
6Properties
partneredGetterget partnered(): boolean;verifiedGetterget verified(): boolean;If the guild is verified.
shardIdGetterget shardId(): number;Shard ID of the guild.
Returns
Shard ID or -1 if the client is not gateway based.
shardGetterget shard(): Shard | undefined;Shard of the guild.
Returns
Shard or undefined, if the client is not gateway based always undefined.
id: string;createdTimestampGetterget createdTimestamp(): number;Create a timestamp for the current object.
createdAtGetterget createdAt(): Date;createdAt gets the creation Date instace of the current object.
readonly client: UsingClient;name: string;icon: string | null;splash: string | null;banner?: string | null | undefined;description?: string | null | undefined;features?: GuildFeature[] | undefined;verificationLevel?: GuildVerificationLevel | undefined;vanityUrlCode?: string | null | undefined;welcomeScreen?: { description: string | null; welcomeChannels: { channelId: string; description: string; emojiId: string | null; emojiName: string | null; }[]; } | undefined;Methods
fetch(mode?: 'rest' | 'flow'): Promise<GuildStructure<'cached' | 'api'>>;fetch(mode: 'cache'): ReturnCache<GuildStructure<'cached'> | undefined>;Fetch guild on API
leave(): Promise<void | undefined>;Leave the guild.
iconURL(options?: ImageOptions): string | undefined;iconURL gets the current guild icon.
splashURL(options?: ImageOptions): string | undefined;splashURL gets the current guild splash as a string.
Parameters
options- Image options for the splash url.
Returns
Splash url or void.
bannerURL(options?: ImageOptions): string | undefined;bannerURL gets the current guild banner as a string.
Parameters
options- Image options for the banner url.
Returns
Banner url or void
toString(): string;Returns a string representation of an object.