whatsapp-web.js
A WhatsApp API client that connects through the WhatsApp Web browser app
It uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocked.
@@ -84,7 +84,7 @@ client.initialize();diff --git a/docs/Base.html b/docs/Base.html index b86f4fb..ae45336 100644 --- a/docs/Base.html +++ b/docs/Base.html @@ -4,7 +4,7 @@
-Indicates if the Chat is archived
+ID that represents the chat
@@ -127,8 +151,33 @@Archives this chat
+Clears all messages from the chat
+Promise containing Boolean
result
+ +Deletes the chat
+Promise containing Boolean
result
+ +Send a message to this chat
@@ -180,6 +229,11 @@ +un-archives this chat
+Enables and returns the archive state of the Chat
+boolean
Closes the client
Gets the current connection state for the client
+Sets up events and requirements, kicks off authentication request
Changes and returns the archive state of the Chat
+boolean
Emitted when an ack event occurrs on message type.
+| Name | +Type | +Optional | +Description | +
|---|---|---|---|
|
+ message + |
+ + + | +
+ + |
+
+ The message that was affected + |
+
|
+ ack + |
+ + + | +
+ + |
+
+ The new ACK value + |
+
Emitted when a new message is created, which may include the current user's own messages.
Indicates if the Chat is archived
+Gets the date at which the group was created
@@ -314,6 +336,35 @@Archives this chat
+Clears all messages from the chat
+result
+Deletes the chat
+result
+Demotes participants by IDs to regular users
un-archives this chat
+Deletes a message from the chat
+| Name | +Type | +Optional | +Description | +
|---|---|---|---|
|
+ everyone + |
+
+ boolean + |
+
+ + |
+
+ If true and the message is sent by the current user, will delete it for everyone in the chat. +Value can be null. + |
+
Downloads and returns the attatched message media
@@ -333,7 +371,7 @@ diff --git a/docs/MessageMedia.html b/docs/MessageMedia.html index 9ffca38..af2551f 100644 --- a/docs/MessageMedia.html +++ b/docs/MessageMedia.html @@ -4,7 +4,7 @@ -Indicates if the Chat is archived
+ID that represents the chat
@@ -139,8 +165,37 @@Archives this chat
+Clears all messages from the chat
+result
+Deletes the chat
+result
+Send a message to this chat
@@ -193,6 +248,13 @@Message that was just sent
+un-archives this chat
+MESSAGE_ACK
++
+
QR_RECEIVED
@@ -273,6 +289,105 @@Message ACK
+| Name | +Type | +Optional | +Description | +
|---|---|---|---|
|
+ ACK_ERROR + |
+
+ + |
+
+ + |
+ + | +
|
+ ACK_PENDING + |
+
+ + |
+
+ + |
+ + | +
|
+ ACK_SERVER + |
+
+ + |
+
+ + |
+ + | +
|
+ ACK_DEVICE + |
+
+ + |
+
+ + |
+ + | +
|
+ ACK_READ + |
+
+ + |
+
+ + |
+ + | +
|
+ ACK_PLAYED + |
+
+ + |
+
+ + |
+ + | +
Message types
@@ -696,7 +811,7 @@ diff --git a/docs/index.html b/docs/index.html index 3825079..196bda4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,7 +4,7 @@ -