Class: Message

Defined in: structures/Message.ts:17

A WhatsApp message with a convenient API on top of the raw Baileys object (accessible via raw for advanced cases).

Constructors

Constructor

new Message(client, raw): Message

Defined in: structures/Message.ts:18

Parameters

client

Client

raw

WAMessage

Returns

Message

Properties

raw

readonly raw: WAMessage

Defined in: structures/Message.ts:20

Accessors

body

Get Signature

get body(): string

Defined in: structures/Message.ts:68

Readable message text (caption included).

Returns

string

---

chatId

Get Signature

get chatId(): string

Defined in: structures/Message.ts:29

JID of the originating chat (user or group; may be a LID).

Returns

string

---

chatIdAlt

Get Signature

get chatIdAlt(): string | undefined

Defined in: structures/Message.ts:34

Alternative chat JID (PN if chatId is a LID).

Returns

string | undefined

---

fromMe

Get Signature

get fromMe(): boolean

Defined in: structures/Message.ts:39

Did I send it?

Returns

boolean

---

hasMedia

Get Signature

get hasMedia(): boolean

Defined in: structures/Message.ts:83

Does it carry downloadable media?

Returns

boolean

---

id

Get Signature

get id(): string

Defined in: structures/Message.ts:24

Unique message ID.

Returns

string

---

isGroup

Get Signature

get isGroup(): boolean

Defined in: structures/Message.ts:44

Does it come from a group?

Returns

boolean

---

notifyName

Get Signature

get notifyName(): string | undefined

Defined in: structures/Message.ts:73

Sender's display name (pushName), if present.

Returns

string | undefined

---

sender

Get Signature

get sender(): Sender

Defined in: structures/Message.ts:49

Identity of whoever sent it (LID/PN-aware).

Returns

Sender

---

timestamp

Get Signature

get timestamp(): number

Defined in: structures/Message.ts:62

Timestamp (epoch seconds).

Returns

number

---

type

Get Signature

get type(): string | undefined

Defined in: structures/Message.ts:78

Content type (conversation, imageMessage, …).

Returns

string | undefined

Methods

delete()

delete(): Promise<void>

Defined in: structures/Message.ts:121

Deletes this message for everyone.

Returns

Promise<void>

---

downloadMedia()

downloadMedia(): Promise<Buffer<ArrayBufferLike>>

Defined in: structures/Message.ts:101

Downloads the message media as a Buffer. Throws if there is no media.

Returns

Promise<Buffer<ArrayBufferLike>>

---

edit()

edit(newText): Promise<Message>

Defined in: structures/Message.ts:131

Edits this message. Only works for your own messages.

Parameters

newText

string

Returns

Promise<Message>

---

forward()

forward(to): Promise<Message>

Defined in: structures/Message.ts:126

Forwards this message to another chat.

Parameters

to

string

Returns

Promise<Message>

---

markRead()

markRead(): Promise<void>

Defined in: structures/Message.ts:116

Marks the chat as read up to this message.

Returns

Promise<void>

---

react()

react(emoji): Promise<void>

Defined in: structures/Message.ts:96

React to this message with an emoji (empty string to remove).

Parameters

emoji

string

Returns

Promise<void>

---

reply()

reply(content, options?): Promise<Message>

Defined in: structures/Message.ts:88

Reply to this message by quoting it.

Parameters

content

string | AnyMessageContent

options?

MiscMessageGenerationOptions = {}

Returns

Promise<Message>