Class Message<InGuild>

Type Parameters

InGuild extends boolean = boolean

Hierarchy

Base
- Message

Constructors

`Private` constructor

new Message<InGuild>(client, data): Message<InGuild>
Type Parameters
- InGuild extends boolean = boolean
Parameters
- client: Client<true>
- data: APIMessage
Returns Message<InGuild>
Overrides Base.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:2137

Properties

`Private` `Readonly` _cacheType

_cacheType: InGuild

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: ActionRow<MessageActionRowComponent>[]

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, null>

id

id: string

interaction

interaction: null | MessageInteraction

Deprecated

Use interactionMetadata instead.

interactionMetadata

interactionMetadata: null | MessageInteractionMetadata

mentions

mentions: MessageMentions<InGuild>

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

channel

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

cleanContent

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

createdAt

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

crosspostable

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

deletable

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

editable

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

editedAt

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

guild

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

hasThread

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

member

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

partial

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

pinnable

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

thread

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

url

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

Methods

`Private` _patch

_patch(data): void
Parameters
- data: APIMessage | GatewayMessageUpdateDispatchData
Returns void
- Defined in node_modules/discord.js/typings/index.d.ts:2138

awaitMessageComponent

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

awaitReactions

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

createMessageComponentCollector

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

createReactionCollector

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

crosspost

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

delete

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

edit

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

equals

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

fetch

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

fetchReference

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

fetchWebhook

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

inGuild

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

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

react

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

removeAttachments

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

reply

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

resolveComponent

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

startThread

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

suppressEmbeds

suppressEmbeds(suppress?): Promise<NonPartialGroupDMChannel<Message<InGuild>>>
Parameters
- Optional suppress: boolean
Returns Promise<NonPartialGroupDMChannel<Message<InGuild>>>
- Defined in node_modules/discord.js/typings/index.d.ts:2212

toJSON

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

toString

toString(): string
Returns string
- Defined in node_modules/discord.js/typings/index.d.ts:2214

unpin

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

valueOf

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

Class Message<InGuild>

Type Parameters

InGuild extends boolean = boolean

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Type Parameters

InGuild extends boolean = boolean

Parameters

client: Client<true>

data: APIMessage

Returns Message<InGuild>

Properties

Private Readonly _cacheType

activity

applicationId

attachments

author

call

channelId

Readonly client

components

content

createdTimestamp

editedTimestamp

embeds

flags

groupActivityApplication

guildId

id

interaction

Deprecated

interactionMetadata

mentions

nonce

pinned

poll

position

reactions

reference

resolved

roleSubscriptionData

stickers

system

tts

type

webhookId

Accessors

bulkDeletable

Returns boolean

channel

Returns If<InGuild, GuildTextBasedChannel, TextBasedChannel>

cleanContent

Returns string

createdAt

Returns Date

crosspostable

Returns boolean

deletable

Returns boolean

editable

Returns boolean

editedAt

Returns null | Date

guild

Returns If<InGuild, Guild, null>

hasThread

Returns boolean

member

Returns null | GuildMember

partial

Returns false

pinnable

Returns boolean

thread

`Private` constructor

`Private` `Readonly` _cacheType

`Readonly` client

`Private` _patch

`Optional` options: AwaitMessageCollectorOptionsParams<ComponentType, InGuild>

`Optional` options: AwaitReactionsOptions

`Optional` options: MessageCollectorOptionsParams<ComponentType, InGuild>

`Optional` options: ReactionCollectorOptions

`Optional` force: boolean

`Optional` reason: string