Class Guild

Constructors

constructor

Properties

afkChannelID? afkTimeout? applicationID? approximateMemberCount? approximatePresenceCount? banner? defaultNotifications? description? discoverySplash? emojis? explicitContentFilter? features? icon? iconHash? id? maxMembers? maxPresences? maxStageVideoChannelUsers? maxVideoChannelUsers? mfaLevel? name? nsfw? nsfwLevel? owner? ownerID? permissions? preferredLocale? premiumProgressBarEnabled? premiumSubscriptionCount? premiumTier? publicUpdatesChannelID? rulesChannelID? safetyAlertsChannelID? splash? stickers? systemChannelFlags? systemChannelID? vanityURL? verificationLevel? welcomeScreen? widgetChannelID? widgetEnabled?

Methods

edit

Constructors

constructor

  • new Guild(client, data): Guild

  • Constructs a new Guild object.

    Parameters

    • client: Client

      The client instance managing this guild.

    • data: any

      The raw data from the API representing the guild.

    Returns Guild

Properties

OptionalafkChannelID

afkChannelID?: string

OptionalafkTimeout

afkTimeout?: number

OptionalapplicationID

applicationID?: string

OptionalapproximateMemberCount

approximateMemberCount?: number

OptionalapproximatePresenceCount

approximatePresenceCount?: number

Optionalbanner

banner?: string

OptionaldefaultNotifications

defaultNotifications?: number

Optionaldescription

description?: string

OptionaldiscoverySplash

discoverySplash?: string

Optionalemojis

emojis?: Emoji[]

OptionalexplicitContentFilter

explicitContentFilter?: number

Optionalfeatures

features?: string[]

Optionalicon

icon?: string

OptionaliconHash

iconHash?: string

Optionalid

id?: string

OptionalmaxMembers

maxMembers?: number

OptionalmaxPresences

maxPresences?: number

OptionalmaxStageVideoChannelUsers

maxStageVideoChannelUsers?: number

OptionalmaxVideoChannelUsers

maxVideoChannelUsers?: number

OptionalmfaLevel

mfaLevel?: number

Optionalname

name?: string

Optionalnsfw

nsfw?: boolean

OptionalnsfwLevel

nsfwLevel?: number

Optionalowner

owner?: boolean

OptionalownerID

ownerID?: string

Optionalpermissions

permissions?: string

OptionalpreferredLocale

preferredLocale?: string

OptionalpremiumProgressBarEnabled

premiumProgressBarEnabled?: boolean

OptionalpremiumSubscriptionCount

premiumSubscriptionCount?: number

OptionalpremiumTier

premiumTier?: number

OptionalpublicUpdatesChannelID

publicUpdatesChannelID?: string

OptionalrulesChannelID

rulesChannelID?: string

OptionalsafetyAlertsChannelID

safetyAlertsChannelID?: string

Optionalsplash

splash?: string

Optionalstickers

stickers?: Sticker[]

OptionalsystemChannelFlags

systemChannelFlags?: number

OptionalsystemChannelID

systemChannelID?: string

OptionalvanityURL

vanityURL?: string

OptionalverificationLevel

verificationLevel?: number

OptionalwelcomeScreen

welcomeScreen?: {
    description: string;
    welcomeChannels: {
        channelID: string;
        description: string;
        emojiID?: string;
        emojiName?: string;
    }[];
}

OptionalwidgetChannelID

widgetChannelID?: string

OptionalwidgetEnabled

widgetEnabled?: boolean

Methods

edit

  • edit(options): Promise<Guild>

  • Edits the guild with the provided options.

    Parameters

    • options: object | GuildPayload

      Fields to update on the guild.

    Returns Promise<Guild>

    The updated Guild object.

    Throws

    Throws if the API request fails.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods