Class MessageContext

Hierarchy (View Summary)

CommandContext
- MessageContext

Constructors

constructor

new MessageContext(context: Message, args?: Args): MessageContext
Parameters
- context: Message
- Optionalargs: Args
Returns MessageContext
Overrides CommandContext.constructor
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:21

Properties

`Optional` `Readonly`args

args?: Args

`Readonly`context

context: Message

Accessors

components

get components(): TopLevelComponent[]
Returns TopLevelComponent[]
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:36

content

get content(): string
Returns string
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:40

createdAt

get createdAt(): Date
Returns Date
Inherited from ChatInputCommandInteractionContext.createdAt
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:43

createdTimestamp

get createdTimestamp(): number
Returns number
Inherited from ChatInputCommandInteractionContext.createdTimestamp
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:47

editedTimestamp

get editedTimestamp(): number | null
Returns number | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:44

embeds

get embeds(): Embed[]
Returns Embed[]
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:48

flags

get flags(): Readonly<MessageFlagsBitField>
Returns Readonly<MessageFlagsBitField>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:108

groupActivityApplication

get groupActivityApplication(): ClientApplication | null
Returns ClientApplication | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:52

guild

get guild(): Guild | null
Returns Guild | null
Inherited from ChatInputCommandInteractionContext.guild
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:51

guildId

get guildId(): string | null
Returns string | null
Inherited from ChatInputCommandInteractionContext.guildId
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:55

id

get id(): string
Returns string
Inherited from ChatInputCommandInteractionContext.id
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:59

interaction

get interaction(): MessageInteractionMetadata | null
Returns MessageInteractionMetadata | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:56

member

get member(): GuildMember | APIInteractionGuildMember | null
Returns GuildMember | APIInteractionGuildMember | null
Inherited from ChatInputCommandInteractionContext.member
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:63

mentions

get mentions(): MessageMentions<boolean>
Returns MessageMentions<boolean>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:60

nonce

get nonce(): string | number | null
Returns string | number | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:64

pinned

get pinned(): boolean
Returns boolean
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:68

poll

get poll(): Poll | null
Returns Poll | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:100

position

get position(): number | null
Returns number | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:80

reactions

get reactions(): ReactionManager
Returns ReactionManager
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:72

reference

get reference(): MessageReference | null
Returns MessageReference | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:112

resolved

get resolved(): CommandInteractionResolvedData<CacheType> | null
Returns CommandInteractionResolvedData<CacheType> | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:88

roleSubscriptionData

get roleSubscriptionData(): RoleSubscriptionData | null
Returns RoleSubscriptionData | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:84

stickers

get stickers(): Collection<string, Sticker>
Returns Collection<string, Sticker>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:76

system

get system(): boolean
Returns boolean
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:92

tts

get tts(): boolean
Returns boolean
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:96

type

get type(): ApplicationCommand | MessageType
Returns ApplicationCommand | MessageType
Inherited from ChatInputCommandInteractionContext.type
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:67

webhookId

get webhookId(): string | null
Returns string | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:104

Methods

awaitMessageComponent

awaitMessageComponent<ComponentType extends MessageComponentType>(
options?: AwaitMessageCollectorOptionsParams<ComponentType, boolean>,
): Promise<MappedInteractionTypes<boolean>[ComponentType]>
Type Parameters
- ComponentType extends MessageComponentType
Parameters
- Optionaloptions: AwaitMessageCollectorOptionsParams<ComponentType, boolean>
Returns Promise<MappedInteractionTypes<boolean>[ComponentType]>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:116

awaitReactions

awaitReactions(
options?: AwaitReactionsOptions,
): Promise<Collection<string, MessageReaction>>
Parameters
- Optionaloptions: AwaitReactionsOptions
Returns Promise<Collection<string, MessageReaction>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:122

createMessageComponentCollector

createMessageComponentCollector<ComponentType extends MessageComponentType>(
options?: MessageCollectorOptionsParams<ComponentType, boolean>,
): InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>
Type Parameters
- ComponentType extends MessageComponentType
Parameters
- Optionaloptions: MessageCollectorOptionsParams<ComponentType, boolean>
Returns InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:132

createReactionCollector

createReactionCollector(options?: ReactionCollectorOptions): ReactionCollector
Parameters
- Optionaloptions: ReactionCollectorOptions
Returns ReactionCollector
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:128

crosspost

crosspost(): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:158

delete

delete(): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:138

edit

edit(
content: string | MessageEditOptions | MessagePayload,
): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Parameters
- content: string | MessageEditOptions | MessagePayload
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:142

equals

equals(message: Message, rawData: unknown): boolean
Parameters
- message: Message
- rawData: unknown
Returns boolean
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:146

fetch

fetch(force?: boolean): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Parameters
- Optionalforce: boolean
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:162

fetchReference

fetchReference(): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:150

fetchWebhook

fetchWebhook(): Promise<Webhook<WebhookType>>
Returns Promise<Webhook<WebhookType>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:154

inGuild

inGuild(): boolean
Returns boolean
Inherited from CommandContext.inGuild
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:71

isChatInputInteractionContext

isChatInputInteractionContext(): this is ChatInputCommandInteractionContext
Returns this is ChatInputCommandInteractionContext
Inherited from CommandContext.isChatInputInteractionContext
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:95

isCommandInteraction

isCommandInteraction(): this is CommandInteractionContext
Returns this is CommandInteractionContext
Inherited from CommandContext.isCommandInteraction
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:91

isMessageContext

isMessageContext(): this is MessageContext
Returns this is MessageContext
Inherited from CommandContext.isMessageContext
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:87

isMessageContextMenuInteractionContext

isMessageContextMenuInteractionContext(): this is MessageContextMenuCommandInteractionContext
Returns this is MessageContextMenuCommandInteractionContext
Inherited from CommandContext.isMessageContextMenuInteractionContext
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:103

isUserContextMenuInteractionContext

isUserContextMenuInteractionContext(): this is UserContextMenuCommandInteractionContext
Returns this is UserContextMenuCommandInteractionContext
Inherited from CommandContext.isUserContextMenuInteractionContext
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:99

pin(reason?: string): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Parameters
- Optionalreason: string
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:166

react

react(emoji: EmojiIdentifierResolvable): Promise<MessageReaction>
Parameters
- emoji: EmojiIdentifierResolvable
Returns Promise<MessageReaction>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:170

removeAttachments

removeAttachments(): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:174

reply

reply(options: string | MessagePayloadOption): Promise<Message<boolean>>
Parameters
- options: string | MessagePayloadOption
Returns Promise<Message<boolean>>
Inherited from CommandContext.reply
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:130

resolveComponent

resolveComponent(customId: string): MessageActionRowComponent | null
Parameters
- customId: string
Returns MessageActionRowComponent | null
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:178

send

send(options: string | MessagePayloadOption): Promise<Message<boolean>>
Parameters
- options: string | MessagePayloadOption
Returns Promise<Message<boolean>>
Inherited from CommandContext.send
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:107

startThread

startThread(options: StartThreadOptions): Promise<PublicThreadChannel<false>>
Parameters
- options: StartThreadOptions
Returns Promise<PublicThreadChannel<false>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:182

suppressEmbeds

suppressEmbeds(
suppress?: boolean,
): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Parameters
- Optionalsuppress: boolean
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:186

toJSON

toJSON(...props: Record<string, string | boolean>[]): unknown
Parameters
- ...props: Record<string, string | boolean>[]
Returns unknown
Inherited from CommandContext.toJSON
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:75

toString

toString(): string
Returns string
Inherited from CommandContext.toString
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:79

unpin

unpin(reason?: string): Promise<OmitPartialGroupDMChannel<Message<boolean>>>
Parameters
- Optionalreason: string
Returns Promise<OmitPartialGroupDMChannel<Message<boolean>>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:190

valueOf

valueOf(): string
Returns string
Inherited from CommandContext.valueOf
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:83

Class MessageContext

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MessageContext

Properties

Optional Readonlyargs

Readonlycontext

Accessors

activity

Returns MessageActivity | null

applicationId

Returns string | null

attachments

Returns Collection<string, Attachment>

author

Returns User

channel

Returns TextBasedChannel | null

channelId

Returns string

client

Returns Client<true>

components

Returns TopLevelComponent[]

content

Returns string

createdAt

Returns Date

createdTimestamp

Returns number

editedTimestamp

Returns number | null

embeds

Returns Embed[]

flags

Returns Readonly<MessageFlagsBitField>

groupActivityApplication

Returns ClientApplication | null

guild

Returns Guild | null

guildId

Returns string | null

id

Returns string

interaction

Returns MessageInteractionMetadata | null

member

Returns GuildMember | APIInteractionGuildMember | null

mentions

Returns MessageMentions<boolean>

nonce

Returns string | number | null

pinned

Returns boolean

poll

Returns Poll | null

position

Returns number | null

reactions

Returns ReactionManager

reference

Returns MessageReference | null

resolved

Returns CommandInteractionResolvedData<CacheType> | null

roleSubscriptionData

Returns RoleSubscriptionData | null

stickers

Returns Collection<string, Sticker>

system

Returns boolean

tts

Returns boolean

type

`Optional` `Readonly`args

`Readonly`context