Class Message<InGuild>

Type Parameters

InGuild extends boolean = boolean

Hierarchy (View Summary)

Base
- Message

Properties

activity

activity: null | MessageActivity

applicationId

applicationId: null | string

attachments

attachments: Collection<string, Attachment>

author

author: User

call

call: null | MessageCall

channelId

channelId: string

`Readonly`client

client: Client<true>

components

components: TopLevelComponent[]

content

content: string

createdTimestamp

createdTimestamp: number

editedTimestamp

editedTimestamp: null | number

embeds

embeds: Embed[]

flags

flags: Readonly<MessageFlagsBitField>

groupActivityApplication

groupActivityApplication: null | ClientApplication

guildId

guildId: If<InGuild, string>

id

id: string

interaction

interaction: null | MessageInteraction

Deprecated

Use Message.interactionMetadata instead.

interactionMetadata

interactionMetadata: null | MessageInteractionMetadata

mentions

mentions: MessageMentions<InGuild>

messageSnapshots

messageSnapshots: Collection<string, MessageSnapshot>

nonce

nonce: null | string | number

pinned

pinned: boolean

poll

poll: null | Poll

position

position: null | number

reactions

reactions: ReactionManager

reference

reference: null | MessageReference

resolved

resolved: null | CommandInteractionResolvedData<CacheType>

roleSubscriptionData

roleSubscriptionData: null | RoleSubscriptionData

stickers

stickers: Collection<string, Sticker>

system

system: boolean

tts

tts: boolean

type

type: MessageType

webhookId

webhookId: null | string

Accessors

bulkDeletable

get bulkDeletable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:2389

channel

get channel(): If<InGuild, GuildTextBasedChannel, TextBasedChannel>
Returns If<InGuild, GuildTextBasedChannel, TextBasedChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:2390

cleanContent

get cleanContent(): string
Returns string
- Defined in node_modules/discord.js/typings/index.d.ts:2392

createdAt

get createdAt(): Date
Returns Date
- Defined in node_modules/discord.js/typings/index.d.ts:2395

crosspostable

get crosspostable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:2397

deletable

get deletable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:2398

editable

get editable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:2399

editedAt

get editedAt(): null | Date
Returns null | Date
- Defined in node_modules/discord.js/typings/index.d.ts:2400

guild

get guild(): If<InGuild, Guild>
Returns If<InGuild, Guild>
- Defined in node_modules/discord.js/typings/index.d.ts:2405

hasThread

get hasThread(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:2406

member

get member(): null | GuildMember
Returns null | GuildMember
- Defined in node_modules/discord.js/typings/index.d.ts:2411

partial

get partial(): false
Returns false
- Defined in node_modules/discord.js/typings/index.d.ts:2414

pinnable

get pinnable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:2415

thread

get thread(): null | AnyThreadChannel
Returns null | AnyThreadChannel
- Defined in node_modules/discord.js/typings/index.d.ts:2423

url

get url(): string
Returns string
- Defined in node_modules/discord.js/typings/index.d.ts:2428

Methods

awaitMessageComponent

awaitMessageComponent<ComponentType extends MessageComponentType>(
options?: AwaitMessageCollectorOptionsParams<ComponentType, InGuild>,
): Promise<MappedInteractionTypes<InGuild>[ComponentType]>
Type Parameters
- ComponentType extends MessageComponentType
Parameters
- Optionaloptions: AwaitMessageCollectorOptionsParams<ComponentType, InGuild>
Returns Promise<MappedInteractionTypes<InGuild>[ComponentType]>
- Defined in node_modules/discord.js/typings/index.d.ts:2433

awaitReactions

awaitReactions(
options?: AwaitReactionsOptions,
): Promise<Collection<string, MessageReaction>>
Parameters
- Optionaloptions: AwaitReactionsOptions
Returns Promise<Collection<string, MessageReaction>>
- Defined in node_modules/discord.js/typings/index.d.ts:2436

createMessageComponentCollector

createMessageComponentCollector<ComponentType extends MessageComponentType>(
options?: MessageCollectorOptionsParams<ComponentType, InGuild>,
): InteractionCollector<MappedInteractionTypes<InGuild>[ComponentType]>
Type Parameters
- ComponentType extends MessageComponentType
Parameters
- Optionaloptions: MessageCollectorOptionsParams<ComponentType, InGuild>
Returns InteractionCollector<MappedInteractionTypes<InGuild>[ComponentType]>
- Defined in node_modules/discord.js/typings/index.d.ts:2438

createReactionCollector

createReactionCollector(options?: ReactionCollectorOptions): ReactionCollector
Parameters
- Optionaloptions: ReactionCollectorOptions
Returns ReactionCollector
- Defined in node_modules/discord.js/typings/index.d.ts:2437

crosspost

crosspost(): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2448

delete

delete(): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2441

edit

edit(
content: string | MessagePayload | MessageEditOptions,
): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Parameters
- content: string | MessagePayload | MessageEditOptions
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2442

equals

equals(message: Message, rawData: unknown): boolean
Parameters
- message: Message
- rawData: unknown
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:2445

fetch

fetch(force?: boolean): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Parameters
- Optionalforce: boolean
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2449

fetchReference

fetchReference(): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2446

fetchWebhook

fetchWebhook(): Promise<Webhook<WebhookType>>
Returns Promise<Webhook<WebhookType>>
- Defined in node_modules/discord.js/typings/index.d.ts:2447

forward

forward(
    channel:
        | string
        | DMChannel
        | PartialDMChannel
        | NewsChannel
        | StageChannel
        | TextChannel
        | PublicThreadChannel<boolean>
        | PrivateThreadChannel
        | VoiceChannel,
): Promise<Message<boolean>>
Parameters
- channel:
      | string
      | DMChannel
      | PartialDMChannel
      | NewsChannel
      | StageChannel
      | TextChannel
      | PublicThreadChannel<boolean>
      | PrivateThreadChannel
      | VoiceChannel
Returns Promise<Message<boolean>>
- Defined in node_modules/discord.js/typings/index.d.ts:2456

inGuild

inGuild(): this is Message<true>
Returns this is Message<true>
- Defined in node_modules/discord.js/typings/index.d.ts:2463

pin

pin(reason?: string): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Parameters
- Optionalreason: string
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2450

react

react(emoji: EmojiIdentifierResolvable): Promise<MessageReaction>
Parameters
- emoji: EmojiIdentifierResolvable
Returns Promise<MessageReaction>
- Defined in node_modules/discord.js/typings/index.d.ts:2451

removeAttachments

removeAttachments(): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2452

reply

reply(
options: string | MessagePayload | MessageReplyOptions,
): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Parameters
- options: string | MessagePayload | MessageReplyOptions
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2453

resolveComponent

resolveComponent(customId: string): null | MessageActionRowComponent
Parameters
- customId: string
Returns null | MessageActionRowComponent
- Defined in node_modules/discord.js/typings/index.d.ts:2457

startThread

startThread(options: StartThreadOptions): Promise<PublicThreadChannel<false>>
Parameters
- options: StartThreadOptions
Returns Promise<PublicThreadChannel<false>>
- Defined in node_modules/discord.js/typings/index.d.ts:2458

suppressEmbeds

suppressEmbeds(
suppress?: boolean,
): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Parameters
- Optionalsuppress: boolean
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2459

toJSON

toJSON(): unknown
Returns unknown
Overrides Base.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:2460

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in node_modules/discord.js/typings/index.d.ts:2461

unpin

unpin(reason?: string): Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
Parameters
- Optionalreason: string
Returns Promise<OmitPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2462

valueOf

valueOf(): string
Returns string
Inherited from Base.valueOf
- Defined in node_modules/discord.js/typings/index.d.ts:561