Chat
Source: Structures/
Represents a Chat on WhatsApp
Properties
new Chat()
- Extends
- Base
Properties
archived boolean
Indicates if the Chat is archived
id object
ID that represents the chat
isGroup boolean
Indicates if the Chat is a Group Chat
isMuted boolean
Indicates if the chat is muted or not
isReadOnly boolean
Indicates if the Chat is readonly
lastMessage Message
Last message fo chat
muteExpiration number
Unix timestamp for when the mute expires
name string
Title of the chat
pinned boolean
Indicates if the Chat is pinned
timestamp number
Unix timestamp for when the last activity occurred
unreadCount number
Amount of messages unread
Methods
archive()
Archives this chat
changeLabels(labelIds) → Promise containing void
Add or remove labels to this Chat
Parameter
Name | Type | Optional | Description |
---|---|---|---|
labelIds |
Array of (number or string) |
|
- Returns
-
Promise containing void
clearMessages() → Promise containing Boolean
Clears all messages from the chat
- Returns
-
Promise containing Boolean
result
clearState()
Stops typing or recording in chat immediately.
delete() → Promise containing Boolean
Deletes the chat
- Returns
-
Promise containing Boolean
result
fetchMessages(searchOptions) → Promise containing Array of Message
Loads chat messages, sorted from earliest to latest.
Parameters
Name | Type | Optional | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searchOptions |
Object |
|
Options for searching messages. Right now only limit and fromMe is supported. Values in
|
- Returns
-
Promise containing Array of Message
getContact() → Promise containing Contact
Returns the Contact that corresponds to this Chat.
- Returns
-
Promise containing Contact
getLabels() → Promise containing Array of Label
Returns array of all Labels assigned to this Chat
- Returns
-
Promise containing Array of Label
markUnread()
Mark this chat as unread
mute(unmuteDate)
Mutes this chat forever, unless a date is specified
Parameter
Name | Type | Optional | Description |
---|---|---|---|
unmuteDate |
Date |
|
Date at which the Chat will be unmuted, leave as is to mute forever Value can be null. |
pin() → Promise containing boolean
Pins this chat
- Returns
-
Promise containing boolean
New pin state. Could be false if the max number of pinned chats was reached.
sendMessage(content[, options]) → Promise containing Message
Send a message to this chat
Parameters
Name | Type | Optional | Description |
---|---|---|---|
content |
(string, MessageMedia, or Location) |
|
|
options |
Yes |
- Returns
-
Promise containing Message
Message that was just sent
sendSeen() → Promise containing Boolean
Set the message as seen
- Returns
-
Promise containing Boolean
result
sendStateRecording()
Simulate recording audio in chat. This will last for 25 seconds.
sendStateTyping()
Simulate typing in chat. This will last for 25 seconds.
unarchive()
un-archives this chat
unmute()
Unmutes this chat
unpin() → Promise containing boolean
Unpins this chat
- Returns
-
Promise containing boolean
New pin state