Skip to content

GuildManager

Defined in: packages/managers/src/guild.ts:51

Generic REST-backed resource manager.

new GuildManager(rest, options?): GuildManager

Defined in: packages/managers/src/guild.ts:81

REST

number

GuildManager

ResourceManager.constructor

readonly cache: Collection<string, Guild>

Defined in: packages/managers/src/base.ts:27

Authoritative resource state. Entries never expire: see Manager.set.

ResourceManager.cache

get size(): number

Defined in: packages/managers/src/base.ts:105

Gets cache size.

number

Number of cached values.

ResourceManager.size

[iterator](): IterableIterator<[string, Guild]>

Defined in: packages/managers/src/base.ts:121

Iterates cached entries.

IterableIterator<[string, Guild]>

Cache iterator.

ResourceManager.[iterator]


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.

ResourceContext

void


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.

string

Manager<string, APIAutoModerationRule>


bans(guildId): GuildBanManager

Defined in: packages/managers/src/guild.ts:92

Ban manager for a guild (one instance per guild).

string

GuildBanManager


clear(): void

Defined in: packages/managers/src/base.ts:101

Clears the cache.

void

Nothing.

ResourceManager.clear


create(options): Promise<Guild>

Defined in: packages/managers/src/guild.ts:235

Creates a new guild. (Bot must be in fewer than 10 guilds).

GuildCreateOptions

Promise<Guild>


createAutoModerationRule(guildId, options): Promise<AutoModerationRule>

Defined in: packages/managers/src/guild.ts:451

Creates a new auto moderation rule.

string

Record<string, unknown> & object

Promise<AutoModerationRule>


delete(id): boolean

Defined in: packages/managers/src/guild.ts:219

Removes a guild and every per-guild manager that belongs to it.

string

boolean

ResourceManager.delete


deleteAutoModerationRule(guildId, ruleId, reason?): Promise<void>

Defined in: packages/managers/src/guild.ts:480

Deletes an auto moderation rule.

string

string

string

Audit-log reason.

Promise<void>


edit(id, options): Promise<Guild>

Defined in: packages/managers/src/guild.ts:241

Modifies a guild’s settings.

string

GuildEditOptions

Promise<Guild>


editAutoModerationRule(guildId, ruleId, options): Promise<AutoModerationRule>

Defined in: packages/managers/src/guild.ts:465

Modifies an existing auto moderation rule.

string

string

Record<string, unknown> & object

Promise<AutoModerationRule>


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).

string

string[]

boolean

number

APIOnboardingPrompt[]

string

Promise<APIGuildOnboarding>


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".

string

string

string

string | null

boolean

Promise<void>


editWelcomeScreen(id, options): Promise<APIWelcomeScreen>

Defined in: packages/managers/src/guild.ts:267

Edits the welcome screen (needs Manage Guild and the Community feature).

string

string | null

boolean

string

APIWelcomeScreenChannel[] | null

Promise<APIWelcomeScreen>


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).

string

EmojiManager


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.

string

Promise<Guild>

ResourceManager.fetch


fetchActiveThreads(id): Promise<{ members: unknown[]; threads: APIChannel[]; }>

Defined in: packages/managers/src/guild.ts:340

Fetches all active threads in the guild.

string

Promise<{ members: unknown[]; threads: APIChannel[]; }>


fetchAuditLog(guildId, options?): Promise<AuditLogResponse>

Defined in: packages/managers/src/guild.ts:364

Fetches audit log entries for a guild.

string

Guild identifier.

Filter options: userId (filter by actor), actionType (AuditLogEvent number), before (entry ID cursor), limit (1–100, default 50).

number

string

string

number

string

Promise<AuditLogResponse>

Typed audit log response with audit_log_entries and related resources.


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.

string

{ actionType?: number; after?: string; before?: string; limit?: number; userId?: string; } | undefined

Promise<AuditLog>

const kick = (await guilds.fetchAuditLogEntries(id, { actionType: AuditLogEvent.MemberKick })).find({ targetId: userId, since: Date.now() - 60_000 });

fetchAutoModerationRule(guildId, ruleId): Promise<AutoModerationRule>

Defined in: packages/managers/src/guild.ts:440

Fetches a single auto moderation rule.

string

string

Promise<AutoModerationRule>


fetchAutoModerationRules(guildId): Promise<AutoModerationRule[]>

Defined in: packages/managers/src/guild.ts:430

Fetches a list of all auto moderation rules currently configured for guild.

string

Promise<AutoModerationRule[]>


fetchInvites(id): Promise<APIInvite[]>

Defined in: packages/managers/src/guild.ts:354

Fetches all invites in the guild.

string

Promise<APIInvite[]>


fetchMany(ids): Promise<Guild[]>

Defined in: packages/managers/src/base.ts:158

Iterable<string>

Promise<Guild[]>

ResourceManager.fetchMany


fetchMembers(guildId, options?): Promise<Record<string, unknown>[]>

Defined in: packages/managers/src/guild.ts:413

Fetches members from a guild (paginated).

string

Guild identifier.

Fetch options: limit (1–1000, default 100), after (member ID cursor).

string

number

Promise<Record<string, unknown>[]>

Array of raw member data payloads.


fetchOnboarding(id): Promise<APIGuildOnboarding>

Defined in: packages/managers/src/guild.ts:285

Fetches a guild’s onboarding: prompts, default channels and mode.

string

Promise<APIGuildOnboarding>


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).

string

Promise<APIGuildPreview>


fetchWebhooks(id): Promise<APIWebhook[]>

Defined in: packages/managers/src/guild.ts:349

Fetches all webhooks in the guild.

string

Promise<APIWebhook[]>


fetchWelcomeScreen(id): Promise<APIWelcomeScreen>

Defined in: packages/managers/src/guild.ts:262

Fetches the welcome screen of a community guild.

string

Promise<APIWelcomeScreen>


find(predicate): Guild | undefined

Defined in: packages/managers/src/base.ts:117

Finds a cached value.

(value, key) => boolean

Predicate.

Guild | undefined

Matching value.

ResourceManager.find


first(): Guild | undefined

Defined in: packages/managers/src/base.ts:109

Gets the first cached value.

Guild | undefined

First value.

ResourceManager.first


get(id): Guild | undefined

Defined in: packages/managers/src/base.ts:36

Gets a cached value.

string

Cache key.

Guild | undefined

Cached value.

ResourceManager.get


has(id): boolean

Defined in: packages/managers/src/base.ts:40

Checks whether a value is cached.

string

Cache key.

boolean

True when cached.

ResourceManager.has


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.

string

Manager<string, APIInviteCreate>


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).

string

GuildMemberManager


patch(data): Guild

Defined in: packages/managers/src/guild.ts:200

Merges a guild payload into the cached instance, keeping object identity.

APIGuild

Guild


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.

string

Manager<string, APIPresenceUpdate>


remove(id): Promise<void>

Defined in: packages/managers/src/guild.ts:252

Deletes a guild permanently. The bot must own it.

string

Promise<void>


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.

string

string

string

Promise<void>


resolve(id): Promise<Guild>

Defined in: packages/managers/src/base.ts:145

string

Promise<Guild>

ResourceManager.resolve


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).

string

RoleManager


scheduledEvents(guildId): GuildScheduledEventManager

Defined in: packages/managers/src/guild.ts:103

Scheduled-event manager for a guild (one instance per guild).

string

GuildScheduledEventManager


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.

string

Cache key.

Guild

Value.

this

This manager.

ResourceManager.set


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).

string

GuildSoundboardManager


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).

string

GuildStickerManager


update(resource): Guild

Defined in: packages/managers/src/base.ts:180

Guild

Guild

ResourceManager.update


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.

Guild

Guild

The canonical instance.

ResourceManager.upsert


values(): Guild[]

Defined in: packages/managers/src/base.ts:113

Returns cached values.

Guild[]

Array of values.

ResourceManager.values


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.

string

Manager<string, APIVoiceState>