docs/PrivateChat.html
isMutedisReadOnlylastMessagemuteExpiration
namepinnedtimestampunreadCount
addOrEditCustomerNote(note)archive()changeLabels(labelIds)clearMessages()clearState()delete()fetchMessages(searchOptions)getContact()
getCustomerNote()getLabels()getPinnedMessages()markUnread()mute(unmuteDate)pin()sendMessage(content[, options])sendSeen()
sendStateRecording()sendStateTyping()syncHistory()unarchive()unmute()unpin()
ExtendsChat
Indicates if the Chat is archived
Inherited fromChat#archived
ID that represents the chat
Inherited fromChat#id
Indicates if the Chat is a Group Chat
Inherited fromChat#isGroup
Indicates if the Chat is locked
Inherited fromChat#isLocked
Indicates if the chat is muted or not
Inherited fromChat#isMuted
Indicates if the Chat is readonly
Inherited fromChat#isReadOnly
Last message fo chat
Inherited fromChat#lastMessage
Unix timestamp for when the mute expires
Inherited fromChat#muteExpiration
Title of the chat
Inherited fromChat#name
Indicates if the Chat is pinned
Inherited fromChat#pinned
Unix timestamp for when the last activity occurred
Inherited fromChat#timestamp
Amount of messages unread
Inherited fromChat#unreadCount
async
Add or edit a customer note
| Name | Type | Optional | Description |
|---|---|---|---|
note
|
|
|
The note to add
|
Inherited fromChat#addOrEditCustomerNoteSee alsohttps://faq.whatsapp.com/1433099287594476Returns async
Archives this chat
Inherited fromChat#archive async
Add or remove labels to this Chat
| Name | Type | Optional | Description |
|---|---|---|---|
labelIds
|
|
| |
Inherited fromChat#changeLabelsReturns async
Clears all messages from the chat
Inherited fromChat#clearMessagesReturns
result
async
Stops typing or recording in chat immediately.
Inherited fromChat#clearState async
Deletes the chat
Inherited fromChat#deleteReturns
result
async
Loads chat messages, sorted from earliest to latest.
| Name | Type | Optional | Description |
|---|---|---|---|
searchOptions
|
|
|
Options for searching messages. Right now only limit and fromMe is supported.
Values in searchOptions have the following properties:
| Name | Type | Optional | Description |
|---|---|---|---|
limit
|
|
Yes
|
The amount of messages to return. If no limit is specified, the available messages will be returned. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.
| |
fromMe
|
|
Yes
|
Return only messages from the bot number or vise versa. To get all messages, leave the option undefined.
|
|
Inherited fromChat#fetchMessagesReturns async
Returns the Contact that corresponds to this Chat.
Inherited fromChat#getContactReturns async
Get a customer note
Inherited fromChat#getCustomerNoteSee alsohttps://faq.whatsapp.com/1433099287594476Returns async
Returns array of all Labels assigned to this Chat
Inherited fromChat#getLabelsReturns async
Gets instances of all pinned messages in a chat
Inherited fromChat#getPinnedMessagesReturns async
Mark this chat as unread
Inherited fromChat#markUnread async
Mutes this chat forever, unless a date is specified
| Name | Type | Optional | Description |
|---|---|---|---|
unmuteDate
|
|
|
Date when the chat will be unmuted, don't provide a value to mute forever
Value can be null.
|
Inherited fromChat#muteReturns async
Pins this chat
Inherited fromChat#pinReturns
New pin state. Could be false if the max number of pinned chats was reached.
async
Send a message to this chat
| Name | Type | Optional | Description |
|---|---|---|---|
content
|
|
| | |
options
|
|
Yes
| |
Inherited fromChat#sendMessageReturns
Message that was just sent
async
Sets the chat as seen
Inherited fromChat#sendSeenReturns
result
async
Simulate recording audio in chat. This will last for 25 seconds.
Inherited fromChat#sendStateRecording async
Simulate typing in chat. This will last for 25 seconds.
Inherited fromChat#sendStateTyping async
Sync chat history conversation
Inherited fromChat#syncHistoryReturns
True if operation completed successfully, false otherwise.
async
un-archives this chat
Inherited fromChat#unarchive async
Unmutes this chat
Inherited fromChat#unmuteReturns async
Unpins this chat
Inherited fromChat#unpinReturns
New pin state