Guild Class

seyfertlib/structures/Guild.d.ts

Signature

@Mixins(DiscordBase)export declare class Guild<State extends StructStates = 'api'> extends ToClass<Omit<BaseGuild, keyof ObjectToLower<APIPartialGuild>>, Guild>

Methods

constructor fetchOwner listActiveThreads edit searchMessages fetch toString leave iconURL splashURL bannerURL

Properties

joinedAt

joinedAt: StructPropState<number, State, 'create'>;

memberCount

memberCount: StructPropState<number, State, 'create'>;

large

large: StructPropState<boolean, State, 'create'>;

unavailable

unavailable?: StructPropState<boolean, State, 'create'>;

webhooks

webhooks: {    list: () => Promise<WebhookStructure[]>;};

maxStickersGetter

get maxStickers(): MaxStickers;

maxEmojisGetter

get maxEmojis(): MaxEmojis;

templates

templates: {    fetch: (code: string) => Promise<GuildTemplateStructure>;    list: () => Promise<GuildTemplateStructure[]>;    create: (body: RESTPostAPIGuildTemplatesJSONBody) => Promise<GuildTemplateStructure>;    sync: (code: string) => Promise<GuildTemplateStructure>;    edit: (code: string, body: RESTPatchAPIGuildTemplateJSONBody) => Promise<GuildTemplateStructure>;    delete: (code: string) => Promise<GuildTemplateStructure>;};

stickers

stickers: {    list: () => Promise<StickerStructure[]>;    create: (payload: CreateStickerBodyRequest, reason?: string) => Promise<StickerStructure>;    edit: (stickerId: string, body: RESTPatchAPIGuildStickerJSONBody, reason?: string) => Promise<StickerStructure>;    fetch: (stickerId: string, force?: boolean) => Promise<StickerStructure>;    delete: (stickerId: string, reason?: string) => Promise<void>;};

members

members: {    resolve: (resolve: GuildMemberResolvable) => Promise<GuildMemberStructure | undefined>;    search: (query: RESTGetAPIGuildMembersSearchQuery) => Promise<GuildMemberStructure[]>;    unban: (id: string, reason?: string) => Promise<undefined>;    ban: (id: string, options?: BanOptions) => Promise<void>;    kick: (id: string, reason?: string) => Promise<void>;    edit: (id: string, body: RESTPatchAPIGuildMemberJSONBody, reason?: string) => Promise<GuildMemberStructure>;    add: (id: string, body: RESTPutAPIGuildMemberJSONBody) => Promise<GuildMemberStructure | undefined>;    addRole: (memberId: string, id: string) => Promise<undefined>;    removeRole: (memberId: string, id: string) => Promise<undefined>;    fetch: (memberId: string, force?: boolean) => Promise<GuildMemberStructure>;    list: (query?: RESTGetAPIGuildMembersQuery, force?: boolean) => Promise<GuildMemberStructure[]>;};

moderationRules

moderationRules: {    list: () => Promise<AutoModerationRuleStructure[]>;    create: (body: RESTPostAPIAutoModerationRuleJSONBody) => Promise<AutoModerationRuleStructure>;    delete: (ruleId: string, reason?: string) => Promise<undefined>;    fetch: (ruleId: string) => Promise<AutoModerationRuleStructure>;    edit: (ruleId: string, body: RESTPatchAPIAutoModerationRuleJSONBody, reason?: string) => Promise<AutoModerationRuleStructure>;};

roles

roles: {    create: (body: RESTPostAPIGuildRoleJSONBody) => Promise<GuildRoleStructure>;    list: (force?: boolean) => Promise<GuildRoleStructure[]>;    edit: (roleId: string, body: RESTPatchAPIGuildRoleJSONBody, reason?: string) => Promise<GuildRoleStructure>;    delete: (roleId: string, reason?: string) => Promise<void>;    editPositions: (body: RESTPatchAPIGuildRolePositionsJSONBody) => Promise<GuildRoleStructure[]>;    memberCounts: () => Promise<RESTGetAPIGuildRoleMemberCountsResult>;};

channels

channels: {    list: (force?: boolean) => Promise<AllChannels[]>;    fetch: (id: string, force?: boolean) => Promise<AllChannels>;    create: <T extends GuildChannelTypes = GuildChannelTypes>(body: RESTPostAPIGuildChannelJSONBody & {        type: T;    }) => Promise<SeyfertChannelMap[T]>;    delete: (id: string, reason?: string) => Promise<AllChannels>;    edit: (id: string, body: RESTPatchAPIChannelJSONBody, reason?: string) => Promise<AllChannels>;    editPositions: (body: RESTPatchAPIGuildChannelPositionsJSONBody) => Promise<undefined>;};

emojis

emojis: {    edit: (emojiId: string, body: RESTPatchAPIGuildEmojiJSONBody, reason?: string) => Promise<GuildEmojiStructure>;    create: (body: Parameters<EmojiShorter#["create"]>[1]) => Promise<GuildEmojiStructure>;    fetch: (emojiId: string, force?: boolean) => Promise<GuildEmojiStructure>;    list: (force?: boolean) => Promise<GuildEmojiStructure[]>;};

bans

bans: {    fetch: (userId: string, force?: boolean) => Promise<GuildBanStructure>;    list: (query?: RESTGetAPIGuildBansQuery, force?: boolean) => Promise<GuildBanStructure[]>;    create: (memberId: string, options?: Parameters<BanShorter#["create"]>[2]) => Promise<void>;    remove: (memberId: string, reason?: string) => Promise<undefined>;    bulkCreate: (body: Parameters<BanShorter#["bulkCreate"]>[1], reason?: string) => Promise<RESTPostAPIGuildBulkBanResult>;};

invites

invites: {    list: () => Promise<{        uses: number;        maxUses: number;        maxAge: number;        temporary: boolean;        createdAt: string;        code: string;        guild?: {            id: string;            name: string;            description: string | null;            icon: string | null;            splash: string | null;            banner: string | null;            features: GuildFeature[];            verificationLevel: GuildVerificationLevel;            vanityUrlCode: string | null;            premiumSubscriptionCount?: number | undefined;            nsfwLevel: GuildNSFWLevel;        } | undefined;        channel: {            id: string;            type: ChannelType;            name: string | null;        } | null;        inviter?: {            id: string;            username: string;            discriminator: string;            globalName: string | null;            avatar: string | null;            bot?: boolean | undefined;            system?: boolean | undefined;            mfaEnabled?: boolean | undefined;            banner?: string | null | undefined;            accentColor?: number | null | undefined;            locale?: string | undefined;            verified?: boolean | undefined;            email?: string | null | undefined;            flags?: UserFlags | undefined;            premiumType?: UserPremiumType | undefined;            publicFlags?: UserFlags | undefined;            avatarDecorationData?: APIAvatarDecorationData | null | undefined;            collectibles?: APICollectibles | null | undefined;            primaryGuild?: APIUserPrimaryGuild | null | undefined;        } | undefined;        targetType?: InviteTargetType | undefined;        targetUser?: {            id: string;            username: string;            discriminator: string;            globalName: string | null;            avatar: string | null;            bot?: boolean | undefined;            system?: boolean | undefined;            mfaEnabled?: boolean | undefined;            banner?: string | null | undefined;            accentColor?: number | null | undefined;            locale?: string | undefined;            verified?: boolean | undefined;            email?: string | null | undefined;            flags?: UserFlags | undefined;            premiumType?: UserPremiumType | undefined;            publicFlags?: UserFlags | undefined;            avatarDecorationData?: APIAvatarDecorationData | null | undefined;            collectibles?: APICollectibles | null | undefined;            primaryGuild?: APIUserPrimaryGuild | null | undefined;        } | undefined;        targetApplication?: {            id?: string | undefined;            name?: string | undefined;            icon?: string | null | undefined;            description?: string | undefined;            rpcOrigins?: string[] | undefined;            botPublic?: boolean | undefined;            botRequireCodeGrant?: boolean | undefined;            bot?: APIUser | undefined;            termsOfServiceUrl?: string | undefined;            privacyPolicyUrl?: string | undefined;            owner?: APIUser | undefined;            verifyKey?: string | undefined;            team?: APITeam | null | undefined;            guildId?: string | undefined;            guild?: APIPartialGuild | undefined;            primarySkuId?: string | undefined;            slug?: string | undefined;            coverImage?: string | undefined;            flags?: ApplicationFlags | undefined;            approximateGuildCount?: number | undefined;            approximateUserInstallCount?: number | undefined;            redirectUris?: string[] | undefined;            interactionsEndpointUrl?: string | null | undefined;            roleConnectionsVerificationUrl?: string | null | undefined;            tags?: [                string,                (string | undefined)?,                (string | undefined)?,                (string | undefined)?,                (string | undefined)?            ] | undefined;            installParams?: APIApplicationInstallParams | undefined;            integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined;            customInstallUrl?: string | undefined;        } | undefined;        approximatePresenceCount?: number | undefined;        approximateMemberCount?: number | undefined;        expiresAt?: string | null | undefined;        guildScheduledEvent?: {            channelId: string;            entityMetadata: null;            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.StageInstance;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | {            channelId: string;            entityMetadata: null;            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.Voice;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | {            channelId: null;            entityMetadata: {                location: string;            };            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.External;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | undefined;        type: InviteType;    }[]>;    create: (data: CreateInviteFromChannel) => Promise<{        uses: number;        maxUses: number;        maxAge: number;        temporary: boolean;        createdAt: string;        code: string;        guild?: {            id: string;            name: string;            description: string | null;            icon: string | null;            splash: string | null;            banner: string | null;            features: GuildFeature[];            verificationLevel: GuildVerificationLevel;            vanityUrlCode: string | null;            premiumSubscriptionCount?: number | undefined;            nsfwLevel: GuildNSFWLevel;        } | undefined;        channel: {            id: string;            type: ChannelType;            name: string | null;        } | null;        inviter?: {            id: string;            username: string;            discriminator: string;            globalName: string | null;            avatar: string | null;            bot?: boolean | undefined;            system?: boolean | undefined;            mfaEnabled?: boolean | undefined;            banner?: string | null | undefined;            accentColor?: number | null | undefined;            locale?: string | undefined;            verified?: boolean | undefined;            email?: string | null | undefined;            flags?: UserFlags | undefined;            premiumType?: UserPremiumType | undefined;            publicFlags?: UserFlags | undefined;            avatarDecorationData?: APIAvatarDecorationData | null | undefined;            collectibles?: APICollectibles | null | undefined;            primaryGuild?: APIUserPrimaryGuild | null | undefined;        } | undefined;        targetType?: InviteTargetType | undefined;        targetUser?: {            id: string;            username: string;            discriminator: string;            globalName: string | null;            avatar: string | null;            bot?: boolean | undefined;            system?: boolean | undefined;            mfaEnabled?: boolean | undefined;            banner?: string | null | undefined;            accentColor?: number | null | undefined;            locale?: string | undefined;            verified?: boolean | undefined;            email?: string | null | undefined;            flags?: UserFlags | undefined;            premiumType?: UserPremiumType | undefined;            publicFlags?: UserFlags | undefined;            avatarDecorationData?: APIAvatarDecorationData | null | undefined;            collectibles?: APICollectibles | null | undefined;            primaryGuild?: APIUserPrimaryGuild | null | undefined;        } | undefined;        targetApplication?: {            id?: string | undefined;            name?: string | undefined;            icon?: string | null | undefined;            description?: string | undefined;            rpcOrigins?: string[] | undefined;            botPublic?: boolean | undefined;            botRequireCodeGrant?: boolean | undefined;            bot?: APIUser | undefined;            termsOfServiceUrl?: string | undefined;            privacyPolicyUrl?: string | undefined;            owner?: APIUser | undefined;            verifyKey?: string | undefined;            team?: APITeam | null | undefined;            guildId?: string | undefined;            guild?: APIPartialGuild | undefined;            primarySkuId?: string | undefined;            slug?: string | undefined;            coverImage?: string | undefined;            flags?: ApplicationFlags | undefined;            approximateGuildCount?: number | undefined;            approximateUserInstallCount?: number | undefined;            redirectUris?: string[] | undefined;            interactionsEndpointUrl?: string | null | undefined;            roleConnectionsVerificationUrl?: string | null | undefined;            tags?: [                string,                (string | undefined)?,                (string | undefined)?,                (string | undefined)?,                (string | undefined)?            ] | undefined;            installParams?: APIApplicationInstallParams | undefined;            integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined;            customInstallUrl?: string | undefined;        } | undefined;        approximatePresenceCount?: number | undefined;        approximateMemberCount?: number | undefined;        expiresAt?: string | null | undefined;        guildScheduledEvent?: {            channelId: string;            entityMetadata: null;            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.StageInstance;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | {            channelId: string;            entityMetadata: null;            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.Voice;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | {            channelId: null;            entityMetadata: {                location: string;            };            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.External;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | undefined;        type: InviteType;    }>;    delete: (code: string, reason?: string) => Promise<{        code: string;        guild?: {            id: string;            name: string;            description: string | null;            icon: string | null;            splash: string | null;            banner: string | null;            features: GuildFeature[];            verificationLevel: GuildVerificationLevel;            vanityUrlCode: string | null;            premiumSubscriptionCount?: number | undefined;            nsfwLevel: GuildNSFWLevel;        } | undefined;        channel: {            id: string;            type: ChannelType;            name: string | null;        } | null;        inviter?: {            id: string;            username: string;            discriminator: string;            globalName: string | null;            avatar: string | null;            bot?: boolean | undefined;            system?: boolean | undefined;            mfaEnabled?: boolean | undefined;            banner?: string | null | undefined;            accentColor?: number | null | undefined;            locale?: string | undefined;            verified?: boolean | undefined;            email?: string | null | undefined;            flags?: UserFlags | undefined;            premiumType?: UserPremiumType | undefined;            publicFlags?: UserFlags | undefined;            avatarDecorationData?: APIAvatarDecorationData | null | undefined;            collectibles?: APICollectibles | null | undefined;            primaryGuild?: APIUserPrimaryGuild | null | undefined;        } | undefined;        targetType?: InviteTargetType | undefined;        targetUser?: {            id: string;            username: string;            discriminator: string;            globalName: string | null;            avatar: string | null;            bot?: boolean | undefined;            system?: boolean | undefined;            mfaEnabled?: boolean | undefined;            banner?: string | null | undefined;            accentColor?: number | null | undefined;            locale?: string | undefined;            verified?: boolean | undefined;            email?: string | null | undefined;            flags?: UserFlags | undefined;            premiumType?: UserPremiumType | undefined;            publicFlags?: UserFlags | undefined;            avatarDecorationData?: APIAvatarDecorationData | null | undefined;            collectibles?: APICollectibles | null | undefined;            primaryGuild?: APIUserPrimaryGuild | null | undefined;        } | undefined;        targetApplication?: {            id?: string | undefined;            name?: string | undefined;            icon?: string | null | undefined;            description?: string | undefined;            rpcOrigins?: string[] | undefined;            botPublic?: boolean | undefined;            botRequireCodeGrant?: boolean | undefined;            bot?: APIUser | undefined;            termsOfServiceUrl?: string | undefined;            privacyPolicyUrl?: string | undefined;            owner?: APIUser | undefined;            verifyKey?: string | undefined;            team?: APITeam | null | undefined;            guildId?: string | undefined;            guild?: APIPartialGuild | undefined;            primarySkuId?: string | undefined;            slug?: string | undefined;            coverImage?: string | undefined;            flags?: ApplicationFlags | undefined;            approximateGuildCount?: number | undefined;            approximateUserInstallCount?: number | undefined;            redirectUris?: string[] | undefined;            interactionsEndpointUrl?: string | null | undefined;            roleConnectionsVerificationUrl?: string | null | undefined;            tags?: [                string,                (string | undefined)?,                (string | undefined)?,                (string | undefined)?,                (string | undefined)?            ] | undefined;            installParams?: APIApplicationInstallParams | undefined;            integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined;            customInstallUrl?: string | undefined;        } | undefined;        approximatePresenceCount?: number | undefined;        approximateMemberCount?: number | undefined;        expiresAt?: string | null | undefined;        guildScheduledEvent?: {            channelId: string;            entityMetadata: null;            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.StageInstance;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | {            channelId: string;            entityMetadata: null;            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.Voice;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | {            channelId: null;            entityMetadata: {                location: string;            };            id: string;            guildId: string;            creatorId?: string | null | undefined;            name: string;            description?: string | null | undefined;            scheduledStartTime: string;            scheduledEndTime: string | null;            privacyLevel: GuildScheduledEventPrivacyLevel;            status: GuildScheduledEventStatus;            entityType: GuildScheduledEventEntityType.External;            entityId: string | null;            creator?: APIUser | undefined;            userCount?: number | undefined;            image?: string | null | undefined;            recurrenceRule: APIGuildScheduledEventRecurrenceRule | null;        } | undefined;        type: InviteType;    }>;};

client

readonly client: UsingClient;

shardIdGetter

get shardId(): number;

Shard ID of the guild.

Returns

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

createdTimestampGetter

get createdTimestamp(): number;

Create a timestamp for the current object.

createdAtGetter

get createdAt(): Date;

createdAt gets the creation Date instace of the current object.

verifiedGetter

get verified(): boolean;

If the guild is verified.

Links

https://discord.com/developers/docs/resources/guild#guild-object-guild-features

partneredGetter

get partnered(): boolean;

shardGetter

get shard(): Shard | undefined;

Shard of the guild.

Returns

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

id

id: string;

description

description: string | null;

banner

banner: string | null;

permissions

permissions?: string | undefined;

name

name: string;

applicationId

applicationId: string | null;

icon

icon: string | null;

owner

owner?: boolean | undefined;

welcomeScreen

welcomeScreen?: { description: string | null; welcomeChannels: { channelId: string; description: string; emojiId: string | null; emojiName: string | null; }[]; } | undefined;

splash

splash: string | null;

features

features: GuildFeature[];

verificationLevel

verificationLevel: GuildVerificationLevel;

vanityUrlCode

vanityUrlCode: string | null;

ownerId

ownerId: string;

iconHash

iconHash?: string | null | undefined;

discoverySplash

discoverySplash: string | null;

afkChannelId

afkChannelId: string | null;

afkTimeout

afkTimeout: 1800 | 3600 | 60 | 300 | 900;

widgetEnabled

widgetEnabled?: boolean | undefined;

widgetChannelId

widgetChannelId?: string | null | undefined;

defaultMessageNotifications

defaultMessageNotifications: GuildDefaultMessageNotifications;

explicitContentFilter

explicitContentFilter: GuildExplicitContentFilter;

mfaLevel

mfaLevel: GuildMFALevel;

systemChannelId

systemChannelId: string | null;

systemChannelFlags

systemChannelFlags: GuildSystemChannelFlags;

rulesChannelId

rulesChannelId: string | null;

maxPresences

maxPresences?: number | null | undefined;

maxMembers

maxMembers?: number | undefined;

premiumTier

premiumTier: GuildPremiumTier;

premiumSubscriptionCount

premiumSubscriptionCount?: number | undefined;

preferredLocale

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';

publicUpdatesChannelId

publicUpdatesChannelId: string | null;

maxVideoChannelUsers

maxVideoChannelUsers?: number | undefined;

maxStageVideoChannelUsers

maxStageVideoChannelUsers?: number | undefined;

approximateMemberCount

approximateMemberCount?: number | undefined;

approximatePresenceCount

approximatePresenceCount?: number | undefined;

nsfwLevel

nsfwLevel: GuildNSFWLevel;

premiumProgressBarEnabled

premiumProgressBarEnabled: boolean;

hubType

hubType: GuildHubType | null;

safetyAlertsChannelId

safetyAlertsChannelId: string | null;

incidentsData

incidentsData: { invitesDisabledUntil: string | null; dmsDisabledUntil: string | null; dmSpamDetectedAt?: string | null | undefined; raidDetectedAt?: string | null | undefined; } | null;

Methods

constructorConstructor

constructor(client: UsingClient, data: APIGuild | GatewayGuildCreateDispatchData);

fetchOwner

fetchOwner(force?: boolean): Promise<GuildMemberStructure | null>;

listActiveThreads

listActiveThreads(force?: boolean): Promise<ThreadChannelStructure[]>;

edit

edit(body: RESTPatchAPIGuildJSONBody, reason?: string): Promise<GuildStructure<'api'>>;

searchMessages

searchMessages(query?: RESTGetAPIGuildMessagesSearchQuery, wait?: boolean): Promise<GuildSearchMessagesResult>;

fetch

fetch(mode?: 'rest' | 'flow'): Promise<GuildStructure<'cached' | 'api'>>;fetch(mode: 'cache'): ReturnCache<GuildStructure<'cached'> | undefined>;

Fetch guild on API

toString

toString(): string;

Returns a string representation of an object.

leave

leave(): Promise<void | undefined>;

Leave the guild.

iconURL

iconURL(options?: ImageOptions): string | undefined;

iconURL gets the current guild icon.

Links

https://discord.com/developers/docs/reference#image-formatting

splashURL

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.

Links

https://discord.com/developers/docs/reference#image-formatting

bannerURL

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

Links

https://discord.com/developers/docs/reference#image-formatting