Class MessageContext

Hierarchy (view full)

CommandContext
- MessageContext

Constructors

constructor

new MessageContext(context, args?): MessageContext
Parameters
- context: Message<boolean>
- 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<boolean>

Accessors

activity

get activity(): null | MessageActivity
Returns null | MessageActivity
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:28

applicationId

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

attachments

get attachments(): Collection<string, Attachment>
Returns Collection<string, Attachment>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:32

author

get author(): User
Returns User
Inherited from CommandContext.author
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:27

channel

get channel(): null | TextBasedChannel
Returns null | TextBasedChannel
Inherited from CommandContext.channel
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:31

channelId

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

client

get client(): Client<true>
Returns Client<true>
Inherited from CommandContext.client
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:39

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 CommandContext.createdAt
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:43

createdTimestamp

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

editedTimestamp

get editedTimestamp(): null | number
Returns null | number
- 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(): null | ClientApplication
Returns null | ClientApplication
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:52

guild

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

guildId

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

id

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

interaction

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

member

get member(): null | GuildMember | APIInteractionGuildMember
Returns null | GuildMember | APIInteractionGuildMember
Inherited from CommandContext.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(): null | string | number
Returns null | string | number
- 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(): null | Poll
Returns null | Poll
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:100

position

get position(): null | number
Returns null | number
- 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(): null | MessageReference
Returns null | MessageReference
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:112

resolved

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

roleSubscriptionData

get roleSubscriptionData(): null | RoleSubscriptionData
Returns null | RoleSubscriptionData
- 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 CommandContext.type
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:67

webhookId

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

Methods

awaitMessageComponent

awaitMessageComponent<ComponentType>(options?): 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?): 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>(options?): 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?): 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): 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, rawData): boolean
Parameters
- message: Message<boolean>
- rawData: unknown
Returns boolean
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:146

fetch

fetch(force?): 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

pin(reason?): 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): 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): 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): null | MessageActionRowComponent
Parameters
- customId: string
Returns null | MessageActionRowComponent
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:178

send

send(options): 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): Promise<PublicThreadChannel<false>>
Parameters
- options: StartThreadOptions
Returns Promise<PublicThreadChannel<false>>
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:182

suppressEmbeds

suppressEmbeds(suppress?): 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): unknown
Parameters
- Rest...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?): 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