GuildManager
Defined in: packages/managers/src/guild.ts:51
Generic REST-backed resource manager.
Extends
Section titled “Extends”ResourceManager<string,Guild>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GuildManager(
rest,options?):GuildManager
Defined in: packages/managers/src/guild.ts:81
Parameters
Section titled “Parameters”options?
Section titled “options?”maxMembers?
Section titled “maxMembers?”number
Returns
Section titled “Returns”GuildManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlycache:Collection<string,Guild>
Defined in: packages/managers/src/base.ts:27
Authoritative resource state. Entries never expire: see Manager.set.
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/managers/src/base.ts:105
Gets cache size.
Returns
Section titled “Returns”number
Number of cached values.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[string,Guild]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[string, Guild]>
Cache iterator.
Inherited from
Section titled “Inherited from”attachContext()
Section titled “attachContext()”attachContext(
context):void
Defined in: packages/managers/src/guild.ts:70
Lets members from this manager act through a client (member.kick()…). Called by the client.
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”void
autoModerationRules()
Section titled “autoModerationRules()”autoModerationRules(
guildId):Manager<string,APIAutoModerationRule>
Defined in: packages/managers/src/guild.ts:184
Auto-moderation rules by ID for a guild, kept in sync by AUTO_MODERATION_RULE_* events.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Manager<string, APIAutoModerationRule>
bans()
Section titled “bans()”bans(
guildId):GuildBanManager
Defined in: packages/managers/src/guild.ts:92
Ban manager for a guild (one instance per guild).
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”clear()
Section titled “clear()”clear():
void
Defined in: packages/managers/src/base.ts:101
Clears the cache.
Returns
Section titled “Returns”void
Nothing.
Inherited from
Section titled “Inherited from”create()
Section titled “create()”create(
options):Promise<Guild>
Defined in: packages/managers/src/guild.ts:235
Creates a new guild. (Bot must be in fewer than 10 guilds).
Parameters
Section titled “Parameters”options
Section titled “options”GuildCreateOptions
Returns
Section titled “Returns”Promise<Guild>
createAutoModerationRule()
Section titled “createAutoModerationRule()”createAutoModerationRule(
guildId,options):Promise<AutoModerationRule>
Defined in: packages/managers/src/guild.ts:451
Creates a new auto moderation rule.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
options
Section titled “options”Record<string, unknown> & object
Returns
Section titled “Returns”Promise<AutoModerationRule>
delete()
Section titled “delete()”delete(
id):boolean
Defined in: packages/managers/src/guild.ts:219
Removes a guild and every per-guild manager that belongs to it.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
Overrides
Section titled “Overrides”deleteAutoModerationRule()
Section titled “deleteAutoModerationRule()”deleteAutoModerationRule(
guildId,ruleId,reason?):Promise<void>
Defined in: packages/managers/src/guild.ts:480
Deletes an auto moderation rule.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
ruleId
Section titled “ruleId”string
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
edit()
Section titled “edit()”edit(
id,options):Promise<Guild>
Defined in: packages/managers/src/guild.ts:241
Modifies a guild’s settings.
Parameters
Section titled “Parameters”string
options
Section titled “options”GuildEditOptions
Returns
Section titled “Returns”Promise<Guild>
editAutoModerationRule()
Section titled “editAutoModerationRule()”editAutoModerationRule(
guildId,ruleId,options):Promise<AutoModerationRule>
Defined in: packages/managers/src/guild.ts:465
Modifies an existing auto moderation rule.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
ruleId
Section titled “ruleId”string
options
Section titled “options”Record<string, unknown> & object
Returns
Section titled “Returns”Promise<AutoModerationRule>
editOnboarding()
Section titled “editOnboarding()”editOnboarding(
id,options):Promise<APIGuildOnboarding>
Defined in: packages/managers/src/guild.ts:290
Replaces parts of a guild’s onboarding (needs Manage Guild and Manage Roles).
Parameters
Section titled “Parameters”string
options
Section titled “options”defaultChannelIds?
Section titled “defaultChannelIds?”string[]
enabled?
Section titled “enabled?”boolean
number
prompts?
Section titled “prompts?”reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<APIGuildOnboarding>
editVoiceState()
Section titled “editVoiceState()”editVoiceState(
id,userId,options):Promise<void>
Defined in: packages/managers/src/guild.ts:312
Edits a voice state in a stage channel: unsuppress the bot to speak, or
move a speaker back to the audience. userId may be "@me".
Parameters
Section titled “Parameters”string
userId
Section titled “userId”string
options
Section titled “options”channelId
Section titled “channelId”string
requestToSpeakTimestamp?
Section titled “requestToSpeakTimestamp?”string | null
suppress?
Section titled “suppress?”boolean
Returns
Section titled “Returns”Promise<void>
editWelcomeScreen()
Section titled “editWelcomeScreen()”editWelcomeScreen(
id,options):Promise<APIWelcomeScreen>
Defined in: packages/managers/src/guild.ts:267
Edits the welcome screen (needs Manage Guild and the Community feature).
Parameters
Section titled “Parameters”string
options
Section titled “options”description?
Section titled “description?”string | null
enabled?
Section titled “enabled?”boolean
reason?
Section titled “reason?”string
welcomeChannels?
Section titled “welcomeChannels?”APIWelcomeScreenChannel[] | null
Returns
Section titled “Returns”Promise<APIWelcomeScreen>
emojis()
Section titled “emojis()”emojis(
guildId):EmojiManager
Defined in: packages/managers/src/guild.ts:141
Emoji manager for a guild (one instance per guild, kept in sync by the Gateway).
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”fetch()
Section titled “fetch()”fetch(
id):Promise<Guild>
Defined in: packages/managers/src/base.ts:150
Fetches from Discord; a cached instance is updated in place, so references to it stay current.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Guild>
Inherited from
Section titled “Inherited from”fetchActiveThreads()
Section titled “fetchActiveThreads()”fetchActiveThreads(
id):Promise<{members:unknown[];threads:APIChannel[]; }>
Defined in: packages/managers/src/guild.ts:340
Fetches all active threads in the guild.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<{ members: unknown[]; threads: APIChannel[]; }>
fetchAuditLog()
Section titled “fetchAuditLog()”fetchAuditLog(
guildId,options?):Promise<AuditLogResponse>
Defined in: packages/managers/src/guild.ts:364
Fetches audit log entries for a guild.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Guild identifier.
options?
Section titled “options?”Filter options: userId (filter by actor), actionType (AuditLogEvent number), before (entry ID cursor), limit (1–100, default 50).
actionType?
Section titled “actionType?”number
after?
Section titled “after?”string
before?
Section titled “before?”string
limit?
Section titled “limit?”number
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<AuditLogResponse>
Typed audit log response with audit_log_entries and related resources.
fetchAuditLogEntries()
Section titled “fetchAuditLogEntries()”fetchAuditLogEntries(
guildId,options?):Promise<AuditLog>
Defined in: packages/managers/src/guild.ts:395
Fetches the audit log as an AuditLog: typed info per action
type, and find() / filter() by type, target, user and time.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
options?
Section titled “options?”{ actionType?: number; after?: string; before?: string; limit?: number; userId?: string; } | undefined
Returns
Section titled “Returns”Promise<AuditLog>
Example
Section titled “Example”const kick = (await guilds.fetchAuditLogEntries(id, { actionType: AuditLogEvent.MemberKick })).find({ targetId: userId, since: Date.now() - 60_000 });fetchAutoModerationRule()
Section titled “fetchAutoModerationRule()”fetchAutoModerationRule(
guildId,ruleId):Promise<AutoModerationRule>
Defined in: packages/managers/src/guild.ts:440
Fetches a single auto moderation rule.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
ruleId
Section titled “ruleId”string
Returns
Section titled “Returns”Promise<AutoModerationRule>
fetchAutoModerationRules()
Section titled “fetchAutoModerationRules()”fetchAutoModerationRules(
guildId):Promise<AutoModerationRule[]>
Defined in: packages/managers/src/guild.ts:430
Fetches a list of all auto moderation rules currently configured for guild.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Promise<AutoModerationRule[]>
fetchInvites()
Section titled “fetchInvites()”fetchInvites(
id):Promise<APIInvite[]>
Defined in: packages/managers/src/guild.ts:354
Fetches all invites in the guild.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<APIInvite[]>
fetchMany()
Section titled “fetchMany()”fetchMany(
ids):Promise<Guild[]>
Defined in: packages/managers/src/base.ts:158
Parameters
Section titled “Parameters”Iterable<string>
Returns
Section titled “Returns”Promise<Guild[]>
Inherited from
Section titled “Inherited from”fetchMembers()
Section titled “fetchMembers()”fetchMembers(
guildId,options?):Promise<Record<string,unknown>[]>
Defined in: packages/managers/src/guild.ts:413
Fetches members from a guild (paginated).
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Guild identifier.
options?
Section titled “options?”Fetch options: limit (1–1000, default 100), after (member ID cursor).
after?
Section titled “after?”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<Record<string, unknown>[]>
Array of raw member data payloads.
fetchOnboarding()
Section titled “fetchOnboarding()”fetchOnboarding(
id):Promise<APIGuildOnboarding>
Defined in: packages/managers/src/guild.ts:285
Fetches a guild’s onboarding: prompts, default channels and mode.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<APIGuildOnboarding>
fetchPreview()
Section titled “fetchPreview()”fetchPreview(
id):Promise<APIGuildPreview>
Defined in: packages/managers/src/guild.ts:257
Fetches a guild’s preview (even if the bot is not in the guild).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<APIGuildPreview>
fetchWebhooks()
Section titled “fetchWebhooks()”fetchWebhooks(
id):Promise<APIWebhook[]>
Defined in: packages/managers/src/guild.ts:349
Fetches all webhooks in the guild.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<APIWebhook[]>
fetchWelcomeScreen()
Section titled “fetchWelcomeScreen()”fetchWelcomeScreen(
id):Promise<APIWelcomeScreen>
Defined in: packages/managers/src/guild.ts:262
Fetches the welcome screen of a community guild.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<APIWelcomeScreen>
find()
Section titled “find()”find(
predicate):Guild|undefined
Defined in: packages/managers/src/base.ts:117
Finds a cached value.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, key) => boolean
Predicate.
Returns
Section titled “Returns”Guild | undefined
Matching value.
Inherited from
Section titled “Inherited from”first()
Section titled “first()”first():
Guild|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”Guild | undefined
First value.
Inherited from
Section titled “Inherited from”get(
id):Guild|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”Guild | undefined
Cached value.
Inherited from
Section titled “Inherited from”has(
id):boolean
Defined in: packages/managers/src/base.ts:40
Checks whether a value is cached.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when cached.
Inherited from
Section titled “Inherited from”invites()
Section titled “invites()”invites(
guildId):Manager<string,APIInviteCreate>
Defined in: packages/managers/src/guild.ts:195
Invites by code for a guild, kept in sync by INVITE_CREATE / INVITE_DELETE.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Manager<string, APIInviteCreate>
members()
Section titled “members()”members(
guildId):GuildMemberManager
Defined in: packages/managers/src/guild.ts:114
Member manager for a guild (one instance per guild, kept in sync by the Gateway).
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”patch()
Section titled “patch()”patch(
data):Guild
Defined in: packages/managers/src/guild.ts:200
Merges a guild payload into the cached instance, keeping object identity.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”presences()
Section titled “presences()”presences(
guildId):Manager<string,APIPresenceUpdate>
Defined in: packages/managers/src/guild.ts:179
Latest presence by user ID for a guild; filled only when cache.presences is on.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Manager<string, APIPresenceUpdate>
remove()
Section titled “remove()”remove(
id):Promise<void>
Defined in: packages/managers/src/guild.ts:252
Deletes a guild permanently. The bot must own it.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
removeIntegration()
Section titled “removeIntegration()”removeIntegration(
id,integrationId,reason?):Promise<void>
Defined in: packages/managers/src/guild.ts:329
Removes an integration (and the bot or role it created) from a guild.
Parameters
Section titled “Parameters”string
integrationId
Section titled “integrationId”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<void>
resolve()
Section titled “resolve()”resolve(
id):Promise<Guild>
Defined in: packages/managers/src/base.ts:145
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Guild>
Inherited from
Section titled “Inherited from”roles()
Section titled “roles()”roles(
guildId):RoleManager
Defined in: packages/managers/src/guild.ts:130
Role manager for a guild (one instance per guild, kept in sync by the Gateway).
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”scheduledEvents()
Section titled “scheduledEvents()”scheduledEvents(
guildId):GuildScheduledEventManager
Defined in: packages/managers/src/guild.ts:103
Scheduled-event manager for a guild (one instance per guild).
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”set(
id,value):this
Defined in: packages/managers/src/base.ts:88
Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.
Parameters
Section titled “Parameters”string
Cache key.
Value.
Returns
Section titled “Returns”this
This manager.
Inherited from
Section titled “Inherited from”soundboard()
Section titled “soundboard()”soundboard(
guildId):GuildSoundboardManager
Defined in: packages/managers/src/guild.ts:163
Soundboard manager for a guild (one instance per guild, kept in sync by the Gateway).
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”stickers()
Section titled “stickers()”stickers(
guildId):GuildStickerManager
Defined in: packages/managers/src/guild.ts:152
Sticker manager for a guild (one instance per guild, kept in sync by the Gateway).
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”update()
Section titled “update()”update(
resource):Guild
Defined in: packages/managers/src/base.ts:180
Parameters
Section titled “Parameters”resource
Section titled “resource”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”upsert()
Section titled “upsert()”upsert(
resource):Guild
Defined in: packages/managers/src/base.ts:163
Stores a resource, merging into the cached instance when there is one so existing references stay current.
Parameters
Section titled “Parameters”resource
Section titled “resource”Returns
Section titled “Returns”The canonical instance.
Inherited from
Section titled “Inherited from”values()
Section titled “values()”values():
Guild[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”Guild[]
Array of values.
Inherited from
Section titled “Inherited from”voiceStates()
Section titled “voiceStates()”voiceStates(
guildId):Manager<string,APIVoiceState>
Defined in: packages/managers/src/guild.ts:174
Voice states by user ID for a guild, kept in sync by GUILD_CREATE and VOICE_STATE_UPDATE.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Manager<string, APIVoiceState>