Class Guild<State>

Type Parameters

State extends StructStates = "api"

Hierarchy

ObjectToLower<Omit<APIGuild, "stickers" | "emojis" | "roles">>
DiscordBase
{
    api: APIRoutes;
    cache: Cache;
    client: UsingClient;
    createdAt: Date;
    createdTimestamp: number;
    partnered: boolean;
    rest: ApiHandler;
    shard: Shard | undefined;
    shardId: number;
    verified: boolean;
    bannerURL(options?: CDNUrlOptions): string | undefined;
    fetch(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api">>;
    fetch(mode: "cache"): ReturnCache<Guild<"cached"> | undefined>;
    iconURL(options?: CDNUrlOptions): string | undefined;
    leave(): Promise<void | undefined>;
    splashURL(options?: CDNUrlOptions): string | undefined;
    toString(): string;
}
- Guild

Index

Constructors

constructor

new Guild<State extends keyof StructWhen<any, "cached"> = "api">(
client: UsingClient,
data: APIGuild | GatewayGuildCreateDispatchData,
): Guild<State>
Type Parameters
- State extends keyof StructWhen<any, "cached"> = "api"
Parameters
- client: UsingClient
- data: APIGuild | GatewayGuildCreateDispatchData
Returns Guild<State>
Inherited from ObjectToLower<Omit<APIGuild, 'stickers' | 'emojis' | 'roles'>>.constructor
- Defined in src/structures/Guild.ts:27

Properties

afkChannelId

afkChannelId: string | null

afkTimeout

afkTimeout: 60 | 300 | 900 | 1800 | 3600

api

api: APIRoutes

applicationId

applicationId: string | null

`Optional`approximateMemberCount

approximateMemberCount?: number

`Optional`approximatePresenceCount

approximatePresenceCount?: number

banner: string | null

bans

bans: {
    bulkCreate: (
        body: RESTPostAPIGuildBulkBanJSONBody,
        reason?: string,
    ) => Promise<RESTPostAPIGuildBulkBanResult>;
    create: (
        memberId: string,
        body?: RESTPutAPIGuildBanJSONBody,
        reason?: string,
    ) => Promise<void>;
    fetch: (userId: string, force?: boolean) => Promise<GuildBan>;
    list: (
        query?: RESTGetAPIGuildBansQuery,
        force?: boolean,
    ) => Promise<GuildBan[]>;
    remove: (memberId: string, reason?: string) => Promise<undefined>;
} = ...

cache

cache: Cache

channels

channels: {
    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>;
    fetch: (id: string, force?: boolean) => Promise<AllChannels>;
    list: (force?: boolean) => Promise<AllChannels[]>;
} = ...

`Readonly`client

client: UsingClient

createdAt

createdAt: Date

createdTimestamp

createdTimestamp: number

defaultMessageNotifications

defaultMessageNotifications: GuildDefaultMessageNotifications

description

description: string | null

discoverySplash

discoverySplash: string | null

emojis

emojis: {
    create: (
        body: Omit<RESTPostAPIGuildEmojiJSONBody, "image"> & {
            image: ImageResolvable;
        },
    ) => Promise<GuildEmoji>;
    edit: (
        emojiId: string,
        body: RESTPatchAPIGuildEmojiJSONBody,
        reason?: string,
    ) => Promise<GuildEmoji>;
    fetch: (emojiId: string, force?: boolean) => Promise<GuildEmoji>;
    list: (force?: boolean) => Promise<GuildEmoji[]>;
} = ...

explicitContentFilter

explicitContentFilter: GuildExplicitContentFilter

features

features: GuildFeature[]

hubType

hubType: GuildHubType | null

icon

icon: string | null

`Optional`iconHash

iconHash?: string | null

id

id: string

invites

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

joinedAt

joinedAt: StructPropState<number, State, "create">

large

large: StructPropState<boolean, State, "create">

`Optional`maxMembers

maxMembers?: number

`Optional`maxPresences

maxPresences?: number | null

`Optional`maxStageVideoChannelUsers

maxStageVideoChannelUsers?: number

`Optional`maxVideoChannelUsers

maxVideoChannelUsers?: number

memberCount

memberCount: StructPropState<number, State, "create">

members

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

mfaLevel

mfaLevel: GuildMFALevel

moderationRules

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

name

name: string

nsfwLevel

nsfwLevel: GuildNSFWLevel

`Optional`owner

owner?: boolean

ownerId

ownerId: string

partnered

partnered: boolean

`Optional`permissions

permissions?: string

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"

premiumProgressBarEnabled

premiumProgressBarEnabled: boolean

`Optional`premiumSubscriptionCount

premiumSubscriptionCount?: number

premiumTier

premiumTier: GuildPremiumTier

publicUpdatesChannelId

publicUpdatesChannelId: string | null

rest

rest: ApiHandler

roles

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

rulesChannelId

rulesChannelId: string | null

safetyAlertsChannelId

safetyAlertsChannelId: string | null

shard

shard: Shard | undefined

shardId

shardId: number

splash

splash: string | null

stickers

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

systemChannelFlags

systemChannelFlags: GuildSystemChannelFlags

systemChannelId

systemChannelId: string | null

templates

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

`Optional`unavailable

unavailable?: StructPropState<boolean, State, "create">

vanityUrlCode

vanityUrlCode: string | null

verificationLevel

verificationLevel: GuildVerificationLevel

verified

verified: boolean

webhooks

webhooks: { list: () => Promise<Webhook[]> } = ...

`Optional`welcomeScreen

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

`Optional`widgetChannelId

widgetChannelId?: string | null

`Optional`widgetEnabled

widgetEnabled?: boolean

Accessors

maxEmojis

get maxEmojis(): MaxEmojis
Returns MaxEmojis
- Defined in src/structures/Guild.ts:53

maxStickers

get maxStickers(): MaxStickers
Returns MaxStickers
- Defined in src/structures/Guild.ts:40

Methods

bannerURL

bannerURL(options?: CDNUrlOptions): string | undefined
bannerURL gets the current guild banner as a string.
Parameters
- Optionaloptions: CDNUrlOptions
  Image options for the banner url.
Returns string | undefined
Banner url or void

Link
https://discord.com/developers/docs/reference#image-formatting
- Defined in src/structures/extra/BaseGuild.ts:84

edit

edit(body: RESTPatchAPIGuildJSONBody, reason?: string): Promise<Guild<"api">>
Parameters
- body: RESTPatchAPIGuildJSONBody
- Optionalreason: string
Returns Promise<Guild<"api">>
- Defined in src/structures/Guild.ts:87

fetch

fetch(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api">>
Fetch guild on API
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<Guild<"cached" | "api">>
- Defined in src/structures/extra/BaseGuild.ts:35
fetch(mode: "cache"): ReturnCache<Guild<"cached"> | undefined>
Fetch guild on API
Parameters
- mode: "cache"
Returns ReturnCache<Guild<"cached"> | undefined>
- Defined in src/structures/extra/BaseGuild.ts:36

fetchOwner

fetchOwner(force?: boolean): Promise<GuildMember | null>
Parameters
- force: boolean = false
Returns Promise<GuildMember | null>
- Defined in src/structures/Guild.ts:66

iconURL

iconURL(options?: CDNUrlOptions): string | undefined
iconURL gets the current guild icon.
Parameters
- Optionaloptions: CDNUrlOptions
Returns string | undefined
Link
https://discord.com/developers/docs/reference#image-formatting
- Defined in src/structures/extra/BaseGuild.ts:60

leave

leave(): Promise<void | undefined>
Leave the guild.

Returns Promise<void | undefined>
- Defined in src/structures/extra/BaseGuild.ts:52

listActiveThreads

listActiveThreads(force?: boolean): Promise<ThreadChannel[]>
Parameters
- force: boolean = false
Returns Promise<ThreadChannel[]>
- Defined in src/structures/Guild.ts:74

splashURL

splashURL(options?: CDNUrlOptions): string | undefined
splashURL gets the current guild splash as a string.
Parameters
- Optionaloptions: CDNUrlOptions
  Image options for the splash url.
Returns string | undefined
Splash url or void.

Link
https://discord.com/developers/docs/reference#image-formatting
- Defined in src/structures/extra/BaseGuild.ts:72

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in src/structures/extra/BaseGuild.ts:119

Class Guild<State>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Guild<State>

Properties

afkChannelId

afkTimeout

api

applicationId

OptionalapproximateMemberCount

OptionalapproximatePresenceCount

banner

bans

cache

channels

Readonlyclient

createdAt

createdTimestamp

defaultMessageNotifications

description

discoverySplash

emojis

explicitContentFilter

features

hubType

icon

OptionaliconHash

id

invites

joinedAt

large

OptionalmaxMembers

OptionalmaxPresences

OptionalmaxStageVideoChannelUsers

OptionalmaxVideoChannelUsers

memberCount

members

mfaLevel

moderationRules

name

nsfwLevel

Optionalowner

ownerId

partnered

Optionalpermissions

preferredLocale

premiumProgressBarEnabled

OptionalpremiumSubscriptionCount

premiumTier

publicUpdatesChannelId

rest

roles

rulesChannelId

safetyAlertsChannelId

shard

shardId

splash

stickers

systemChannelFlags

systemChannelId

templates

Optionalunavailable

vanityUrlCode

verificationLevel

verified

webhooks

OptionalwelcomeScreen

OptionalwidgetChannelId

OptionalwidgetEnabled

Accessors

maxEmojis

`Optional`approximateMemberCount

`Optional`approximatePresenceCount

`Readonly`client

`Optional`iconHash

`Optional`maxMembers

`Optional`maxPresences

`Optional`maxStageVideoChannelUsers

`Optional`maxVideoChannelUsers

`Optional`owner

`Optional`permissions

`Optional`premiumSubscriptionCount

`Optional`unavailable

`Optional`welcomeScreen

`Optional`widgetChannelId

`Optional`widgetEnabled