Class MessageContext

Hierarchy (view full)

CommandContext
- MessageContext

Index

Constructors

Properties

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:40

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:47

applicationId

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

attachments

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

author

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

bulkDeletable

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

channel

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

channelId

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

cleanContent

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

client

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

components

get components(): ActionRow<MessageActionRowComponent>[]
Returns ActionRow<MessageActionRowComponent>[]
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:63

content

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

createdAt

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

createdTimestamp

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

crosspostable

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

deletable

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

editable

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

editedAt

get editedAt(): null | Date
Returns null | Date
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:83

editedTimestamp

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

embeds

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

flags

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

groupActivityApplication

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

guild

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

guildId

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

hasThread

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

id

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

interaction

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

member

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

mentions

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

nonce

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

partial

get partial(): false
Returns false
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:115

pinnable

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

pinned

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

poll

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

position

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

reactions

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

reference

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

resolved

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

roleSubscriptionData

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

stickers

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

system

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

thread

get thread(): null | AnyThreadChannel
Returns null | AnyThreadChannel
- Defined in packages/command-context/src/lib/structures/MessageContext.ts:151

tts

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

type

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

url

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

webhookId

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

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:179

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:185

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:195

createReactionCollector

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

crosspost

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

delete

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

edit

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

equals

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

fetch

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

fetchReference

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

fetchWebhook

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

inGuild

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

isChatInputInteractionContext

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

isCommandInteraction

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

isMessageContext

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

isMessageContextMenuInteractionContext

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

isUserContextMenuInteractionContext

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

pin

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

react

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

removeAttachments

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

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:126

resolveComponent

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

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:105

startThread

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

suppressEmbeds

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

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:73

toString

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

unpin

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

valueOf

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