Skip to main content

CreateBotOptions

Documentation

Documentation / @discordeno/bot / CreateBotOptions

Interface: CreateBotOptions<TProps, TBehavior>

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

Type Parameters​

TProps​

TProps extends RecursivePartial<TransformersDesiredProperties>

TBehavior​

TBehavior extends DesiredPropertiesBehavior

Properties​

applicationId?​

optional applicationId: BigString

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

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

desiredProperties​

desiredProperties: TProps

Defined in: bot/src/bot.ts:133

Set the desired properties for the bot

desiredPropertiesBehavior?​

optional desiredPropertiesBehavior: TBehavior

Defined in: bot/src/bot.ts:139

Set the desired properties behavior for undesired properties

Default​

DesiredPropertiesBehavior.RemoveKey

events?​

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

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

The event handlers.

gateway?​

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

Defined in: 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: 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: 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<typeof logger, "debug" | "info" | "warn" | "error" | "fatal">

Defined in: bot/src/bot.ts:148

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

Parameters​

name​

"REST" | "GATEWAY" | "BOT"

Returns​

Pick<typeof logger, "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: bot/src/bot.ts:121

Any options you wish to provide to the rest manager.

token​

token: string

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

The bot's token.

transformers?​

optional transformers: object

Defined in: 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, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordActivityInstance

Returns​

SetupDesiredProps<ActivityInstance, TProps, TBehavior>

activityLocation()?​

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

Parameters​
bot​

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

payload​

DiscordActivityLocation

Returns​

SetupDesiredProps<ActivityLocation, TProps, TBehavior>

application()?​

optional application: (bot, payload, extra?) => Application

Parameters​
bot​

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

payload​

DiscordApplication

extra?​
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, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordAttachment

Returns​

SetupDesiredProps<Attachment, 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, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordAvatarDecorationData

Returns​

SetupDesiredProps<AvatarDecorationData, TProps, TBehavior>

channel()?​

optional channel: (bot, payload, extra?) => SetupDesiredProps<Channel, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordChannel

extra?​
guildId?​

BigString

Returns​

SetupDesiredProps<Channel, TProps, TBehavior>

collectibles()?​

optional collectibles: (bot, payload) => SetupDesiredProps<Collectibles, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordCollectibles

Returns​

SetupDesiredProps<Collectibles, 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 activity: (bot, payload, activity) => any

Parameters​
bot​

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

payload​

DiscordActivity

activity​

Activity

Returns​

any

customizers.activityInstance()?​

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

Parameters​
bot​

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

payload​

DiscordActivityInstance

activityInstance​

SetupDesiredProps<ActivityInstance, TProps, TBehavior>

Returns​

any

customizers.activityLocation()?​

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

Parameters​
bot​

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

payload​

DiscordActivityLocation

activityLocation​

SetupDesiredProps<ActivityLocation, TProps, TBehavior>

Returns​

any

customizers.application()?​

optional application: (bot, payload, application, extra?) => any

Parameters​
bot​

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

payload​

DiscordApplication

application​

Application

extra?​
shardId?​

number

Returns​

any

customizers.applicationCommand()?​

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

Parameters​
bot​

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

payload​

DiscordApplicationCommand

applicationCommand​

ApplicationCommand

Returns​

any

customizers.applicationCommandOption()?​

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

Parameters​
bot​

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

payload​

DiscordApplicationCommandOption

applicationCommandOption​

ApplicationCommandOption

Returns​

any

customizers.applicationCommandOptionChoice()?​

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

Parameters​
bot​

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

payload​

DiscordApplicationCommandOptionChoice

applicationCommandOptionChoice​

ApplicationCommandOptionChoice

Returns​

any

customizers.applicationCommandPermission()?​

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

Parameters​
bot​

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

payload​

DiscordGuildApplicationCommandPermissions

applicationCommandPermission​

GuildApplicationCommandPermissions

Returns​

any

customizers.attachment()?​

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

Parameters​
bot​

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

payload​

DiscordAttachment

attachment​

SetupDesiredProps<Attachment, TProps, TBehavior>

Returns​

any

customizers.auditLogEntry()?​

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

Parameters​
bot​

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

payload​

DiscordAuditLogEntry

auditLogEntry​

AuditLogEntry

Returns​

any

customizers.automodActionExecution()?​

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

Parameters​
bot​

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

payload​

DiscordAutoModerationActionExecution

automodActionExecution​

AutoModerationActionExecution

Returns​

any

customizers.automodRule()?​

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

Parameters​
bot​

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

payload​

DiscordAutoModerationRule

automodRule​

AutoModerationRule

Returns​

any

customizers.avatarDecorationData()?​

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

Parameters​
bot​

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

payload​

DiscordAvatarDecorationData

avatarDecorationData​

SetupDesiredProps<AvatarDecorationData, TProps, TBehavior>

Returns​

any

customizers.channel()?​

optional channel: (bot, payload, channel, extra?) => any

Parameters​
bot​

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

payload​

DiscordChannel

channel​

SetupDesiredProps<Channel, TProps, TBehavior>

extra?​
guildId?​

bigint

Returns​

any

customizers.collectibles()?​

optional collectibles: (bot, payload, collectibles) => any

Parameters​
bot​

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

payload​

DiscordCollectibles

collectibles​

SetupDesiredProps<Collectibles, TProps, TBehavior>

Returns​

any

customizers.component()?​

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

Parameters​
bot​

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

payload​

DiscordMessageComponent

component​

Component

Returns​

any

customizers.defaultReactionEmoji()?​

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

Parameters​
bot​

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

payload​

DiscordDefaultReactionEmoji

defaultReactionEmoji​

SetupDesiredProps<DefaultReactionEmoji, TProps, TBehavior>

Returns​

any

customizers.embed()?​

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

Parameters​
bot​

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

payload​

DiscordEmbed

embed​

Embed

Returns​

any

customizers.emoji()?​

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

Parameters​
bot​

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

payload​

DiscordEmoji

emoji​

SetupDesiredProps<Emoji, TProps, TBehavior>

Returns​

any

customizers.entitlement()?​

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

Parameters​
bot​

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

payload​

DiscordEntitlement

entitlement​

SetupDesiredProps<Entitlement, TProps, TBehavior>

Returns​

any

customizers.forumTag()?​

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

Parameters​
bot​

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

payload​

DiscordForumTag

forumTag​

SetupDesiredProps<ForumTag, TProps, TBehavior>

Returns​

any

customizers.gatewayBot()?​

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

Parameters​
bot​

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

payload​

DiscordGetGatewayBot

getGatewayBot​

GetGatewayBot

Returns​

any

customizers.guild()?​

optional guild: (bot, payload, guild, extra?) => any

Parameters​
bot​

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

payload​

DiscordGuild

guild​

SetupDesiredProps<Guild, TProps, TBehavior>

extra?​
shardId?​

number

Returns​

any

customizers.guildOnboarding()?​

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

Parameters​
bot​

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

payload​

DiscordGuildOnboarding

onboarding​

SetupDesiredProps<GuildOnboarding, TProps, TBehavior>

Returns​

any

customizers.guildOnboardingPrompt()?​

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

Parameters​
bot​

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

payload​

DiscordGuildOnboardingPrompt

onboardingPrompt​

SetupDesiredProps<GuildOnboardingPrompt, TProps, TBehavior>

Returns​

any

customizers.guildOnboardingPromptOption()?​

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

Parameters​
bot​

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

payload​

DiscordGuildOnboardingPromptOption

onboardingPromptOption​

SetupDesiredProps<GuildOnboardingPromptOption, TProps, TBehavior>

Returns​

any

customizers.incidentsData()?​

optional incidentsData: (bot, payload, incidentsData) => any

Parameters​
bot​

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

payload​

DiscordIncidentsData

incidentsData​

SetupDesiredProps<IncidentsData, TProps, TBehavior>

Returns​

any

customizers.integration()?​

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

Parameters​
bot​

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

payload​

DiscordIntegrationCreateUpdate

integration​

Integration

Returns​

any

customizers.interaction()?​

optional interaction: (bot, payload, interaction, extra?) => any

Parameters​
bot​

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

payload​

DiscordInteraction

interaction​

SetupDesiredProps<Interaction, TProps, TBehavior>

extra?​
shardId?​

number

Returns​

any

customizers.interactionCallback()?​

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

Parameters​
bot​

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

payload​

DiscordInteractionCallback

interactionCallback​

SetupDesiredProps<InteractionCallback, TProps, TBehavior>

Returns​

any

customizers.interactionCallbackResponse()?​

optional interactionCallbackResponse: (bot, payload, interactionCallbackResponse, extra?) => any

Parameters​
bot​

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

payload​

DiscordInteractionCallbackResponse

interactionCallbackResponse​

SetupDesiredProps<InteractionCallbackResponse, TProps, TBehavior>

extra?​
shardId?​

number

Returns​

any

customizers.interactionDataOptions()?​

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

Parameters​
bot​

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

payload​

DiscordInteractionDataOption

interactionDataOptions​

InteractionDataOption

Returns​

any

customizers.interactionDataResolved()?​

optional interactionDataResolved: (bot, payload, interactionDataResolved, extra?) => any

Parameters​
bot​

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

payload​

DiscordInteractionDataResolved

interactionDataResolved​

InteractionDataResolved

extra?​
guildId?​

bigint

shardId?​

number

Returns​

any

customizers.interactionResource()?​

optional interactionResource: (bot, payload, interactionResource, extra?) => any

Parameters​
bot​

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

payload​

DiscordInteractionResource

interactionResource​

SetupDesiredProps<InteractionResource, TProps, TBehavior>

extra?​
shardId?​

number

Returns​

any

customizers.invite()?​

optional invite: (bot, payload, invite, extra?) => any

Parameters​
bot​

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

payload​

DiscordInviteMetadata | DiscordInviteCreate

invite​

SetupDesiredProps<Invite, TProps, TBehavior>

extra?​
shardId?​

number

Returns​

any

customizers.inviteStageInstance()?​

optional inviteStageInstance: (bot, payload, inviteStageInstance, extra?) => any

Parameters​
bot​

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

payload​

DiscordInviteStageInstance

inviteStageInstance​

SetupDesiredProps<InviteStageInstance, TProps, TBehavior>

extra?​
guildId?​

bigint

Returns​

any

customizers.lobby()?​

optional lobby: (bot, payload, lobby) => any

Parameters​
bot​

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

payload​

DiscordLobby

lobby​

SetupDesiredProps<Lobby, TProps, TBehavior>

Returns​

any

customizers.lobbyMember()?​

optional lobbyMember: (bot, payload, lobbyMember) => any

Parameters​
bot​

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

payload​

DiscordLobbyMember

lobbyMember​

SetupDesiredProps<LobbyMember, TProps, TBehavior>

Returns​

any

customizers.mediaGalleryItem()?​

optional mediaGalleryItem: (bot, payload, item) => any

Parameters​
bot​

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

payload​

DiscordMediaGalleryItem

item​

MediaGalleryItem

Returns​

any

customizers.member()?​

optional member: (bot, payload, member, extra?) => any

Parameters​
bot​

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

payload​

DiscordMember

member​

SetupDesiredProps<Member, TProps, TBehavior>

extra?​
guildId?​

bigint

userId?​

bigint

Returns​

any

customizers.message()?​

optional message: (bot, payload, message, extra?) => any

Parameters​
bot​

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

payload​

DiscordMessage

message​

SetupDesiredProps<Message, TProps, TBehavior>

extra?​
shardId?​

number

Returns​

any

customizers.messageCall()?​

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

Parameters​
bot​

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

payload​

DiscordMessageCall

call​

SetupDesiredProps<MessageCall, TProps, TBehavior>

Returns​

any

customizers.messageInteractionMetadata()?​

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

Parameters​
bot​

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

payload​

DiscordMessageInteractionMetadata

metadata​

SetupDesiredProps<MessageInteractionMetadata, TProps, TBehavior>

Returns​

any

customizers.messagePin()?​

optional messagePin: (bot, payload, call, extra?) => any

Parameters​
bot​

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

payload​

DiscordMessagePin

call​

SetupDesiredProps<MessagePin, TProps, TBehavior>

extra?​
shardId?​

number

Returns​

any

customizers.messageSnapshot()?​

optional messageSnapshot: (bot, payload, messageSnapshot, extra?) => any

Parameters​
bot​

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

payload​

DiscordMessageSnapshot

messageSnapshot​

SetupDesiredProps<MessageSnapshot, TProps, TBehavior>

extra?​
shardId?​

number

Returns​

any

customizers.nameplate()?​

optional nameplate: (bot, payload, nameplate) => any

Parameters​
bot​

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

payload​

DiscordNameplate

nameplate​

SetupDesiredProps<Nameplate, TProps, TBehavior>

Returns​

any

customizers.poll()?​

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

Parameters​
bot​

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

payload​

DiscordPoll

poll​

SetupDesiredProps<Poll, TProps, TBehavior>

Returns​

any

customizers.pollMedia()?​

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

Parameters​
bot​

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

payload​

DiscordPollMedia

pollMedia​

SetupDesiredProps<PollMedia, TProps, TBehavior>

Returns​

any

customizers.presence()?​

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

Parameters​
bot​

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

payload​

DiscordPresenceUpdate

presence​

PresenceUpdate

Returns​

any

customizers.role()?​

optional role: (bot, payload, role, extra?) => any

Parameters​
bot​

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

payload​

DiscordRole

role​

SetupDesiredProps<Role, TProps, TBehavior>

extra?​
guildId?​

bigint

Returns​

any

customizers.roleColors()?​

optional roleColors: (bot, payload, roleColors) => any

Parameters​
bot​

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

payload​

DiscordRoleColors

roleColors​

SetupDesiredProps<RoleColors, TProps, TBehavior>

Returns​

any

customizers.scheduledEvent()?​

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

Parameters​
bot​

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

payload​

DiscordScheduledEvent

scheduledEvent​

SetupDesiredProps<ScheduledEvent, TProps, TBehavior>

Returns​

any

customizers.scheduledEventRecurrenceRule()?​

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

Parameters​
bot​

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

payload​

DiscordScheduledEventRecurrenceRule

scheduledEvent​

SetupDesiredProps<ScheduledEventRecurrenceRule, TProps, TBehavior>

Returns​

any

customizers.sku()?​

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

Parameters​
bot​

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

payload​

DiscordSku

sku​

SetupDesiredProps<Sku, TProps, TBehavior>

Returns​

any

customizers.soundboardSound()?​

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

Parameters​
bot​

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

payload​

DiscordSoundboardSound

soundboardSound​

SetupDesiredProps<SoundboardSound, TProps, TBehavior>

Returns​

any

customizers.stageInstance()?​

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

Parameters​
bot​

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

payload​

DiscordStageInstance

stageInstance​

SetupDesiredProps<StageInstance, TProps, TBehavior>

Returns​

any

customizers.sticker()?​

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

Parameters​
bot​

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

payload​

DiscordSticker

sticker​

SetupDesiredProps<Sticker, TProps, TBehavior>

Returns​

any

customizers.stickerPack()?​

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

Parameters​
bot​

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

payload​

DiscordStickerPack

stickerPack​

StickerPack

Returns​

any

customizers.subscription()?​

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

Parameters​
bot​

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

payload​

DiscordSubscription

subscription​

SetupDesiredProps<Subscription, TProps, TBehavior>

Returns​

any

customizers.team()?​

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

Parameters​
bot​

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

payload​

DiscordTeam

team​

Team

Returns​

any

customizers.template()?​

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

Parameters​
bot​

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

payload​

DiscordTemplate

template​

Template

Returns​

any

customizers.threadMember()?​

optional threadMember: (bot, payload, threadMember, extra?) => any

Parameters​
bot​

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

payload​

DiscordThreadMember

threadMember​

ThreadMember

extra?​

ThreadMemberTransformerExtra

Returns​

any

customizers.threadMemberGuildCreate()?​

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

Parameters​
bot​

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

payload​

DiscordThreadMemberGuildCreate

threadMemberGuildCreate​

ThreadMemberGuildCreate

Returns​

any

customizers.unfurledMediaItem()?​

optional unfurledMediaItem: (bot, payload, unfurledMediaItem) => any

Parameters​
bot​

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

payload​

DiscordUnfurledMediaItem

unfurledMediaItem​

UnfurledMediaItem

Returns​

any

customizers.user()?​

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

Parameters​
bot​

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

payload​

DiscordUser

user​

SetupDesiredProps<User, TProps, TBehavior>

Returns​

any

customizers.userPrimaryGuild()?​

optional userPrimaryGuild: (bot, payload, userPrimaryGuild) => any

Parameters​
bot​

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

payload​

DiscordUserPrimaryGuild

userPrimaryGuild​

SetupDesiredProps<UserPrimaryGuild, TProps, TBehavior>

Returns​

any

customizers.voiceRegion()?​

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

Parameters​
bot​

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

payload​

DiscordVoiceRegion

voiceRegion​

VoiceRegion

Returns​

any

customizers.voiceState()?​

optional voiceState: (bot, payload, voiceState, extra?) => any

Parameters​
bot​

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

payload​

DiscordVoiceState

voiceState​

SetupDesiredProps<VoiceState, TProps, TBehavior>

extra?​
guildId?​

bigint

Returns​

any

customizers.webhook()?​

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

Parameters​
bot​

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

payload​

DiscordWebhook

webhook​

SetupDesiredProps<Webhook, TProps, TBehavior>

Returns​

any

customizers.welcomeScreen()?​

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

Parameters​
bot​

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

payload​

DiscordWelcomeScreen

welcomeScreen​

WelcomeScreen

Returns​

any

customizers.widget()?​

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

Parameters​
bot​

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

payload​

DiscordGuildWidget

widget​

GuildWidget

Returns​

any

customizers.widgetSettings()?​

optional 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, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordDefaultReactionEmoji

Returns​

SetupDesiredProps<DefaultReactionEmoji, TProps, TBehavior>

desiredProperties?​

optional desiredProperties: object

desiredProperties.activityInstance?​

optional activityInstance: object

desiredProperties.activityInstance.applicationId?​

optional applicationId: boolean

desiredProperties.activityInstance.instanceId?​

optional instanceId: boolean

desiredProperties.activityInstance.launchId?​

optional launchId: boolean

desiredProperties.activityInstance.location?​

optional location: boolean

desiredProperties.activityInstance.users?​

optional users: boolean

desiredProperties.activityLocation?​

optional activityLocation: object

desiredProperties.activityLocation.channelId?​

optional channelId: boolean

desiredProperties.activityLocation.guildId?​

optional guildId: boolean

desiredProperties.activityLocation.id?​

optional id: boolean

desiredProperties.activityLocation.kind?​

optional kind: boolean

desiredProperties.attachment?​

optional attachment: object

desiredProperties.attachment.contentType?​

optional contentType: boolean

desiredProperties.attachment.description?​

optional description: boolean

desiredProperties.attachment.duration_secs?​

optional duration_secs: boolean

desiredProperties.attachment.ephemeral?​

optional ephemeral: boolean

desiredProperties.attachment.filename?​

optional filename: boolean

desiredProperties.attachment.flags?​

optional flags: boolean

desiredProperties.attachment.height?​

optional height: boolean

desiredProperties.attachment.id?​

optional id: boolean

desiredProperties.attachment.proxyUrl?​

optional proxyUrl: boolean

desiredProperties.attachment.size?​

optional size: boolean

desiredProperties.attachment.title?​

optional title: boolean

desiredProperties.attachment.url?​

optional url: boolean

desiredProperties.attachment.waveform?​

optional waveform: boolean

desiredProperties.attachment.width?​

optional width: boolean

desiredProperties.avatarDecorationData?​

optional avatarDecorationData: object

desiredProperties.avatarDecorationData.asset?​

optional asset: boolean

desiredProperties.avatarDecorationData.skuId?​

optional skuId: boolean

desiredProperties.channel?​

optional channel: object

desiredProperties.channel.applicationId?​

optional applicationId: boolean

desiredProperties.channel.appliedTags?​

optional appliedTags: boolean

desiredProperties.channel.availableTags?​

optional availableTags: boolean

desiredProperties.channel.bitrate?​

optional bitrate: boolean

desiredProperties.channel.defaultAutoArchiveDuration?​

optional defaultAutoArchiveDuration: boolean

desiredProperties.channel.defaultForumLayout?​

optional defaultForumLayout: boolean

desiredProperties.channel.defaultReactionEmoji?​

optional defaultReactionEmoji: boolean

desiredProperties.channel.defaultSortOrder?​

optional defaultSortOrder: boolean

desiredProperties.channel.defaultThreadRateLimitPerUser?​

optional defaultThreadRateLimitPerUser: boolean

desiredProperties.channel.flags?​

optional flags: boolean

desiredProperties.channel.guildId?​

optional guildId: boolean

desiredProperties.channel.icon?​

optional icon: boolean

desiredProperties.channel.id?​

optional id: boolean

desiredProperties.channel.lastMessageId?​

optional lastMessageId: boolean

desiredProperties.channel.lastPinTimestamp?​

optional lastPinTimestamp: boolean

desiredProperties.channel.member?​

optional member: boolean

desiredProperties.channel.memberCount?​

optional memberCount: boolean

desiredProperties.channel.messageCount?​

optional messageCount: boolean

desiredProperties.channel.name?​

optional name: boolean

desiredProperties.channel.ownerId?​

optional ownerId: boolean

desiredProperties.channel.parentId?​

optional parentId: boolean

desiredProperties.channel.permissionOverwrites?​

optional permissionOverwrites: boolean

desiredProperties.channel.permissions?​

optional permissions: boolean

desiredProperties.channel.position?​

optional position: boolean

desiredProperties.channel.rateLimitPerUser?​

optional rateLimitPerUser: boolean

desiredProperties.channel.recipients?​

optional recipients: boolean

desiredProperties.channel.rtcRegion?​

optional rtcRegion: boolean

desiredProperties.channel.threadMetadata?​

optional threadMetadata: boolean

desiredProperties.channel.topic?​

optional topic: boolean

desiredProperties.channel.totalMessageSent?​

optional totalMessageSent: boolean

desiredProperties.channel.type?​

optional type: boolean

desiredProperties.channel.userLimit?​

optional userLimit: boolean

desiredProperties.channel.videoQualityMode?​

optional videoQualityMode: boolean

desiredProperties.collectibles?​

optional collectibles: object

desiredProperties.collectibles.nameplate?​

optional nameplate: boolean

desiredProperties.component?​

optional component: object

desiredProperties.component.accentColor?​

optional accentColor: boolean

desiredProperties.component.accessory?​

optional accessory: boolean

desiredProperties.component.channelTypes?​

optional channelTypes: boolean

desiredProperties.component.components?​

optional components: boolean

desiredProperties.component.content?​

optional content: boolean

desiredProperties.component.customId?​

optional customId: boolean

desiredProperties.component.defaultValues?​

optional defaultValues: boolean

desiredProperties.component.description?​

optional description: boolean

desiredProperties.component.disabled?​

optional disabled: boolean

desiredProperties.component.divider?​

optional divider: boolean

desiredProperties.component.emoji?​

optional emoji: boolean

desiredProperties.component.file?​

optional file: boolean

desiredProperties.component.id?​

optional id: boolean

desiredProperties.component.items?​

optional items: boolean

desiredProperties.component.label?​

optional label: boolean

desiredProperties.component.maxLength?​

optional maxLength: boolean

desiredProperties.component.maxValues?​

optional maxValues: boolean

desiredProperties.component.media?​

optional media: boolean

desiredProperties.component.minLength?​

optional minLength: boolean

desiredProperties.component.minValues?​

optional minValues: boolean

desiredProperties.component.name?​

optional name: boolean

desiredProperties.component.options?​

optional options: boolean

desiredProperties.component.placeholder?​

optional placeholder: boolean

desiredProperties.component.required?​

optional required: boolean

desiredProperties.component.size?​

optional size: boolean

desiredProperties.component.skuId?​

optional skuId: boolean

desiredProperties.component.spacing?​

optional spacing: boolean

desiredProperties.component.spoiler?​

optional spoiler: boolean

desiredProperties.component.style?​

optional style: boolean

desiredProperties.component.type?​

optional type: boolean

desiredProperties.component.url?​

optional url: boolean

desiredProperties.component.value?​

optional value: boolean

desiredProperties.defaultReactionEmoji?​

optional defaultReactionEmoji: object

desiredProperties.defaultReactionEmoji.emojiId?​

optional emojiId: boolean

desiredProperties.defaultReactionEmoji.emojiName?​

optional emojiName: boolean

desiredProperties.emoji?​

optional emoji: object

desiredProperties.emoji.id?​

optional id: boolean

desiredProperties.emoji.name?​

optional name: boolean

desiredProperties.emoji.roles?​

optional roles: boolean

desiredProperties.emoji.user?​

optional user: boolean

desiredProperties.entitlement?​

optional entitlement: object

desiredProperties.entitlement.applicationId?​

optional applicationId: boolean

desiredProperties.entitlement.consumed?​

optional consumed: boolean

desiredProperties.entitlement.deleted?​

optional deleted: boolean

desiredProperties.entitlement.endsAt?​

optional endsAt: boolean

desiredProperties.entitlement.guildId?​

optional guildId: boolean

desiredProperties.entitlement.id?​

optional id: boolean

desiredProperties.entitlement.skuId?​

optional skuId: boolean

desiredProperties.entitlement.startsAt?​

optional startsAt: boolean

desiredProperties.entitlement.type?​

optional type: boolean

desiredProperties.entitlement.userId?​

optional userId: boolean

desiredProperties.forumTag?​

optional forumTag: object

desiredProperties.forumTag.emojiId?​

optional emojiId: boolean

desiredProperties.forumTag.emojiName?​

optional emojiName: boolean

desiredProperties.forumTag.id?​

optional id: boolean

desiredProperties.forumTag.moderated?​

optional moderated: boolean

desiredProperties.forumTag.name?​

optional name: boolean

desiredProperties.guild?​

optional guild: object

desiredProperties.guild.afkChannelId?​

optional afkChannelId: boolean

desiredProperties.guild.afkTimeout?​

optional afkTimeout: boolean

desiredProperties.guild.applicationId?​

optional applicationId: boolean

desiredProperties.guild.approximateMemberCount?​

optional approximateMemberCount: boolean

desiredProperties.guild.approximatePresenceCount?​

optional approximatePresenceCount: boolean

desiredProperties.guild.banner?​

optional banner: boolean

desiredProperties.guild.channels?​

optional channels: boolean

desiredProperties.guild.defaultMessageNotifications?​

optional defaultMessageNotifications: boolean

desiredProperties.guild.description?​

optional description: boolean

desiredProperties.guild.discoverySplash?​

optional discoverySplash: boolean

desiredProperties.guild.emojis?​

optional emojis: boolean

desiredProperties.guild.explicitContentFilter?​

optional explicitContentFilter: boolean

desiredProperties.guild.icon?​

optional icon: boolean

desiredProperties.guild.iconHash?​

optional iconHash: boolean

desiredProperties.guild.id?​

optional id: boolean

desiredProperties.guild.incidentsData?​

optional incidentsData: boolean

desiredProperties.guild.joinedAt?​

optional joinedAt: boolean

desiredProperties.guild.large?​

optional large: boolean

desiredProperties.guild.maxMembers?​

optional maxMembers: boolean

desiredProperties.guild.maxPresences?​

optional maxPresences: boolean

desiredProperties.guild.maxStageVideoChannelUsers?​

optional maxStageVideoChannelUsers: boolean

desiredProperties.guild.maxVideoChannelUsers?​

optional maxVideoChannelUsers: boolean

desiredProperties.guild.memberCount?​

optional memberCount: boolean

desiredProperties.guild.members?​

optional members: boolean

desiredProperties.guild.mfaLevel?​

optional mfaLevel: boolean

desiredProperties.guild.name?​

optional name: boolean

desiredProperties.guild.nsfwLevel?​

optional nsfwLevel: boolean

desiredProperties.guild.owner?​

optional owner: boolean

desiredProperties.guild.ownerId?​

optional ownerId: boolean

desiredProperties.guild.permissions?​

optional permissions: boolean

desiredProperties.guild.preferredLocale?​

optional preferredLocale: boolean

desiredProperties.guild.premiumProgressBarEnabled?​

optional premiumProgressBarEnabled: boolean

desiredProperties.guild.premiumSubscriptionCount?​

optional premiumSubscriptionCount: boolean

desiredProperties.guild.premiumTier?​

optional premiumTier: boolean

desiredProperties.guild.presences?​

optional presences: boolean

desiredProperties.guild.publicUpdatesChannelId?​

optional publicUpdatesChannelId: boolean

desiredProperties.guild.roles?​

optional roles: boolean

desiredProperties.guild.rulesChannelId?​

optional rulesChannelId: boolean

desiredProperties.guild.safetyAlertsChannelId?​

optional safetyAlertsChannelId: boolean

desiredProperties.guild.shardId?​

optional shardId: boolean

desiredProperties.guild.splash?​

optional splash: boolean

desiredProperties.guild.stageInstances?​

optional stageInstances: boolean

desiredProperties.guild.stickers?​

optional stickers: boolean

desiredProperties.guild.systemChannelFlags?​

optional systemChannelFlags: boolean

desiredProperties.guild.systemChannelId?​

optional systemChannelId: boolean

desiredProperties.guild.toggles?​

optional toggles: boolean

desiredProperties.guild.unavailable?​

optional unavailable: boolean

desiredProperties.guild.vanityUrlCode?​

optional vanityUrlCode: boolean

desiredProperties.guild.verificationLevel?​

optional verificationLevel: boolean

desiredProperties.guild.voiceStates?​

optional voiceStates: boolean

desiredProperties.guild.welcomeScreen?​

optional welcomeScreen: boolean

desiredProperties.guild.widgetChannelId?​

optional widgetChannelId: boolean

desiredProperties.guild.widgetEnabled?​

optional widgetEnabled: boolean

desiredProperties.guildOnboarding?​

optional guildOnboarding: object

desiredProperties.guildOnboarding.defaultChannelIds?​

optional defaultChannelIds: boolean

desiredProperties.guildOnboarding.enabled?​

optional enabled: boolean

desiredProperties.guildOnboarding.guildId?​

optional guildId: boolean

desiredProperties.guildOnboarding.mode?​

optional mode: boolean

desiredProperties.guildOnboarding.prompts?​

optional prompts: boolean

desiredProperties.guildOnboardingPrompt?​

optional guildOnboardingPrompt: object

desiredProperties.guildOnboardingPrompt.id?​

optional id: boolean

desiredProperties.guildOnboardingPrompt.inOnboarding?​

optional inOnboarding: boolean

desiredProperties.guildOnboardingPrompt.options?​

optional options: boolean

desiredProperties.guildOnboardingPrompt.required?​

optional required: boolean

desiredProperties.guildOnboardingPrompt.singleSelect?​

optional singleSelect: boolean

desiredProperties.guildOnboardingPrompt.title?​

optional title: boolean

desiredProperties.guildOnboardingPrompt.type?​

optional type: boolean

desiredProperties.guildOnboardingPromptOption?​

optional guildOnboardingPromptOption: object

desiredProperties.guildOnboardingPromptOption.channelIds?​

optional channelIds: boolean

desiredProperties.guildOnboardingPromptOption.description?​

optional description: boolean

desiredProperties.guildOnboardingPromptOption.emoji?​

optional emoji: boolean

desiredProperties.guildOnboardingPromptOption.id?​

optional id: boolean

desiredProperties.guildOnboardingPromptOption.roleIds?​

optional roleIds: boolean

desiredProperties.guildOnboardingPromptOption.title?​

optional title: boolean

desiredProperties.incidentsData?​

optional incidentsData: object

desiredProperties.incidentsData.dmsDisabledUntil?​

optional dmsDisabledUntil: boolean

desiredProperties.incidentsData.dmSpamDetectedAt?​

optional dmSpamDetectedAt: boolean

desiredProperties.incidentsData.invitesDisabledUntil?​

optional invitesDisabledUntil: boolean

desiredProperties.incidentsData.raidDetectedAt?​

optional raidDetectedAt: boolean

desiredProperties.interaction?​

optional interaction: object

desiredProperties.interaction.applicationId?​

optional applicationId: boolean

desiredProperties.interaction.appPermissions?​

optional appPermissions: boolean

desiredProperties.interaction.attachmentSizeLimit?​

optional attachmentSizeLimit: boolean

desiredProperties.interaction.authorizingIntegrationOwners?​

optional authorizingIntegrationOwners: boolean

desiredProperties.interaction.channel?​

optional channel: boolean

desiredProperties.interaction.channelId?​

optional channelId: boolean

desiredProperties.interaction.context?​

optional context: boolean

desiredProperties.interaction.data?​

optional data: boolean

desiredProperties.interaction.entitlements?​

optional entitlements: boolean

desiredProperties.interaction.guild?​

optional guild: boolean

desiredProperties.interaction.guildId?​

optional guildId: boolean

desiredProperties.interaction.guildLocale?​

optional guildLocale: boolean

desiredProperties.interaction.id?​

optional id: boolean

desiredProperties.interaction.locale?​

optional locale: boolean

desiredProperties.interaction.member?​

optional member: boolean

desiredProperties.interaction.message?​

optional message: boolean

desiredProperties.interaction.token?​

optional token: boolean

desiredProperties.interaction.type?​

optional type: boolean

desiredProperties.interaction.user?​

optional user: boolean

desiredProperties.interaction.version?​

optional version: boolean

desiredProperties.interactionCallback?​

optional interactionCallback: object

desiredProperties.interactionCallback.activityInstanceId?​

optional activityInstanceId: boolean

desiredProperties.interactionCallback.id?​

optional id: boolean

desiredProperties.interactionCallback.responseMessageEphemeral?​

optional responseMessageEphemeral: boolean

desiredProperties.interactionCallback.responseMessageId?​

optional responseMessageId: boolean

desiredProperties.interactionCallback.responseMessageLoading?​

optional responseMessageLoading: boolean

desiredProperties.interactionCallback.type?​

optional type: boolean

desiredProperties.interactionCallbackResponse?​

optional interactionCallbackResponse: object

desiredProperties.interactionCallbackResponse.interaction?​

optional interaction: boolean

desiredProperties.interactionCallbackResponse.resource?​

optional resource: boolean

desiredProperties.interactionResource?​

optional interactionResource: object

desiredProperties.interactionResource.activityInstance?​

optional activityInstance: boolean

desiredProperties.interactionResource.message?​

optional message: boolean

desiredProperties.interactionResource.type?​

optional type: boolean

desiredProperties.invite?​

optional invite: object

desiredProperties.invite.approximateMemberCount?​

optional approximateMemberCount: boolean

desiredProperties.invite.approximatePresenceCount?​

optional approximatePresenceCount: boolean

desiredProperties.invite.channelId?​

optional channelId: boolean

desiredProperties.invite.code?​

optional code: boolean

desiredProperties.invite.createdAt?​

optional createdAt: boolean

desiredProperties.invite.expiresAt?​

optional expiresAt: boolean

desiredProperties.invite.flags?​

optional flags: boolean

desiredProperties.invite.guildId?​

optional guildId: boolean

desiredProperties.invite.guildScheduledEvent?​

optional guildScheduledEvent: boolean

desiredProperties.invite.inviter?​

optional inviter: boolean

desiredProperties.invite.maxAge?​

optional maxAge: boolean

desiredProperties.invite.maxUses?​

optional maxUses: boolean

desiredProperties.invite.stageInstance?​

optional stageInstance: boolean

desiredProperties.invite.targetApplication?​

optional targetApplication: boolean

desiredProperties.invite.targetType?​

optional targetType: boolean

desiredProperties.invite.targetUser?​

optional targetUser: boolean

desiredProperties.invite.temporary?​

optional temporary: boolean

desiredProperties.invite.type?​

optional type: boolean

desiredProperties.invite.uses?​

optional uses: boolean

desiredProperties.inviteStageInstance?​

optional inviteStageInstance: object

desiredProperties.inviteStageInstance.members?​

optional members: boolean

desiredProperties.inviteStageInstance.participantCount?​

optional participantCount: boolean

desiredProperties.inviteStageInstance.speakerCount?​

optional speakerCount: boolean

desiredProperties.inviteStageInstance.topic?​

optional topic: boolean

desiredProperties.lobby?​

optional lobby: object

desiredProperties.lobby.applicationId?​

optional applicationId: boolean

desiredProperties.lobby.id?​

optional id: boolean

desiredProperties.lobby.linkedChannel?​

optional linkedChannel: boolean

desiredProperties.lobby.members?​

optional members: boolean

desiredProperties.lobby.metadata?​

optional metadata: boolean

desiredProperties.lobbyMember?​

optional lobbyMember: object

desiredProperties.lobbyMember.flags?​

optional flags: boolean

desiredProperties.lobbyMember.id?​

optional id: boolean

desiredProperties.lobbyMember.metadata?​

optional metadata: boolean

desiredProperties.mediaGalleryItem?​

optional mediaGalleryItem: object

desiredProperties.mediaGalleryItem.description?​

optional description: boolean

desiredProperties.mediaGalleryItem.media?​

optional media: boolean

desiredProperties.mediaGalleryItem.spoiler?​

optional spoiler: boolean

desiredProperties.member?​

optional member: object

desiredProperties.member.avatar?​

optional avatar: boolean

desiredProperties.member.avatarDecorationData?​

optional avatarDecorationData: boolean

desiredProperties.member.banner?​

optional banner: boolean

desiredProperties.member.communicationDisabledUntil?​

optional communicationDisabledUntil: boolean

desiredProperties.member.guildId?​

optional guildId: boolean

desiredProperties.member.id?​

optional id: boolean

desiredProperties.member.joinedAt?​

optional joinedAt: boolean

desiredProperties.member.nick?​

optional nick: boolean

desiredProperties.member.permissions?​

optional permissions: boolean

desiredProperties.member.premiumSince?​

optional premiumSince: boolean

desiredProperties.member.roles?​

optional roles: boolean

desiredProperties.member.toggles?​

optional toggles: boolean

desiredProperties.member.user?​

optional user: boolean

desiredProperties.message?​

optional message: object

desiredProperties.message.activity?​

optional activity: boolean

desiredProperties.message.application?​

optional application: boolean

desiredProperties.message.applicationId?​

optional applicationId: boolean

desiredProperties.message.attachments?​

optional attachments: boolean

desiredProperties.message.author?​

optional author: boolean

desiredProperties.message.call?​

optional call: boolean

desiredProperties.message.channelId?​

optional channelId: boolean

desiredProperties.message.components?​

optional components: boolean

desiredProperties.message.content?​

optional content: boolean

desiredProperties.message.editedTimestamp?​

optional editedTimestamp: boolean

desiredProperties.message.embeds?​

optional embeds: boolean

desiredProperties.message.guildId?​

optional guildId: boolean

desiredProperties.message.id?​

optional id: boolean

desiredProperties.message.interaction?​

optional interaction: boolean

desiredProperties.message.interactionMetadata?​

optional interactionMetadata: boolean

desiredProperties.message.member?​

optional member: boolean

desiredProperties.message.mentionedChannelIds?​

optional mentionedChannelIds: boolean

desiredProperties.message.mentionedRoleIds?​

optional mentionedRoleIds: boolean

desiredProperties.message.mentions?​

optional mentions: boolean

desiredProperties.message.messageReference?​

optional messageReference: boolean

desiredProperties.message.messageSnapshots?​

optional messageSnapshots: boolean

desiredProperties.message.nonce?​

optional nonce: boolean

desiredProperties.message.poll?​

optional poll: boolean

desiredProperties.message.reactions?​

optional reactions: boolean

desiredProperties.message.referencedMessage?​

optional referencedMessage: boolean

desiredProperties.message.stickerItems?​

optional stickerItems: boolean

desiredProperties.message.thread?​

optional thread: boolean

desiredProperties.message.type?​

optional type: boolean

desiredProperties.message.webhookId?​

optional webhookId: boolean

desiredProperties.messageCall?​

optional messageCall: object

desiredProperties.messageCall.endedTimestamp?​

optional endedTimestamp: boolean

desiredProperties.messageCall.participants?​

optional participants: boolean

desiredProperties.messageInteraction?​

optional messageInteraction: object

desiredProperties.messageInteraction.id?​

optional id: boolean

desiredProperties.messageInteraction.member?​

optional member: boolean

desiredProperties.messageInteraction.name?​

optional name: boolean

desiredProperties.messageInteraction.type?​

optional type: boolean

desiredProperties.messageInteraction.user?​

optional user: boolean

desiredProperties.messageInteractionMetadata?​

optional messageInteractionMetadata: object

desiredProperties.messageInteractionMetadata.authorizingIntegrationOwners?​

optional authorizingIntegrationOwners: boolean

desiredProperties.messageInteractionMetadata.id?​

optional id: boolean

desiredProperties.messageInteractionMetadata.interactedMessageId?​

optional interactedMessageId: boolean

desiredProperties.messageInteractionMetadata.originalResponseMessageId?​

optional originalResponseMessageId: boolean

desiredProperties.messageInteractionMetadata.targetMessageId?​

optional targetMessageId: boolean

desiredProperties.messageInteractionMetadata.targetUser?​

optional targetUser: boolean

desiredProperties.messageInteractionMetadata.triggeringInteractionMetadata?​

optional triggeringInteractionMetadata: boolean

desiredProperties.messageInteractionMetadata.type?​

optional type: boolean

desiredProperties.messageInteractionMetadata.user?​

optional user: boolean

desiredProperties.messagePin?​

optional messagePin: object

desiredProperties.messagePin.message?​

optional message: boolean

desiredProperties.messagePin.pinnedAt?​

optional pinnedAt: boolean

desiredProperties.messageReference?​

optional messageReference: object

desiredProperties.messageReference.channelId?​

optional channelId: boolean

desiredProperties.messageReference.guildId?​

optional guildId: boolean

desiredProperties.messageReference.messageId?​

optional messageId: boolean

desiredProperties.messageSnapshot?​

optional messageSnapshot: object

desiredProperties.messageSnapshot.message?​

optional message: boolean

desiredProperties.nameplate?​

optional nameplate: object

desiredProperties.nameplate.asset?​

optional asset: boolean

desiredProperties.nameplate.label?​

optional label: boolean

desiredProperties.nameplate.palette?​

optional palette: boolean

desiredProperties.nameplate.skuId?​

optional skuId: boolean

desiredProperties.poll?​

optional poll: object

desiredProperties.poll.allowMultiselect?​

optional allowMultiselect: boolean

desiredProperties.poll.answers?​

optional answers: boolean

desiredProperties.poll.expiry?​

optional expiry: boolean

desiredProperties.poll.layoutType?​

optional layoutType: boolean

desiredProperties.poll.question?​

optional question: boolean

desiredProperties.poll.results?​

optional results: boolean

desiredProperties.pollAnswer?​

optional pollAnswer: object

desiredProperties.pollAnswer.answerId?​

optional answerId: boolean

desiredProperties.pollAnswer.pollMedia?​

optional pollMedia: boolean

desiredProperties.pollAnswerCount?​

optional pollAnswerCount: object

desiredProperties.pollAnswerCount.count?​

optional count: boolean

desiredProperties.pollAnswerCount.id?​

optional id: boolean

desiredProperties.pollAnswerCount.meVoted?​

optional meVoted: boolean

desiredProperties.pollMedia?​

optional pollMedia: object

desiredProperties.pollMedia.emoji?​

optional emoji: boolean

desiredProperties.pollMedia.text?​

optional text: boolean

desiredProperties.pollResult?​

optional pollResult: object

desiredProperties.pollResult.answerCounts?​

optional answerCounts: boolean

desiredProperties.pollResult.isFinalized?​

optional isFinalized: boolean

desiredProperties.role?​

optional role: object

desiredProperties.role.color?​

optional color: boolean

desiredProperties.role.colors?​

optional colors: boolean

desiredProperties.role.flags?​

optional flags: boolean

desiredProperties.role.guildId?​

optional guildId: boolean

desiredProperties.role.icon?​

optional icon: boolean

desiredProperties.role.id?​

optional id: boolean

desiredProperties.role.name?​

optional name: boolean

desiredProperties.role.permissions?​

optional permissions: boolean

desiredProperties.role.position?​

optional position: boolean

desiredProperties.role.tags?​

optional tags: boolean

desiredProperties.role.toggles?​

optional toggles: boolean

desiredProperties.role.unicodeEmoji?​

optional unicodeEmoji: boolean

desiredProperties.roleColors?​

optional roleColors: object

desiredProperties.roleColors.primaryColor?​

optional primaryColor: boolean

desiredProperties.roleColors.secondaryColor?​

optional secondaryColor: boolean

desiredProperties.roleColors.tertiaryColor?​

optional tertiaryColor: boolean

desiredProperties.scheduledEvent?​

optional scheduledEvent: object

desiredProperties.scheduledEvent.channelId?​

optional channelId: boolean

desiredProperties.scheduledEvent.creator?​

optional creator: boolean

desiredProperties.scheduledEvent.creatorId?​

optional creatorId: boolean

desiredProperties.scheduledEvent.description?​

optional description: boolean

desiredProperties.scheduledEvent.entityId?​

optional entityId: boolean

desiredProperties.scheduledEvent.entityType?​

optional entityType: boolean

desiredProperties.scheduledEvent.guildId?​

optional guildId: boolean

desiredProperties.scheduledEvent.id?​

optional id: boolean

desiredProperties.scheduledEvent.image?​

optional image: boolean

desiredProperties.scheduledEvent.location?​

optional location: boolean

desiredProperties.scheduledEvent.name?​

optional name: boolean

desiredProperties.scheduledEvent.privacyLevel?​

optional privacyLevel: boolean

desiredProperties.scheduledEvent.recurrenceRule?​

optional recurrenceRule: boolean

desiredProperties.scheduledEvent.scheduledEndTime?​

optional scheduledEndTime: boolean

desiredProperties.scheduledEvent.scheduledStartTime?​

optional scheduledStartTime: boolean

desiredProperties.scheduledEvent.status?​

optional status: boolean

desiredProperties.scheduledEvent.userCount?​

optional userCount: boolean

desiredProperties.scheduledEventRecurrenceRule?​

optional scheduledEventRecurrenceRule: object

desiredProperties.scheduledEventRecurrenceRule.byMonth?​

optional byMonth: boolean

desiredProperties.scheduledEventRecurrenceRule.byMonthDay?​

optional byMonthDay: boolean

desiredProperties.scheduledEventRecurrenceRule.byNWeekday?​

optional byNWeekday: boolean

desiredProperties.scheduledEventRecurrenceRule.byWeekday?​

optional byWeekday: boolean

desiredProperties.scheduledEventRecurrenceRule.byYearDay?​

optional byYearDay: boolean

desiredProperties.scheduledEventRecurrenceRule.count?​

optional count: boolean

desiredProperties.scheduledEventRecurrenceRule.end?​

optional end: boolean

desiredProperties.scheduledEventRecurrenceRule.frequency?​

optional frequency: boolean

desiredProperties.scheduledEventRecurrenceRule.interval?​

optional interval: boolean

desiredProperties.scheduledEventRecurrenceRule.start?​

optional start: boolean

desiredProperties.sku?​

optional sku: object

desiredProperties.sku.applicationId?​

optional applicationId: boolean

desiredProperties.sku.flags?​

optional flags: boolean

desiredProperties.sku.id?​

optional id: boolean

desiredProperties.sku.name?​

optional name: boolean

desiredProperties.sku.slug?​

optional slug: boolean

desiredProperties.sku.type?​

optional type: boolean

desiredProperties.soundboardSound?​

optional soundboardSound: object

desiredProperties.soundboardSound.available?​

optional available: boolean

desiredProperties.soundboardSound.emojiId?​

optional emojiId: boolean

desiredProperties.soundboardSound.emojiName?​

optional emojiName: boolean

desiredProperties.soundboardSound.guildId?​

optional guildId: boolean

desiredProperties.soundboardSound.name?​

optional name: boolean

desiredProperties.soundboardSound.soundId?​

optional soundId: boolean

desiredProperties.soundboardSound.user?​

optional user: boolean

desiredProperties.soundboardSound.volume?​

optional volume: boolean

desiredProperties.stageInstance?​

optional stageInstance: object

desiredProperties.stageInstance.channelId?​

optional channelId: boolean

desiredProperties.stageInstance.guildId?​

optional guildId: boolean

desiredProperties.stageInstance.guildScheduledEventId?​

optional guildScheduledEventId: boolean

desiredProperties.stageInstance.id?​

optional id: boolean

desiredProperties.stageInstance.topic?​

optional topic: boolean

desiredProperties.sticker?​

optional sticker: object

desiredProperties.sticker.available?​

optional available: boolean

desiredProperties.sticker.description?​

optional description: boolean

desiredProperties.sticker.formatType?​

optional formatType: boolean

desiredProperties.sticker.guildId?​

optional guildId: boolean

desiredProperties.sticker.id?​

optional id: boolean

desiredProperties.sticker.name?​

optional name: boolean

desiredProperties.sticker.packId?​

optional packId: boolean

desiredProperties.sticker.sortValue?​

optional sortValue: boolean

desiredProperties.sticker.tags?​

optional tags: boolean

desiredProperties.sticker.type?​

optional type: boolean

desiredProperties.sticker.user?​

optional user: boolean

desiredProperties.subscription?​

optional subscription: object

desiredProperties.subscription.canceledAt?​

optional canceledAt: boolean

desiredProperties.subscription.country?​

optional country: boolean

desiredProperties.subscription.currentPeriodEnd?​

optional currentPeriodEnd: boolean

desiredProperties.subscription.currentPeriodStart?​

optional currentPeriodStart: boolean

desiredProperties.subscription.entitlementIds?​

optional entitlementIds: boolean

desiredProperties.subscription.id?​

optional id: boolean

desiredProperties.subscription.renewalSkuIds?​

optional renewalSkuIds: boolean

desiredProperties.subscription.skuIds?​

optional skuIds: boolean

desiredProperties.subscription.status?​

optional status: boolean

desiredProperties.subscription.userId?​

optional userId: boolean

desiredProperties.unfurledMediaItem?​

optional unfurledMediaItem: object

desiredProperties.unfurledMediaItem.attachmentId?​

optional attachmentId: boolean

desiredProperties.unfurledMediaItem.contentType?​

optional contentType: boolean

desiredProperties.unfurledMediaItem.height?​

optional height: boolean

desiredProperties.unfurledMediaItem.proxyUrl?​

optional proxyUrl: boolean

desiredProperties.unfurledMediaItem.url?​

optional url: boolean

desiredProperties.unfurledMediaItem.width?​

optional width: boolean

desiredProperties.user?​

optional user: object

desiredProperties.user.accentColor?​

optional accentColor: boolean

desiredProperties.user.avatar?​

optional avatar: boolean

desiredProperties.user.avatarDecorationData?​

optional avatarDecorationData: boolean

desiredProperties.user.banner?​

optional banner: boolean

desiredProperties.user.collectibles?​

optional collectibles: boolean

desiredProperties.user.discriminator?​

optional discriminator: boolean

desiredProperties.user.email?​

optional email: boolean

desiredProperties.user.flags?​

optional flags: boolean

desiredProperties.user.globalName?​

optional globalName: boolean

desiredProperties.user.id?​

optional id: boolean

desiredProperties.user.locale?​

optional locale: boolean

desiredProperties.user.premiumType?​

optional premiumType: boolean

desiredProperties.user.primaryGuild?​

optional primaryGuild: boolean

desiredProperties.user.publicFlags?​

optional publicFlags: boolean

desiredProperties.user.toggles?​

optional toggles: boolean

desiredProperties.user.username?​

optional username: boolean

desiredProperties.userPrimaryGuild?​

optional userPrimaryGuild: object

desiredProperties.userPrimaryGuild.badge?​

optional badge: boolean

desiredProperties.userPrimaryGuild.identityEnabled?​

optional identityEnabled: boolean

desiredProperties.userPrimaryGuild.identityGuildId?​

optional identityGuildId: boolean

desiredProperties.userPrimaryGuild.tag?​

optional tag: boolean

desiredProperties.voiceState?​

optional voiceState: object

desiredProperties.voiceState.channelId?​

optional channelId: boolean

desiredProperties.voiceState.guildId?​

optional guildId: boolean

desiredProperties.voiceState.requestToSpeakTimestamp?​

optional requestToSpeakTimestamp: boolean

desiredProperties.voiceState.sessionId?​

optional sessionId: boolean

desiredProperties.voiceState.toggles?​

optional toggles: boolean

desiredProperties.voiceState.userId?​

optional userId: boolean

desiredProperties.webhook?​

optional webhook: object

desiredProperties.webhook.applicationId?​

optional applicationId: boolean

desiredProperties.webhook.avatar?​

optional avatar: boolean

desiredProperties.webhook.channelId?​

optional channelId: boolean

desiredProperties.webhook.guildId?​

optional guildId: boolean

desiredProperties.webhook.id?​

optional id: boolean

desiredProperties.webhook.name?​

optional name: boolean

desiredProperties.webhook.sourceChannel?​

optional sourceChannel: boolean

desiredProperties.webhook.sourceGuild?​

optional sourceGuild: boolean

desiredProperties.webhook.token?​

optional token: boolean

desiredProperties.webhook.type?​

optional type: boolean

desiredProperties.webhook.url?​

optional url: boolean

desiredProperties.webhook.user?​

optional 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, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordEmoji

Returns​

SetupDesiredProps<Emoji, TProps, TBehavior>

entitlement()?​

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

Parameters​
bot​

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

payload​

DiscordEntitlement

Returns​

SetupDesiredProps<Entitlement, TProps, TBehavior>

forumTag()?​

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

Parameters​
bot​

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

payload​

DiscordForumTag

Returns​

SetupDesiredProps<ForumTag, TProps, TBehavior>

gatewayBot()?​

optional gatewayBot: (bot, payload) => GetGatewayBot

Parameters​
bot​

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

payload​

DiscordGetGatewayBot

Returns​

GetGatewayBot

guild()?​

optional guild: (bot, payload, extra?) => SetupDesiredProps<Guild, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordGuild

extra?​
shardId?​

number

Returns​

SetupDesiredProps<Guild, TProps, TBehavior>

guildOnboarding()?​

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

Parameters​
bot​

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

payload​

DiscordGuildOnboarding

Returns​

SetupDesiredProps<GuildOnboarding, TProps, TBehavior>

guildOnboardingPrompt()?​

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

Parameters​
bot​

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

payload​

DiscordGuildOnboardingPrompt

Returns​

SetupDesiredProps<GuildOnboardingPrompt, TProps, TBehavior>

guildOnboardingPromptOption()?​

optional guildOnboardingPromptOption: (bot, payload) => GuildOnboardingPromptOption

Parameters​
bot​

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

payload​

DiscordGuildOnboardingPromptOption

Returns​

GuildOnboardingPromptOption

incidentsData()?​

optional incidentsData: (bot, payload) => IncidentsData

Parameters​
bot​

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

payload​

DiscordIncidentsData

Returns​

IncidentsData

integration()?​

optional integration: (bot, payload) => Integration

Parameters​
bot​

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

payload​

DiscordIntegrationCreateUpdate

Returns​

Integration

interaction()?​

optional interaction: (bot, payload, extra?) => SetupDesiredProps<Interaction, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordInteraction

extra?​
shardId?​

number

Returns​

SetupDesiredProps<Interaction, TProps, TBehavior>

interactionCallback()?​

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

Parameters​
bot​

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

payload​

DiscordInteractionCallback

Returns​

SetupDesiredProps<InteractionCallback, TProps, TBehavior>

interactionCallbackResponse()?​

optional interactionCallbackResponse: (bot, payload, extra?) => SetupDesiredProps<InteractionCallbackResponse, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordInteractionCallbackResponse

extra?​
shardId?​

number

Returns​

SetupDesiredProps<InteractionCallbackResponse, TProps, TBehavior>

interactionDataOptions()?​

optional interactionDataOptions: (bot, payload) => InteractionDataOption

Parameters​
bot​

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

payload​

DiscordInteractionDataOption

Returns​

InteractionDataOption

interactionDataResolved()?​

optional interactionDataResolved: (bot, payload, extra?) => object

Parameters​
bot​

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

payload​

DiscordInteractionDataResolved

extra?​
guildId?​

BigString

shardId?​

number

Returns​

object

attachments?​

optional attachments: Collection<bigint, SetupDesiredProps<Attachment, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>

channels?​

optional channels: Collection<bigint, InteractionResolvedDataChannel<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>

members?​

optional members: Collection<bigint, InteractionResolvedDataMember<CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>

messages?​

optional messages: Collection<bigint, SetupDesiredProps<Message, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>

roles?​

optional roles: Collection<bigint, SetupDesiredProps<Role, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>

users?​

optional users: Collection<bigint, SetupDesiredProps<User, CompleteDesiredProperties<NoInfer<TProps>>, TBehavior>>

interactionResource()?​

optional interactionResource: (bot, payload, extra?) => SetupDesiredProps<InteractionResource, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordInteractionResource

extra?​
shardId?​

number

Returns​

SetupDesiredProps<InteractionResource, TProps, TBehavior>

invite()?​

optional invite: (bot, payload, extra?) => SetupDesiredProps<Invite, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordInviteMetadata | DiscordInviteCreate

extra?​
shardId?​

number

Returns​

SetupDesiredProps<Invite, TProps, TBehavior>

inviteStageInstance()?​

optional inviteStageInstance: (bot, payload, extra?) => SetupDesiredProps<InviteStageInstance, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordInviteStageInstance

extra?​
guildId​

BigString

Returns​

SetupDesiredProps<InviteStageInstance, TProps, TBehavior>

lobby()?​

optional lobby: (bot, payload) => SetupDesiredProps<Lobby, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordLobby

Returns​

SetupDesiredProps<Lobby, TProps, TBehavior>

lobbyMember()?​

optional lobbyMember: (bot, payload) => SetupDesiredProps<LobbyMember, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordLobbyMember

Returns​

SetupDesiredProps<LobbyMember, TProps, TBehavior>

mediaGalleryItem()?​

optional mediaGalleryItem: (bot, payload) => MediaGalleryItem

Parameters​
bot​

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

payload​

DiscordMediaGalleryItem

Returns​

MediaGalleryItem

member()?​

optional member: (bot, payload, extra?) => SetupDesiredProps<Member, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordMember

extra?​
guildId?​

BigString

userId?​

BigString

Returns​

SetupDesiredProps<Member, TProps, TBehavior>

message()?​

optional message: (bot, payload, extra?) => SetupDesiredProps<Message, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordMessage

extra?​
shardId?​

number

Returns​

SetupDesiredProps<Message, TProps, TBehavior>

messageCall()?​

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

Parameters​
bot​

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

payload​

DiscordMessageCall

Returns​

SetupDesiredProps<MessageCall, TProps, TBehavior>

messageInteractionMetadata()?​

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

Parameters​
bot​

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

payload​

DiscordMessageInteractionMetadata

Returns​

SetupDesiredProps<MessageInteractionMetadata, TProps, TBehavior>

messagePin()?​

optional messagePin: (bot, payload, extra?) => SetupDesiredProps<MessagePin, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordMessagePin

extra?​
shardId?​

number

Returns​

SetupDesiredProps<MessagePin, TProps, TBehavior>

messageSnapshot()?​

optional messageSnapshot: (bot, payload, extra?) => SetupDesiredProps<MessageSnapshot, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordMessageSnapshot

extra?​
shardId?​

number

Returns​

SetupDesiredProps<MessageSnapshot, TProps, TBehavior>

nameplate()?​

optional nameplate: (bot, payload) => SetupDesiredProps<Nameplate, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordNameplate

Returns​

SetupDesiredProps<Nameplate, TProps, TBehavior>

poll()?​

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

Parameters​
bot​

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

payload​

DiscordPoll

Returns​

SetupDesiredProps<Poll, TProps, TBehavior>

pollMedia()?​

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

Parameters​
bot​

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

payload​

DiscordPollMedia

Returns​

SetupDesiredProps<PollMedia, 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 activity: (bot, payload) => DiscordActivity

Parameters​
bot​

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

payload​

Activity

Returns​

DiscordActivity

reverse.allowedMentions()?​

optional allowedMentions: (bot, payload) => DiscordAllowedMentions

Parameters​
bot​

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

payload​

AllowedMentions

Returns​

DiscordAllowedMentions

reverse.application()?​

optional application: (bot, payload) => DiscordApplication

Parameters​
bot​

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

payload​

Application

Returns​

DiscordApplication

reverse.applicationCommand()?​

optional applicationCommand: (bot, payload) => DiscordApplicationCommand

Parameters​
bot​

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

payload​

ApplicationCommand

Returns​

DiscordApplicationCommand

reverse.applicationCommandOption()?​

optional applicationCommandOption: (bot, payload) => DiscordApplicationCommandOption

Parameters​
bot​

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

payload​

ApplicationCommandOption

Returns​

DiscordApplicationCommandOption

reverse.applicationCommandOptionChoice()?​

optional applicationCommandOptionChoice: (bot, payload) => DiscordApplicationCommandOptionChoice

Parameters​
bot​

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

payload​

ApplicationCommandOptionChoice

Returns​

DiscordApplicationCommandOptionChoice

reverse.attachment()?​

optional attachment: (bot, payload) => DiscordAttachment

Parameters​
bot​

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

payload​

SetupDesiredProps<Attachment, TProps, TBehavior>

Returns​

DiscordAttachment

reverse.component()?​

optional component: (bot, payload) => DiscordMessageComponent

Parameters​
bot​

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

payload​

Component

Returns​

DiscordMessageComponent

reverse.embed()?​

optional embed: (bot, payload) => DiscordEmbed

Parameters​
bot​

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

payload​

Embed

Returns​

DiscordEmbed

reverse.mediaGalleryItem()?​

optional mediaGalleryItem: (bot, payload) => DiscordMediaGalleryItem

Parameters​
bot​

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

payload​

MediaGalleryItem

Returns​

DiscordMediaGalleryItem

reverse.member()?​

optional member: (bot, payload) => DiscordMember

Parameters​
bot​

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

payload​

SetupDesiredProps<Member, TProps, TBehavior>

Returns​

DiscordMember

reverse.snowflake()?​

optional snowflake: (snowflake) => string

Parameters​
snowflake​

BigString

Returns​

string

reverse.team()?​

optional team: (bot, payload) => DiscordTeam

Parameters​
bot​

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

payload​

Team

Returns​

DiscordTeam

reverse.unfurledMediaItem()?​

optional unfurledMediaItem: (bot, payload) => DiscordUnfurledMediaItem

Parameters​
bot​

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

payload​

UnfurledMediaItem

Returns​

DiscordUnfurledMediaItem

reverse.user()?​

optional user: (bot, payload) => DiscordUser

Parameters​
bot​

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

payload​

SetupDesiredProps<User, TProps, TBehavior>

Returns​

DiscordUser

role()?​

optional role: (bot, payload, extra?) => SetupDesiredProps<Role, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordRole

extra?​
guildId?​

BigString

Returns​

SetupDesiredProps<Role, TProps, TBehavior>

roleColors()?​

optional roleColors: (bot, payload) => SetupDesiredProps<RoleColors, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordRoleColors

Returns​

SetupDesiredProps<RoleColors, TProps, TBehavior>

scheduledEvent()?​

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

Parameters​
bot​

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

payload​

DiscordScheduledEvent

Returns​

SetupDesiredProps<ScheduledEvent, TProps, TBehavior>

scheduledEventRecurrenceRule()?​

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

Parameters​
bot​

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

payload​

DiscordScheduledEventRecurrenceRule

Returns​

SetupDesiredProps<ScheduledEventRecurrenceRule, TProps, TBehavior>

sku()?​

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

Parameters​
bot​

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

payload​

DiscordSku

Returns​

SetupDesiredProps<Sku, TProps, TBehavior>

snowflake()?​

optional snowflake: (snowflake) => bigint

Parameters​
snowflake​

BigString

Returns​

bigint

soundboardSound()?​

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

Parameters​
bot​

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

payload​

DiscordSoundboardSound

Returns​

SetupDesiredProps<SoundboardSound, TProps, TBehavior>

stageInstance()?​

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

Parameters​
bot​

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

payload​

DiscordStageInstance

Returns​

SetupDesiredProps<StageInstance, TProps, TBehavior>

sticker()?​

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

Parameters​
bot​

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

payload​

DiscordSticker

Returns​

SetupDesiredProps<Sticker, 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, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordSubscription

Returns​

SetupDesiredProps<Subscription, 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, extra?) => ThreadMember

Parameters​
bot​

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

payload​

DiscordThreadMember

extra?​

ThreadMemberTransformerExtra

Returns​

ThreadMember

threadMemberGuildCreate()?​

optional threadMemberGuildCreate: (bot, payload) => ThreadMemberGuildCreate

Parameters​
bot​

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

payload​

DiscordThreadMemberGuildCreate

Returns​

ThreadMemberGuildCreate

unfurledMediaItem()?​

optional unfurledMediaItem: (bot, payload) => UnfurledMediaItem

Parameters​
bot​

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

payload​

DiscordUnfurledMediaItem

Returns​

UnfurledMediaItem

user()?​

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

Parameters​
bot​

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

payload​

DiscordUser

Returns​

SetupDesiredProps<User, TProps, TBehavior>

userPrimaryGuild()?​

optional userPrimaryGuild: (bot, payload) => SetupDesiredProps<UserPrimaryGuild, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordUserPrimaryGuild

Returns​

SetupDesiredProps<UserPrimaryGuild, TProps, TBehavior>

voiceRegion()?​

optional voiceRegion: (bot, payload) => VoiceRegion

Parameters​
bot​

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

payload​

DiscordVoiceRegion

Returns​

VoiceRegion

voiceState()?​

optional voiceState: (bot, payload, extra?) => SetupDesiredProps<VoiceState, TProps, TBehavior>

Parameters​
bot​

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

payload​

DiscordVoiceState

extra?​
guildId?​

BigString

Returns​

SetupDesiredProps<VoiceState, TProps, TBehavior>

webhook()?​

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

Parameters​
bot​

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

payload​

DiscordWebhook

Returns​

SetupDesiredProps<Webhook, 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