LogoRobo.js
Packages@robojs/mock

SessionState

Interface: SessionState

Isolated state for a session

Properties

PropertyTypeDescription
applicationEmojisMap<string, MockEmoji>-
applicationIdstring-
attachmentStorageMemoryAttachmentStorage-
auditLogsMap<string, MockAuditLogEntry[]>-
autoModRulesMap<string, MockAutoModRule>-
bansMap<string, MockBan>-
botUserMockUser-
channelsMap<string, MockChannel>-
commandPermissionsMap<string, MockCommandPermission[]>-
commandsMap<string, MockApplicationCommand>-
currentUserMockUserCurrent "acting" user for Stage UI interactions (separate from botUser)
dmChannelsMap<string, MockChannel>-
emojisMap<string, MockEmoji>-
guildMembersMap<string, MockGuildMember>-
guildsMap<string, MockGuild>-
interactionsMap<string, MockInteraction>-
invitesMap<string, MockInvite>-
messagesMap<string, MockMessage>-
pollVotesMap<string, Map<string, number[]>>-
rolesMap<string, MockRole>-
scheduledEventsMap<string, MockScheduledEvent>-
sequencenumber-
stageInstancesMap<string, MockStageInstance>-
stickersMap<string, MockSticker>-
threadMembersMap<string, Map<string, MockThreadMember>>-
usersMap<string, MockUser>-
voiceStatesMap<string, MockVoiceState>-
webhooksMap<string, MockWebhook>-

Methods

addChannel()

addChannel(channel): void

Parameters

ParameterType
channelMockChannel

Returns

void


addChannelToGuild()

addChannelToGuild(guildId, channel): void

Parameters

ParameterType
guildIdstring
channelMockChannel

Returns

void


addForumTag()

addForumTag(channelId, tag): undefined | MockForumTag

Parameters

ParameterType
channelIdstring
tagOmit<MockForumTag, "id">

Returns

undefined | MockForumTag


addGuild()

addGuild(guild): void

Parameters

ParameterType
guildMockGuild

Returns

void


addInteraction()

addInteraction(interaction): void

Parameters

ParameterType
interactionMockInteraction

Returns

void


addMemberRole()

addMemberRole(
   guildId, 
   userId, 
   roleId): boolean

Parameters

ParameterType
guildIdstring
userIdstring
roleIdstring

Returns

boolean


addPollVote()

addPollVote(
   messageId, 
   userId, 
   answerId): boolean

Parameters

ParameterType
messageIdstring
userIdstring
answerIdnumber

Returns

boolean


addReaction()

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

Parameters

ParameterType
messageIdstring
userIdstring
emoji{ id: null | string; name: string; }
emoji.idnull | string
emoji.namestring

Returns

undefined | MockReaction[]


addScheduledEventSubscriber()

addScheduledEventSubscriber(
   guildId, 
   eventId, 
   userId): boolean

Parameters

ParameterType
guildIdstring
eventIdstring
userIdstring

Returns

boolean


addSticker()

addSticker(sticker): void

Parameters

ParameterType
stickerMockSticker

Returns

void


addThreadMember()

addThreadMember(threadId, userId): undefined | MockThreadMember

Parameters

ParameterType
threadIdstring
userIdstring

Returns

undefined | MockThreadMember


addUser()

addUser(user): void

Parameters

ParameterType
userMockUser

Returns

void


bulkOverwriteCommands()

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

Parameters

ParameterType
configsMockApplicationCommandConfig[]
guildId?string

Returns

null | MockApplicationCommand[]


checkAutoArchiveThreads()

checkAutoArchiveThreads(): string[]

Returns

string[]


checkPollExpiry()

checkPollExpiry(messageId): boolean

Parameters

ParameterType
messageIdstring

Returns

boolean


cleanupExpiredInteractions()

cleanupExpiredInteractions(): void

Returns

void


createAuditLogEntry()

createAuditLogEntry(guildId, config): MockAuditLogEntry

Parameters

ParameterType
guildIdstring
configMockAuditLogEntryConfig

Returns

MockAuditLogEntry


createAutoModRule()

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

Parameters

ParameterType
guildIdstring
configMockAutoModRuleConfig
creatorIdstring

Returns

null | MockAutoModRule


createBan()

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

Parameters

ParameterType
guildIdstring
userIdstring
config?MockBanConfig

Returns

null | MockBan


createCommand()

createCommand(config, guildId?): null | MockApplicationCommand

Parameters

ParameterType
configMockApplicationCommandConfig
guildId?string

Returns

null | MockApplicationCommand


createEveryoneRole()

createEveryoneRole(guildId): MockRole

Parameters

ParameterType
guildIdstring

Returns

MockRole


createForumChannel()

createForumChannel(config): MockForumChannel

Parameters

ParameterType
configMockForumChannelConfig

Returns

MockForumChannel


createForumPost()

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

Parameters

ParameterType
configMockForumPostConfig

Returns

{
  message: MockMessage;
  thread: MockForumThread;
}
NameType
messageMockMessage
threadMockForumThread

createGuildEmoji()

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

Parameters

ParameterType
guildIdstring
configMockEmojiConfig
uploaderIdstring

Returns

null | MockEmoji


createGuildMember()

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

Parameters

ParameterType
guildIdstring
userIdstring
config?MockGuildMemberConfig

Returns

null | MockGuildMember


createGuildRole()

createGuildRole(guildId, config?): null | MockRole

Parameters

ParameterType
guildIdstring
config?MockRoleConfig

Returns

null | MockRole


createGuildSticker()

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

Parameters

ParameterType
guildIdstring
configMockStickerConfig
uploaderIdstring

Returns

null | MockSticker


createInvite()

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

Parameters

ParameterType
guildIdstring
channelIdstring
configMockInviteConfig
inviterIdstring

Returns

null | MockInvite


createMessage()

createMessage(config): MockMessage

Parameters

ParameterType
configMockMessageConfig

Returns

MockMessage


createScheduledEvent()

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

Parameters

ParameterType
guildIdstring
configMockScheduledEventConfig
creatorIdstring

Returns

null | MockScheduledEvent


createStageInstance()

createStageInstance(guildId, config): null | MockStageInstance

Parameters

ParameterType
guildIdstring
configMockStageInstanceConfig

Returns

null | MockStageInstance


createThread()

createThread(config): MockThread

Parameters

ParameterType
configMockThreadConfig

Returns

MockThread


createWebhook()

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

Parameters

ParameterType
channelIdstring
configMockWebhookConfig
creatorIdstring

Returns

null | MockWebhook


deleteAttachment()

deleteAttachment(id): boolean

Parameters

ParameterType
idstring

Returns

boolean


deleteAutoModRule()

deleteAutoModRule(guildId, ruleId): null | MockAutoModRule

Parameters

ParameterType
guildIdstring
ruleIdstring

Returns

null | MockAutoModRule


deleteChannelOverwrite()

deleteChannelOverwrite(channelId, overwriteId): boolean

Parameters

ParameterType
channelIdstring
overwriteIdstring

Returns

boolean


deleteCommand()

deleteCommand(commandId): boolean

Parameters

ParameterType
commandIdstring

Returns

boolean


deleteGuildEmoji()

deleteGuildEmoji(emojiId): boolean

Parameters

ParameterType
emojiIdstring

Returns

boolean


deleteGuildRole()

deleteGuildRole(
   guildId, 
   roleId, 
   reason?): boolean

Parameters

ParameterType
guildIdstring
roleIdstring
reason?string

Returns

boolean


deleteGuildSticker()

deleteGuildSticker(stickerId): boolean

Parameters

ParameterType
stickerIdstring

Returns

boolean


deleteInvite()

deleteInvite(code): null | MockInvite

Parameters

ParameterType
codestring

Returns

null | MockInvite


deleteMessage()

deleteMessage(id): boolean

Parameters

ParameterType
idstring

Returns

boolean


deleteScheduledEvent()

deleteScheduledEvent(guildId, eventId): boolean

Parameters

ParameterType
guildIdstring
eventIdstring

Returns

boolean


deleteStageInstance()

deleteStageInstance(channelId): null | MockStageInstance

Parameters

ParameterType
channelIdstring

Returns

null | MockStageInstance


deleteThread()

deleteThread(threadId): boolean

Parameters

ParameterType
threadIdstring

Returns

boolean


deleteWebhook()

deleteWebhook(webhookId): boolean

Parameters

ParameterType
webhookIdstring

Returns

boolean


expirePoll()

expirePoll(messageId): boolean

Parameters

ParameterType
messageIdstring

Returns

boolean


findCommandByName()

findCommandByName(name, guildId?): undefined | MockApplicationCommand

Parameters

ParameterType
namestring
guildId?string

Returns

undefined | MockApplicationCommand


getActiveThreadsForGuild()

getActiveThreadsForGuild(guildId): MockThread[]

Parameters

ParameterType
guildIdstring

Returns

MockThread[]


getAttachment()

getAttachment(id): undefined | StoredAttachment

Parameters

ParameterType
idstring

Returns

undefined | StoredAttachment


getAttachmentsForMessage()

getAttachmentsForMessage(messageId): StoredAttachment[]

Parameters

ParameterType
messageIdstring

Returns

StoredAttachment[]


getAuditLogEntries()

getAuditLogEntries(guildId, options?): MockAuditLogEntry[]

Parameters

ParameterType
guildIdstring
options?{ action_type: number; after: string; before: string; limit: number; user_id: string; }
options.action_type?number
options.after?string
options.before?string
options.limit?number
options.user_id?string

Returns

MockAuditLogEntry[]


getAutoModRule()

getAutoModRule(guildId, ruleId): undefined | MockAutoModRule

Parameters

ParameterType
guildIdstring
ruleIdstring

Returns

undefined | MockAutoModRule


getBan()

getBan(guildId, userId): undefined | MockBan

Parameters

ParameterType
guildIdstring
userIdstring

Returns

undefined | MockBan


getChannel()

getChannel(id): undefined | MockChannel

Parameters

ParameterType
idstring

Returns

undefined | MockChannel


getChannelInvites()

getChannelInvites(channelId): MockInvite[]

Parameters

ParameterType
channelIdstring

Returns

MockInvite[]


getChannelOverwrites()

getChannelOverwrites(channelId): MockChannelOverwrite[]

Parameters

ParameterType
channelIdstring

Returns

MockChannelOverwrite[]


getChannelsForGuild()

getChannelsForGuild(guildId): MockChannel[]

Parameters

ParameterType
guildIdstring

Returns

MockChannel[]


getCommand()

getCommand(commandId): undefined | MockApplicationCommand

Parameters

ParameterType
commandIdstring

Returns

undefined | MockApplicationCommand


getDMChannel()

getDMChannel(recipientId): undefined | MockChannel

Parameters

ParameterType
recipientIdstring

Returns

undefined | MockChannel


getEmoji()

getEmoji(emojiId): undefined | MockEmoji

Parameters

ParameterType
emojiIdstring

Returns

undefined | MockEmoji


getForumChannel()

getForumChannel(id): undefined | MockForumChannel

Parameters

ParameterType
idstring

Returns

undefined | MockForumChannel


getForumChannelsForGuild()

getForumChannelsForGuild(guildId): MockForumChannel[]

Parameters

ParameterType
guildIdstring

Returns

MockForumChannel[]


getForumPosts()

getForumPosts(forumChannelId, options?): MockForumThread[]

Parameters

ParameterType
forumChannelIdstring
options?{ archived: boolean; }
options.archived?boolean

Returns

MockForumThread[]


getForumThread()

getForumThread(id): undefined | MockForumThread

Parameters

ParameterType
idstring

Returns

undefined | MockForumThread


getGlobalCommands()

getGlobalCommands(): MockApplicationCommand[]

Returns

MockApplicationCommand[]


getGuild()

getGuild(id): undefined | MockGuild

Parameters

ParameterType
idstring

Returns

undefined | MockGuild


getGuildAutoModRules()

getGuildAutoModRules(guildId): MockAutoModRule[]

Parameters

ParameterType
guildIdstring

Returns

MockAutoModRule[]


getGuildBans()

getGuildBans(guildId): MockBan[]

Parameters

ParameterType
guildIdstring

Returns

MockBan[]


getGuildCommands()

getGuildCommands(guildId): MockApplicationCommand[]

Parameters

ParameterType
guildIdstring

Returns

MockApplicationCommand[]


getGuildEmojis()

getGuildEmojis(guildId): MockEmoji[]

Parameters

ParameterType
guildIdstring

Returns

MockEmoji[]


getGuildInvites()

getGuildInvites(guildId): MockInvite[]

Parameters

ParameterType
guildIdstring

Returns

MockInvite[]


getGuildMember()

getGuildMember(guildId, userId): undefined | MockGuildMember

Parameters

ParameterType
guildIdstring
userIdstring

Returns

undefined | MockGuildMember


getGuildMembers()

getGuildMembers(guildId): MockGuildMember[]

Parameters

ParameterType
guildIdstring

Returns

MockGuildMember[]


getGuildRole()

getGuildRole(guildId, roleId): undefined | MockRole

Parameters

ParameterType
guildIdstring
roleIdstring

Returns

undefined | MockRole


getGuildRoles()

getGuildRoles(guildId): MockRole[]

Parameters

ParameterType
guildIdstring

Returns

MockRole[]


getGuildScheduledEvents()

getGuildScheduledEvents(guildId): MockScheduledEvent[]

Parameters

ParameterType
guildIdstring

Returns

MockScheduledEvent[]


getGuildStageInstances()

getGuildStageInstances(guildId): MockStageInstance[]

Parameters

ParameterType
guildIdstring

Returns

MockStageInstance[]


getGuildStickers()

getGuildStickers(guildId): MockSticker[]

Parameters

ParameterType
guildIdstring

Returns

MockSticker[]


getInteraction()

getInteraction(id): undefined | MockInteraction

Parameters

ParameterType
idstring

Returns

undefined | MockInteraction


getInteractionByToken()

getInteractionByToken(token): undefined | MockInteraction

Parameters

ParameterType
tokenstring

Returns

undefined | MockInteraction


getInvite()

getInvite(code): undefined | MockInvite

Parameters

ParameterType
codestring

Returns

undefined | MockInvite


getMessage()

getMessage(id): undefined | MockMessage

Parameters

ParameterType
idstring

Returns

undefined | MockMessage


getMessagesForChannel()

getMessagesForChannel(channelId, limit?): MockMessage[]

Parameters

ParameterType
channelIdstring
limit?number

Returns

MockMessage[]


getOrCreateDMChannel()

getOrCreateDMChannel(recipientId): MockChannel

Parameters

ParameterType
recipientIdstring

Returns

MockChannel


getOrCreateTestUser()

getOrCreateTestUser(userId?): MockUser

Parameters

ParameterType
userId?string

Returns

MockUser


getPollVoters()

getPollVoters(messageId, answerId): string[]

Parameters

ParameterType
messageIdstring
answerIdnumber

Returns

string[]


getRole()

getRole(roleId): undefined | MockRole

Parameters

ParameterType
roleIdstring

Returns

undefined | MockRole


getScheduledEvent()

getScheduledEvent(guildId, eventId): undefined | MockScheduledEvent

Parameters

ParameterType
guildIdstring
eventIdstring

Returns

undefined | MockScheduledEvent


getScheduledEventSubscribers()

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

Parameters

ParameterType
guildIdstring
eventIdstring
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; }[]


getStageInstance()

getStageInstance(channelId): undefined | MockStageInstance

Parameters

ParameterType
channelIdstring

Returns

undefined | MockStageInstance


getSticker()

getSticker(stickerId): undefined | MockSticker

Parameters

ParameterType
stickerIdstring

Returns

undefined | MockSticker


getThread()

getThread(id): undefined | MockThread

Parameters

ParameterType
idstring

Returns

undefined | MockThread


getThreadMember()

getThreadMember(threadId, userId): undefined | MockThreadMember

Parameters

ParameterType
threadIdstring
userIdstring

Returns

undefined | MockThreadMember


getThreadMembers()

getThreadMembers(threadId): MockThreadMember[]

Parameters

ParameterType
threadIdstring

Returns

MockThreadMember[]


getThreadsForChannel()

getThreadsForChannel(channelId, options?): MockThread[]

Parameters

ParameterType
channelIdstring
options?{ archived: boolean; }
options.archived?boolean

Returns

MockThread[]


getUser()

getUser(id): undefined | MockUser

Parameters

ParameterType
idstring

Returns

undefined | MockUser


getUserPollVotes()

getUserPollVotes(messageId, userId): number[]

Parameters

ParameterType
messageIdstring
userIdstring

Returns

number[]


getWebhook()

getWebhook(webhookId): undefined | MockWebhook

Parameters

ParameterType
webhookIdstring

Returns

undefined | MockWebhook


getWebhookByToken()

getWebhookByToken(token): undefined | MockWebhook

Parameters

ParameterType
tokenstring

Returns

undefined | MockWebhook


getWebhooksForChannel()

getWebhooksForChannel(channelId): MockWebhook[]

Parameters

ParameterType
channelIdstring

Returns

MockWebhook[]


getWebhooksForGuild()

getWebhooksForGuild(guildId): MockWebhook[]

Parameters

ParameterType
guildIdstring

Returns

MockWebhook[]


incrementThreadMessageCount()

incrementThreadMessageCount(threadId): void

Parameters

ParameterType
threadIdstring

Returns

void


isBanned()

isBanned(guildId, userId): boolean

Parameters

ParameterType
guildIdstring
userIdstring

Returns

boolean


isForumChannel()

isForumChannel(channelId): boolean

Parameters

ParameterType
channelIdstring

Returns

boolean


isForumThread()

isForumThread(threadId): boolean

Parameters

ParameterType
threadIdstring

Returns

boolean


isThread()

isThread(channelId): boolean

Parameters

ParameterType
channelIdstring

Returns

boolean


nextSequence()

nextSequence(): number

Returns

number


removeBan()

removeBan(guildId, userId): boolean

Parameters

ParameterType
guildIdstring
userIdstring

Returns

boolean


removeChannel()

removeChannel(id): boolean

Parameters

ParameterType
idstring

Returns

boolean


removeForumTag()

removeForumTag(channelId, tagId): boolean

Parameters

ParameterType
channelIdstring
tagIdstring

Returns

boolean


removeGuild()

removeGuild(id): boolean

Parameters

ParameterType
idstring

Returns

boolean


removeGuildMember()

removeGuildMember(guildId, userId): boolean

Parameters

ParameterType
guildIdstring
userIdstring

Returns

boolean


removeInteraction()

removeInteraction(id): boolean

Parameters

ParameterType
idstring

Returns

boolean


removeMemberRole()

removeMemberRole(
   guildId, 
   userId, 
   roleId): boolean

Parameters

ParameterType
guildIdstring
userIdstring
roleIdstring

Returns

boolean


removePollVote()

removePollVote(
   messageId, 
   userId, 
   answerId): boolean

Parameters

ParameterType
messageIdstring
userIdstring
answerIdnumber

Returns

boolean


removeReaction()

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

Parameters

ParameterType
messageIdstring
userIdstring
emoji{ id: null | string; name: string; }
emoji.idnull | string
emoji.namestring

Returns

undefined | MockReaction[]


removeScheduledEventSubscriber()

removeScheduledEventSubscriber(
   guildId, 
   eventId, 
   userId): boolean

Parameters

ParameterType
guildIdstring
eventIdstring
userIdstring

Returns

boolean


removeThreadMember()

removeThreadMember(threadId, userId): boolean

Parameters

ParameterType
threadIdstring
userIdstring

Returns

boolean


removeUser()

removeUser(id): boolean

Parameters

ParameterType
idstring

Returns

boolean


reset()

reset(): void

Returns

void


serialize()

serialize(): SerializedSessionState

Returns

SerializedSessionState


setChannelOverwrite()

setChannelOverwrite(channelId, overwrite): boolean

Parameters

ParameterType
channelIdstring
overwriteMockChannelOverwrite

Returns

boolean


storeAttachment()

storeAttachment(attachment): void

Parameters

ParameterType
attachmentStoredAttachment

Returns

void


switchCurrentUser()

switchCurrentUser(userId): undefined | MockUser

Switch to a different user as the current user

Parameters

ParameterType
userIdstring

Returns

undefined | MockUser


updateAutoModRule()

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

Parameters

ParameterType
guildIdstring
ruleIdstring
updatesMockAutoModRuleUpdateConfig

Returns

null | MockAutoModRule


updateCommand()

updateCommand(commandId, updates): null | MockApplicationCommand

Parameters

ParameterType
commandIdstring
updatesPartial<MockApplicationCommandConfig>

Returns

null | MockApplicationCommand


updateCurrentUser()

updateCurrentUser(updates): MockUser

Update the current user's properties without changing their ID

Parameters

ParameterType
updatesPartial<Omit<MockUser, "id">>

Returns

MockUser


updateForumTag()

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

Parameters

ParameterType
channelIdstring
tagIdstring
updatesPartial<Omit<MockForumTag, "id">>

Returns

undefined | MockForumTag


updateForumThreadTags()

updateForumThreadTags(threadId, appliedTags): undefined | MockForumThread

Parameters

ParameterType
threadIdstring
appliedTagsstring[]

Returns

undefined | MockForumThread


updateGuildEmoji()

updateGuildEmoji(emojiId, updates): null | MockEmoji

Parameters

ParameterType
emojiIdstring
updates{ name: string; roles: string[]; }
updates.name?string
updates.roles?string[]

Returns

null | MockEmoji


updateGuildMember()

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

Parameters

ParameterType
guildIdstring
userIdstring
updatesPartial<MockGuildMemberConfig>

Returns

null | MockGuildMember


updateGuildRole()

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

Parameters

ParameterType
guildIdstring
roleIdstring
updatesPartial<MockRoleConfig>
reason?string

Returns

null | MockRole


updateGuildRolePositions()

updateGuildRolePositions(guildId, positions): MockRole[]

Parameters

ParameterType
guildIdstring
positions{ id: string; position: number; }[]

Returns

MockRole[]


updateGuildSticker()

updateGuildSticker(stickerId, updates): null | MockSticker

Parameters

ParameterType
stickerIdstring
updates{ description: string; name: string; tags: string; }
updates.description?string
updates.name?string
updates.tags?string

Returns

null | MockSticker


updateMessage()

updateMessage(id, updates): undefined | MockMessage

Parameters

ParameterType
idstring
updatesPartial<MockMessage>

Returns

undefined | MockMessage


updatePollResults()

updatePollResults(messageId): void

Parameters

ParameterType
messageIdstring

Returns

void


updateScheduledEvent()

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

Parameters

ParameterType
guildIdstring
eventIdstring
updatesMockScheduledEventUpdateConfig

Returns

null | MockScheduledEvent


updateStageInstance()

updateStageInstance(channelId, updates): null | MockStageInstance

Parameters

ParameterType
channelIdstring
updates{ privacy_level: StageInstancePrivacyLevel; topic: string; }
updates.privacy_level?StageInstancePrivacyLevel
updates.topic?string

Returns

null | MockStageInstance


updateThread()

updateThread(threadId, updates): undefined | MockThread

Parameters

ParameterType
threadIdstring
updatesPartial<{ archived: boolean; auto_archive_duration: 60 | 1440 | 4320 | 10080; invitable: boolean; locked: boolean; name: string; rateLimitPerUser: number; }>

Returns

undefined | MockThread


updateWebhook()

updateWebhook(webhookId, updates): null | MockWebhook

Parameters

ParameterType
webhookIdstring
updates{ avatar: null | string; channel_id: string; name: string; }
updates.avatar?null | string
updates.channel_id?string
updates.name?string

Returns

null | MockWebhook


useInvite()

useInvite(code): boolean

Parameters

ParameterType
codestring

Returns

boolean

On this page

Interface: SessionState
Properties
Methods
addChannel()
Parameters
Returns
addChannelToGuild()
Parameters
Returns
addForumTag()
Parameters
Returns
addGuild()
Parameters
Returns
addInteraction()
Parameters
Returns
addMemberRole()
Parameters
Returns
addPollVote()
Parameters
Returns
addReaction()
Parameters
Returns
addScheduledEventSubscriber()
Parameters
Returns
addSticker()
Parameters
Returns
addThreadMember()
Parameters
Returns
addUser()
Parameters
Returns
bulkOverwriteCommands()
Parameters
Returns
checkAutoArchiveThreads()
Returns
checkPollExpiry()
Parameters
Returns
cleanupExpiredInteractions()
Returns
createAuditLogEntry()
Parameters
Returns
createAutoModRule()
Parameters
Returns
createBan()
Parameters
Returns
createCommand()
Parameters
Returns
createEveryoneRole()
Parameters
Returns
createForumChannel()
Parameters
Returns
createForumPost()
Parameters
Returns
createGuildEmoji()
Parameters
Returns
createGuildMember()
Parameters
Returns
createGuildRole()
Parameters
Returns
createGuildSticker()
Parameters
Returns
createInvite()
Parameters
Returns
createMessage()
Parameters
Returns
createScheduledEvent()
Parameters
Returns
createStageInstance()
Parameters
Returns
createThread()
Parameters
Returns
createWebhook()
Parameters
Returns
deleteAttachment()
Parameters
Returns
deleteAutoModRule()
Parameters
Returns
deleteChannelOverwrite()
Parameters
Returns
deleteCommand()
Parameters
Returns
deleteGuildEmoji()
Parameters
Returns
deleteGuildRole()
Parameters
Returns
deleteGuildSticker()
Parameters
Returns
deleteInvite()
Parameters
Returns
deleteMessage()
Parameters
Returns
deleteScheduledEvent()
Parameters
Returns
deleteStageInstance()
Parameters
Returns
deleteThread()
Parameters
Returns
deleteWebhook()
Parameters
Returns
expirePoll()
Parameters
Returns
findCommandByName()
Parameters
Returns
getActiveThreadsForGuild()
Parameters
Returns
getAttachment()
Parameters
Returns
getAttachmentsForMessage()
Parameters
Returns
getAuditLogEntries()
Parameters
Returns
getAutoModRule()
Parameters
Returns
getBan()
Parameters
Returns
getChannel()
Parameters
Returns
getChannelInvites()
Parameters
Returns
getChannelOverwrites()
Parameters
Returns
getChannelsForGuild()
Parameters
Returns
getCommand()
Parameters
Returns
getDMChannel()
Parameters
Returns
getEmoji()
Parameters
Returns
getForumChannel()
Parameters
Returns
getForumChannelsForGuild()
Parameters
Returns
getForumPosts()
Parameters
Returns
getForumThread()
Parameters
Returns
getGlobalCommands()
Returns
getGuild()
Parameters
Returns
getGuildAutoModRules()
Parameters
Returns
getGuildBans()
Parameters
Returns
getGuildCommands()
Parameters
Returns
getGuildEmojis()
Parameters
Returns
getGuildInvites()
Parameters
Returns
getGuildMember()
Parameters
Returns
getGuildMembers()
Parameters
Returns
getGuildRole()
Parameters
Returns
getGuildRoles()
Parameters
Returns
getGuildScheduledEvents()
Parameters
Returns
getGuildStageInstances()
Parameters
Returns
getGuildStickers()
Parameters
Returns
getInteraction()
Parameters
Returns
getInteractionByToken()
Parameters
Returns
getInvite()
Parameters
Returns
getMessage()
Parameters
Returns
getMessagesForChannel()
Parameters
Returns
getOrCreateDMChannel()
Parameters
Returns
getOrCreateTestUser()
Parameters
Returns
getPollVoters()
Parameters
Returns
getRole()
Parameters
Returns
getScheduledEvent()
Parameters
Returns
getScheduledEventSubscribers()
Parameters
Returns
getStageInstance()
Parameters
Returns
getSticker()
Parameters
Returns
getThread()
Parameters
Returns
getThreadMember()
Parameters
Returns
getThreadMembers()
Parameters
Returns
getThreadsForChannel()
Parameters
Returns
getUser()
Parameters
Returns
getUserPollVotes()
Parameters
Returns
getWebhook()
Parameters
Returns
getWebhookByToken()
Parameters
Returns
getWebhooksForChannel()
Parameters
Returns
getWebhooksForGuild()
Parameters
Returns
incrementThreadMessageCount()
Parameters
Returns
isBanned()
Parameters
Returns
isForumChannel()
Parameters
Returns
isForumThread()
Parameters
Returns
isThread()
Parameters
Returns
nextSequence()
Returns
removeBan()
Parameters
Returns
removeChannel()
Parameters
Returns
removeForumTag()
Parameters
Returns
removeGuild()
Parameters
Returns
removeGuildMember()
Parameters
Returns
removeInteraction()
Parameters
Returns
removeMemberRole()
Parameters
Returns
removePollVote()
Parameters
Returns
removeReaction()
Parameters
Returns
removeScheduledEventSubscriber()
Parameters
Returns
removeThreadMember()
Parameters
Returns
removeUser()
Parameters
Returns
reset()
Returns
serialize()
Returns
setChannelOverwrite()
Parameters
Returns
storeAttachment()
Parameters
Returns
switchCurrentUser()
Parameters
Returns
updateAutoModRule()
Parameters
Returns
updateCommand()
Parameters
Returns
updateCurrentUser()
Parameters
Returns
updateForumTag()
Parameters
Returns
updateForumThreadTags()
Parameters
Returns
updateGuildEmoji()
Parameters
Returns
updateGuildMember()
Parameters
Returns
updateGuildRole()
Parameters
Returns
updateGuildRolePositions()
Parameters
Returns
updateGuildSticker()
Parameters
Returns
updateMessage()
Parameters
Returns
updatePollResults()
Parameters
Returns
updateScheduledEvent()
Parameters
Returns
updateStageInstance()
Parameters
Returns
updateThread()
Parameters
Returns
updateWebhook()
Parameters
Returns
useInvite()
Parameters
Returns