Class Guild

Hierarchy (View Summary)

AnonymousGuild
- Guild

Index

Accessors

afkChannel createdAt createdTimestamp joinedAt maximumBitrate nameAcronym partnered publicUpdatesChannel rulesChannel safetyAlertsChannel shard systemChannel verified voiceAdapterCreator widgetChannel

Properties

afkChannelId

afkChannelId: null | string

afkTimeout

afkTimeout: number

applicationId

applicationId: null | string

approximateMemberCount

approximateMemberCount: null | number

approximatePresenceCount

approximatePresenceCount: null | number

autoModerationRules

autoModerationRules: AutoModerationRuleManager

available

available: boolean

banner

banner: null | string

bans

bans: GuildBanManager

channels

channels: GuildChannelManager

`Readonly`client

client: Client<true>

commands

commands: GuildApplicationCommandManager

defaultMessageNotifications

defaultMessageNotifications: GuildDefaultMessageNotifications

description

description: null | string

discoverySplash

discoverySplash: null | string

emojis

emojis: GuildEmojiManager

explicitContentFilter

explicitContentFilter: GuildExplicitContentFilter

features

icon

icon: null | string

id

id: string

incidentsData

incidentsData: null | IncidentActions

invites

invites: GuildInviteManager

joinedTimestamp

joinedTimestamp: number

large

large: boolean

maximumMembers

maximumMembers: null | number

maximumPresences

maximumPresences: null | number

maxStageVideoChannelUsers

maxStageVideoChannelUsers: null | number

maxVideoChannelUsers

maxVideoChannelUsers: null | number

memberCount

memberCount: number

members

members: GuildMemberManager

mfaLevel

mfaLevel: GuildMFALevel

name

name: string

nsfwLevel

nsfwLevel: GuildNSFWLevel

ownerId

ownerId: string

preferredLocale

preferredLocale: Locale

premiumProgressBarEnabled

premiumProgressBarEnabled: boolean

premiumSubscriptionCount

premiumSubscriptionCount: null | number

premiumTier

premiumTier: GuildPremiumTier

presences

presences: PresenceManager

publicUpdatesChannelId

publicUpdatesChannelId: null | string

roles

roles: RoleManager

rulesChannelId

rulesChannelId: null | string

safetyAlertsChannelId

safetyAlertsChannelId: null | string

scheduledEvents

scheduledEvents: GuildScheduledEventManager

shardId

shardId: number

soundboardSounds

soundboardSounds: GuildSoundboardSoundManager

splash

splash: null | string

systemChannelId

systemChannelId: null | string

vanityURLCode

vanityURLCode: null | string

vanityURLUses

vanityURLUses: null | number

verificationLevel

verificationLevel: GuildVerificationLevel

voiceStates

voiceStates: VoiceStateManager

widgetChannelId

widgetChannelId: null | string

widgetEnabled

widgetEnabled: null | boolean

Accessors

afkChannel

get afkChannel(): null | VoiceChannel
Returns null | VoiceChannel
- Defined in node_modules/discord.js/typings/index.d.ts:1578

createdAt

get createdAt(): Date
Returns Date
Inherited from AnonymousGuild.createdAt
- Defined in node_modules/discord.js/typings/index.d.ts:685

createdTimestamp

get createdTimestamp(): number
Returns number
Inherited from AnonymousGuild.createdTimestamp
- Defined in node_modules/discord.js/typings/index.d.ts:686

joinedAt

get joinedAt(): Date
Returns Date
- Defined in node_modules/discord.js/typings/index.d.ts:1595

maximumBitrate

get maximumBitrate(): number
Returns number
- Defined in node_modules/discord.js/typings/index.d.ts:1632

nameAcronym

get nameAcronym(): string
Returns string
Inherited from AnonymousGuild.nameAcronym
- Defined in node_modules/discord.js/typings/index.d.ts:691

partnered

get partnered(): boolean
Returns boolean
Inherited from AnonymousGuild.partnered
- Defined in node_modules/discord.js/typings/index.d.ts:692

publicUpdatesChannel

get publicUpdatesChannel(): null | TextChannel
Returns null | TextChannel
- Defined in node_modules/discord.js/typings/index.d.ts:1609

rulesChannel

get rulesChannel(): null | TextChannel
Returns null | TextChannel
- Defined in node_modules/discord.js/typings/index.d.ts:1612

safetyAlertsChannel

get safetyAlertsChannel(): null | TextChannel
Returns null | TextChannel
- Defined in node_modules/discord.js/typings/index.d.ts:1614

shard

get shard(): WebSocketShard
Returns WebSocketShard
- Defined in node_modules/discord.js/typings/index.d.ts:1617

systemChannel

get systemChannel(): null | TextChannel
Returns null | TextChannel
- Defined in node_modules/discord.js/typings/index.d.ts:1623

verified

get verified(): boolean
Returns boolean
Inherited from AnonymousGuild.verified
- Defined in node_modules/discord.js/typings/index.d.ts:693

voiceAdapterCreator

get voiceAdapterCreator(): InternalDiscordGatewayAdapterCreator
Returns InternalDiscordGatewayAdapterCreator
- Defined in node_modules/discord.js/typings/index.d.ts:1627

widgetChannel

get widgetChannel(): | null
| NewsChannel
| TextChannel
| ForumChannel
| MediaChannel
| VoiceBasedChannel
Returns
    | null
    | NewsChannel
    | TextChannel
    | ForumChannel
    | MediaChannel
    | VoiceBasedChannel
- Defined in node_modules/discord.js/typings/index.d.ts:1629

Methods

bannerURL

bannerURL(options?: ImageURLOptions): null | string
Parameters
- Optionaloptions: ImageURLOptions
Returns null | string
Inherited from AnonymousGuild.bannerURL
- Defined in node_modules/discord.js/typings/index.d.ts:385

createTemplate

createTemplate(name: string, description?: string): Promise<GuildTemplate>
Parameters
- name: string
- Optionaldescription: string
Returns Promise<GuildTemplate>
- Defined in node_modules/discord.js/typings/index.d.ts:1633

delete

delete(): Promise<Guild>
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1634

disableInvites

disableInvites(disabled?: boolean): Promise<Guild>
Parameters
- Optionaldisabled: boolean
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1655

discoverySplashURL

discoverySplashURL(options?: ImageURLOptions): null | string
Parameters
- Optionaloptions: ImageURLOptions
Returns null | string
- Defined in node_modules/discord.js/typings/index.d.ts:1635

edit

edit(options: GuildEditOptions): Promise<Guild>
Parameters
- options: GuildEditOptions
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1636

editOnboarding

editOnboarding(options: GuildOnboardingEditOptions): Promise<GuildOnboarding>
Parameters
- options: GuildOnboardingEditOptions
Returns Promise<GuildOnboarding>
- Defined in node_modules/discord.js/typings/index.d.ts:1637

editWelcomeScreen

editWelcomeScreen(options: WelcomeScreenEditOptions): Promise<WelcomeScreen>
Parameters
- options: WelcomeScreenEditOptions
Returns Promise<WelcomeScreen>
- Defined in node_modules/discord.js/typings/index.d.ts:1638

equals

equals(guild: Guild): boolean
Parameters
- guild: Guild
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:1639

fetch

fetch(): Promise<Guild>
Returns Promise<Guild>
Inherited from AnonymousGuild.fetch
- Defined in node_modules/discord.js/typings/index.d.ts:694

fetchAuditLogs

fetchAuditLogs<Event extends GuildAuditLogsResolvable = AuditLogEvent>(
options?: GuildAuditLogsFetchOptions<Event>,
): Promise<GuildAuditLogs<Event extends null ? AuditLogEvent : Event>>
Type Parameters
- Event extends GuildAuditLogsResolvable = AuditLogEvent
Parameters
- Optionaloptions: GuildAuditLogsFetchOptions<Event>
Returns Promise<GuildAuditLogs<Event extends null ? AuditLogEvent : Event>>
- Defined in node_modules/discord.js/typings/index.d.ts:1640

fetchIntegrations

fetchIntegrations(): Promise<Collection<string, Integration>>
Returns Promise<Collection<string, Integration>>
- Defined in node_modules/discord.js/typings/index.d.ts:1643

fetchOnboarding

fetchOnboarding(): Promise<GuildOnboarding>
Returns Promise<GuildOnboarding>
- Defined in node_modules/discord.js/typings/index.d.ts:1644

fetchOwner

fetchOwner(options?: BaseFetchOptions): Promise<GuildMember>
Parameters
- Optionaloptions: BaseFetchOptions
Returns Promise<GuildMember>
- Defined in node_modules/discord.js/typings/index.d.ts:1645

fetchPreview

fetchPreview(): Promise<GuildPreview>
Returns Promise<GuildPreview>
- Defined in node_modules/discord.js/typings/index.d.ts:1646

fetchTemplates

fetchTemplates(): Promise<Collection<string, GuildTemplate>>
Returns Promise<Collection<string, GuildTemplate>>
- Defined in node_modules/discord.js/typings/index.d.ts:1647

fetchVanityData

fetchVanityData(): Promise<Vanity>
Returns Promise<Vanity>
- Defined in node_modules/discord.js/typings/index.d.ts:1648

fetchWebhooks

fetchWebhooks(): Promise<
Collection<string, Webhook<Incoming | ChannelFollower>>,
>
Returns Promise<Collection<string, Webhook<Incoming | ChannelFollower>>>
- Defined in node_modules/discord.js/typings/index.d.ts:1649

fetchWelcomeScreen

fetchWelcomeScreen(): Promise<WelcomeScreen>
Returns Promise<WelcomeScreen>
- Defined in node_modules/discord.js/typings/index.d.ts:1650

fetchWidget

fetchWidget(): Promise<Widget>
Returns Promise<Widget>
- Defined in node_modules/discord.js/typings/index.d.ts:1651

fetchWidgetSettings

fetchWidgetSettings(): Promise<GuildWidgetSettings>
Returns Promise<GuildWidgetSettings>
- Defined in node_modules/discord.js/typings/index.d.ts:1652

iconURL

iconURL(options?: ImageURLOptions): null | string
Parameters
- Optionaloptions: ImageURLOptions
Returns null | string
Inherited from AnonymousGuild.iconURL
- Defined in node_modules/discord.js/typings/index.d.ts:695

leave

leave(): Promise<Guild>
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1654

setAFKChannel

setAFKChannel(
afkChannel: null | VoiceChannelResolvable,
reason?: string,
): Promise<Guild>
Parameters
- afkChannel: null | VoiceChannelResolvable
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1657

setAFKTimeout

setAFKTimeout(afkTimeout: number, reason?: string): Promise<Guild>
Parameters
- afkTimeout: number
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1658

setBanner

setBanner(banner: null | string | Buffer, reason?: string): Promise<Guild>
Parameters
- banner: null | string | Buffer
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1659

setDefaultMessageNotifications

setDefaultMessageNotifications(
defaultMessageNotifications: null | GuildDefaultMessageNotifications,
reason?: string,
): Promise<Guild>
Parameters
- defaultMessageNotifications: null | GuildDefaultMessageNotifications
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1660

setDiscoverySplash

setDiscoverySplash(
discoverySplash: null | string | Buffer,
reason?: string,
): Promise<Guild>
Parameters
- discoverySplash: null | string | Buffer
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1664

setExplicitContentFilter

setExplicitContentFilter(
explicitContentFilter: null | GuildExplicitContentFilter,
reason?: string,
): Promise<Guild>
Parameters
- explicitContentFilter: null | GuildExplicitContentFilter
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1668

setIcon

setIcon(icon: null | string | Buffer, reason?: string): Promise<Guild>
Parameters
- icon: null | string | Buffer
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1672

setIncidentActions

setIncidentActions(
incidentActions: IncidentActionsEditOptions,
): Promise<IncidentActions>
Parameters
- incidentActions: IncidentActionsEditOptions
Returns Promise<IncidentActions>
- Defined in node_modules/discord.js/typings/index.d.ts:1656

setMFALevel

setMFALevel(level: GuildMFALevel, reason?: string): Promise<Guild>
Parameters
- level: GuildMFALevel
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1685

setName

setName(name: string, reason?: string): Promise<Guild>
Parameters
- name: string
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1673

setOwner

setOwner(owner: GuildMemberResolvable, reason?: string): Promise<Guild>
Parameters
- owner: GuildMemberResolvable
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1674

setPreferredLocale

setPreferredLocale(
preferredLocale: null | Locale,
reason?: string,
): Promise<Guild>
Parameters
- preferredLocale: null | Locale
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1675

setPremiumProgressBarEnabled

setPremiumProgressBarEnabled(enabled?: boolean, reason?: string): Promise<Guild>
Parameters
- Optionalenabled: boolean
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1683

setPublicUpdatesChannel

setPublicUpdatesChannel(
publicUpdatesChannel: null | TextChannelResolvable,
reason?: string,
): Promise<Guild>
Parameters
- publicUpdatesChannel: null | TextChannelResolvable
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1676

setRulesChannel

setRulesChannel(
rulesChannel: null | TextChannelResolvable,
reason?: string,
): Promise<Guild>
Parameters
- rulesChannel: null | TextChannelResolvable
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1677

setSafetyAlertsChannel

setSafetyAlertsChannel(
safetyAlertsChannel: null | TextChannelResolvable,
reason?: string,
): Promise<Guild>
Parameters
- safetyAlertsChannel: null | TextChannelResolvable
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1678

setSplash

setSplash(splash: null | string | Buffer, reason?: string): Promise<Guild>
Parameters
- splash: null | string | Buffer
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1679

setSystemChannel

setSystemChannel(
systemChannel: null | TextChannelResolvable,
reason?: string,
): Promise<Guild>
Parameters
- systemChannel: null | TextChannelResolvable
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1680

setSystemChannelFlags

setSystemChannelFlags(
systemChannelFlags: SystemChannelFlagsResolvable,
reason?: string,
): Promise<Guild>
Parameters
- systemChannelFlags: SystemChannelFlagsResolvable
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1681

setVerificationLevel

setVerificationLevel(
verificationLevel: null | GuildVerificationLevel,
reason?: string,
): Promise<Guild>
Parameters
- verificationLevel: null | GuildVerificationLevel
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1682

setWidgetSettings

setWidgetSettings(
settings: GuildWidgetSettingsData,
reason?: string,
): Promise<Guild>
Parameters
- settings: GuildWidgetSettingsData
- Optionalreason: string
Returns Promise<Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:1684

splashURL

splashURL(options?: ImageURLOptions): null | string
Parameters
- Optionaloptions: ImageURLOptions
Returns null | string
Inherited from AnonymousGuild.splashURL
- Defined in node_modules/discord.js/typings/index.d.ts:386

toJSON

toJSON(): unknown
Returns unknown
Overrides AnonymousGuild.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:1686

toString

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

Returns string
Inherited from AnonymousGuild.toString
- Defined in node_modules/discord.js/typings/index.d.ts:696

valueOf

valueOf(): string
Returns string
Inherited from AnonymousGuild.valueOf
- Defined in node_modules/discord.js/typings/index.d.ts:561

widgetImageURL

widgetImageURL(style?: GuildWidgetStyle): string
Parameters
- Optionalstyle: GuildWidgetStyle
Returns string
- Defined in node_modules/discord.js/typings/index.d.ts:1653

Class Guild

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

afkChannelId

afkTimeout

applicationId

approximateMemberCount

approximatePresenceCount

autoModerationRules

available

banner

bans

channels

Readonlyclient

commands

defaultMessageNotifications

description

discoverySplash

emojis

explicitContentFilter

features

icon

id

incidentsData

invites

joinedTimestamp

large

maximumMembers

maximumPresences

maxStageVideoChannelUsers

maxVideoChannelUsers

memberCount

members

mfaLevel

name

nsfwLevel

ownerId

preferredLocale

premiumProgressBarEnabled

premiumSubscriptionCount

premiumTier

presences

publicUpdatesChannelId

roles

rulesChannelId

safetyAlertsChannelId

scheduledEvents

shardId

soundboardSounds

splash

stageInstances

stickers

systemChannelFlags

systemChannelId

vanityURLCode

vanityURLUses

verificationLevel

voiceStates

widgetChannelId

widgetEnabled

Accessors

afkChannel

Returns null | VoiceChannel

createdAt

Returns Date

createdTimestamp

Returns number

joinedAt

Returns Date

maximumBitrate

Returns number

nameAcronym

Returns string

partnered

Returns boolean

publicUpdatesChannel

`Readonly`client

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