Class: MockServerState

Centralized state management for a mock session. Provides CRUD methods for all mock entities.

Implements

SessionState

Constructors

new MockServerState()

new MockServerState(options?): MockServerState

Parameters

Parameter	Type
`options`?	`StateOptions`

Returns

MockServerState

Properties

Property	Modifier	Type	Description
`applicationEmojis`	`readonly`	`Map`<`string`, `MockEmoji`>	-
`applicationId`	`readonly`	`string`	-
`attachmentStorage`	`readonly`	`MemoryAttachmentStorage`	Attachment storage backend. See - AttachmentStorage for the interface - MemoryAttachmentStorage for the default implementation
`auditLogs`	`readonly`	`Map`<`string`, `MockAuditLogEntry`[]>	-
`autoModRules`	`readonly`	`Map`<`string`, `MockAutoModRule`>	-
`bans`	`readonly`	`Map`<`string`, `MockBan`>	-
`botUser`	`readonly`	`MockUser`	-
`channels`	`readonly`	`Map`<`string`, `MockChannel`>	-
`commandPermissions`	`readonly`	`Map`<`string`, `MockCommandPermission`[]>	-
`commands`	`readonly`	`Map`<`string`, `MockApplicationCommand`>	-
`dmChannels`	`readonly`	`Map`<`string`, `MockChannel`>	-
`emojis`	`readonly`	`Map`<`string`, `MockEmoji`>	-
`guildMembers`	`readonly`	`Map`<`string`, `MockGuildMember`>	-
`guilds`	`readonly`	`Map`<`string`, `MockGuild`>	-
`interactions`	`readonly`	`Map`<`string`, `MockInteraction`>	-
`invites`	`readonly`	`Map`<`string`, `MockInvite`>	-
`messages`	`readonly`	`Map`<`string`, `MockMessage`>	-
`pollVotes`	`readonly`	`Map`<`string`, `Map`<`string`, `number`[]>>	-
`roles`	`readonly`	`Map`<`string`, `MockRole`>	-
`scheduledEvents`	`readonly`	`Map`<`string`, `MockScheduledEvent`>	-
`stageInstances`	`readonly`	`Map`<`string`, `MockStageInstance`>	-
`stickers`	`readonly`	`Map`<`string`, `MockSticker`>	-
`threadMembers`	`readonly`	`Map`<`string`, `Map`<`string`, `MockThreadMember`>>	-
`users`	`readonly`	`Map`<`string`, `MockUser`>	-
`voiceStates`	`readonly`	`Map`<`string`, `MockVoiceState`>	-
`webhooks`	`readonly`	`Map`<`string`, `MockWebhook`>	-

Accessors

currentUser

Get Signature

get currentUser(): MockUser

Get the current acting user for Stage UI interactions. Creates a default user on first access if none is set.

Returns

MockUser

Set Signature

set currentUser(user): void

Set the current acting user.

Parameters

Parameter	Type
`user`	`MockUser`

Returns

void

Current "acting" user for Stage UI interactions (separate from botUser)

Implementation of

SessionState.currentUser

sequence

Get Signature

get sequence(): number

Returns

number

Set Signature

set sequence(value): void

Parameters

Parameter	Type
`value`	`number`

Returns

void

Implementation of

SessionState.sequence

Methods

addChannel()

addChannel(channel): void

Add a channel to the state

Parameters

Parameter	Type
`channel`	`MockChannel`

Returns

void

Implementation of

SessionState.addChannel

addChannelToGuild()

addChannelToGuild(guildId, channel): void

Add a channel to a guild

Parameters

Parameter	Type
`guildId`	`string`
`channel`	`MockChannel`

Returns

void

Implementation of

SessionState.addChannelToGuild

addForumTag()

addForumTag(channelId, tag): undefined | MockForumTag

Add a tag to a forum channel

Parameters

Parameter	Type
`channelId`	`string`
`tag`	`Omit`<`MockForumTag`, `"id"`>

Returns

undefined | MockForumTag

Implementation of

SessionState.addForumTag

addGuild()

addGuild(guild): void

Add a guild to the state

Parameters

Parameter	Type
`guild`	`MockGuild`

Returns

void

Implementation of

SessionState.addGuild

addInteraction()

addInteraction(interaction): void

Add an interaction to the state

Parameters

Parameter	Type
`interaction`	`MockInteraction`

Returns

void

Implementation of

SessionState.addInteraction

addMemberRole()

addMemberRole(
   guildId, 
   userId, 
   roleId): boolean

Add a role to a member

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`roleId`	`string`

Returns

boolean

true if added, false if member/role not found or already has role

Implementation of

SessionState.addMemberRole

addMemberToGuild()

addMemberToGuild(
   guildId, 
   userId, 
   config?): void

Add a user as a member to a guild. Creates the guild member entry if it doesn't exist.

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`config`?	`Partial`<`MockGuildMemberConfig`>

Returns

void

addPollVote()

addPollVote(
   messageId, 
   userId, 
   answerId): boolean

Add a vote to a poll

Parameters

Parameter	Type
`messageId`	`string`
`userId`	`string`
`answerId`	`number`

Returns

boolean

true if vote was added, false if already voted (single-select) or invalid

Implementation of

SessionState.addPollVote

addReaction()

addReaction(
   messageId, 
   userId, 
   emoji): undefined | MockReaction[]

Add a reaction to a message Returns the updated reactions array or undefined if message not found

Parameters

Parameter	Type
`messageId`	`string`
`userId`	`string`
`emoji`	{ `id`: `null` \| `string`; `name`: `string`; }
`emoji.id`	`null` \| `string`
`emoji.name`	`string`

Returns

undefined | MockReaction[]

Implementation of

SessionState.addReaction

addScheduledEventSubscriber()

addScheduledEventSubscriber(
   guildId, 
   eventId, 
   userId): boolean

Add a subscriber to a scheduled event

Parameters

Parameter	Type
`guildId`	`string`
`eventId`	`string`
`userId`	`string`

Returns

boolean

true if added, false if event not found

Implementation of

SessionState.addScheduledEventSubscriber

addSticker()

addSticker(sticker): void

Add a sticker directly to state (for control API) This allows adding standard/nitro stickers without a guild

Parameters

Parameter	Type
`sticker`	`MockSticker`

Returns

void

Implementation of

SessionState.addSticker

addThreadMember()

addThreadMember(threadId, userId): undefined | MockThreadMember

Add a member to a thread

Parameters

Parameter	Type
`threadId`	`string`
`userId`	`string`

Returns

undefined | MockThreadMember

Implementation of

SessionState.addThreadMember

addUser()

addUser(user): void

Add a user to the state

Parameters

Parameter	Type
`user`	`MockUser`

Returns

void

Implementation of

SessionState.addUser

bulkOverwriteCommands()

bulkOverwriteCommands(configs, guildId?): null | MockApplicationCommand[]

Bulk overwrite commands for a scope (global or guild) Replaces all existing commands with the provided ones

Parameters

Parameter	Type
`configs`	`MockApplicationCommandConfig`[]
`guildId`?	`string`

Returns

null | MockApplicationCommand[]

Array of created commands, or null if validation fails

Implementation of

SessionState.bulkOverwriteCommands

checkAutoArchiveThreads()

checkAutoArchiveThreads(): string[]

Check and archive inactive threads based on auto_archive_duration Returns array of thread IDs that were archived

Returns

string[]

Implementation of

SessionState.checkAutoArchiveThreads

checkPollExpiry()

checkPollExpiry(messageId): boolean

Check if a poll has expired and finalize it

Parameters

Parameter	Type
`messageId`	`string`

Returns

boolean

true if poll was expired

Implementation of

SessionState.checkPollExpiry

cleanupExpiredInteractions()

cleanupExpiredInteractions(): void

Cleanup expired interactions (older than 15 minutes)

Returns

void

Implementation of

SessionState.cleanupExpiredInteractions

createAuditLogEntry()

createAuditLogEntry(guildId, config): MockAuditLogEntry

Create an audit log entry for a guild

Parameters

Parameter	Type	Description
`guildId`	`string`	The guild ID
`config`	`MockAuditLogEntryConfig`	The audit log entry configuration

Returns

MockAuditLogEntry

The created audit log entry

Implementation of

SessionState.createAuditLogEntry

createAutoModRule()

createAutoModRule(
   guildId, 
   config, 
   creatorId): null | MockAutoModRule

Create an auto-mod rule

Parameters

Parameter	Type
`guildId`	`string`
`config`	`MockAutoModRuleConfig`
`creatorId`	`string`

Returns

null | MockAutoModRule

The created rule, or null if validation fails

Implementation of

SessionState.createAutoModRule

createBan()

createBan(
   guildId, 
   userId, 
   config?): null | MockBan

Create a ban for a user in a guild Also removes the member from the guild if they're a member

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`config`?	`MockBanConfig`

Returns

null | MockBan

The created ban, or null if guild doesn't exist

Implementation of

SessionState.createBan

createCommand()

createCommand(config, guildId?): null | MockApplicationCommand

Create a new application command

Parameters

Parameter	Type
`config`	`MockApplicationCommandConfig`
`guildId`?	`string`

Returns

null | MockApplicationCommand

The created command, or null if validation fails

Implementation of

SessionState.createCommand

createEveryoneRole()

createEveryoneRole(guildId): MockRole

Create the

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockRole

Everyone

role for a guild Called automatically when a guild is created

Implementation of

SessionState.createEveryoneRole

createForumChannel()

createForumChannel(config): MockForumChannel

Create a forum or media channel

Parameters

Parameter	Type
`config`	`MockForumChannelConfig`

Returns

MockForumChannel

Implementation of

SessionState.createForumChannel

createForumPost()

createForumPost(config): {
  message: MockMessage;
  thread: MockForumThread;
}

Create a forum post (thread with initial message)

Parameters

Parameter	Type
`config`	`MockForumPostConfig`

Returns

{
  message: MockMessage;
  thread: MockForumThread;
}

Name	Type
`message`	`MockMessage`
`thread`	`MockForumThread`

Implementation of

SessionState.createForumPost

createGuildEmoji()

createGuildEmoji(
   guildId, 
   config, 
   uploaderId): null | MockEmoji

Create a guild emoji

Parameters

Parameter	Type
`guildId`	`string`
`config`	`MockEmojiConfig`
`uploaderId`	`string`

Returns

null | MockEmoji

The created emoji, or null if guild doesn't exist or limit reached

Implementation of

SessionState.createGuildEmoji

createGuildMember()

createGuildMember(
   guildId, 
   userId, 
   config?): null | MockGuildMember

Create or add a member to a guild

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`config`?	`MockGuildMemberConfig`

Returns

null | MockGuildMember

The created/existing member, or null if guild doesn't exist

Implementation of

SessionState.createGuildMember

createGuildRole()

createGuildRole(guildId, config?): null | MockRole

Create a new role in a guild

Parameters

Parameter	Type
`guildId`	`string`
`config`?	`MockRoleConfig`

Returns

null | MockRole

The created role, or null if guild doesn't exist or limit reached

Implementation of

SessionState.createGuildRole

createGuildSticker()

createGuildSticker(
   guildId, 
   config, 
   uploaderId): null | MockSticker

Create a guild sticker

Parameters

Parameter	Type
`guildId`	`string`
`config`	`MockStickerConfig`
`uploaderId`	`string`

Returns

null | MockSticker

The created sticker, or null if guild doesn't exist or limit reached

Implementation of

SessionState.createGuildSticker

createInvite()

createInvite(
   guildId, 
   channelId, 
   config, 
   inviterId): null | MockInvite

Create an invite for a channel

Parameters

Parameter	Type
`guildId`	`string`
`channelId`	`string`
`config`	`MockInviteConfig`
`inviterId`	`string`

Returns

null | MockInvite

The created invite, or null if channel doesn't exist

Implementation of

SessionState.createInvite

createMessage()

createMessage(config): MockMessage

Create and store a message

Parameters

Parameter	Type
`config`	`MockMessageConfig`

Returns

MockMessage

Implementation of

SessionState.createMessage

createScheduledEvent()

createScheduledEvent(
   guildId, 
   config, 
   creatorId): null | MockScheduledEvent

Create a scheduled event

Parameters

Parameter	Type
`guildId`	`string`
`config`	`MockScheduledEventConfig`
`creatorId`	`string`

Returns

null | MockScheduledEvent

The created event, or null if validation fails

Implementation of

SessionState.createScheduledEvent

createStageInstance()

createStageInstance(guildId, config): null | MockStageInstance

Create a stage instance

Parameters

Parameter	Type
`guildId`	`string`
`config`	`MockStageInstanceConfig`

Returns

null | MockStageInstance

The created stage instance, or null if validation fails

Implementation of

SessionState.createStageInstance

createThread()

createThread(config): MockThread

Create a thread channel

Parameters

Parameter	Type
`config`	`MockThreadConfig`

Returns

MockThread

Implementation of

SessionState.createThread

createWebhook()

createWebhook(
   channelId, 
   config, 
   creatorId): null | MockWebhook

Create a webhook

Parameters

Parameter	Type
`channelId`	`string`
`config`	`MockWebhookConfig`
`creatorId`	`string`

Returns

null | MockWebhook

The created webhook, or null if channel doesn't exist or limit reached

Implementation of

SessionState.createWebhook

deleteAttachment()

deleteAttachment(id): boolean

Delete an attachment by ID.

Parameters

Parameter	Type
`id`	`string`

Returns

boolean

Implementation of

SessionState.deleteAttachment

deleteAutoModRule()

deleteAutoModRule(guildId, ruleId): null | MockAutoModRule

Delete an auto-mod rule

Parameters

Parameter	Type
`guildId`	`string`
`ruleId`	`string`

Returns

null | MockAutoModRule

The deleted rule, or null if not found

Implementation of

SessionState.deleteAutoModRule

deleteChannelOverwrite()

deleteChannelOverwrite(channelId, overwriteId): boolean

Delete a permission overwrite from a channel

Parameters

Parameter	Type
`channelId`	`string`
`overwriteId`	`string`

Returns

boolean

true if deleted, false if not found

Implementation of

SessionState.deleteChannelOverwrite

deleteCommand()

deleteCommand(commandId): boolean

Delete a command by ID

Parameters

Parameter	Type
`commandId`	`string`

Returns

boolean

true if deleted, false if not found

Implementation of

SessionState.deleteCommand

deleteGuildEmoji()

deleteGuildEmoji(emojiId): boolean

Delete a guild emoji

Parameters

Parameter	Type
`emojiId`	`string`

Returns

boolean

true if deleted, false if not found

Implementation of

SessionState.deleteGuildEmoji

deleteGuildRole()

deleteGuildRole(
   guildId, 
   roleId, 
   reason?): boolean

Delete a role from a guild

Parameters

Parameter	Type
`guildId`	`string`
`roleId`	`string`
`reason`?	`string`

Returns

boolean

true if deleted, false if not found or cannot delete

Everyone

Implementation of

SessionState.deleteGuildRole

deleteGuildSticker()

deleteGuildSticker(stickerId): boolean

Delete a guild sticker

Parameters

Parameter	Type
`stickerId`	`string`

Returns

boolean

true if deleted, false if not found

Implementation of

SessionState.deleteGuildSticker

deleteInvite()

deleteInvite(code): null | MockInvite

Delete an invite by code

Parameters

Parameter	Type
`code`	`string`

Returns

null | MockInvite

The deleted invite, or null if not found

Implementation of

SessionState.deleteInvite

deleteMessage()

deleteMessage(id): boolean

Delete a message and its associated attachments

Parameters

Parameter	Type
`id`	`string`

Returns

boolean

Implementation of

SessionState.deleteMessage

deleteScheduledEvent()

deleteScheduledEvent(guildId, eventId): boolean

Delete a scheduled event

Parameters

Parameter	Type
`guildId`	`string`
`eventId`	`string`

Returns

boolean

true if deleted, false if not found

Implementation of

SessionState.deleteScheduledEvent

deleteStageInstance()

deleteStageInstance(channelId): null | MockStageInstance

Delete a stage instance

Parameters

Parameter	Type
`channelId`	`string`

Returns

null | MockStageInstance

The deleted stage instance, or null if not found

Implementation of

SessionState.deleteStageInstance

deleteThread()

deleteThread(threadId): boolean

Delete a thread

Parameters

Parameter	Type
`threadId`	`string`

Returns

boolean

Implementation of

SessionState.deleteThread

deleteWebhook()

deleteWebhook(webhookId): boolean

Delete a webhook

Parameters

Parameter	Type
`webhookId`	`string`

Returns

boolean

true if deleted, false if not found

Implementation of

SessionState.deleteWebhook

expirePoll()

expirePoll(messageId): boolean

Expire (finalize) a poll

Parameters

Parameter	Type
`messageId`	`string`

Returns

boolean

true if poll was expired, false if already expired or no poll

Implementation of

SessionState.expirePoll

findCommandByName()

findCommandByName(name, guildId?): undefined | MockApplicationCommand

Find a command by name within a scope (global or guild)

Parameters

Parameter	Type
`name`	`string`
`guildId`?	`string`

Returns

undefined | MockApplicationCommand

Implementation of

SessionState.findCommandByName

getActiveThreadsForGuild()

getActiveThreadsForGuild(guildId): MockThread[]

Get all active (non-archived) threads in a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockThread[]

Implementation of

SessionState.getActiveThreadsForGuild

getAttachment()

getAttachment(id): undefined | StoredAttachment

Get an attachment by ID.

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | StoredAttachment

Implementation of

SessionState.getAttachment

getAttachmentsForMessage()

getAttachmentsForMessage(messageId): StoredAttachment[]

Get all attachments for a message.

Parameters

Parameter	Type
`messageId`	`string`

Returns

StoredAttachment[]

Implementation of

SessionState.getAttachmentsForMessage

getAuditLogEntries()

getAuditLogEntries(guildId, options?): MockAuditLogEntry[]

Get audit log entries for a guild with optional filtering

Parameters

Parameter	Type	Description
`guildId`	`string`	The guild ID
`options`?	{ `actionType`: `AuditLogEvent`; `before`: `string`; `limit`: `number`; `userId`: `string`; }	Filtering options
`options.actionType`?	`AuditLogEvent`	-
`options.before`?	`string`	-
`options.limit`?	`number`	-
`options.userId`?	`string`	-

Returns

MockAuditLogEntry[]

Array of audit log entries

Implementation of

SessionState.getAuditLogEntries

getAutoModRule()

getAutoModRule(guildId, ruleId): undefined | MockAutoModRule

Get an auto-mod rule by ID

Parameters

Parameter	Type
`guildId`	`string`
`ruleId`	`string`

Returns

undefined | MockAutoModRule

Implementation of

SessionState.getAutoModRule

getBan()

getBan(guildId, userId): undefined | MockBan

Get a ban for a specific user in a guild

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

undefined | MockBan

Implementation of

SessionState.getBan

getChannel()

getChannel(id): undefined | MockChannel

Get a channel by ID (includes guild channels and DM channels)

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | MockChannel

Implementation of

SessionState.getChannel

getChannelInvites()

getChannelInvites(channelId): MockInvite[]

Get all invites for a channel

Parameters

Parameter	Type
`channelId`	`string`

Returns

MockInvite[]

Implementation of

SessionState.getChannelInvites

getChannelOverwrites()

getChannelOverwrites(channelId): MockChannelOverwrite[]

Get permission overwrites for a channel

Parameters

Parameter	Type
`channelId`	`string`

Returns

MockChannelOverwrite[]

Implementation of

SessionState.getChannelOverwrites

getChannelsForGuild()

getChannelsForGuild(guildId): MockChannel[]

Get all channels for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockChannel[]

Implementation of

SessionState.getChannelsForGuild

getCommand()

getCommand(commandId): undefined | MockApplicationCommand

Get a command by ID

Parameters

Parameter	Type
`commandId`	`string`

Returns

undefined | MockApplicationCommand

Implementation of

SessionState.getCommand

getDMChannel()

getDMChannel(recipientId): undefined | MockChannel

Get a DM channel by recipient user ID (uses currentUser as the other participant)

Parameters

Parameter	Type
`recipientId`	`string`

Returns

undefined | MockChannel

Implementation of

SessionState.getDMChannel

getEmoji()

getEmoji(emojiId): undefined | MockEmoji

Get an emoji by ID

Parameters

Parameter	Type
`emojiId`	`string`

Returns

undefined | MockEmoji

Implementation of

SessionState.getEmoji

getForumChannel()

getForumChannel(id): undefined | MockForumChannel

Get a forum channel by ID (returns undefined if not a forum/media channel)

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | MockForumChannel

Implementation of

SessionState.getForumChannel

getForumChannelsForGuild()

getForumChannelsForGuild(guildId): MockForumChannel[]

Get all forum/media channels in a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockForumChannel[]

Implementation of

SessionState.getForumChannelsForGuild

getForumPosts()

getForumPosts(forumChannelId, options?): MockForumThread[]

Get posts (threads) in a forum channel

Parameters

Parameter	Type
`forumChannelId`	`string`
`options`?	{ `archived`: `boolean`; }
`options.archived`?	`boolean`

Returns

MockForumThread[]

Implementation of

SessionState.getForumPosts

getForumThread()

getForumThread(id): undefined | MockForumThread

Get a forum thread by ID (returns undefined if not a forum thread)

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | MockForumThread

Implementation of

SessionState.getForumThread

getGlobalCommands()

getGlobalCommands(): MockApplicationCommand[]

Get all global commands (no guild_id)

Returns

MockApplicationCommand[]

Implementation of

SessionState.getGlobalCommands

getGuild()

getGuild(id): undefined | MockGuild

Get a guild by ID

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | MockGuild

Implementation of

SessionState.getGuild

getGuildAutoModRules()

getGuildAutoModRules(guildId): MockAutoModRule[]

Get all auto-mod rules for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockAutoModRule[]

Implementation of

SessionState.getGuildAutoModRules

getGuildBans()

getGuildBans(guildId): MockBan[]

Get all bans for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockBan[]

Implementation of

SessionState.getGuildBans

getGuildCommands()

getGuildCommands(guildId): MockApplicationCommand[]

Get all commands for a specific guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockApplicationCommand[]

Implementation of

SessionState.getGuildCommands

getGuildEmojis()

getGuildEmojis(guildId): MockEmoji[]

Get all emojis for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockEmoji[]

Implementation of

SessionState.getGuildEmojis

getGuildInvites()

getGuildInvites(guildId): MockInvite[]

Get all invites for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockInvite[]

Implementation of

SessionState.getGuildInvites

getGuildMember()

getGuildMember(guildId, userId): undefined | MockGuildMember

Get a guild member

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

undefined | MockGuildMember

Implementation of

SessionState.getGuildMember

getGuildMembers()

getGuildMembers(guildId): MockGuildMember[]

Get all members of a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockGuildMember[]

Implementation of

SessionState.getGuildMembers

getGuildRole()

getGuildRole(guildId, roleId): undefined | MockRole

Get a role by ID within a guild

Parameters

Parameter	Type
`guildId`	`string`
`roleId`	`string`

Returns

undefined | MockRole

Implementation of

SessionState.getGuildRole

getGuildRoles()

getGuildRoles(guildId): MockRole[]

Get all roles for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockRole[]

Implementation of

SessionState.getGuildRoles

getGuildScheduledEvents()

getGuildScheduledEvents(guildId): MockScheduledEvent[]

Get all scheduled events for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockScheduledEvent[]

Implementation of

SessionState.getGuildScheduledEvents

getGuildStageInstances()

getGuildStageInstances(guildId): MockStageInstance[]

Get all stage instances for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockStageInstance[]

Implementation of

SessionState.getGuildStageInstances

getGuildStickers()

getGuildStickers(guildId): MockSticker[]

Get all stickers for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockSticker[]

Implementation of

SessionState.getGuildStickers

getInteraction()

getInteraction(id): undefined | MockInteraction

Get an interaction by ID

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | MockInteraction

Implementation of

SessionState.getInteraction

getInteractionByToken()

getInteractionByToken(token): undefined | MockInteraction

Get an interaction by token

Parameters

Parameter	Type
`token`	`string`

Returns

undefined | MockInteraction

Implementation of

SessionState.getInteractionByToken

getInvite()

getInvite(code): undefined | MockInvite

Get an invite by code

Parameters

Parameter	Type
`code`	`string`

Returns

undefined | MockInvite

Implementation of

SessionState.getInvite

getMessage()

getMessage(id): undefined | MockMessage

Get a message by ID

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | MockMessage

Implementation of

SessionState.getMessage

getMessagesForChannel()

getMessagesForChannel(channelId, limit?): MockMessage[]

Get messages for a channel, optionally limited

Parameters

Parameter	Type
`channelId`	`string`
`limit`?	`number`

Returns

MockMessage[]

Implementation of

SessionState.getMessagesForChannel

getOrCreateDMChannel()

getOrCreateDMChannel(recipientId): MockChannel

Get or create a DM channel for a recipient (uses currentUser as the other participant)

Parameters

Parameter	Type
`recipientId`	`string`

Returns

MockChannel

Implementation of

SessionState.getOrCreateDMChannel

getOrCreateTestUser()

getOrCreateTestUser(userId?): MockUser

Get or create a default test user for dispatching messages This creates a consistent "TestUser" that can be used when no author is specified

Parameters

Parameter	Type
`userId`?	`string`

Returns

MockUser

Implementation of

SessionState.getOrCreateTestUser

getPollVoters()

getPollVoters(messageId, answerId): string[]

Get all users who voted for a specific answer

Parameters

Parameter	Type
`messageId`	`string`
`answerId`	`number`

Returns

string[]

Implementation of

SessionState.getPollVoters

getRole()

getRole(roleId): undefined | MockRole

Get a role by ID

Parameters

Parameter	Type
`roleId`	`string`

Returns

undefined | MockRole

Implementation of

SessionState.getRole

getScheduledEvent()

getScheduledEvent(guildId, eventId): undefined | MockScheduledEvent

Get a scheduled event by ID

Parameters

Parameter	Type
`guildId`	`string`
`eventId`	`string`

Returns

undefined | MockScheduledEvent

Implementation of

SessionState.getScheduledEvent

getScheduledEventSubscribers()

getScheduledEventSubscribers(
   guildId, 
   eventId, 
   options?): {
  member: MockGuildMember;
  user: MockUser;
 }[]

Get subscribers for a scheduled event

Parameters

Parameter	Type
`guildId`	`string`
`eventId`	`string`
`options`?	{ `after`: `string`; `before`: `string`; `limit`: `number`; `withMember`: `boolean`; }
`options.after`?	`string`
`options.before`?	`string`
`options.limit`?	`number`
`options.withMember`?	`boolean`

Returns

{ member: MockGuildMember; user: MockUser; }[]

Implementation of

SessionState.getScheduledEventSubscribers

getStageInstance()

getStageInstance(channelId): undefined | MockStageInstance

Get a stage instance by channel ID

Parameters

Parameter	Type
`channelId`	`string`

Returns

undefined | MockStageInstance

Implementation of

SessionState.getStageInstance

getSticker()

getSticker(stickerId): undefined | MockSticker

Get a sticker by ID

Parameters

Parameter	Type
`stickerId`	`string`

Returns

undefined | MockSticker

Implementation of

SessionState.getSticker

getThread()

getThread(id): undefined | MockThread

Get a thread by ID (returns undefined if not a thread)

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | MockThread

Implementation of

SessionState.getThread

getThreadMember()

getThreadMember(threadId, userId): undefined | MockThreadMember

Get a thread member

Parameters

Parameter	Type
`threadId`	`string`
`userId`	`string`

Returns

undefined | MockThreadMember

Implementation of

SessionState.getThreadMember

getThreadMembers()

getThreadMembers(threadId): MockThreadMember[]

Get all members of a thread

Parameters

Parameter	Type
`threadId`	`string`

Returns

MockThreadMember[]

Implementation of

SessionState.getThreadMembers

getThreadsForChannel()

getThreadsForChannel(channelId, options?): MockThread[]

Get all threads for a parent channel

Parameters

Parameter	Type
`channelId`	`string`
`options`?	{ `archived`: `boolean`; }
`options.archived`?	`boolean`

Returns

MockThread[]

Implementation of

SessionState.getThreadsForChannel

getUser()

getUser(id): undefined | MockUser

Get a user by ID

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | MockUser

Implementation of

SessionState.getUser

getUserPollVotes()

getUserPollVotes(messageId, userId): number[]

Get all votes for a user on a poll

Parameters

Parameter	Type
`messageId`	`string`
`userId`	`string`

Returns

number[]

Implementation of

SessionState.getUserPollVotes

getWebhook()

getWebhook(webhookId): undefined | MockWebhook

Get a webhook by ID

Parameters

Parameter	Type
`webhookId`	`string`

Returns

undefined | MockWebhook

Implementation of

SessionState.getWebhook

getWebhookByToken()

getWebhookByToken(token): undefined | MockWebhook

Get a webhook by its token

Parameters

Parameter	Type
`token`	`string`

Returns

undefined | MockWebhook

Implementation of

SessionState.getWebhookByToken

getWebhooksForChannel()

getWebhooksForChannel(channelId): MockWebhook[]

Get all webhooks for a channel

Parameters

Parameter	Type
`channelId`	`string`

Returns

MockWebhook[]

Implementation of

SessionState.getWebhooksForChannel

getWebhooksForGuild()

getWebhooksForGuild(guildId): MockWebhook[]

Get all webhooks for a guild

Parameters

Parameter	Type
`guildId`	`string`

Returns

MockWebhook[]

Implementation of

SessionState.getWebhooksForGuild

incrementThreadMessageCount()

incrementThreadMessageCount(threadId): void

Increment thread message count and update activity timestamp

Parameters

Parameter	Type
`threadId`	`string`

Returns

void

Implementation of

SessionState.incrementThreadMessageCount

isBanned()

isBanned(guildId, userId): boolean

Check if a user is banned from a guild

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

boolean

Implementation of

SessionState.isBanned

isForumChannel()

isForumChannel(channelId): boolean

Check if a channel is a forum or media channel (type 15 or 16)

Parameters

Parameter	Type
`channelId`	`string`

Returns

boolean

Implementation of

SessionState.isForumChannel

isForumThread()

isForumThread(threadId): boolean

Check if a thread is a forum thread (has applied_tags)

Parameters

Parameter	Type
`threadId`	`string`

Returns

boolean

Implementation of

SessionState.isForumThread

isThread()

isThread(channelId): boolean

Check if a channel is a thread type (10, 11, or 12)

Parameters

Parameter	Type
`channelId`	`string`

Returns

boolean

Implementation of

SessionState.isThread

nextSequence()

nextSequence(): number

Get and increment the sequence number

Returns

number

Implementation of

SessionState.nextSequence

removeBan()

removeBan(guildId, userId): boolean

Remove a ban for a user in a guild

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

boolean

true if removed, false if not found

Implementation of

SessionState.removeBan

removeChannel()

removeChannel(id): boolean

Remove a channel from the state

Parameters

Parameter	Type
`id`	`string`

Returns

boolean

Implementation of

SessionState.removeChannel

removeForumTag()

removeForumTag(channelId, tagId): boolean

Remove a tag from a forum channel

Parameters

Parameter	Type
`channelId`	`string`
`tagId`	`string`

Returns

boolean

Implementation of

SessionState.removeForumTag

removeGuild()

removeGuild(id): boolean

Remove a guild from the state

Parameters

Parameter	Type
`id`	`string`

Returns

boolean

Implementation of

SessionState.removeGuild

removeGuildMember()

removeGuildMember(guildId, userId): boolean

Remove a member from a guild

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

boolean

true if removed, false if not found

Implementation of

SessionState.removeGuildMember

removeInteraction()

removeInteraction(id): boolean

Remove an interaction from the state

Parameters

Parameter	Type
`id`	`string`

Returns

boolean

Implementation of

SessionState.removeInteraction

removeMemberRole()

removeMemberRole(
   guildId, 
   userId, 
   roleId): boolean

Remove a role from a member

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`roleId`	`string`

Returns

boolean

true if removed, false if member not found or doesn't have role

Implementation of

SessionState.removeMemberRole

removePollVote()

removePollVote(
   messageId, 
   userId, 
   answerId): boolean

Remove a vote from a poll (only for multiselect polls)

Parameters

Parameter	Type
`messageId`	`string`
`userId`	`string`
`answerId`	`number`

Returns

boolean

true if vote was removed, false if not voted or invalid

Implementation of

SessionState.removePollVote

removeReaction()

removeReaction(
   messageId, 
   userId, 
   emoji): undefined | MockReaction[]

Remove a reaction from a message Returns the updated reactions array or undefined if message/reaction not found

Parameters

Parameter	Type
`messageId`	`string`
`userId`	`string`
`emoji`	{ `id`: `null` \| `string`; `name`: `string`; }
`emoji.id`	`null` \| `string`
`emoji.name`	`string`

removeScheduledEventSubscriber(
   guildId, 
   eventId, 
   userId): boolean

Remove a subscriber from a scheduled event

Parameters

Parameter	Type
`guildId`	`string`
`eventId`	`string`
`userId`	`string`

removeThreadMember(threadId, userId): boolean

Remove a member from a thread

Parameters

Parameter	Type
`threadId`	`string`
`userId`	`string`

removeUser(id): boolean

Remove a user from the state (cannot remove bot user)

Parameters

Parameter	Type
`id`	`string`

reset(): void

Reset state to initial values (keeps bot user)

serialize(): SerializedSessionState

Serialize state for API responses

setChannelOverwrite(channelId, overwrite): boolean

Set a permission overwrite on a channel Creates or updates the overwrite for the given role/member ID

Parameters

Parameter	Type
`channelId`	`string`
`overwrite`	`MockChannelOverwrite`

storeAttachment(attachment): void

Store an attachment using the configured storage backend.

Parameters

Parameter	Type
`attachment`	`StoredAttachment`

switchCurrentUser(userId): undefined | MockUser

Switch to a different user as the current user. Returns the user if found, undefined otherwise.

Parameters

Parameter	Type
`userId`	`string`

updateAutoModRule(
   guildId, 
   ruleId, 
   updates): null | MockAutoModRule

Update an auto-mod rule

Parameters

Parameter	Type
`guildId`	`string`
`ruleId`	`string`
`updates`	`MockAutoModRuleUpdateConfig`

updateCommand(commandId, updates): null | MockApplicationCommand

Update an existing command

Parameters

Parameter	Type
`commandId`	`string`
`updates`	`Partial`<`MockApplicationCommandConfig`>

updateCurrentUser(updates): MockUser

Update the current user's properties without changing their ID.

Parameters

Parameter	Type
`updates`	`Partial`<`Omit`<`MockUser`, `"id"`>>

updateForumTag(
   channelId, 
   tagId, 
   updates): undefined | MockForumTag

Update a tag in a forum channel

Parameters

Parameter	Type
`channelId`	`string`
`tagId`	`string`
`updates`	`Partial`<`Omit`<`MockForumTag`, `"id"`>>

updateForumThreadTags(threadId, appliedTags): undefined | MockForumThread

Update applied tags on a forum thread

Parameters

Parameter	Type
`threadId`	`string`
`appliedTags`	`string`[]

updateGuildEmoji(emojiId, updates): null | MockEmoji

Update a guild emoji

Parameters

Parameter	Type
`emojiId`	`string`
`updates`	{ `name`: `string`; `roles`: `string`[]; }
`updates.name`?	`string`
`updates.roles`?	`string`[]

updateGuildMember(
   guildId, 
   userId, 
   updates): null | MockGuildMember

Update a guild member

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`
`updates`	`Partial`<`MockGuildMemberConfig`>

updateGuildRole(
   guildId, 
   roleId, 
   updates, 
   reason?): null | MockRole

Update a role

Parameters

Parameter	Type
`guildId`	`string`
`roleId`	`string`
`updates`	`Partial`<`MockRoleConfig`>
`reason`?	`string`

updateGuildRolePositions(guildId, positions): MockRole[]

Update role positions in batch

Parameters

Parameter	Type
`guildId`	`string`
`positions`	{ `id`: `string`; `position`: `number`; }[]

updateGuildSticker(stickerId, updates): null | MockSticker

Update a guild sticker

Parameters

Parameter	Type
`stickerId`	`string`
`updates`	{ `description`: `string`; `name`: `string`; `tags`: `string`; }
`updates.description`?	`string`
`updates.name`?	`string`
`updates.tags`?	`string`

updateMessage(id, updates): undefined | MockMessage

Update a message

Parameters

Parameter	Type
`id`	`string`
`updates`	`Partial`<`MockMessage`>

updatePollResults(messageId): void

Update poll results based on current votes

Parameters

Parameter	Type
`messageId`	`string`

updateScheduledEvent(
   guildId, 
   eventId, 
   updates): null | MockScheduledEvent

Update a scheduled event

Parameters

Parameter	Type
`guildId`	`string`
`eventId`	`string`
`updates`	`MockScheduledEventUpdateConfig`

updateStageInstance(channelId, updates): null | MockStageInstance

Update a stage instance

Parameters

Parameter	Type
`channelId`	`string`
`updates`	{ `privacyLevel`: `StageInstancePrivacyLevel`; `topic`: `string`; }
`updates.privacyLevel`?	`StageInstancePrivacyLevel`
`updates.topic`?	`string`

updateThread(threadId, updates): undefined | MockThread

Update thread metadata

Parameters

Parameter	Type
`threadId`	`string`
`updates`	`Partial`<{ `archived`: `boolean`; `auto_archive_duration`: `60` \| `1440` \| `4320` \| `10080`; `invitable`: `boolean`; `locked`: `boolean`; `name`: `string`; `rateLimitPerUser`: `number`; }>

updateWebhook(webhookId, updates): null | MockWebhook

Update a webhook

Parameters

Parameter	Type
`webhookId`	`string`
`updates`	{ `avatar`: `null` \| `string`; `channel_id`: `string`; `name`: `string`; }
`updates.avatar`?	`null` \| `string`
`updates.channel_id`?	`string`
`updates.name`?	`string`

useInvite(code): boolean

Increment invite use count (when someone joins via invite)

Parameters

Parameter	Type
`code`	`string`

Returns

boolean

true if invite is still valid, false if expired/maxed out

Implementation of

SessionState.useInvite