Class Guild

afkChannelId

afkTimeout

applicationId

approximateMemberCount

approximatePresenceCount

autoModerationRules

available

bans

channels

commands

defaultMessageNotifications

discoverySplash

emojis

explicitContentFilter

invites

joinedTimestamp

large

maxStageVideoChannelUsers

maxVideoChannelUsers

maximumMembers

maximumPresences

memberCount

members

mfaLevel

ownerId

preferredLocale

premiumProgressBarEnabled

premiumTier

presences

publicUpdatesChannelId

roles

rulesChannelId

safetyAlertsChannelId

scheduledEvents

shardId

stageInstances

stickers

systemChannelFlags

systemChannelId

vanityURLUses

voiceStates

widgetChannelId

widgetEnabled

afkChannel

• get afkChannel(): null | VoiceChannel

• Returns null | VoiceChannel

joinedAt

• get joinedAt(): Date

• Returns Date

maximumBitrate

• get maximumBitrate(): number

• Returns number

publicUpdatesChannel

• get publicUpdatesChannel(): null | TextChannel

• Returns null | TextChannel

rulesChannel

• get rulesChannel(): null | TextChannel

• Returns null | TextChannel

safetyAlertsChannel

• get safetyAlertsChannel(): null | TextChannel

• Returns null | TextChannel

shard

• get shard(): WebSocketShard

• Returns WebSocketShard

systemChannel

• get systemChannel(): null | TextChannel

• Returns null | TextChannel

voiceAdapterCreator

• get voiceAdapterCreator(): InternalDiscordGatewayAdapterCreator

• Returns InternalDiscordGatewayAdapterCreator

widgetChannel

• get widgetChannel(): null | NewsChannel | TextChannel | ForumChannel | MediaChannel | VoiceBasedChannel

• Returns null | NewsChannel | TextChannel | ForumChannel | MediaChannel | VoiceBasedChannel

createTemplate

• createTemplate(name, description?): Promise<GuildTemplate>

• Parameters

  • name: string

  • Optional description: string

  Returns Promise<GuildTemplate>

delete

• delete(): Promise<Guild>

• Returns Promise<Guild>

disableInvites

• disableInvites(disabled?): Promise<Guild>

• Parameters

  • Optional disabled: boolean

  Returns Promise<Guild>

discoverySplashURL

• discoverySplashURL(options?): null | string

• Parameters

  • Optional options: ImageURLOptions

  Returns null | string

edit

• edit(options): Promise<Guild>

• Parameters

  • options: GuildEditOptions

  Returns Promise<Guild>

editOnboarding

• editOnboarding(options): Promise<GuildOnboarding>

• Parameters

  • options: GuildOnboardingEditOptions

  Returns Promise<GuildOnboarding>

editWelcomeScreen

• editWelcomeScreen(options): Promise<WelcomeScreen>

• Parameters

  • options: WelcomeScreenEditOptions

  Returns Promise<WelcomeScreen>

equals

• equals(guild): boolean

• Parameters

  • guild: Guild

  Returns boolean

fetchAuditLogs

• fetchAuditLogs<Event>(options?): Promise<GuildAuditLogs<Event>>

• Type Parameters

  • Event extends GuildAuditLogsResolvable = null

  Parameters

  • Optional options: GuildAuditLogsFetchOptions<Event>

  Returns Promise<GuildAuditLogs<Event>>

fetchIntegrations

• fetchIntegrations(): Promise<Collection<string, Integration>>

• Returns Promise<Collection<string, Integration>>

fetchOnboarding

• fetchOnboarding(): Promise<GuildOnboarding>

• Returns Promise<GuildOnboarding>

fetchOwner

• fetchOwner(options?): Promise<GuildMember>

• Parameters

  • Optional options: BaseFetchOptions

  Returns Promise<GuildMember>

fetchPreview

• fetchPreview(): Promise<GuildPreview>

• Returns Promise<GuildPreview>

fetchTemplates

• fetchTemplates(): Promise<Collection<string, GuildTemplate>>

• Returns Promise<Collection<string, GuildTemplate>>

fetchVanityData

• fetchVanityData(): Promise<Vanity>

• Returns Promise<Vanity>

fetchWebhooks

• fetchWebhooks(): Promise<Collection<string, Webhook<Incoming | ChannelFollower>>>

• Returns Promise<Collection<string, Webhook<Incoming | ChannelFollower>>>

fetchWelcomeScreen

• fetchWelcomeScreen(): Promise<WelcomeScreen>

• Returns Promise<WelcomeScreen>

fetchWidget

• fetchWidget(): Promise<Widget>

• Returns Promise<Widget>

fetchWidgetSettings

• fetchWidgetSettings(): Promise<GuildWidgetSettings>

• Returns Promise<GuildWidgetSettings>

leave

• leave(): Promise<Guild>

• Returns Promise<Guild>

setAFKChannel

• setAFKChannel(afkChannel, reason?): Promise<Guild>

• Parameters

  • afkChannel: null | VoiceChannelResolvable

  • Optional reason: string

  Returns Promise<Guild>

setAFKTimeout

• setAFKTimeout(afkTimeout, reason?): Promise<Guild>

• Parameters

  • afkTimeout: number

  • Optional reason: string

  Returns Promise<Guild>

setBanner

• setBanner(banner, reason?): Promise<Guild>

• Parameters

  • banner: null | string | Buffer

  • Optional reason: string

  Returns Promise<Guild>

setDefaultMessageNotifications

• setDefaultMessageNotifications(defaultMessageNotifications, reason?): Promise<Guild>

• Parameters

  • defaultMessageNotifications: null | GuildDefaultMessageNotifications

  • Optional reason: string

  Returns Promise<Guild>

setDiscoverySplash

• setDiscoverySplash(discoverySplash, reason?): Promise<Guild>

• Parameters

  • discoverySplash: null | string | Buffer

  • Optional reason: string

  Returns Promise<Guild>

setExplicitContentFilter

• setExplicitContentFilter(explicitContentFilter, reason?): Promise<Guild>

• Parameters

  • explicitContentFilter: null | GuildExplicitContentFilter

  • Optional reason: string

  Returns Promise<Guild>

setIcon

• setIcon(icon, reason?): Promise<Guild>

• Parameters

  • icon: null | string | Buffer

  • Optional reason: string

  Returns Promise<Guild>

setMFALevel

• setMFALevel(level, reason?): Promise<Guild>

• Parameters

  • level: GuildMFALevel

  • Optional reason: string

  Returns Promise<Guild>

setName

• setName(name, reason?): Promise<Guild>

• Parameters

  • name: string

  • Optional reason: string

  Returns Promise<Guild>

setOwner

• setOwner(owner, reason?): Promise<Guild>

• Parameters

  • owner: GuildMemberResolvable

  • Optional reason: string

  Returns Promise<Guild>

setPreferredLocale

• setPreferredLocale(preferredLocale, reason?): Promise<Guild>

• Parameters

  • preferredLocale: null | Locale

  • Optional reason: string

  Returns Promise<Guild>

setPremiumProgressBarEnabled

• setPremiumProgressBarEnabled(enabled?, reason?): Promise<Guild>

• Parameters

  • Optional enabled: boolean

  • Optional reason: string

  Returns Promise<Guild>

setPublicUpdatesChannel

• setPublicUpdatesChannel(publicUpdatesChannel, reason?): Promise<Guild>

• Parameters

  • publicUpdatesChannel: null | TextChannelResolvable

  • Optional reason: string

  Returns Promise<Guild>

setRulesChannel

• setRulesChannel(rulesChannel, reason?): Promise<Guild>

• Parameters

  • rulesChannel: null | TextChannelResolvable

  • Optional reason: string

  Returns Promise<Guild>

setSafetyAlertsChannel

• setSafetyAlertsChannel(safetyAlertsChannel, reason?): Promise<Guild>

• Parameters

  • safetyAlertsChannel: null | TextChannelResolvable

  • Optional reason: string

  Returns Promise<Guild>

setSplash

• setSplash(splash, reason?): Promise<Guild>

• Parameters

  • splash: null | string | Buffer

  • Optional reason: string

  Returns Promise<Guild>

setSystemChannel

• setSystemChannel(systemChannel, reason?): Promise<Guild>

• Parameters

  • systemChannel: null | TextChannelResolvable

  • Optional reason: string

  Returns Promise<Guild>

setSystemChannelFlags

• setSystemChannelFlags(systemChannelFlags, reason?): Promise<Guild>

• Parameters

  • systemChannelFlags: SystemChannelFlagsResolvable

  • Optional reason: string

  Returns Promise<Guild>

setVerificationLevel

• setVerificationLevel(verificationLevel, reason?): Promise<Guild>

• Parameters

  • verificationLevel: null | GuildVerificationLevel

  • Optional reason: string

  Returns Promise<Guild>

setWidgetSettings

• setWidgetSettings(settings, reason?): Promise<Guild>

• Parameters

  • settings: GuildWidgetSettingsData

  • Optional reason: string

  Returns Promise<Guild>

toJSON

• toJSON(): unknown

• Returns unknown

widgetImageURL

• widgetImageURL(style?): string

• Parameters

  • Optional style: GuildWidgetStyle

  Returns string