Class Guild

Represents a Discord server.

Hierarchy

Constructors

constructor

Properties

afkChannel? afkChannelID afkTimeout application? applicationID approximateMemberCount? approximatePresenceCount? auditLogEntries autoModerationRules banner channels client defaultMessageNotifications description discoverySplash emojis explicitContentFilter features icon id integrations invites joinedAt large maxMembers? maxPresences? maxStageVideoChannelUsers? maxVideoChannelUsers? memberCount members mfaLevel name nsfwLevel owner? ownerID preferredLocale premiumProgressBarEnabled premiumSubscriptionCount? premiumTier publicUpdatesChannel? publicUpdatesChannelID region? roles rulesChannel? rulesChannelID safetyAlertsChannel? safetyAlertsChannelID scheduledEvents splash stageInstances stickers systemChannel? systemChannelFlags systemChannelID threads unavailable vanityURLCode verificationLevel voiceStates welcomeScreen? widgetChannel? widgetChannelID widgetEnabled?

Accessors

clientMember createdAt shard voiceAdapterCreator

Methods

addMember addMemberRole bannerURL beginPrune createAutoModerationRule createBan createChannel createEmoji createRole createScheduledEvent createSticker createTemplate delete deleteAutoModerationRule deleteEmoji deleteIntegration deleteRole deleteScheduledEvent deleteSticker deleteTemplate disableCommunity disableDiscovery disableInvites disableRaidAlerts discoverySplashURL edit editAutoModerationRule editChannelPositions editCurrentMember editCurrentUserVoiceState editEmoji editMFALevel editMember editRole editRolePositions editScheduledEvent editSticker editTemplate editUserVoiceState editWelcomeScreen editWidget enableCommunity enableDiscovery enableInvites enableRaidAlerts fetchMembers getActiveThreads getAuditLog getAutoModerationRule getAutoModerationRules getBan getBans getChannels getEmoji getEmojis getIntegrations getInvites getMember getMembers getPreview getPruneCount getRoles getScheduledEvent getScheduledEventUsers getScheduledEvents getSticker getStickers getTemplates getVanityURL getVoiceRegions getWebhooks getWelcomeScreen getWidget getWidgetImage getWidgetJSON getWidgetSettings iconURL joinChannel leave leaveChannel permissionsOf removeBan removeMember removeMemberRole searchMembers splashURL syncTemplate toJSON toString getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

Optional afkChannel

afkChannel?: null | VoiceChannel

This guild's afk voice channel.

afkChannelID

afkChannelID: null | string

The ID of this guild's afk voice channel.

afkTimeout

afkTimeout: number

The seconds after which voice users will be moved to the afk channel.

Optional application

application?: null | ClientApplication

The application that created this guild, if applicable.

applicationID

applicationID: null | string

The ID of the application that created this guild, if applicable.

Optional approximateMemberCount

approximateMemberCount?: number

The approximate number of members in this guild (if retrieved with counts).

Optional approximatePresenceCount

approximatePresenceCount?: number

The approximate number of non-offline members in this guild (if retrieved with counts).

auditLogEntries

auditLogEntries: TypedCollection<string, RawAuditLogEntry, AuditLogEntry, []>

The cached audit log entries. This requires both the GUILD_MODERATION intent, as well as the Constants~Permissions.VIEW_AUDIT_LOG | VIEW_AUDIT_LOG permission.

autoModerationRules

autoModerationRules: TypedCollection<string, RawAutoModerationRule, AutoModerationRule, []>

The auto moderation rules in this guild.

banner

banner: null | string

The hash of this guild's banner.

channels

channels: TypedCollection<string, RawGuildChannel, AnyGuildChannelWithoutThreads, []>

The channels in this guild.

client

client: Client<ClientEvents>

defaultMessageNotifications

defaultMessageNotifications: DefaultMessageNotificationLevels

The default message notifications level of this guild.

description

description: null | string

The description of this guild.

discoverySplash

discoverySplash: null | string

The discovery splash of this guild. Only present if the guild has the DISCOVERABLE feature.

emojis

emojis: GuildEmoji[]

The custom emojis of this guild.

explicitContentFilter

explicitContentFilter: ExplicitContentFilterLevels

The explicit content filter of this guild.

features

features: ("APPLICATION_COMMAND_PERMISSIONS_V2" | "ANIMATED_BANNER" | "ANIMATED_ICON" | "AUTO_MODERATION" | "BANNER" | "BOT_DEVELOPER_EARLY_ACCESS" | "COMMUNITY" | "CREATOR_MONETIZABLE" | "CREATOR_MONETIZABLE_DISABLED" | "CREATOR_MONETIZABLE_PROVISIONAL" | "CREATOR_STORE_PAGE" | "DEVELOPER_SUPPORT_SERVER" | "DISCOVERABLE" | "DISCOVERABLE_DISABLED" | "ENABLED_DISCOVERABLE_BEFORE" | "EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT" | "FEATURABLE" | "GUILD_HOME_TEST" | "HAD_EARLY_ACTIVITIES_ACCESS" | "HAS_DIRECTORY_ENTRY" | "HUB" | "INCREASED_THREAD_LIMIT" | "INTERNAL_EMPLOYEE_ONLY" | "INVITES_DISABLED" | "INVITE_SPLASH" | "LINKED_TO_HUB" | "MEMBER_PROFILES" | "MEMBER_VERIFICATION_GATE_ENABLED" | "MONETIZATION_ENABLED" | "MORE_EMOJI" | "MORE_EMOJIS" | "MORE_STICKERS" | "NEWS" | "NEW_THREAD_PERMISSIONS" | "PARTNERED" | "PREVIEW_ENABLED" | "PREVIOUSLY_DISCOVERABLE" | "PRIVATE_THREADS" | "RAID_ALERTS_ENABLED" | "ROLE_ICONS" | "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE" | "ROLE_SUBSCRIPTIONS_ENABLED" | "SEVEN_DAY_THREAD_ARCHIVE" | "TEXT_IN_VOICE_ENABLED" | "THREADS_ENABLED" | "THREADS_ENABLED_TESTING" | "THREE_DAY_THREAD_ARCHIVE" | "TICKETED_EVENTS_ENABLED" | "VANITY_URL" | "VERIFIED" | "VIP_REGIONS" | "WELCOME_SCREEN_ENABLED")[]

The features this guild has.

icon

icon: null | string

The icon hash of this guild.

id

id: string

integrations

integrations: TypedCollection<string, RawIntegration, Integration, [guildID?: string]>

The integrations in this guild.

invites

invites: Collection<string, Invite<"withMetadata", Uncached | InviteChannel>>

The cached invites in this guild. This will only be populated by invites created while the client is active.

joinedAt

joinedAt: null | Date

The date at which this guild was joined.

large

large: boolean

If this guild is considered large.

Optional maxMembers

maxMembers?: number

The maximum amount of members this guild can have.

Optional maxPresences

maxPresences?: number

The maximum amount of people that can be present at a time in this guild. Only present for very large guilds.

Optional maxStageVideoChannelUsers

maxStageVideoChannelUsers?: number

The maximum amount of users that can be present in a stage video channel.

Optional maxVideoChannelUsers

maxVideoChannelUsers?: number

The maximum amount of users that can be present in a video channel.

memberCount

memberCount: number

The number of members in this guild.

members

members: TypedCollection<string, RawMember | RESTMember, Member, [guildID: string]>

The cached members in this guild.

mfaLevel

mfaLevel: MFALevels

The required mfa level for moderators of this guild.

name

name: string

The name of this guild.

nsfwLevel

nsfwLevel: GuildNSFWLevels

The nsfw level of this guild.

Optional owner

owner?: User

The owner of this guild.

ownerID

ownerID: string

The ID of the owner of this guild.

preferredLocale

preferredLocale: string

The preferred locale of this guild.

premiumProgressBarEnabled

premiumProgressBarEnabled: boolean

If this guild has the boost progress bar enabled.

Optional premiumSubscriptionCount

premiumSubscriptionCount?: number

The number of nitro boosts this guild has.

premiumTier

premiumTier: PremiumTiers

The boost level of this guild.

Optional publicUpdatesChannel

publicUpdatesChannel?: null | AnyGuildTextChannel

The channel where notices from Discord are received. Only present in guilds with the COMMUNITY feature.

publicUpdatesChannelID

publicUpdatesChannelID: null | string

The id of the channel where notices from Discord are received. Only present in guilds with the COMMUNITY feature.

Optional region

region?: null | string

Deprecated

The region of this guild.

roles

roles: TypedCollection<string, RawRole, Role, [guildID: string]>

The roles in this guild.

Optional rulesChannel

rulesChannel?: null | TextChannel

The channel where rules/guidelines are displayed. Only present in guilds with the COMMUNITY feature.

rulesChannelID

rulesChannelID: null | string

The id of the channel where rules/guidelines are displayed. Only present in guilds with the COMMUNITY feature.

Optional safetyAlertsChannel

safetyAlertsChannel?: null | TextChannel

The channel where safety related notices are posted.

safetyAlertsChannelID

safetyAlertsChannelID: null | string

The ID if the channel where safety related notices are posted.

scheduledEvents

scheduledEvents: TypedCollection<string, RawScheduledEvent, GuildScheduledEvent, []>

The scheduled events in this guild.

splash

splash: null | string

The invite splash hash of this guild.

stageInstances

stageInstances: TypedCollection<string, RawStageInstance, StageInstance, []>

The stage instances in this guild.

stickers

stickers: Sticker[]

The custom stickers of this guild.

Optional systemChannel

systemChannel?: null | TextChannel

The channel where welcome messages and boosts notices are posted.

systemChannelFlags

systemChannelFlags: number

The flags for the system channel.

systemChannelID

systemChannelID: null | string

The ID of the channel where welcome messages and boosts notices are posted.

threads

threads: TypedCollection<string, RawThreadChannel, AnyThreadChannel, []>

The threads in this guild.

unavailable

unavailable: boolean

If this guild is unavailable.

vanityURLCode

vanityURLCode: null | string

The vanity url of this guild. Only present in guilds with the VANITY_URL feature.

verificationLevel

verificationLevel: VerificationLevels

The verification level of this guild.

voiceStates

voiceStates: TypedCollection<string, RawVoiceState, VoiceState, []>

The voice states of members in voice channels.

Optional welcomeScreen

welcomeScreen?: WelcomeScreen

The welcome screen configuration. Only present in guilds with the WELCOME_SCREEN_ENABLED feature.

Optional widgetChannel

widgetChannel?: null | TextChannel | VoiceChannel | AnnouncementChannel | AnnouncementThreadChannel | PublicThreadChannel | PrivateThreadChannel | StageChannel | ForumChannel

The channel the widget will generate an invite to, or null if set to no invite.

widgetChannelID

widgetChannelID: null | string

The id of the channel the widget will generate an invite to, or null if set to no invite.

Optional widgetEnabled

widgetEnabled?: boolean

If the widget is enabled.

Accessors

clientMember

  • get clientMember(): Member

  • The client's member for this guild. This will throw an error if the guild was obtained via rest and the member is not cached.

    Returns Member

createdAt

shard

voiceAdapterCreator

  • get voiceAdapterCreator(): DiscordGatewayAdapterCreator

  • The voice adapter creator for this guild that can be used with @discordjs/voice to play audio in voice and stage channels.

    Returns DiscordGatewayAdapterCreator

Methods

addMember

  • Add a member to this guild. Requires an access token with the guilds.join scope.

    Returns the newly added member upon success, or void if the member is already in the guild.

    Parameters

    • userID: string

      The ID of the user to add.

    • options: AddMemberOptions

      The options for adding the member.

    Returns Promise<void | Member>

addMemberRole

  • Add a role to a member.

    Parameters

    • memberID: string

      The ID of the member.

    • roleID: string

      The ID of the role to add.

    • Optional reason: string

      The reason for adding the role.

    Returns Promise<void>

bannerURL

  • The url of this guild's banner.

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format the url should be.

    • Optional size: number

      The dimensions of the image.

    Returns null | string

beginPrune

createAutoModerationRule

createBan

createChannel

createEmoji

createRole

createScheduledEvent

createSticker

createTemplate

delete

deleteAutoModerationRule

  • Delete an auto moderation rule in this guild.

    Parameters

    • ruleID: string

      The ID of the rule to delete.

    • Optional reason: string

      The reason for deleting the rule.

    Returns Promise<void>

deleteEmoji

  • Delete an emoji in this guild.

    Parameters

    • emojiID: string

      The ID of the emoji.

    • Optional reason: string

      The reason for deleting the emoji.

    Returns Promise<void>

deleteIntegration

  • Delete an integration.

    Parameters

    • integrationID: string

      The ID of the integration.

    • Optional reason: string

      The reason for deleting the integration.

    Returns Promise<void>

deleteRole

  • Delete a role.

    Parameters

    • roleID: string

      The ID of the role to delete.

    • Optional reason: string

      The reason for deleting the role.

    Returns Promise<void>

deleteScheduledEvent

  • Delete a scheduled event.

    Parameters

    • eventID: string

      The ID of the scheduled event.

    • Optional reason: string

      The reason for deleting the scheduled event. Discord's docs do not explicitly state a reason can be provided, so it may not be used.

    Returns Promise<void>

deleteSticker

  • Delete a sticker.

    Parameters

    • stickerID: string

      The ID of the sticker to delete.

    • Optional reason: string

      The reason for deleting the sticker.

    Returns Promise<void>

deleteTemplate

  • Delete a template.

    Parameters

    • code: string

      The code of the template.

    Returns Promise<void>

disableCommunity

  • Disable the COMMUNITY feature for this guild. Requires the Administrator permission.

    Parameters

    • Optional reason: string

      The reason for disable the feature.

    Returns Promise<Guild>

disableDiscovery

  • Disable the DISCOVERABLE feature for this guild. Requires the Administrator permission.

    Parameters

    • Optional reason: string

      The reason for disabling the feature.

    Returns Promise<Guild>

disableInvites

  • Disable the INVITES_DISABLED feature for this guild. Requires the Manage Guild permission.

    Parameters

    • Optional reason: string

      The reason for disabling the feature.

    Returns Promise<Guild>

disableRaidAlerts

  • Disable the RAID_ALERTS_ENABLED feature for this guild. Requires the Manage Guild permission.

    Parameters

    • Optional reason: string

      The reason for disabling the feature.

    Returns Promise<Guild>

discoverySplashURL

  • The url of this guild's discovery splash.

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format the url should be.

    • Optional size: number

      The dimensions of the image.

    Returns null | string

edit

editAutoModerationRule

editChannelPositions

editCurrentMember

editCurrentUserVoiceState

editEmoji

editMFALevel

editMember

  • Edit a member of this guild. Use <Guild>.editCurrentMember if you wish to update the nick of this client using the CHANGE_NICKNAME permission.

    Parameters

    • memberID: string

      The ID of the member.

    • options: EditMemberOptions

      The options for editing the member.

    Returns Promise<Member>

editRole

editRolePositions

editScheduledEvent

editSticker

editTemplate

editUserVoiceState

editWelcomeScreen

editWidget

enableCommunity

  • Enable the COMMUNITY feature for this guild. Requires the Administrator permission.

    Parameters

    • Optional reason: string

      The reason for enabling the feature.

    Returns Promise<Guild>

enableDiscovery

  • Enable the DISCOVERABLE feature for this guild. Requires the Administrator permission. The server must also be passing all discovery requirements.

    Parameters

    • Optional reason: string

      The reason for enabling the feature.

    Returns Promise<Guild>

enableInvites

  • Enable the INVITES_DISABLED feature for this guild. Requires the Manage Guild permission.

    Parameters

    • Optional reason: string

      The reason for enabling the feature.

    Returns Promise<Guild>

enableRaidAlerts

  • Enable the RAID_ALERTS_ENABLED feature for this guild. Requires the Manage Guild permission.

    Parameters

    • Optional reason: string

      The reason for enabling the feature.

    Returns Promise<Guild>

fetchMembers

getActiveThreads

getAuditLog

getAutoModerationRule

getAutoModerationRules

getBan

  • Get a ban in this guild.

    Parameters

    • userID: string

      The ID of the user to get the ban of.

    Returns Promise<Ban>

getBans

getChannels

getEmoji

getEmojis

getIntegrations

getInvites

getMember

getMembers

getPreview

getPruneCount

getRoles

getScheduledEvent

  • Get a scheduled event.

    Parameters

    • eventID: string

      The ID of the scheduled event to get.

    • Optional withUserCount: number

      If the number of users subscribed to the event should be included.

    Returns Promise<GuildScheduledEvent>

getScheduledEventUsers

getScheduledEvents

getSticker

  • Get a sticker. Response will include a user if the client has the MANAGE_EMOJIS_AND_STICKERS permissions.

    Parameters

    • stickerID: string

      The ID of the sticker to get.

    Returns Promise<Sticker>

getStickers

  • Get this guild's stickers. Stickers will include a user if the client has the MANAGE_EMOJIS_AND_STICKERS permissions.

    Returns Promise<Sticker[]>

getTemplates

getVanityURL

getVoiceRegions

getWebhooks

getWelcomeScreen

getWidget

getWidgetImage

getWidgetJSON

getWidgetSettings

iconURL

  • The url of this guild's icon.

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format the url should be.

    • Optional size: number

      The dimensions of the image.

    Returns null | string

joinChannel

leave

leaveChannel

permissionsOf

removeBan

  • Remove a ban.

    Parameters

    • userID: string

      The ID of the user to remove the ban from.

    • Optional reason: string

      The reason for removing the ban.

    Returns Promise<void>

removeMember

  • Remove a member from this guild.

    Parameters

    • memberID: string

      The ID of the user to remove.

    • Optional reason: string

      The reason for the removal.

    Returns Promise<void>

removeMemberRole

  • remove a role from a member.

    Parameters

    • memberID: string

      The ID of the member.

    • roleID: string

      The ID of the role to remove.

    • Optional reason: string

      The reason for removing the role.

    Returns Promise<void>

searchMembers

splashURL

  • The url of this guild's invite splash.

    Parameters

    • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

      The format the url should be.

    • Optional size: number

      The dimensions of the image.

    Returns null | string

syncTemplate

toJSON

toString

Static getCreatedAt

Static getDiscordEpoch

Settings

Member Visibility

Theme