Class REST/Guilds

Various methods for interacting with guilds. Located at Client#rest .guilds.

Hierarchy

REST/Guilds

Index

Constructors

Methods

addMember addMemberRole beginPrune create createAutoModerationRule createBan createChannel createEmoji createFromTemplate createRole createScheduledEvent createSticker createTemplate delete deleteAutoModerationRule deleteEmoji deleteIntegration deleteRole deleteScheduledEvent deleteSticker deleteTemplate edit editAutoModerationRule editChannelPositions editCurrentMember editCurrentUserVoiceState editEmoji editIncidentActions editMFALevel editMember editOnboarding editRole editRolePositions editScheduledEvent editSticker editTemplate editUserVoiceState editWelcomeScreen editWidget get getActiveThreads getAuditLog getAutoModerationRule getAutoModerationRules getBan getBans getChannels getEmoji getEmojis getIntegrations getInvites getMember getMembers getOnboarding getPreview getPruneCount getRoles getScheduledEvent getScheduledEventUsers getScheduledEvents getSticker getStickers getTemplate getTemplates getVanityURL getVoiceRegions getWelcomeScreen getWidget getWidgetImage getWidgetJSON getWidgetSettings removeBan removeMember removeMemberRole searchMembers syncTemplate

Constructors

constructor

new Guilds(manager): REST/Guilds
Parameters
- manager: RESTManager
Returns REST/Guilds
- Defined in lib/routes/Guilds.ts:97

Methods

addMember

addMember(guildID, userID, options): Promise<undefined | Member>
Add a member to a 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
- guildID: string
  
  The ID of the guild.
- userID: string
  
  The ID of the user to add.
- options: AddMemberOptions
  
  The options for adding the member.
Returns Promise<undefined | Member>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#members
- Defined in lib/routes/Guilds.ts:111

addMemberRole

addMemberRole(guildID, memberID, roleID, reason?): Promise<void>
Add a role to a member.
Parameters
- guildID: string
  
  The ID of the guild.
- 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:133

beginPrune

beginPrune(guildID, options?): Promise<null | number>
Begin a prune.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional options: BeginPruneOptions
  
  The options for the prune.
Returns Promise<null | number>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:147

create

create(options): Promise<Guild>
Create a guild. This can only be used by bots in under 10 guilds.
Parameters
- options: CreateGuildOptions
  
  The options for creating the guild.
Returns Promise<Guild>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:169

createAutoModerationRule

createAutoModerationRule(guildID, options): Promise<AutoModerationRule>
Create an auto moderation rule for a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: CreateAutoModerationRuleOptions
  
  The options for creating the rule.
Returns Promise<AutoModerationRule>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#autoModerationRules
- Defined in lib/routes/Guilds.ts:200

createBan

createBan(guildID, userID, options?): Promise<void>
Create a ban for a user.
Parameters
- guildID: string
  
  The ID of the guild.
- userID: string
  
  The ID of the user to ban.
- Optional options: CreateBanOptions
  
  The options for creating the ban.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:242

createChannel

createChannel<T>(guildID, type, options): Promise<ChannelTypeMap[T]>
Create a channel in a guild.
Type Parameters
- T extends GUILD_TEXT | GUILD_VOICE | GUILD_CATEGORY | GUILD_ANNOUNCEMENT | GUILD_STAGE_VOICE | GUILD_DIRECTORY | GUILD_FORUM | GUILD_MEDIA
Parameters
- guildID: string
  
  The ID of the guild.
- type: T
- options: Omit<CreateChannelOptions<GUILD_TEXT | GUILD_VOICE | GUILD_CATEGORY | GUILD_ANNOUNCEMENT | GUILD_STAGE_VOICE | GUILD_DIRECTORY | GUILD_FORUM | GUILD_MEDIA>, "type">
  
  The options for creating the channel.
Returns Promise<ChannelTypeMap[T]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#channels
- Defined in lib/routes/Guilds.ts:265

createEmoji

createEmoji(guildID, options): Promise<GuildEmoji>
Create an emoji in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: CreateEmojiOptions
  
  The options for creating the emoji.
Returns Promise<GuildEmoji>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#emojis
Client#users (creator, if applicable)
- Defined in lib/routes/Guilds.ts:308

createFromTemplate

createFromTemplate(code, options): Promise<Guild>
Create a guild from a template. This can only be used by bots in less than 10 guilds.

Note: This does NOT add the guild to the client's cache.
Parameters
- code: string
  
  The code of the template to use.
- options: CreateGuildFromTemplateOptions
  
  The options for creating the guild.
Returns Promise<Guild>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:336

createRole

createRole(guildID, options?): Promise<Role>
Create a role.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional options: CreateRoleOptions
  
  The options for creating the role.
Returns Promise<Role>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#roles
- Defined in lib/routes/Guilds.ts:357

createScheduledEvent

createScheduledEvent(guildID, options): Promise<GuildScheduledEvent>
Create a scheduled event in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: CreateScheduledEventOptions
  
  The options for creating the scheduled event.
Returns Promise<GuildScheduledEvent>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#scheduledEvents
- Defined in lib/routes/Guilds.ts:388

createSticker

createSticker(guildID, options): Promise<Sticker>
Create a sticker.
Parameters
- guildID: string
  
  The ID of the guild.
- options: CreateStickerOptions
  
  The options for creating the sticker.
Returns Promise<Sticker>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#stickers
Client#users (creator, if applicable)
- Defined in lib/routes/Guilds.ts:421

createTemplate

createTemplate(guildID, options): Promise<GuildTemplate>
Create a guild template.
Parameters
- guildID: string
  
  The ID of the guild to create a template from.
- options: CreateTemplateOptions
  
  The options for creating the template.
Returns Promise<GuildTemplate>
- Defined in lib/routes/Guilds.ts:454

delete

delete(guildID): Promise<void>
Delete a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:470

deleteAutoModerationRule

deleteAutoModerationRule(guildID, ruleID, reason?): Promise<void>
Delete an auto moderation rule.
Parameters
- guildID: string
  
  The ID of the guild.
- ruleID: string
  
  The ID of the rule to delete.
- Optional reason: string
  
  The reason for deleting the rule.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:484

deleteEmoji

deleteEmoji(guildID, emojiID, reason?): Promise<void>
Delete an emoji.
Parameters
- guildID: string
  
  The ID of the guild.
- emojiID: string
  
  The ID of the emoji.
- Optional reason: string
  
  The reason for deleting the emoji.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:499

deleteIntegration

deleteIntegration(guildID, integrationID, reason?): Promise<void>
Delete an integration.
Parameters
- guildID: string
  
  The ID of the guild.
- integrationID: string
  
  The ID of the integration.
- Optional reason: string
  
  The reason for deleting the integration.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:514

deleteRole

deleteRole(guildID, roleID, reason?): Promise<void>
Delete a role.
Parameters
- guildID: string
  
  The ID of the guild.
- roleID: string
  
  The ID of the role to delete.
- Optional reason: string
  
  The reason for deleting the role.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:529

deleteScheduledEvent

deleteScheduledEvent(guildID, eventID, reason?): Promise<void>
Delete a scheduled event.
Parameters
- guildID: string
  
  The ID of the guild.
- 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:544

deleteSticker

deleteSticker(guildID, stickerID, reason?): Promise<void>
Delete a sticker.
Parameters
- guildID: string
  
  The ID of the guild.
- stickerID: string
  
  The ID of the sticker to delete.
- Optional reason: string
  
  The reason for deleting the sticker.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:559

deleteTemplate

deleteTemplate(guildID, code): Promise<void>
Delete a template.
Parameters
- guildID: string
  
  The ID of the guild.
- code: string
  
  The code of the template.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:573

edit

edit(guildID, options): Promise<Guild>
Edit a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditGuildOptions
  
  The options for editing the guild.
Returns Promise<Guild>

Caching
This method may cache its result. The result will not be cached if the guild is not already cached.

Caches
Client#guilds
- Defined in lib/routes/Guilds.ts:587

editAutoModerationRule

editAutoModerationRule(guildID, ruleID, options): Promise<AutoModerationRule>
Edit an existing auto moderation rule.
Parameters
- guildID: string
  
  The ID of the guild.
- ruleID: string
  
  The ID of the rule to edit.
- options: Partial<Pick<CreateAutoModerationRuleOptions, "name" | "reason" | "eventType" | "triggerMetadata" | "actions" | "enabled" | "exemptRoles" | "exemptChannels">>
  
  The options for editing the rule.
Returns Promise<AutoModerationRule>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#autoModerationRules
- Defined in lib/routes/Guilds.ts:642

editChannelPositions

editChannelPositions(guildID, options): Promise<void>
Edit the positions of channels in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: ModifyChannelPositionsEntry[]
  
  The channels to move. Unedited channels do not need to be specified.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:683

editCurrentMember

editCurrentMember(guildID, options): Promise<Member>
Modify the current member in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditCurrentMemberOptions
  
  The options for editing the member.
Returns Promise<Member>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#members
Guild#clientMember
- Defined in lib/routes/Guilds.ts:703

editCurrentUserVoiceState

editCurrentUserVoiceState(guildID, options): Promise<void>
Edit the current member's voice state in a guild. channelID is required, and the current member must already be in that channel. See Discord's docs for more information.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditCurrentUserVoiceStateOptions
  
  The options for editing the voice state.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:722

editEmoji

editEmoji(guildID, emojiID, options): Promise<GuildEmoji>
Edit an existing emoji.
Parameters
- guildID: string
  
  The ID of the guild the emoji is in.
- emojiID: string
- options: EditEmojiOptions
  
  The options for editing the emoji.
Returns Promise<GuildEmoji>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#emojis
- Defined in lib/routes/Guilds.ts:741

editIncidentActions

editIncidentActions(guildID, options): Promise<IncidentActions>
Edit the incident actions for a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditIncidentActionsOptions
  
  The options for editing the incident actions.
Returns Promise<IncidentActions>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:763

editMFALevel

editMFALevel(guildID, options): Promise<MFALevels>
Edit the mfa level of a guild. This can only be used by the guild owner.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditMFALevelOptions
  
  The options for editing the MFA level.
Returns Promise<MFALevels>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:788

editMember

editMember(guildID, memberID, options): Promise<Member>
Edit a guild member. Use editCurrentMember if you wish to update the nick of this client using the CHANGE_NICKNAME permission.
Parameters
- guildID: string
  
  The ID of the guild.
- memberID: string
  
  The ID of the member.
- options: EditMemberOptions
  
  The options for editing the member.
Returns Promise<Member>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#members
- Defined in lib/routes/Guilds.ts:809

editOnboarding

editOnboarding(guildID, options): Promise<Onboarding>
Edit a guild's onboarding configuration.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditOnboardingOptions
  
  The options for editing the onboarding configuration.
Returns Promise<Onboarding>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:835

editRole

editRole(guildID, roleID, options): Promise<Role>
Edit an existing role.
Parameters
- guildID: string
  
  The ID of the guild.
- roleID: string
- options: EditRoleOptions
  
  The options for editing the role.
Returns Promise<Role>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#roles
- Defined in lib/routes/Guilds.ts:894

editRolePositions

editRolePositions(guildID, options, reason?): Promise<Role[]>
Edit the position of roles in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditRolePositionsEntry[]
  
  The roles to move.
- Optional reason: string
Returns Promise<Role[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#roles
- Defined in lib/routes/Guilds.ts:925

editScheduledEvent

editScheduledEvent(guildID, options): Promise<GuildScheduledEvent>
Edit an existing scheduled event in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditScheduledEventOptions
  
  The options for editing the scheduled event.
Returns Promise<GuildScheduledEvent>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#scheduledEvents
- Defined in lib/routes/Guilds.ts:945

editSticker

editSticker(guildID, stickerID, options): Promise<Sticker>
Edit a sticker.
Parameters
- guildID: string
  
  The ID of the guild.
- stickerID: string
- options: EditStickerOptions
  
  The options for editing the sticker.
Returns Promise<Sticker>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#stickers
- Defined in lib/routes/Guilds.ts:979

editTemplate

editTemplate(guildID, code, options): Promise<GuildTemplate>
Edit a guild template.
Parameters
- guildID: string
  
  The ID of the guild.
- code: string
  
  The code of the template.
- options: EditGuildTemplateOptions
  
  The options for editing the template.
Returns Promise<GuildTemplate>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:999

editUserVoiceState

editUserVoiceState(guildID, memberID, options): Promise<void>
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.
Parameters
- guildID: string
  
  The ID of the guild.
- memberID: string
  
  The ID of the member.
- options: EditUserVoiceStateOptions
  
  The options for editing the voice state.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1018

editWelcomeScreen

editWelcomeScreen(guildID, options): Promise<WelcomeScreen>
Edit the welcome screen in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: EditWelcomeScreenOptions
  
  The options for editing the welcome screen.
Returns Promise<WelcomeScreen>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1035

editWidget

editWidget(guildID, options): Promise<Widget>
Edit the widget of a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: WidgetSettings
  
  The options for editing the widget.
Returns Promise<Widget>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1071

get

get(guildID, withCounts?): Promise<Guild>
Get a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional withCounts: boolean
  
  If the approximate number of members and online members should be included.
Returns Promise<Guild>

Caching
This method may cache its result. The result will not be cached if the guild is not already cached.

Caches
Client#guilds
- Defined in lib/routes/Guilds.ts:1105

getActiveThreads

getActiveThreads(guildID): Promise<GetActiveThreadsResponse>
Get the active threads in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<GetActiveThreadsResponse>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#threads
- Defined in lib/routes/Guilds.ts:1123

getAuditLog

getAuditLog(guildID, options?): Promise<AuditLog>
Get a guild's audit log.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional options: GetAuditLogOptions
  
  The options for getting the audit logs.
Returns Promise<AuditLog>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#autoModerationRules
Guild#scheduledEvents
Guild#integrations
Guild#threads
Client#users
- Defined in lib/routes/Guilds.ts:1145

getAutoModerationRule

getAutoModerationRule(guildID, ruleID): Promise<AutoModerationRule>
Get an auto moderation rule for a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- ruleID: string
  
  The ID of the rule to get.
Returns Promise<AutoModerationRule>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#autoModerationRules
- Defined in lib/routes/Guilds.ts:1183

getAutoModerationRules

getAutoModerationRules(guildID): Promise<AutoModerationRule[]>
Get the auto moderation rules for a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<AutoModerationRule[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#autoModerationRules
- Defined in lib/routes/Guilds.ts:1196

getBan

getBan(guildID, userID): Promise<Ban>
Get a ban.
Parameters
- guildID: string
  
  The ID of the guild.
- userID: string
  
  The ID of the user to get the ban of.
Returns Promise<Ban>

Caching
This method does cache part of its result.

Caches
Client#users
- Defined in lib/routes/Guilds.ts:1211

getBans

getBans(guildID, options?): Promise<Ban[]>
Get the bans in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional options: GetBansOptions
  
  The options for getting the bans.
Returns Promise<Ban[]>

Caching
This method does cache part of its result.

Caches
Client#users
- Defined in lib/routes/Guilds.ts:1228

getChannels

getChannels(guildID): Promise<AnyGuildChannelWithoutThreads[]>
Get the channels in a guild. Does not include threads.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<AnyGuildChannelWithoutThreads[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#channels
- Defined in lib/routes/Guilds.ts:1292

getEmoji

getEmoji(guildID, emojiID): Promise<GuildEmoji>
Get an emoji in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- emojiID: string
  
  The ID of the emoji to get.
Returns Promise<GuildEmoji>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#emojis
- Defined in lib/routes/Guilds.ts:1306

getEmojis

getEmojis(guildID): Promise<GuildEmoji[]>
Get the emojis in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<GuildEmoji[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#emojis (will be completely cleared and refilled)
- Defined in lib/routes/Guilds.ts:1319

getIntegrations

getIntegrations(guildID): Promise<Integration[]>
Get the integrations in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<Integration[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#integrations
- Defined in lib/routes/Guilds.ts:1336

getInvites

getInvites<CH>(guildID): Promise<Invite<"withMetadata", CH>[]>
Get the invites of a guild.
Type Parameters
- CH extends AnyInviteChannel | Uncached | PartialInviteChannel = AnyInviteChannel | Uncached | PartialInviteChannel
Parameters
- guildID: string
  
  The ID of the guild to get the invites of.
Returns Promise<Invite<"withMetadata", CH>[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#invites
- Defined in lib/routes/Guilds.ts:1350

getMember

getMember(guildID, memberID): Promise<Member>
Get a guild member.
Parameters
- guildID: string
  
  The ID of the guild.
- memberID: string
  
  The ID of the member.
Returns Promise<Member>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#members
- Defined in lib/routes/Guilds.ts:1365

getMembers

getMembers(guildID, options?): Promise<Member[]>
Get a guild's members. This requires the GUILD_MEMBERS intent.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional options: GetMembersOptions
  
  The options for getting the members.
Returns Promise<Member[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#members}
- Defined in lib/routes/Guilds.ts:1379

getOnboarding

getOnboarding(guildID): Promise<Onboarding>
Get a guild's onboarding info.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<Onboarding>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1399

getPreview

getPreview(guildID): Promise<GuildPreview>
Get a preview of a guild. If the client is not already in this guild, the guild must be lurkable.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<GuildPreview>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1431

getPruneCount

getPruneCount(guildID, options?): Promise<number>
Get the prune count of a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional options: GetPruneCountOptions
  
  The options for getting the prune count.
Returns Promise<number>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1444

getRoles

getRoles(guildID): Promise<Role[]>
Get the roles in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<Role[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#roles
- Defined in lib/routes/Guilds.ts:1465

getScheduledEvent

getScheduledEvent(guildID, eventID, withUserCount?): Promise<GuildScheduledEvent>
Get a scheduled event.
Parameters
- guildID: string
  
  The ID of the guild.
- 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>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#scheduledEvents
- Defined in lib/routes/Guilds.ts:1481

getScheduledEventUsers

getScheduledEventUsers(guildID, eventID, options?): Promise<ScheduledEventUser[]>
Get the users subscribed to a scheduled event.
Parameters
- guildID: string
  
  The ID of the guild.
- eventID: string
  
  The ID of the scheduled event.
- Optional options: GetScheduledEventUsersOptions
  
  The options for getting the users.
Returns Promise<ScheduledEventUser[]>

Caching
This method does cache part its result. Members will not be cached if the guild is not cached.

Caches
Client#users
Guild#members
- Defined in lib/routes/Guilds.ts:1502

getScheduledEvents

getScheduledEvents(guildID, withUserCount?): Promise<GuildScheduledEvent[]>
Get a guild's scheduled events.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional withUserCount: number
  
  If the number of users subscribed to the event should be included.
Returns Promise<GuildScheduledEvent[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#scheduledEvents
- Defined in lib/routes/Guilds.ts:1535

getSticker

getSticker(guildID, stickerID): Promise<Sticker>
Get a sticker. Response will include a user if the client has the MANAGE_EMOJIS_AND_STICKERS permissions.
Parameters
- guildID: string
  
  The ID of the guild.
- stickerID: string
  
  The ID of the sticker to get.
Returns Promise<Sticker>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#stickers
- Defined in lib/routes/Guilds.ts:1555

getStickers

getStickers(guildID): Promise<Sticker[]>
Get a guild's stickers. Stickers will include a user if the client has the MANAGE_EMOJIS_AND_STICKERS permissions.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<Sticker[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#stickers (will be completely cleared and refilled)
- Defined in lib/routes/Guilds.ts:1568

getTemplate

getTemplate(code): Promise<GuildTemplate>
Get a guild template.
Parameters
- code: string
  
  The code of the template to get.
Returns Promise<GuildTemplate>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1584

getTemplates

getTemplates(guildID): Promise<GuildTemplate[]>
Get a guild's templates.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<GuildTemplate[]>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1596

getVanityURL

getVanityURL(guildID): Promise<GetVanityURLResponse>
Get the vanity url of a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<GetVanityURLResponse>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1608

getVoiceRegions

getVoiceRegions(guildID): Promise<VoiceRegion[]>
Get the list of usable voice regions for a guild. This will return VIP servers when the guild is VIP-enabled.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<VoiceRegion[]>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1620

getWelcomeScreen

getWelcomeScreen(guildID): Promise<WelcomeScreen>
Get the welcome screen for a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<WelcomeScreen>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1632

getWidget

getWidget(guildID): Promise<Widget>
Get the widget of a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<Widget>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1652

getWidgetImage

getWidgetImage(guildID, style?): Promise<Buffer>
Get the widget image of a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- Optional style: WidgetImageStyle
  
  The style of the image.
Returns Promise<Buffer>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1681

getWidgetJSON

getWidgetJSON(guildID): Promise<RawWidget>
Get the raw JSON widget of a guild.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<RawWidget>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1698

getWidgetSettings

getWidgetSettings(guildID): Promise<WidgetSettings>
Get a guild's widget settings.
Parameters
- guildID: string
  
  The ID of the guild.
Returns Promise<WidgetSettings>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1710

removeBan

removeBan(guildID, userID, reason?): Promise<void>
Remove a ban.
Parameters
- guildID: string
  
  The ID of the guild.
- userID: string
  
  The ID of the user to remove the ban from.
- Optional reason: string
  
  The reason for removing the ban.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1727

removeMember

removeMember(guildID, memberID, reason?): Promise<void>
Remove a member from a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- memberID: string
  
  The ID of the user to remove.
- Optional reason: string
  
  The reason for the removal.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1742

removeMemberRole

removeMemberRole(guildID, memberID, roleID, reason?): Promise<void>
Remove a role from a member.
Parameters
- guildID: string
  
  The ID of the guild.
- 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1758

searchMembers

searchMembers(guildID, options): Promise<Member[]>
Search the username & nicknames of members in a guild.
Parameters
- guildID: string
  
  The ID of the guild.
- options: SearchMembersOptions
  
  The options to search with.
Returns Promise<Member[]>

Caching
This method may cache its result. The result will not be cached if the guild is not cached.

Caches
Guild#members
- Defined in lib/routes/Guilds.ts:1773

syncTemplate

syncTemplate(guildID, code): Promise<GuildTemplate>
Sync a guild template.
Parameters
- guildID: string
  
  The ID of the guild.
- code: string
  
  The code of the template to sync.
Returns Promise<GuildTemplate>

Caching
This method does not cache its result.
- Defined in lib/routes/Guilds.ts:1792

Class REST/Guilds

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns REST/Guilds

Methods

addMember

Parameters

guildID: string

userID: string

options: AddMemberOptions

Returns Promise<undefined | Member>

Caching

Caches

addMemberRole

Parameters

guildID: string

memberID: string

roleID: string

Optional reason: string

Returns Promise<void>

Caching

beginPrune

Parameters

guildID: string

Optional options: BeginPruneOptions

Returns Promise<null | number>

Caching

create

Parameters

options: CreateGuildOptions

Returns Promise<Guild>

Caching

createAutoModerationRule

Parameters

guildID: string

options: CreateAutoModerationRuleOptions

Returns Promise<AutoModerationRule>

Caching

Caches

createBan

Parameters

guildID: string

userID: string

Optional options: CreateBanOptions

Returns Promise<void>

Caching

createChannel

Type Parameters

T extends GUILD_TEXT | GUILD_VOICE | GUILD_CATEGORY | GUILD_ANNOUNCEMENT | GUILD_STAGE_VOICE | GUILD_DIRECTORY | GUILD_FORUM | GUILD_MEDIA

Parameters

guildID: string

type: T

options: Omit<CreateChannelOptions<GUILD_TEXT | GUILD_VOICE | GUILD_CATEGORY | GUILD_ANNOUNCEMENT | GUILD_STAGE_VOICE | GUILD_DIRECTORY | GUILD_FORUM | GUILD_MEDIA>, "type">

Returns Promise<ChannelTypeMap[T]>

Caching

Caches

createEmoji

Parameters

guildID: string

options: CreateEmojiOptions

Returns Promise<GuildEmoji>

Caching

Caches

createFromTemplate

Parameters

code: string

options: CreateGuildFromTemplateOptions

Returns Promise<Guild>

Caching

createRole

Parameters

guildID: string

Optional options: CreateRoleOptions

Returns Promise<Role>

`Optional` reason: string

`Optional` options: BeginPruneOptions

`Optional` options: CreateBanOptions

`Optional` options: CreateRoleOptions

`Optional` reason: string

`Optional` reason: string

`Optional` reason: string

`Optional` reason: string

`Optional` reason: string

`Optional` reason: string