This guild's afk voice channel. This can be a partial object with just an id
property.
The seconds after which voice users will be moved to the afk channel.
The application that created this guild, if applicable. This can be a partial object with just an id
property.
Optional
approximateThe approximate number of members in this guild (if retreived with counts).
Optional
approximateThe approximate number of non-offline members in this guild (if retreived with counts).
The auto moderation rules in this guild.
The hash of this guild's banner.
The channels in this guild.
The default message notifications level of this guild.
The description of this guild.
The discovery splash of this guild. Only present if the guild has the DISCOVERABLE
feature.
The custom emojis of this guild.
The explicit content filter of this guild.
The features this guild has.
The icon hash of this guild.
The integrations in this guild.
The date at which this guild was joined.
If this guild is considered large.
Optional
maxThe maximum amount of members this guild can have.
Optional
maxThe maximum amount of people that can be present at a time in this guild. Only present for very large guilds.
Optional
maxThe maximum amount of users that can be present in a video channel.
The number of members in this guild.
The cached members in this guild.
The required mfa level for moderators of this guild.
The name of this guild.
The nsfw level of this guild.
Optional
oauthIf the current user is the owner of this guild (only present when getting the current user's guilds).
The id of the owner of this guild.
Optional
permissionsThe permissions of the current user in this guild (only present when getting the current user's guilds).
The preferred locale of this guild.
If this guild has the boost progress bar enabled.
Optional
premiumThe number of nitro boosts this guild has.
The boost level of this guild.
The id of the channel where notices from Discord are recieved. Only present in guilds with the COMMUNITY
feature.
Optional
regionThe region of this guild.
The roles in this guild.
The id of the channel where rules/guidelines are displayed. Only present in guilds with the COMMUNITY
feature.
The scheduled events in this guild.
The invite splash hash of this guild.
The stage instances in this guild.
The custom stickers of this guild.
The id of the channel where welcome messages and boosts notices are posted.
The flags for the system channel.
The threads in this guild.
If this guild is unavailable.
The vanity url of this guild. Only present in guilds with the VANITY_URL
feature.
The verfication level of this guild.
The voice states of members in voice channels.
Optional
welcomeThe welcome screen configuration. Only present in guilds with the WELCOME_SCREEN_ENABLED
feature.
Optional
widgetThe id of the channel the widget will generate an invite to, or null
if set to no invite.
Optional
widgetIf the widget is enabled.
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.
The ID of the user to add.
The url of this guild's banner.
Optional
format: "jpg" | "jpeg" | "png" | "webp" | "gif"The format the url should be.
Optional
size: numberThe dimensions of the image.
Begine a prune.
Optional
options: BeginPruneOptionsCreate an auto moderation rule for this guild.
Create a bon for a user.
The ID of the user.
Optional
options: CreateBanOptionsCreate a channel in this guild.
Create an emoji in this guild.
Create a role.
Optional
options: CreateRoleOptionsCreate a scheduled event in this guild.
Create a guild template.
Delete a scheduled event.
The ID of the scheduled event.
Optional
reason: stringThe reason for deleting the scheduled event. Discord's docs do not explicitly state a reason can be provided, so it may not be used.
Edit this guild.
Edit an existing auto moderation rule in this guild.
The ID of the rule to edit.
Edit the positions of channels in this guild.
The channels to move. Unedited channels do not need to be specifed.
Modify the current member in this guild.
Edit the current member's voice state in this guild. channelID
is required, and the current member must already be in that channel. See Discord's docs for more information.
Edit an existing emoji in this guild.
Edit a member of this guild.
The ID of the member.
Edit an existing role.
Edit the position of roles in this guild.
Optional
reason: stringThe reason for moving the roles.
Edit an existing scheduled event in this guild.
Edit a template.
The code of the template.
Edit a guild member's voice state. channelID
is required, and the user must already be in that channel. See Discord's docs for more information.
The ID of the member.
Edit the welcome screen in this guild.
Edit the widget of this guild.
Get the active threads in this guild.
Get this guild's audit log.
Note: everything under the entries
key is raw from Discord. See their documentation for structure and other information. (audit_log_entries
)
Optional
options: GetAuditLogOptionsGet an auto moderation rule for this guild.
The ID of the rule to get.
Get the auto moderation rules for this guild.
Get the bans in this guild.
Optional
options: GetBansOptionsGet the channels in a guild. Does not include threads. Only use this if you need to. See the channels
collection.
Get an emoji in this guild.
The ID of the emoji to get.
Get the emojis in this guild.
Get the integrations in this guild.
Get the invites of this guild.
Get this guild's members. This requires the GUILD_MEMBERS
intent.
Optional
options: GetMembersOptionsGet a preview of this guild.
Get the prune count of this guild.
Optional
options: GetPruneCountOptionsGet a scheduled event.
The ID of the scheduled event to get.
Optional
withUserCount: numberIf the number of users subscribed to the event should be included.
Get the users subscribed to a scheduled event.
Optional
options: GetScheduledEventUsersOptionsGet this guild's scheduled events
Optional
withUserCount: numberIf the number of users subscribed to the event should be included.
Get this guild's templates.
Get the vanity url of this guild.
Get the list of usable voice regions for this guild. This will return VIP servers when the guild is VIP-enabled.
Get the welcome screen for this guild.
Get the widget image of this guild.
Optional
style: WidgetImageStyleThe style of the image.
Get this guild's widget settings.
Search the username & nicknames of members in this guild.
Sync a guild template.
The code of the template to sync.
Static
getStatic
get
Represents a Discord server.