CreateBotOptions

@discordeno/bot

---

Documentation / @discordeno/bot / CreateBotOptions

Interface: CreateBotOptions<TProps, TBehavior>

Defined in: packages/bot/src/bot.ts:113

Type Parameters

• TProps extends RecursivePartial<TransformersDesiredProperties>

• TBehavior extends DesiredPropertiesBehavior

Properties

applicationId?

optional applicationId: BigString

Defined in: packages/bot/src/bot.ts:117

Application Id of the bot incase it is an old bot token.

---

desiredProperties?

optional desiredProperties: TProps

Defined in: packages/bot/src/bot.ts:135

Set the desired properties for the bot

Default

{}

---

desiredPropertiesBehavior?

optional desiredPropertiesBehavior: TBehavior

Defined in: packages/bot/src/bot.ts:141

Set the desired properties behavior for undesired properties

Default

DesiredPropertiesBehavior.RemoveKey

---

events?

optional events: Partial<EventHandlers<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>

Defined in: packages/bot/src/bot.ts:125

The event handlers.

---

gateway?

optional gateway: Omit<CreateGatewayManagerOptions, "token"> & Partial<Pick<CreateGatewayManagerOptions, "token">>

Defined in: packages/bot/src/bot.ts:123

Any options you wish to provide to the gateway manager.

---

handlers?

optional handlers: Partial<Record<GatewayDispatchEventNames, BotGatewayHandler<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>>

Defined in: packages/bot/src/bot.ts:129

The handler functions that should handle incoming discord payloads from gateway and call an event.

---

intents?

optional intents: GatewayIntents

Defined in: packages/bot/src/bot.ts:119

The bot's intents that will be used to make a connection with discords gateway.

---

loggerFactory()?

optional loggerFactory: (name) => Pick<{ debug: (...args) => void; error: (...args) => void; fatal: (...args) => void; info: (...args) => void; log: (level, ...args) => void; setDepth: (level) => void; setLevel: (level) => void; warn: (...args) => void; }, "debug" | "info" | "warn" | "error" | "fatal">

Defined in: packages/bot/src/bot.ts:150

This factory will be invoked to create the logger for gateway, rest and bot

Parameters

name

"REST" | "GATEWAY" | "BOT"

Returns

Pick<{ debug: (...args) => void; error: (...args) => void; fatal: (...args) => void; info: (...args) => void; log: (level, ...args) => void; setDepth: (level) => void; setLevel: (level) => void; warn: (...args) => void; }, "debug" | "info" | "warn" | "error" | "fatal">

Remarks

If not provided the default logger will be used with rest and gateway sharing the same logger

This function will be invoked 3 times, one with the name of REST, one with GATEWAY and the third one with name BOT

---

rest?

optional rest: Omit<CreateRestManagerOptions, "token"> & Partial<Pick<CreateRestManagerOptions, "token">>

Defined in: packages/bot/src/bot.ts:121

Any options you wish to provide to the rest manager.

---

token

token: string

Defined in: packages/bot/src/bot.ts:115

The bot's token.

---

transformers?

optional transformers: object

Defined in: packages/bot/src/bot.ts:127

The functions that should transform discord objects to discordeno shaped objects.

activity()?

optional activity: (bot, payload) => Activity

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordActivity

Returns

Activity

activityInstance()?

optional activityInstance: (bot, payload) => SetupDesiredProps<ActivityInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordActivityInstance

Returns

SetupDesiredProps<ActivityInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

activityLocation()?

optional activityLocation: (bot, payload) => SetupDesiredProps<ActivityLocation, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordActivityLocation

Returns

SetupDesiredProps<ActivityLocation, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

application()?

optional application: (bot, payload) => Application

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

application

DiscordApplication

shardId

number

Returns

Application

applicationCommand()?

optional applicationCommand: (bot, payload) => ApplicationCommand

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordApplicationCommand

Returns

ApplicationCommand

applicationCommandOption()?

optional applicationCommandOption: (bot, payload) => ApplicationCommandOption

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordApplicationCommandOption

Returns

ApplicationCommandOption

applicationCommandOptionChoice()?

optional applicationCommandOptionChoice: (bot, payload) => ApplicationCommandOptionChoice

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordApplicationCommandOptionChoice

Returns

ApplicationCommandOptionChoice

applicationCommandPermission()?

optional applicationCommandPermission: (bot, payload) => GuildApplicationCommandPermissions

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildApplicationCommandPermissions

Returns

GuildApplicationCommandPermissions

attachment()?

optional attachment: (bot, payload) => SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAttachment

Returns

SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

auditLogEntry()?

optional auditLogEntry: (bot, payload) => AuditLogEntry

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAuditLogEntry

Returns

AuditLogEntry

automodActionExecution()?

optional automodActionExecution: (bot, payload) => AutoModerationActionExecution

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAutoModerationActionExecution

Returns

AutoModerationActionExecution

automodRule()?

optional automodRule: (bot, payload) => AutoModerationRule

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAutoModerationRule

Returns

AutoModerationRule

avatarDecorationData()?

optional avatarDecorationData: (bot, payload) => SetupDesiredProps<AvatarDecorationData, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAvatarDecorationData

Returns

SetupDesiredProps<AvatarDecorationData, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

channel()?

optional channel: (bot, payload) => SetupDesiredProps<Channel, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

channel

DiscordChannel

guildId

BigString

Returns

SetupDesiredProps<Channel, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

component()?

optional component: (bot, payload) => Component

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMessageComponent

Returns

Component

customizers?

optional customizers: object

customizers.activity()?

optional customizers.activity: (bot, payload, activity) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordActivity

activity

Activity

Returns

any

customizers.activityInstance()?

optional customizers.activityInstance: (bot, payload, activityInstance) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordActivityInstance

activityInstance

SetupDesiredProps<ActivityInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.activityLocation()?

optional customizers.activityLocation: (bot, payload, activityLocation) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordActivityLocation

activityLocation

SetupDesiredProps<ActivityLocation, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.application()?

optional customizers.application: (bot, payload, application) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordApplication

application

Application

Returns

any

customizers.applicationCommand()?

optional customizers.applicationCommand: (bot, payload, applicationCommand) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordApplicationCommand

applicationCommand

ApplicationCommand

Returns

any

customizers.applicationCommandOption()?

optional customizers.applicationCommandOption: (bot, payload, applicationCommandOption) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordApplicationCommandOption

applicationCommandOption

ApplicationCommandOption

Returns

any

customizers.applicationCommandOptionChoice()?

optional customizers.applicationCommandOptionChoice: (bot, payload, applicationCommandOptionChoice) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordApplicationCommandOptionChoice

applicationCommandOptionChoice

ApplicationCommandOptionChoice

Returns

any

customizers.applicationCommandPermission()?

optional customizers.applicationCommandPermission: (bot, payload, applicationCommandPermission) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildApplicationCommandPermissions

applicationCommandPermission

GuildApplicationCommandPermissions

Returns

any

customizers.attachment()?

optional customizers.attachment: (bot, payload, attachment) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAttachment

attachment

SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.auditLogEntry()?

optional customizers.auditLogEntry: (bot, payload, auditLogEntry) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAuditLogEntry

auditLogEntry

AuditLogEntry

Returns

any

customizers.automodActionExecution()?

optional customizers.automodActionExecution: (bot, payload, automodActionExecution) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAutoModerationActionExecution

automodActionExecution

AutoModerationActionExecution

Returns

any

customizers.automodRule()?

optional customizers.automodRule: (bot, payload, automodRule) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAutoModerationRule

automodRule

AutoModerationRule

Returns

any

customizers.avatarDecorationData()?

optional customizers.avatarDecorationData: (bot, payload, avatarDecorationData) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordAvatarDecorationData

avatarDecorationData

SetupDesiredProps<AvatarDecorationData, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.channel()?

optional customizers.channel: (bot, payload, channel) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordChannel

channel

SetupDesiredProps<Channel, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.component()?

optional customizers.component: (bot, payload, component) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMessageComponent

component

Component

Returns

any

customizers.defaultReactionEmoji()?

optional customizers.defaultReactionEmoji: (bot, payload, defaultReactionEmoji) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordDefaultReactionEmoji

defaultReactionEmoji

SetupDesiredProps<DefaultReactionEmoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.embed()?

optional customizers.embed: (bot, payload, embed) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordEmbed

embed

Embed

Returns

any

customizers.emoji()?

optional customizers.emoji: (bot, payload, emoji) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordEmoji

emoji

SetupDesiredProps<Emoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.entitlement()?

optional customizers.entitlement: (bot, payload, entitlement) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordEntitlement

entitlement

SetupDesiredProps<Entitlement, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.forumTag()?

optional customizers.forumTag: (bot, payload, forumTag) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordForumTag

forumTag

SetupDesiredProps<ForumTag, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.gatewayBot()?

optional customizers.gatewayBot: (bot, payload, getGatewayBot) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGetGatewayBot

getGatewayBot

GetGatewayBot

Returns

any

customizers.guild()?

optional customizers.guild: (bot, payload, guild) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuild

guild

SetupDesiredProps<Guild, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.guildOnboarding()?

optional customizers.guildOnboarding: (bot, payload, onboarding) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildOnboarding

onboarding

SetupDesiredProps<GuildOnboarding, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.guildOnboardingPrompt()?

optional customizers.guildOnboardingPrompt: (bot, payload, onboardingPrompt) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildOnboardingPrompt

onboardingPrompt

SetupDesiredProps<GuildOnboardingPrompt, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.guildOnboardingPromptOption()?

optional customizers.guildOnboardingPromptOption: (bot, payload, onboardingPromptOption) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildOnboardingPromptOption

onboardingPromptOption

GuildOnboardingPromptOption

Returns

any

customizers.integration()?

optional customizers.integration: (bot, payload, integration) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordIntegrationCreateUpdate

integration

Integration

Returns

any

customizers.interaction()?

optional customizers.interaction: (bot, payload, interaction) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

interaction

DiscordInteraction

shardId

number

interaction

SetupDesiredProps<Interaction, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.interactionCallback()?

optional customizers.interactionCallback: (bot, payload, interactionCallback) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInteractionCallback

interactionCallback

SetupDesiredProps<InteractionCallback, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.interactionCallbackResponse()?

optional customizers.interactionCallbackResponse: (bot, payload, interactionCallbackResponse) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInteractionCallbackResponse

interactionCallbackResponse

SetupDesiredProps<InteractionCallbackResponse, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.interactionDataOptions()?

optional customizers.interactionDataOptions: (bot, payload, interactionDataOptions) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInteractionDataOption

interactionDataOptions

InteractionDataOption

Returns

any

customizers.interactionDataResolved()?

optional customizers.interactionDataResolved: (bot, payload, interactionDataResolved) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

guildId

bigint

resolved

DiscordInteractionDataResolved

interactionDataResolved

InteractionDataResolved

Returns

any

customizers.interactionResource()?

optional customizers.interactionResource: (bot, payload, interactionResource) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInteractionResource

interactionResource

SetupDesiredProps<InteractionResource, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.invite()?

optional customizers.invite: (bot, payload, invite) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInviteCreate | DiscordInviteMetadata

invite

SetupDesiredProps<Invite, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.inviteStageInstance()?

optional customizers.inviteStageInstance: (bot, payload, inviteStageInstance) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInviteStageInstance

inviteStageInstance

SetupDesiredProps<InviteStageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.member()?

optional customizers.member: (bot, payload, member) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMember

member

SetupDesiredProps<Member, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.message()?

optional customizers.message: (bot, payload, message) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMessage

message

SetupDesiredProps<Message, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.messageCall()?

optional customizers.messageCall: (bot, payload, call) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMessageCall

call

SetupDesiredProps<MessageCall, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.messageInteractionMetadata()?

optional customizers.messageInteractionMetadata: (bot, payload, metadata) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMessageInteractionMetadata

metadata

SetupDesiredProps<MessageInteractionMetadata, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.messageSnapshot()?

optional customizers.messageSnapshot: (bot, payload, messageSnapshot) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMessageSnapshot

messageSnapshot

SetupDesiredProps<MessageSnapshot, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.poll()?

optional customizers.poll: (bot, payload, poll) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordPoll

poll

SetupDesiredProps<Poll, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.pollMedia()?

optional customizers.pollMedia: (bot, payload, pollMedia) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordPollMedia

pollMedia

SetupDesiredProps<PollMedia, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.presence()?

optional customizers.presence: (bot, payload, presence) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordPresenceUpdate

presence

PresenceUpdate

Returns

any

customizers.role()?

optional customizers.role: (bot, payload, role) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordRole

role

SetupDesiredProps<Role, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.scheduledEvent()?

optional customizers.scheduledEvent: (bot, payload, scheduledEvent) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordScheduledEvent

scheduledEvent

SetupDesiredProps<ScheduledEvent, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.scheduledEventRecurrenceRule()?

optional customizers.scheduledEventRecurrenceRule: (bot, payload, scheduledEvent) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordScheduledEventRecurrenceRule

scheduledEvent

SetupDesiredProps<ScheduledEventRecurrenceRule, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.sku()?

optional customizers.sku: (bot, payload, sku) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordSku

sku

SetupDesiredProps<Sku, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.soundboardSound()?

optional customizers.soundboardSound: (bot, payload, soundboardSound) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordSoundboardSound

soundboardSound

SetupDesiredProps<SoundboardSound, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.stageInstance()?

optional customizers.stageInstance: (bot, payload, stageInstance) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordStageInstance

stageInstance

SetupDesiredProps<StageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.sticker()?

optional customizers.sticker: (bot, payload, sticker) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordSticker

sticker

SetupDesiredProps<Sticker, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.stickerPack()?

optional customizers.stickerPack: (bot, payload, stickerPack) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordStickerPack

stickerPack

StickerPack

Returns

any

customizers.subscription()?

optional customizers.subscription: (bot, payload, subscription) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordSubscription

subscription

SetupDesiredProps<Subscription, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.team()?

optional customizers.team: (bot, payload, team) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordTeam

team

Team

Returns

any

customizers.template()?

optional customizers.template: (bot, payload, template) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordTemplate

template

Template

Returns

any

customizers.threadMember()?

optional customizers.threadMember: (bot, payload, threadMember) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordThreadMember

threadMember

ThreadMember

Returns

any

customizers.threadMemberGuildCreate()?

optional customizers.threadMemberGuildCreate: (bot, payload, threadMemberGuildCreate) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordThreadMemberGuildCreate

threadMemberGuildCreate

ThreadMemberGuildCreate

Returns

any

customizers.user()?

optional customizers.user: (bot, payload, user) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordUser

user

SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.voiceRegion()?

optional customizers.voiceRegion: (bot, payload, voiceRegion) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordVoiceRegion

voiceRegion

VoiceRegion

Returns

any

customizers.voiceState()?

optional customizers.voiceState: (bot, payload, voiceState) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordVoiceState

voiceState

SetupDesiredProps<VoiceState, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.webhook()?

optional customizers.webhook: (bot, payload, webhook) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordWebhook

webhook

SetupDesiredProps<Webhook, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

any

customizers.welcomeScreen()?

optional customizers.welcomeScreen: (bot, payload, welcomeScreen) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordWelcomeScreen

welcomeScreen

WelcomeScreen

Returns

any

customizers.widget()?

optional customizers.widget: (bot, payload, widget) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildWidget

widget

GuildWidget

Returns

any

customizers.widgetSettings()?

optional customizers.widgetSettings: (bot, payload, widgetSettings) => any

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildWidgetSettings

widgetSettings

GuildWidgetSettings

Returns

any

defaultReactionEmoji()?

optional defaultReactionEmoji: (bot, payload) => SetupDesiredProps<DefaultReactionEmoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordDefaultReactionEmoji

Returns

SetupDesiredProps<DefaultReactionEmoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

desiredProperties?

optional desiredProperties: object

desiredProperties.activityInstance?

optional desiredProperties.activityInstance: object

desiredProperties.activityInstance.applicationId?

optional desiredProperties.activityInstance.applicationId: boolean

desiredProperties.activityInstance.instanceId?

optional desiredProperties.activityInstance.instanceId: boolean

desiredProperties.activityInstance.launchId?

optional desiredProperties.activityInstance.launchId: boolean

desiredProperties.activityInstance.location?

optional desiredProperties.activityInstance.location: boolean

desiredProperties.activityInstance.users?

optional desiredProperties.activityInstance.users: boolean

desiredProperties.activityLocation?

optional desiredProperties.activityLocation: object

desiredProperties.activityLocation.channelId?

optional desiredProperties.activityLocation.channelId: boolean

desiredProperties.activityLocation.guildId?

optional desiredProperties.activityLocation.guildId: boolean

desiredProperties.activityLocation.id?

optional desiredProperties.activityLocation.id: boolean

desiredProperties.activityLocation.kind?

optional desiredProperties.activityLocation.kind: boolean

desiredProperties.attachment?

optional desiredProperties.attachment: object

desiredProperties.attachment.contentType?

optional desiredProperties.attachment.contentType: boolean

desiredProperties.attachment.description?

optional desiredProperties.attachment.description: boolean

desiredProperties.attachment.duration_secs?

optional desiredProperties.attachment.duration_secs: boolean

desiredProperties.attachment.ephemeral?

optional desiredProperties.attachment.ephemeral: boolean

desiredProperties.attachment.filename?

optional desiredProperties.attachment.filename: boolean

desiredProperties.attachment.flags?

optional desiredProperties.attachment.flags: boolean

desiredProperties.attachment.height?

optional desiredProperties.attachment.height: boolean

desiredProperties.attachment.id?

optional desiredProperties.attachment.id: boolean

desiredProperties.attachment.proxyUrl?

optional desiredProperties.attachment.proxyUrl: boolean

desiredProperties.attachment.size?

optional desiredProperties.attachment.size: boolean

desiredProperties.attachment.title?

optional desiredProperties.attachment.title: boolean

desiredProperties.attachment.url?

optional desiredProperties.attachment.url: boolean

desiredProperties.attachment.waveform?

optional desiredProperties.attachment.waveform: boolean

desiredProperties.attachment.width?

optional desiredProperties.attachment.width: boolean

desiredProperties.avatarDecorationData?

optional desiredProperties.avatarDecorationData: object

desiredProperties.avatarDecorationData.asset?

optional desiredProperties.avatarDecorationData.asset: boolean

desiredProperties.avatarDecorationData.skuId?

optional desiredProperties.avatarDecorationData.skuId: boolean

desiredProperties.channel?

optional desiredProperties.channel: object

desiredProperties.channel.applicationId?

optional desiredProperties.channel.applicationId: boolean

desiredProperties.channel.appliedTags?

optional desiredProperties.channel.appliedTags: boolean

desiredProperties.channel.availableTags?

optional desiredProperties.channel.availableTags: boolean

desiredProperties.channel.bitrate?

optional desiredProperties.channel.bitrate: boolean

desiredProperties.channel.defaultAutoArchiveDuration?

optional desiredProperties.channel.defaultAutoArchiveDuration: boolean

desiredProperties.channel.defaultForumLayout?

optional desiredProperties.channel.defaultForumLayout: boolean

desiredProperties.channel.defaultReactionEmoji?

optional desiredProperties.channel.defaultReactionEmoji: boolean

desiredProperties.channel.defaultSortOrder?

optional desiredProperties.channel.defaultSortOrder: boolean

desiredProperties.channel.defaultThreadRateLimitPerUser?

optional desiredProperties.channel.defaultThreadRateLimitPerUser: boolean

desiredProperties.channel.flags?

optional desiredProperties.channel.flags: boolean

desiredProperties.channel.guildId?

optional desiredProperties.channel.guildId: boolean

desiredProperties.channel.icon?

optional desiredProperties.channel.icon: boolean

desiredProperties.channel.id?

optional desiredProperties.channel.id: boolean

desiredProperties.channel.lastMessageId?

optional desiredProperties.channel.lastMessageId: boolean

desiredProperties.channel.lastPinTimestamp?

optional desiredProperties.channel.lastPinTimestamp: boolean

desiredProperties.channel.member?

optional desiredProperties.channel.member: boolean

desiredProperties.channel.memberCount?

optional desiredProperties.channel.memberCount: boolean

desiredProperties.channel.messageCount?

optional desiredProperties.channel.messageCount: boolean

desiredProperties.channel.name?

optional desiredProperties.channel.name: boolean

desiredProperties.channel.ownerId?

optional desiredProperties.channel.ownerId: boolean

desiredProperties.channel.parentId?

optional desiredProperties.channel.parentId: boolean

desiredProperties.channel.permissionOverwrites?

optional desiredProperties.channel.permissionOverwrites: boolean

desiredProperties.channel.permissions?

optional desiredProperties.channel.permissions: boolean

desiredProperties.channel.position?

optional desiredProperties.channel.position: boolean

desiredProperties.channel.rateLimitPerUser?

optional desiredProperties.channel.rateLimitPerUser: boolean

desiredProperties.channel.recipients?

optional desiredProperties.channel.recipients: boolean

desiredProperties.channel.rtcRegion?

optional desiredProperties.channel.rtcRegion: boolean

desiredProperties.channel.threadMetadata?

optional desiredProperties.channel.threadMetadata: boolean

desiredProperties.channel.topic?

optional desiredProperties.channel.topic: boolean

desiredProperties.channel.totalMessageSent?

optional desiredProperties.channel.totalMessageSent: boolean

desiredProperties.channel.type?

optional desiredProperties.channel.type: boolean

desiredProperties.channel.userLimit?

optional desiredProperties.channel.userLimit: boolean

desiredProperties.channel.videoQualityMode?

optional desiredProperties.channel.videoQualityMode: boolean

desiredProperties.defaultReactionEmoji?

optional desiredProperties.defaultReactionEmoji: object

desiredProperties.defaultReactionEmoji.emojiId?

optional desiredProperties.defaultReactionEmoji.emojiId: boolean

desiredProperties.defaultReactionEmoji.emojiName?

optional desiredProperties.defaultReactionEmoji.emojiName: boolean

desiredProperties.emoji?

optional desiredProperties.emoji: object

desiredProperties.emoji.id?

optional desiredProperties.emoji.id: boolean

desiredProperties.emoji.name?

optional desiredProperties.emoji.name: boolean

desiredProperties.emoji.roles?

optional desiredProperties.emoji.roles: boolean

desiredProperties.emoji.user?

optional desiredProperties.emoji.user: boolean

desiredProperties.entitlement?

optional desiredProperties.entitlement: object

desiredProperties.entitlement.applicationId?

optional desiredProperties.entitlement.applicationId: boolean

desiredProperties.entitlement.consumed?

optional desiredProperties.entitlement.consumed: boolean

desiredProperties.entitlement.deleted?

optional desiredProperties.entitlement.deleted: boolean

desiredProperties.entitlement.endsAt?

optional desiredProperties.entitlement.endsAt: boolean

desiredProperties.entitlement.guildId?

optional desiredProperties.entitlement.guildId: boolean

desiredProperties.entitlement.id?

optional desiredProperties.entitlement.id: boolean

desiredProperties.entitlement.skuId?

optional desiredProperties.entitlement.skuId: boolean

desiredProperties.entitlement.startsAt?

optional desiredProperties.entitlement.startsAt: boolean

desiredProperties.entitlement.type?

optional desiredProperties.entitlement.type: boolean

desiredProperties.entitlement.userId?

optional desiredProperties.entitlement.userId: boolean

desiredProperties.forumTag?

optional desiredProperties.forumTag: object

desiredProperties.forumTag.emojiId?

optional desiredProperties.forumTag.emojiId: boolean

desiredProperties.forumTag.emojiName?

optional desiredProperties.forumTag.emojiName: boolean

desiredProperties.forumTag.id?

optional desiredProperties.forumTag.id: boolean

desiredProperties.forumTag.moderated?

optional desiredProperties.forumTag.moderated: boolean

desiredProperties.forumTag.name?

optional desiredProperties.forumTag.name: boolean

desiredProperties.guild?

optional desiredProperties.guild: object

desiredProperties.guild.afkChannelId?

optional desiredProperties.guild.afkChannelId: boolean

desiredProperties.guild.afkTimeout?

optional desiredProperties.guild.afkTimeout: boolean

desiredProperties.guild.applicationId?

optional desiredProperties.guild.applicationId: boolean

desiredProperties.guild.approximateMemberCount?

optional desiredProperties.guild.approximateMemberCount: boolean

desiredProperties.guild.approximatePresenceCount?

optional desiredProperties.guild.approximatePresenceCount: boolean

desiredProperties.guild.banner?

optional desiredProperties.guild.banner: boolean

desiredProperties.guild.channels?

optional desiredProperties.guild.channels: boolean

desiredProperties.guild.defaultMessageNotifications?

optional desiredProperties.guild.defaultMessageNotifications: boolean

desiredProperties.guild.description?

optional desiredProperties.guild.description: boolean

desiredProperties.guild.discoverySplash?

optional desiredProperties.guild.discoverySplash: boolean

desiredProperties.guild.emojis?

optional desiredProperties.guild.emojis: boolean

desiredProperties.guild.explicitContentFilter?

optional desiredProperties.guild.explicitContentFilter: boolean

desiredProperties.guild.icon?

optional desiredProperties.guild.icon: boolean

desiredProperties.guild.iconHash?

optional desiredProperties.guild.iconHash: boolean

desiredProperties.guild.id?

optional desiredProperties.guild.id: boolean

desiredProperties.guild.joinedAt?

optional desiredProperties.guild.joinedAt: boolean

desiredProperties.guild.large?

optional desiredProperties.guild.large: boolean

desiredProperties.guild.maxMembers?

optional desiredProperties.guild.maxMembers: boolean

desiredProperties.guild.maxPresences?

optional desiredProperties.guild.maxPresences: boolean

desiredProperties.guild.maxStageVideoChannelUsers?

optional desiredProperties.guild.maxStageVideoChannelUsers: boolean

desiredProperties.guild.maxVideoChannelUsers?

optional desiredProperties.guild.maxVideoChannelUsers: boolean

desiredProperties.guild.memberCount?

optional desiredProperties.guild.memberCount: boolean

desiredProperties.guild.members?

optional desiredProperties.guild.members: boolean

desiredProperties.guild.mfaLevel?

optional desiredProperties.guild.mfaLevel: boolean

desiredProperties.guild.name?

optional desiredProperties.guild.name: boolean

desiredProperties.guild.nsfwLevel?

optional desiredProperties.guild.nsfwLevel: boolean

desiredProperties.guild.owner?

optional desiredProperties.guild.owner: boolean

desiredProperties.guild.ownerId?

optional desiredProperties.guild.ownerId: boolean

desiredProperties.guild.permissions?

optional desiredProperties.guild.permissions: boolean

desiredProperties.guild.preferredLocale?

optional desiredProperties.guild.preferredLocale: boolean

desiredProperties.guild.premiumProgressBarEnabled?

optional desiredProperties.guild.premiumProgressBarEnabled: boolean

desiredProperties.guild.premiumSubscriptionCount?

optional desiredProperties.guild.premiumSubscriptionCount: boolean

desiredProperties.guild.premiumTier?

optional desiredProperties.guild.premiumTier: boolean

desiredProperties.guild.presences?

optional desiredProperties.guild.presences: boolean

desiredProperties.guild.publicUpdatesChannelId?

optional desiredProperties.guild.publicUpdatesChannelId: boolean

desiredProperties.guild.roles?

optional desiredProperties.guild.roles: boolean

desiredProperties.guild.rulesChannelId?

optional desiredProperties.guild.rulesChannelId: boolean

desiredProperties.guild.safetyAlertsChannelId?

optional desiredProperties.guild.safetyAlertsChannelId: boolean

desiredProperties.guild.shardId?

optional desiredProperties.guild.shardId: boolean

desiredProperties.guild.splash?

optional desiredProperties.guild.splash: boolean

desiredProperties.guild.stageInstances?

optional desiredProperties.guild.stageInstances: boolean

desiredProperties.guild.stickers?

optional desiredProperties.guild.stickers: boolean

desiredProperties.guild.systemChannelFlags?

optional desiredProperties.guild.systemChannelFlags: boolean

desiredProperties.guild.systemChannelId?

optional desiredProperties.guild.systemChannelId: boolean

desiredProperties.guild.toggles?

optional desiredProperties.guild.toggles: boolean

desiredProperties.guild.unavailable?

optional desiredProperties.guild.unavailable: boolean

desiredProperties.guild.vanityUrlCode?

optional desiredProperties.guild.vanityUrlCode: boolean

desiredProperties.guild.verificationLevel?

optional desiredProperties.guild.verificationLevel: boolean

desiredProperties.guild.voiceStates?

optional desiredProperties.guild.voiceStates: boolean

desiredProperties.guild.welcomeScreen?

optional desiredProperties.guild.welcomeScreen: boolean

desiredProperties.guild.widgetChannelId?

optional desiredProperties.guild.widgetChannelId: boolean

desiredProperties.guild.widgetEnabled?

optional desiredProperties.guild.widgetEnabled: boolean

desiredProperties.guildOnboarding?

optional desiredProperties.guildOnboarding: object

desiredProperties.guildOnboarding.defaultChannelIds?

optional desiredProperties.guildOnboarding.defaultChannelIds: boolean

desiredProperties.guildOnboarding.enabled?

optional desiredProperties.guildOnboarding.enabled: boolean

desiredProperties.guildOnboarding.guildId?

optional desiredProperties.guildOnboarding.guildId: boolean

desiredProperties.guildOnboarding.mode?

optional desiredProperties.guildOnboarding.mode: boolean

desiredProperties.guildOnboarding.prompts?

optional desiredProperties.guildOnboarding.prompts: boolean

desiredProperties.guildOnboardingPrompt?

optional desiredProperties.guildOnboardingPrompt: object

desiredProperties.guildOnboardingPrompt.id?

optional desiredProperties.guildOnboardingPrompt.id: boolean

desiredProperties.guildOnboardingPrompt.inOnboarding?

optional desiredProperties.guildOnboardingPrompt.inOnboarding: boolean

desiredProperties.guildOnboardingPrompt.options?

optional desiredProperties.guildOnboardingPrompt.options: boolean

desiredProperties.guildOnboardingPrompt.required?

optional desiredProperties.guildOnboardingPrompt.required: boolean

desiredProperties.guildOnboardingPrompt.singleSelect?

optional desiredProperties.guildOnboardingPrompt.singleSelect: boolean

desiredProperties.guildOnboardingPrompt.title?

optional desiredProperties.guildOnboardingPrompt.title: boolean

desiredProperties.guildOnboardingPrompt.type?

optional desiredProperties.guildOnboardingPrompt.type: boolean

desiredProperties.guildOnboardingPromptOption?

optional desiredProperties.guildOnboardingPromptOption: object

desiredProperties.guildOnboardingPromptOption.channelIds?

optional desiredProperties.guildOnboardingPromptOption.channelIds: boolean

desiredProperties.guildOnboardingPromptOption.description?

optional desiredProperties.guildOnboardingPromptOption.description: boolean

desiredProperties.guildOnboardingPromptOption.emoji?

optional desiredProperties.guildOnboardingPromptOption.emoji: boolean

desiredProperties.guildOnboardingPromptOption.id?

optional desiredProperties.guildOnboardingPromptOption.id: boolean

desiredProperties.guildOnboardingPromptOption.roleIds?

optional desiredProperties.guildOnboardingPromptOption.roleIds: boolean

desiredProperties.guildOnboardingPromptOption.title?

optional desiredProperties.guildOnboardingPromptOption.title: boolean

desiredProperties.interaction?

optional desiredProperties.interaction: object

desiredProperties.interaction.applicationId?

optional desiredProperties.interaction.applicationId: boolean

desiredProperties.interaction.appPermissions?

optional desiredProperties.interaction.appPermissions: boolean

desiredProperties.interaction.authorizingIntegrationOwners?

optional desiredProperties.interaction.authorizingIntegrationOwners: boolean

desiredProperties.interaction.channel?

optional desiredProperties.interaction.channel: boolean

desiredProperties.interaction.channelId?

optional desiredProperties.interaction.channelId: boolean

desiredProperties.interaction.context?

optional desiredProperties.interaction.context: boolean

desiredProperties.interaction.data?

optional desiredProperties.interaction.data: boolean

desiredProperties.interaction.guild?

optional desiredProperties.interaction.guild: boolean

desiredProperties.interaction.guildId?

optional desiredProperties.interaction.guildId: boolean

desiredProperties.interaction.guildLocale?

optional desiredProperties.interaction.guildLocale: boolean

desiredProperties.interaction.id?

optional desiredProperties.interaction.id: boolean

desiredProperties.interaction.locale?

optional desiredProperties.interaction.locale: boolean

desiredProperties.interaction.member?

optional desiredProperties.interaction.member: boolean

desiredProperties.interaction.message?

optional desiredProperties.interaction.message: boolean

desiredProperties.interaction.token?

optional desiredProperties.interaction.token: boolean

desiredProperties.interaction.type?

optional desiredProperties.interaction.type: boolean

desiredProperties.interaction.user?

optional desiredProperties.interaction.user: boolean

desiredProperties.interaction.version?

optional desiredProperties.interaction.version: boolean

desiredProperties.interactionCallback?

optional desiredProperties.interactionCallback: object

desiredProperties.interactionCallback.activityInstanceId?

optional desiredProperties.interactionCallback.activityInstanceId: boolean

desiredProperties.interactionCallback.id?

optional desiredProperties.interactionCallback.id: boolean

desiredProperties.interactionCallback.responseMessageEphemeral?

optional desiredProperties.interactionCallback.responseMessageEphemeral: boolean

desiredProperties.interactionCallback.responseMessageId?

optional desiredProperties.interactionCallback.responseMessageId: boolean

desiredProperties.interactionCallback.responseMessageLoading?

optional desiredProperties.interactionCallback.responseMessageLoading: boolean

desiredProperties.interactionCallback.type?

optional desiredProperties.interactionCallback.type: boolean

desiredProperties.interactionCallbackResponse?

optional desiredProperties.interactionCallbackResponse: object

desiredProperties.interactionCallbackResponse.interaction?

optional desiredProperties.interactionCallbackResponse.interaction: boolean

desiredProperties.interactionCallbackResponse.resource?

optional desiredProperties.interactionCallbackResponse.resource: boolean

desiredProperties.interactionResource?

optional desiredProperties.interactionResource: object

desiredProperties.interactionResource.activityInstance?

optional desiredProperties.interactionResource.activityInstance: boolean

desiredProperties.interactionResource.message?

optional desiredProperties.interactionResource.message: boolean

desiredProperties.interactionResource.type?

optional desiredProperties.interactionResource.type: boolean

desiredProperties.invite?

optional desiredProperties.invite: object

desiredProperties.invite.approximateMemberCount?

optional desiredProperties.invite.approximateMemberCount: boolean

desiredProperties.invite.approximatePresenceCount?

optional desiredProperties.invite.approximatePresenceCount: boolean

desiredProperties.invite.channelId?

optional desiredProperties.invite.channelId: boolean

desiredProperties.invite.code?

optional desiredProperties.invite.code: boolean

desiredProperties.invite.createdAt?

optional desiredProperties.invite.createdAt: boolean

desiredProperties.invite.expiresAt?

optional desiredProperties.invite.expiresAt: boolean

desiredProperties.invite.guildId?

optional desiredProperties.invite.guildId: boolean

desiredProperties.invite.guildScheduledEvent?

optional desiredProperties.invite.guildScheduledEvent: boolean

desiredProperties.invite.inviter?

optional desiredProperties.invite.inviter: boolean

desiredProperties.invite.maxAge?

optional desiredProperties.invite.maxAge: boolean

desiredProperties.invite.maxUses?

optional desiredProperties.invite.maxUses: boolean

desiredProperties.invite.stageInstance?

optional desiredProperties.invite.stageInstance: boolean

desiredProperties.invite.targetApplication?

optional desiredProperties.invite.targetApplication: boolean

desiredProperties.invite.targetType?

optional desiredProperties.invite.targetType: boolean

desiredProperties.invite.targetUser?

optional desiredProperties.invite.targetUser: boolean

desiredProperties.invite.temporary?

optional desiredProperties.invite.temporary: boolean

desiredProperties.invite.type?

optional desiredProperties.invite.type: boolean

desiredProperties.invite.uses?

optional desiredProperties.invite.uses: boolean

desiredProperties.inviteStageInstance?

optional desiredProperties.inviteStageInstance: object

desiredProperties.inviteStageInstance.members?

optional desiredProperties.inviteStageInstance.members: boolean

desiredProperties.inviteStageInstance.participantCount?

optional desiredProperties.inviteStageInstance.participantCount: boolean

desiredProperties.inviteStageInstance.speakerCount?

optional desiredProperties.inviteStageInstance.speakerCount: boolean

desiredProperties.inviteStageInstance.topic?

optional desiredProperties.inviteStageInstance.topic: boolean

desiredProperties.member?

optional desiredProperties.member: object

desiredProperties.member.avatar?

optional desiredProperties.member.avatar: boolean

desiredProperties.member.avatarDecorationData?

optional desiredProperties.member.avatarDecorationData: boolean

desiredProperties.member.banner?

optional desiredProperties.member.banner: boolean

desiredProperties.member.communicationDisabledUntil?

optional desiredProperties.member.communicationDisabledUntil: boolean

desiredProperties.member.guildId?

optional desiredProperties.member.guildId: boolean

desiredProperties.member.id?

optional desiredProperties.member.id: boolean

desiredProperties.member.joinedAt?

optional desiredProperties.member.joinedAt: boolean

desiredProperties.member.nick?

optional desiredProperties.member.nick: boolean

desiredProperties.member.permissions?

optional desiredProperties.member.permissions: boolean

desiredProperties.member.premiumSince?

optional desiredProperties.member.premiumSince: boolean

desiredProperties.member.roles?

optional desiredProperties.member.roles: boolean

desiredProperties.member.toggles?

optional desiredProperties.member.toggles: boolean

desiredProperties.member.user?

optional desiredProperties.member.user: boolean

desiredProperties.message?

optional desiredProperties.message: object

desiredProperties.message.activity?

optional desiredProperties.message.activity: boolean

desiredProperties.message.application?

optional desiredProperties.message.application: boolean

desiredProperties.message.applicationId?

optional desiredProperties.message.applicationId: boolean

desiredProperties.message.attachments?

optional desiredProperties.message.attachments: boolean

desiredProperties.message.author?

optional desiredProperties.message.author: boolean

desiredProperties.message.call?

optional desiredProperties.message.call: boolean

desiredProperties.message.channelId?

optional desiredProperties.message.channelId: boolean

desiredProperties.message.components?

optional desiredProperties.message.components: boolean

desiredProperties.message.content?

optional desiredProperties.message.content: boolean

desiredProperties.message.editedTimestamp?

optional desiredProperties.message.editedTimestamp: boolean

desiredProperties.message.embeds?

optional desiredProperties.message.embeds: boolean

desiredProperties.message.guildId?

optional desiredProperties.message.guildId: boolean

desiredProperties.message.id?

optional desiredProperties.message.id: boolean

desiredProperties.message.interaction?

optional desiredProperties.message.interaction: boolean

desiredProperties.message.interactionMetadata?

optional desiredProperties.message.interactionMetadata: boolean

desiredProperties.message.member?

optional desiredProperties.message.member: boolean

desiredProperties.message.mentionedChannelIds?

optional desiredProperties.message.mentionedChannelIds: boolean

desiredProperties.message.mentionedRoleIds?

optional desiredProperties.message.mentionedRoleIds: boolean

desiredProperties.message.mentions?

optional desiredProperties.message.mentions: boolean

desiredProperties.message.messageReference?

optional desiredProperties.message.messageReference: boolean

desiredProperties.message.messageSnapshots?

optional desiredProperties.message.messageSnapshots: boolean

desiredProperties.message.nonce?

optional desiredProperties.message.nonce: boolean

desiredProperties.message.poll?

optional desiredProperties.message.poll: boolean

desiredProperties.message.reactions?

optional desiredProperties.message.reactions: boolean

desiredProperties.message.referencedMessage?

optional desiredProperties.message.referencedMessage: boolean

desiredProperties.message.stickerItems?

optional desiredProperties.message.stickerItems: boolean

desiredProperties.message.thread?

optional desiredProperties.message.thread: boolean

desiredProperties.message.type?

optional desiredProperties.message.type: boolean

desiredProperties.message.webhookId?

optional desiredProperties.message.webhookId: boolean

desiredProperties.messageCall?

optional desiredProperties.messageCall: object

desiredProperties.messageCall.endedTimestamp?

optional desiredProperties.messageCall.endedTimestamp: boolean

desiredProperties.messageCall.participants?

optional desiredProperties.messageCall.participants: boolean

desiredProperties.messageInteraction?

optional desiredProperties.messageInteraction: object

desiredProperties.messageInteraction.id?

optional desiredProperties.messageInteraction.id: boolean

desiredProperties.messageInteraction.member?

optional desiredProperties.messageInteraction.member: boolean

desiredProperties.messageInteraction.name?

optional desiredProperties.messageInteraction.name: boolean

desiredProperties.messageInteraction.type?

optional desiredProperties.messageInteraction.type: boolean

desiredProperties.messageInteraction.user?

optional desiredProperties.messageInteraction.user: boolean

desiredProperties.messageInteractionMetadata?

optional desiredProperties.messageInteractionMetadata: object

desiredProperties.messageInteractionMetadata.authorizingIntegrationOwners?

optional desiredProperties.messageInteractionMetadata.authorizingIntegrationOwners: boolean

desiredProperties.messageInteractionMetadata.id?

optional desiredProperties.messageInteractionMetadata.id: boolean

desiredProperties.messageInteractionMetadata.interactedMessageId?

optional desiredProperties.messageInteractionMetadata.interactedMessageId: boolean

desiredProperties.messageInteractionMetadata.originalResponseMessageId?

optional desiredProperties.messageInteractionMetadata.originalResponseMessageId: boolean

desiredProperties.messageInteractionMetadata.targetMessageId?

optional desiredProperties.messageInteractionMetadata.targetMessageId: boolean

desiredProperties.messageInteractionMetadata.targetUser?

optional desiredProperties.messageInteractionMetadata.targetUser: boolean

desiredProperties.messageInteractionMetadata.triggeringInteractionMetadata?

optional desiredProperties.messageInteractionMetadata.triggeringInteractionMetadata: boolean

desiredProperties.messageInteractionMetadata.type?

optional desiredProperties.messageInteractionMetadata.type: boolean

desiredProperties.messageInteractionMetadata.user?

optional desiredProperties.messageInteractionMetadata.user: boolean

desiredProperties.messageReference?

optional desiredProperties.messageReference: object

desiredProperties.messageReference.channelId?

optional desiredProperties.messageReference.channelId: boolean

desiredProperties.messageReference.guildId?

optional desiredProperties.messageReference.guildId: boolean

desiredProperties.messageReference.messageId?

optional desiredProperties.messageReference.messageId: boolean

desiredProperties.messageSnapshot?

optional desiredProperties.messageSnapshot: object

desiredProperties.messageSnapshot.message?

optional desiredProperties.messageSnapshot.message: boolean

desiredProperties.poll?

optional desiredProperties.poll: object

desiredProperties.poll.allowMultiselect?

optional desiredProperties.poll.allowMultiselect: boolean

desiredProperties.poll.answers?

optional desiredProperties.poll.answers: boolean

desiredProperties.poll.expiry?

optional desiredProperties.poll.expiry: boolean

desiredProperties.poll.layoutType?

optional desiredProperties.poll.layoutType: boolean

desiredProperties.poll.question?

optional desiredProperties.poll.question: boolean

desiredProperties.poll.results?

optional desiredProperties.poll.results: boolean

desiredProperties.pollAnswer?

optional desiredProperties.pollAnswer: object

desiredProperties.pollAnswer.answerId?

optional desiredProperties.pollAnswer.answerId: boolean

desiredProperties.pollAnswer.pollMedia?

optional desiredProperties.pollAnswer.pollMedia: boolean

desiredProperties.pollAnswerCount?

optional desiredProperties.pollAnswerCount: object

desiredProperties.pollAnswerCount.count?

optional desiredProperties.pollAnswerCount.count: boolean

desiredProperties.pollAnswerCount.id?

optional desiredProperties.pollAnswerCount.id: boolean

desiredProperties.pollAnswerCount.meVoted?

optional desiredProperties.pollAnswerCount.meVoted: boolean

desiredProperties.pollMedia?

optional desiredProperties.pollMedia: object

desiredProperties.pollMedia.emoji?

optional desiredProperties.pollMedia.emoji: boolean

desiredProperties.pollMedia.text?

optional desiredProperties.pollMedia.text: boolean

desiredProperties.pollResult?

optional desiredProperties.pollResult: object

desiredProperties.pollResult.answerCounts?

optional desiredProperties.pollResult.answerCounts: boolean

desiredProperties.pollResult.isFinalized?

optional desiredProperties.pollResult.isFinalized: boolean

desiredProperties.role?

optional desiredProperties.role: object

desiredProperties.role.color?

optional desiredProperties.role.color: boolean

desiredProperties.role.flags?

optional desiredProperties.role.flags: boolean

desiredProperties.role.guildId?

optional desiredProperties.role.guildId: boolean

desiredProperties.role.icon?

optional desiredProperties.role.icon: boolean

desiredProperties.role.id?

optional desiredProperties.role.id: boolean

desiredProperties.role.name?

optional desiredProperties.role.name: boolean

desiredProperties.role.permissions?

optional desiredProperties.role.permissions: boolean

desiredProperties.role.position?

optional desiredProperties.role.position: boolean

desiredProperties.role.tags?

optional desiredProperties.role.tags: boolean

desiredProperties.role.toggles?

optional desiredProperties.role.toggles: boolean

desiredProperties.role.unicodeEmoji?

optional desiredProperties.role.unicodeEmoji: boolean

desiredProperties.scheduledEvent?

optional desiredProperties.scheduledEvent: object

desiredProperties.scheduledEvent.channelId?

optional desiredProperties.scheduledEvent.channelId: boolean

desiredProperties.scheduledEvent.creator?

optional desiredProperties.scheduledEvent.creator: boolean

desiredProperties.scheduledEvent.creatorId?

optional desiredProperties.scheduledEvent.creatorId: boolean

desiredProperties.scheduledEvent.description?

optional desiredProperties.scheduledEvent.description: boolean

desiredProperties.scheduledEvent.entityId?

optional desiredProperties.scheduledEvent.entityId: boolean

desiredProperties.scheduledEvent.entityType?

optional desiredProperties.scheduledEvent.entityType: boolean

desiredProperties.scheduledEvent.guildId?

optional desiredProperties.scheduledEvent.guildId: boolean

desiredProperties.scheduledEvent.id?

optional desiredProperties.scheduledEvent.id: boolean

desiredProperties.scheduledEvent.image?

optional desiredProperties.scheduledEvent.image: boolean

desiredProperties.scheduledEvent.location?

optional desiredProperties.scheduledEvent.location: boolean

desiredProperties.scheduledEvent.name?

optional desiredProperties.scheduledEvent.name: boolean

desiredProperties.scheduledEvent.privacyLevel?

optional desiredProperties.scheduledEvent.privacyLevel: boolean

desiredProperties.scheduledEvent.recurrenceRule?

optional desiredProperties.scheduledEvent.recurrenceRule: boolean

desiredProperties.scheduledEvent.scheduledEndTime?

optional desiredProperties.scheduledEvent.scheduledEndTime: boolean

desiredProperties.scheduledEvent.scheduledStartTime?

optional desiredProperties.scheduledEvent.scheduledStartTime: boolean

desiredProperties.scheduledEvent.status?

optional desiredProperties.scheduledEvent.status: boolean

desiredProperties.scheduledEvent.userCount?

optional desiredProperties.scheduledEvent.userCount: boolean

desiredProperties.scheduledEventRecurrenceRule?

optional desiredProperties.scheduledEventRecurrenceRule: object

desiredProperties.scheduledEventRecurrenceRule.byMonth?

optional desiredProperties.scheduledEventRecurrenceRule.byMonth: boolean

desiredProperties.scheduledEventRecurrenceRule.byMonthDay?

optional desiredProperties.scheduledEventRecurrenceRule.byMonthDay: boolean

desiredProperties.scheduledEventRecurrenceRule.byNWeekday?

optional desiredProperties.scheduledEventRecurrenceRule.byNWeekday: boolean

desiredProperties.scheduledEventRecurrenceRule.byWeekday?

optional desiredProperties.scheduledEventRecurrenceRule.byWeekday: boolean

desiredProperties.scheduledEventRecurrenceRule.byYearDay?

optional desiredProperties.scheduledEventRecurrenceRule.byYearDay: boolean

desiredProperties.scheduledEventRecurrenceRule.count?

optional desiredProperties.scheduledEventRecurrenceRule.count: boolean

desiredProperties.scheduledEventRecurrenceRule.end?

optional desiredProperties.scheduledEventRecurrenceRule.end: boolean

desiredProperties.scheduledEventRecurrenceRule.frequency?

optional desiredProperties.scheduledEventRecurrenceRule.frequency: boolean

desiredProperties.scheduledEventRecurrenceRule.interval?

optional desiredProperties.scheduledEventRecurrenceRule.interval: boolean

desiredProperties.scheduledEventRecurrenceRule.start?

optional desiredProperties.scheduledEventRecurrenceRule.start: boolean

desiredProperties.sku?

optional desiredProperties.sku: object

desiredProperties.sku.applicationId?

optional desiredProperties.sku.applicationId: boolean

desiredProperties.sku.flags?

optional desiredProperties.sku.flags: boolean

desiredProperties.sku.id?

optional desiredProperties.sku.id: boolean

desiredProperties.sku.name?

optional desiredProperties.sku.name: boolean

desiredProperties.sku.slug?

optional desiredProperties.sku.slug: boolean

desiredProperties.sku.type?

optional desiredProperties.sku.type: boolean

desiredProperties.soundboardSound?

optional desiredProperties.soundboardSound: object

desiredProperties.soundboardSound.available?

optional desiredProperties.soundboardSound.available: boolean

desiredProperties.soundboardSound.emojiId?

optional desiredProperties.soundboardSound.emojiId: boolean

desiredProperties.soundboardSound.emojiName?

optional desiredProperties.soundboardSound.emojiName: boolean

desiredProperties.soundboardSound.guildId?

optional desiredProperties.soundboardSound.guildId: boolean

desiredProperties.soundboardSound.name?

optional desiredProperties.soundboardSound.name: boolean

desiredProperties.soundboardSound.soundId?

optional desiredProperties.soundboardSound.soundId: boolean

desiredProperties.soundboardSound.user?

optional desiredProperties.soundboardSound.user: boolean

desiredProperties.soundboardSound.volume?

optional desiredProperties.soundboardSound.volume: boolean

desiredProperties.stageInstance?

optional desiredProperties.stageInstance: object

desiredProperties.stageInstance.channelId?

optional desiredProperties.stageInstance.channelId: boolean

desiredProperties.stageInstance.guildId?

optional desiredProperties.stageInstance.guildId: boolean

desiredProperties.stageInstance.guildScheduledEventId?

optional desiredProperties.stageInstance.guildScheduledEventId: boolean

desiredProperties.stageInstance.id?

optional desiredProperties.stageInstance.id: boolean

desiredProperties.stageInstance.topic?

optional desiredProperties.stageInstance.topic: boolean

desiredProperties.sticker?

optional desiredProperties.sticker: object

desiredProperties.sticker.available?

optional desiredProperties.sticker.available: boolean

desiredProperties.sticker.description?

optional desiredProperties.sticker.description: boolean

desiredProperties.sticker.formatType?

optional desiredProperties.sticker.formatType: boolean

desiredProperties.sticker.guildId?

optional desiredProperties.sticker.guildId: boolean

desiredProperties.sticker.id?

optional desiredProperties.sticker.id: boolean

desiredProperties.sticker.name?

optional desiredProperties.sticker.name: boolean

desiredProperties.sticker.packId?

optional desiredProperties.sticker.packId: boolean

desiredProperties.sticker.sortValue?

optional desiredProperties.sticker.sortValue: boolean

desiredProperties.sticker.tags?

optional desiredProperties.sticker.tags: boolean

desiredProperties.sticker.type?

optional desiredProperties.sticker.type: boolean

desiredProperties.sticker.user?

optional desiredProperties.sticker.user: boolean

desiredProperties.subscription?

optional desiredProperties.subscription: object

desiredProperties.subscription.canceledAt?

optional desiredProperties.subscription.canceledAt: boolean

desiredProperties.subscription.country?

optional desiredProperties.subscription.country: boolean

desiredProperties.subscription.currentPeriodEnd?

optional desiredProperties.subscription.currentPeriodEnd: boolean

desiredProperties.subscription.currentPeriodStart?

optional desiredProperties.subscription.currentPeriodStart: boolean

desiredProperties.subscription.entitlementIds?

optional desiredProperties.subscription.entitlementIds: boolean

desiredProperties.subscription.id?

optional desiredProperties.subscription.id: boolean

desiredProperties.subscription.renewalSkuIds?

optional desiredProperties.subscription.renewalSkuIds: boolean

desiredProperties.subscription.skuIds?

optional desiredProperties.subscription.skuIds: boolean

desiredProperties.subscription.status?

optional desiredProperties.subscription.status: boolean

desiredProperties.subscription.userId?

optional desiredProperties.subscription.userId: boolean

desiredProperties.user?

optional desiredProperties.user: object

desiredProperties.user.accentColor?

optional desiredProperties.user.accentColor: boolean

desiredProperties.user.avatar?

optional desiredProperties.user.avatar: boolean

desiredProperties.user.avatarDecorationData?

optional desiredProperties.user.avatarDecorationData: boolean

desiredProperties.user.banner?

optional desiredProperties.user.banner: boolean

desiredProperties.user.discriminator?

optional desiredProperties.user.discriminator: boolean

desiredProperties.user.email?

optional desiredProperties.user.email: boolean

desiredProperties.user.flags?

optional desiredProperties.user.flags: boolean

desiredProperties.user.globalName?

optional desiredProperties.user.globalName: boolean

desiredProperties.user.id?

optional desiredProperties.user.id: boolean

desiredProperties.user.locale?

optional desiredProperties.user.locale: boolean

desiredProperties.user.premiumType?

optional desiredProperties.user.premiumType: boolean

desiredProperties.user.publicFlags?

optional desiredProperties.user.publicFlags: boolean

desiredProperties.user.toggles?

optional desiredProperties.user.toggles: boolean

desiredProperties.user.username?

optional desiredProperties.user.username: boolean

desiredProperties.voiceState?

optional desiredProperties.voiceState: object

desiredProperties.voiceState.channelId?

optional desiredProperties.voiceState.channelId: boolean

desiredProperties.voiceState.guildId?

optional desiredProperties.voiceState.guildId: boolean

desiredProperties.voiceState.requestToSpeakTimestamp?

optional desiredProperties.voiceState.requestToSpeakTimestamp: boolean

desiredProperties.voiceState.sessionId?

optional desiredProperties.voiceState.sessionId: boolean

desiredProperties.voiceState.toggles?

optional desiredProperties.voiceState.toggles: boolean

desiredProperties.voiceState.userId?

optional desiredProperties.voiceState.userId: boolean

desiredProperties.webhook?

optional desiredProperties.webhook: object

desiredProperties.webhook.applicationId?

optional desiredProperties.webhook.applicationId: boolean

desiredProperties.webhook.avatar?

optional desiredProperties.webhook.avatar: boolean

desiredProperties.webhook.channelId?

optional desiredProperties.webhook.channelId: boolean

desiredProperties.webhook.guildId?

optional desiredProperties.webhook.guildId: boolean

desiredProperties.webhook.id?

optional desiredProperties.webhook.id: boolean

desiredProperties.webhook.name?

optional desiredProperties.webhook.name: boolean

desiredProperties.webhook.sourceChannel?

optional desiredProperties.webhook.sourceChannel: boolean

desiredProperties.webhook.sourceGuild?

optional desiredProperties.webhook.sourceGuild: boolean

desiredProperties.webhook.token?

optional desiredProperties.webhook.token: boolean

desiredProperties.webhook.type?

optional desiredProperties.webhook.type: boolean

desiredProperties.webhook.url?

optional desiredProperties.webhook.url: boolean

desiredProperties.webhook.user?

optional desiredProperties.webhook.user: boolean

embed()?

optional embed: (bot, payload) => Embed

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordEmbed

Returns

Embed

emoji()?

optional emoji: (bot, payload) => SetupDesiredProps<Emoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordEmoji

Returns

SetupDesiredProps<Emoji, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

entitlement()?

optional entitlement: (bot, payload) => SetupDesiredProps<Entitlement, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordEntitlement

Returns

SetupDesiredProps<Entitlement, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

forumTag()?

optional forumTag: (bot, payload) => SetupDesiredProps<ForumTag, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordForumTag

Returns

SetupDesiredProps<ForumTag, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

gatewayBot()?

optional gatewayBot: (bot, payload) => GetGatewayBot

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGetGatewayBot

Returns

GetGatewayBot

guild()?

optional guild: (bot, payload) => SetupDesiredProps<Guild, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

guild

DiscordGuild

shardId

number

Returns

SetupDesiredProps<Guild, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

guildOnboarding()?

optional guildOnboarding: (bot, payload) => SetupDesiredProps<GuildOnboarding, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildOnboarding

Returns

SetupDesiredProps<GuildOnboarding, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

guildOnboardingPrompt()?

optional guildOnboardingPrompt: (bot, payload) => SetupDesiredProps<GuildOnboardingPrompt, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildOnboardingPrompt

Returns

SetupDesiredProps<GuildOnboardingPrompt, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

guildOnboardingPromptOption()?

optional guildOnboardingPromptOption: (bot, payload) => GuildOnboardingPromptOption

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildOnboardingPromptOption

Returns

GuildOnboardingPromptOption

integration()?

optional integration: (bot, payload) => Integration

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordIntegrationCreateUpdate

Returns

Integration

interaction()?

optional interaction: (bot, payload) => SetupDesiredProps<Interaction, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

interaction

DiscordInteraction

shardId

number

Returns

SetupDesiredProps<Interaction, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

interactionCallback()?

optional interactionCallback: (bot, payload) => SetupDesiredProps<InteractionCallback, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInteractionCallback

Returns

SetupDesiredProps<InteractionCallback, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

interactionCallbackResponse()?

optional interactionCallbackResponse: (bot, payload) => SetupDesiredProps<InteractionCallbackResponse, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

interactionCallbackResponse

DiscordInteractionCallbackResponse

shardId

number

Returns

SetupDesiredProps<InteractionCallbackResponse, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

interactionDataOptions()?

optional interactionDataOptions: (bot, payload) => InteractionDataOption

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInteractionDataOption

Returns

InteractionDataOption

interactionDataResolved()?

optional interactionDataResolved: (bot, payload) => InteractionDataResolved

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

guildId

bigint

resolved

DiscordInteractionDataResolved

shardId

number

Returns

InteractionDataResolved

interactionResource()?

optional interactionResource: (bot, payload) => SetupDesiredProps<InteractionResource, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

interactionResource

DiscordInteractionResource

shardId

number

Returns

SetupDesiredProps<InteractionResource, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

invite()?

optional invite: (bot, payload) => SetupDesiredProps<Invite, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

invite

DiscordInviteCreate | DiscordInviteMetadata

shardId

number

Returns

SetupDesiredProps<Invite, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

inviteStageInstance()?

optional inviteStageInstance: (bot, payload) => SetupDesiredProps<InviteStageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordInviteStageInstance & object

Returns

SetupDesiredProps<InviteStageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

member()?

optional member: (bot, payload, guildId, userId) => SetupDesiredProps<Member, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMember

guildId

BigString

userId

BigString

Returns

SetupDesiredProps<Member, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

message()?

optional message: (bot, payload) => SetupDesiredProps<Message, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

message

DiscordMessage

shardId

number

Returns

SetupDesiredProps<Message, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

messageCall()?

optional messageCall: (bot, payload) => SetupDesiredProps<MessageCall, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMessageCall

Returns

SetupDesiredProps<MessageCall, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

messageInteractionMetadata()?

optional messageInteractionMetadata: (bot, payload) => SetupDesiredProps<MessageInteractionMetadata, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordMessageInteractionMetadata

Returns

SetupDesiredProps<MessageInteractionMetadata, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

messageSnapshot()?

optional messageSnapshot: (bot, payload) => SetupDesiredProps<MessageSnapshot, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

messageSnapshot

DiscordMessageSnapshot

shardId

number

Returns

SetupDesiredProps<MessageSnapshot, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

poll()?

optional poll: (bot, payload) => SetupDesiredProps<Poll, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordPoll

Returns

SetupDesiredProps<Poll, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

pollMedia()?

optional pollMedia: (bot, payload) => SetupDesiredProps<PollMedia, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordPollMedia

Returns

SetupDesiredProps<PollMedia, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

presence()?

optional presence: (bot, payload) => PresenceUpdate

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordPresenceUpdate

Returns

PresenceUpdate

reverse?

optional reverse: object

reverse.activity()?

optional reverse.activity: (bot, payload) => DiscordActivity

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Activity

Returns

DiscordActivity

reverse.allowedMentions()?

optional reverse.allowedMentions: (bot, payload) => DiscordAllowedMentions

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

AllowedMentions

Returns

DiscordAllowedMentions

reverse.application()?

optional reverse.application: (bot, payload) => DiscordApplication

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Application

Returns

DiscordApplication

reverse.applicationCommand()?

optional reverse.applicationCommand: (bot, payload) => DiscordApplicationCommand

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

ApplicationCommand

Returns

DiscordApplicationCommand

reverse.applicationCommandOption()?

optional reverse.applicationCommandOption: (bot, payload) => DiscordApplicationCommandOption

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

ApplicationCommandOption

Returns

DiscordApplicationCommandOption

reverse.applicationCommandOptionChoice()?

optional reverse.applicationCommandOptionChoice: (bot, payload) => DiscordApplicationCommandOptionChoice

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

ApplicationCommandOptionChoice

Returns

DiscordApplicationCommandOptionChoice

reverse.attachment()?

optional reverse.attachment: (bot, payload) => DiscordAttachment

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

DiscordAttachment

reverse.component()?

optional reverse.component: (bot, payload) => DiscordMessageComponent

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Component

Returns

DiscordMessageComponent

reverse.createApplicationCommand()?

optional reverse.createApplicationCommand: (bot, payload) => DiscordCreateApplicationCommand

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

CreateApplicationCommand

Returns

DiscordCreateApplicationCommand

reverse.embed()?

optional reverse.embed: (bot, payload) => DiscordEmbed

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Embed

Returns

DiscordEmbed

reverse.member()?

optional reverse.member: (bot, payload) => DiscordMember

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

SetupDesiredProps<Member, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

DiscordMember

reverse.snowflake()?

optional reverse.snowflake: (snowflake) => string

Parameters

snowflake

BigString

Returns

string

reverse.team()?

optional reverse.team: (bot, payload) => DiscordTeam

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

Team

Returns

DiscordTeam

reverse.user()?

optional reverse.user: (bot, payload) => DiscordUser

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Returns

DiscordUser

role()?

optional role: (bot, payload) => SetupDesiredProps<Role, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

guildId

BigString

role

DiscordRole

Returns

SetupDesiredProps<Role, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

scheduledEvent()?

optional scheduledEvent: (bot, payload) => SetupDesiredProps<ScheduledEvent, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordScheduledEvent

Returns

SetupDesiredProps<ScheduledEvent, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

scheduledEventRecurrenceRule()?

optional scheduledEventRecurrenceRule: (bot, payload) => SetupDesiredProps<ScheduledEventRecurrenceRule, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordScheduledEventRecurrenceRule

Returns

SetupDesiredProps<ScheduledEventRecurrenceRule, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

sku()?

optional sku: (bot, payload) => SetupDesiredProps<Sku, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordSku

Returns

SetupDesiredProps<Sku, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

snowflake()?

optional snowflake: (snowflake) => bigint

Parameters

snowflake

BigString

Returns

bigint

soundboardSound()?

optional soundboardSound: (bot, payload) => SetupDesiredProps<SoundboardSound, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordSoundboardSound

Returns

SetupDesiredProps<SoundboardSound, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

stageInstance()?

optional stageInstance: (bot, payload) => SetupDesiredProps<StageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordStageInstance

Returns

SetupDesiredProps<StageInstance, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

sticker()?

optional sticker: (bot, payload) => SetupDesiredProps<Sticker, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordSticker

Returns

SetupDesiredProps<Sticker, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

stickerPack()?

optional stickerPack: (bot, payload) => StickerPack

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordStickerPack

Returns

StickerPack

subscription()?

optional subscription: (bot, payload) => SetupDesiredProps<Subscription, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordSubscription

Returns

SetupDesiredProps<Subscription, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

team()?

optional team: (bot, payload) => Team

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordTeam

Returns

Team

template()?

optional template: (bot, payload) => Template

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordTemplate

Returns

Template

threadMember()?

optional threadMember: (bot, payload) => ThreadMember

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordThreadMember

Returns

ThreadMember

threadMemberGuildCreate()?

optional threadMemberGuildCreate: (bot, payload) => ThreadMemberGuildCreate

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordThreadMemberGuildCreate

Returns

ThreadMemberGuildCreate

user()?

optional user: (bot, payload) => SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordUser

Returns

SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

voiceRegion()?

optional voiceRegion: (bot, payload) => VoiceRegion

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordVoiceRegion

Returns

VoiceRegion

voiceState()?

optional voiceState: (bot, payload) => SetupDesiredProps<VoiceState, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

guildId

BigString

voiceState

DiscordVoiceState

Returns

SetupDesiredProps<VoiceState, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

webhook()?

optional webhook: (bot, payload) => SetupDesiredProps<Webhook, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordWebhook

Returns

SetupDesiredProps<Webhook, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

welcomeScreen()?

optional welcomeScreen: (bot, payload) => WelcomeScreen

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordWelcomeScreen

Returns

WelcomeScreen

widget()?

optional widget: (bot, payload) => GuildWidget

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildWidget

Returns

GuildWidget

widgetSettings()?

optional widgetSettings: (bot, payload) => GuildWidgetSettings

Parameters

bot

Bot<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>

payload

DiscordGuildWidgetSettings

Returns

GuildWidgetSettings