chore(): generate docs

2025-08-08 21:39:18 +00:00 · 2025-08-08 21:39:18 +00:00 · 30b3f5e82e
commit 30b3f5e82e
parent b296ea8d5a
77 changed files with 1732 additions and 368 deletions
--- a/docs/index.html
+++ b/docs/index.html
@ -3,7 +3,7 @@
        <head>
                <meta name="generator" content="JSDoc 3.6.11">
                <meta charset="utf-8">
-        <title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Home</title>
+        <title>whatsapp-web.js 1.32.0 &raquo; Home</title>
                <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
                <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
                <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -13,7 +13,7 @@
                <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
    <div id="jsdoc-navbar-container">
        <div id="jsdoc-navbar-content">
-            <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>31.<wbr>1-alpha.<wbr>0</a>
+            <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>32.<wbr>0</a>
        </div>
    </div>
 </nav>
@ -26,7 +26,7 @@
                                        <div id="jsdoc-main" role="main">
                <header class="page-header">
        <h1>
-            whatsapp-web.js 1.31.1-alpha.0
+            whatsapp-web.js 1.32.0
        </h1>
    </header>

@ -882,7 +882,7 @@ limitations under the License.</p></article>
            <dd>
            </dd>
            <dt class="symbol-index-name">
-                <a href="Chat.html#id" class="!symbol-index-name">Chat#<wbr>id</a>
+                <a href="Chat.html#getPinnedMessages" class="!symbol-index-name">Chat#<wbr>getPinnedMessages()</a>
            </dt>
            <dd>
            </dd>
@ -891,6 +891,11 @@ limitations under the License.</p></article>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Chat.html#id" class="!symbol-index-name">Chat#<wbr>id</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Chat.html#isGroup" class="!symbol-index-name">Chat#<wbr>isGroup</a>
            </dt>
@ -941,16 +946,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-            <dt class="symbol-index-name">
-                <a href="Chat.html#sendMessage" class="!symbol-index-name">Chat#<wbr>sendMessage(content[, options])</a>
-            </dt>
-            <dd>
-            </dd>
    </dl>
 </div>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Chat.html#sendMessage" class="!symbol-index-name">Chat#<wbr>sendMessage(content[, options])</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Chat.html#sendSeen" class="!symbol-index-name">Chat#<wbr>sendSeen()</a>
            </dt>
@ -1090,6 +1095,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#createCallLink" class="!symbol-index-name">Client#<wbr>createCallLink(startTime, callType)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#createChannel" class="!symbol-index-name">Client#<wbr>createChannel(title, options)</a>
            </dt>
@ -1155,6 +1165,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#event:code" class="!symbol-index-name">Client#<wbr>event:code</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#event:contact_changed" class="!symbol-index-name">Client#<wbr>event:contact_changed</a>
            </dt>
@ -1315,6 +1330,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#getContactLidAndPhone" class="!symbol-index-name">Client#<wbr>getContactLidAndPhone(userIds)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#getContacts" class="!symbol-index-name">Client#<wbr>getContacts()</a>
            </dt>
@ -1355,6 +1375,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#getPinnedMessages" class="!symbol-index-name">Client#<wbr>getPinnedMessages(chatId)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#getProfilePicUrl" class="!symbol-index-name">Client#<wbr>getProfilePicUrl(contactId)</a>
            </dt>
@ -1431,7 +1456,7 @@ limitations under the License.</p></article>
            <dd>
            </dd>
            <dt class="symbol-index-name">
-                <a href="Client.html#requestPairingCode" class="!symbol-index-name">Client#<wbr>requestPairingCode(phoneNumber, showNotification)</a>
+                <a href="Client.html#requestPairingCode" class="!symbol-index-name">Client#<wbr>requestPairingCode(phoneNumber[, showNotification][, intervalMs])</a>
            </dt>
            <dd>
            </dd>
@ -1480,6 +1505,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#sendResponseToScheduledEvent" class="!symbol-index-name">Client#<wbr>sendResponseToScheduledEvent(response, eventMessageId)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#sendSeen" class="!symbol-index-name">Client#<wbr>sendSeen(chatId)</a>
            </dt>
@ -1786,6 +1816,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="global.html#Events#.CODE_RECEIVED" class="!symbol-index-name">Events.<wbr>CODE_RECEIVED</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="global.html#Events#.CONTACT_CHANGED" class="!symbol-index-name">Events.<wbr>CONTACT_CHANGED</a>
            </dt>
@ -1806,16 +1841,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-            <dt class="symbol-index-name">
-                <a href="global.html#Events#.GROUP_LEAVE" class="!symbol-index-name">Events.<wbr>GROUP_LEAVE</a>
-            </dt>
-            <dd>
-            </dd>
    </dl>
 </div>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="global.html#Events#.GROUP_LEAVE" class="!symbol-index-name">Events.<wbr>GROUP_LEAVE</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="global.html#Events#.GROUP_MEMBERSHIP_REQUEST" class="!symbol-index-name">Events.<wbr>GROUP_MEMBERSHIP_REQUEST</a>
            </dt>
@ -1861,16 +1896,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-            <dt class="symbol-index-name">
-                <a href="global.html#Events#.MESSAGE_REACTION" class="!symbol-index-name">Events.<wbr>MESSAGE_REACTION</a>
-            </dt>
-            <dd>
-            </dd>
    </dl>
 </div>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="global.html#Events#.MESSAGE_REACTION" class="!symbol-index-name">Events.<wbr>MESSAGE_REACTION</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="global.html#Events#.MESSAGE_RECEIVED" class="!symbol-index-name">Events.<wbr>MESSAGE_RECEIVED</a>
            </dt>
@ -2023,6 +2058,11 @@ limitations under the License.</p></article>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="GroupChat.html#getPinnedMessages" class="!symbol-index-name">GroupChat#<wbr>getPinnedMessages()</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="GroupChat.html#id" class="!symbol-index-name">GroupChat#<wbr>id</a>
            </dt>
@ -2108,16 +2148,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-            <dt class="symbol-index-name">
-                <a href="GroupChat.html#revokeInvite" class="!symbol-index-name">GroupChat#<wbr>revokeInvite()</a>
-            </dt>
-            <dd>
-            </dd>
    </dl>
 </div>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="GroupChat.html#revokeInvite" class="!symbol-index-name">GroupChat#<wbr>revokeInvite()</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="GroupChat.html#sendMessage" class="!symbol-index-name">GroupChat#<wbr>sendMessage(content[, options])</a>
            </dt>
@ -2706,6 +2746,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Message.html#editScheduledEvent" class="!symbol-index-name">Message#<wbr>editScheduledEvent(editedEventObject)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Message.html#forward" class="!symbol-index-name">Message#<wbr>forward(chat)</a>
            </dt>
@ -2736,16 +2781,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-            <dt class="symbol-index-name">
-                <a href="Message.html#getGroupMentions" class="!symbol-index-name">Message#<wbr>getGroupMentions()</a>
-            </dt>
-            <dd>
-            </dd>
    </dl>
 </div>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Message.html#getGroupMentions" class="!symbol-index-name">Message#<wbr>getGroupMentions()</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Message.html#getInfo" class="!symbol-index-name">Message#<wbr>getInfo()</a>
            </dt>
@ -2831,16 +2876,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-            <dt class="symbol-index-name">
-                <a href="Message.html#links" class="!symbol-index-name">Message#<wbr>links</a>
-            </dt>
-            <dd>
-            </dd>
    </dl>
 </div>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Message.html#links" class="!symbol-index-name">Message#<wbr>links</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Message.html#location" class="!symbol-index-name">Message#<wbr>location</a>
            </dt>
@ -3107,16 +3152,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-    </dl>
-</div>
-
-                            <div class="symbol-index-column">
-    <dl class="symbol-index-list">
            <dt class="symbol-index-name">
                <a href="global.html#MessageTypes#.GROUP_NOTIFICATION" class="!symbol-index-name">MessageTypes.<wbr>GROUP_NOTIFICATION</a>
            </dt>
            <dd>
            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
            <dt class="symbol-index-name">
                <a href="global.html#MessageTypes#.HSM" class="!symbol-index-name">MessageTypes.<wbr>HSM</a>
            </dt>
@ -3172,11 +3217,6 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-    </dl>
-</div>
-
-                            <div class="symbol-index-column">
-    <dl class="symbol-index-list">
            <dt class="symbol-index-name">
                <a href="global.html#MessageTypes#.PAYMENT" class="!symbol-index-name">MessageTypes.<wbr>PAYMENT</a>
            </dt>
@ -3187,6 +3227,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
            <dt class="symbol-index-name">
                <a href="global.html#MessageTypes#.PRODUCT" class="!symbol-index-name">MessageTypes.<wbr>PRODUCT</a>
            </dt>
@ -3207,6 +3252,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="global.html#MessageTypes#.SCHEDULED_EVENT_CREATION" class="!symbol-index-name">MessageTypes.<wbr>SCHEDULED_EVENT_CREATION</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="global.html#MessageTypes#.STICKER" class="!symbol-index-name">MessageTypes.<wbr>STICKER</a>
            </dt>
@ -3525,7 +3575,7 @@ limitations under the License.</p></article>
            <dd>
            </dd>
            <dt class="symbol-index-name">
-                <a href="PrivateChat.html#id" class="!symbol-index-name">PrivateChat#<wbr>id</a>
+                <a href="PrivateChat.html#getPinnedMessages" class="!symbol-index-name">PrivateChat#<wbr>getPinnedMessages()</a>
            </dt>
            <dd>
            </dd>
@ -3534,6 +3584,11 @@ limitations under the License.</p></article>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="PrivateChat.html#id" class="!symbol-index-name">PrivateChat#<wbr>id</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="PrivateChat.html#isGroup" class="!symbol-index-name">PrivateChat#<wbr>isGroup</a>
            </dt>
@ -3584,16 +3639,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
-            <dt class="symbol-index-name">
-                <a href="PrivateChat.html#sendMessage" class="!symbol-index-name">PrivateChat#<wbr>sendMessage(content[, options])</a>
-            </dt>
-            <dd>
-            </dd>
    </dl>
 </div>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="PrivateChat.html#sendMessage" class="!symbol-index-name">PrivateChat#<wbr>sendMessage(content[, options])</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="PrivateChat.html#sendSeen" class="!symbol-index-name">PrivateChat#<wbr>sendSeen()</a>
            </dt>
@ -4007,6 +4062,53 @@ limitations under the License.</p></article>
                </div>
            </div>
        </section>
+        <section>
+            <div class="symbol-index-content">
+                <h2 id="ScheduledEvent">ScheduledEvent</h2>
+                <div class="symbol-index-section">
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="ScheduledEvent.html" class="!symbol-index-name">ScheduledEvent(name, startTime, options)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="ScheduledEvent.html#_validateInputs" class="!symbol-index-name">ScheduledEvent#<wbr>_validateInputs(propName, propValue)</a>
+            </dt>
+            <dd>
+            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="ScheduledEvent.html#eventSendOptions" class="!symbol-index-name">ScheduledEvent#<wbr>eventSendOptions</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="ScheduledEvent.html#name" class="!symbol-index-name">ScheduledEvent#<wbr>name</a>
+            </dt>
+            <dd>
+            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="ScheduledEvent.html#startTimeTs" class="!symbol-index-name">ScheduledEvent#<wbr>startTimeTs</a>
+            </dt>
+            <dd>
+            </dd>
+    </dl>
+</div>
+
+                </div>
+            </div>
+        </section>
        <section>
            <div class="symbol-index-content">
                <h2 id="Status">Status</h2>
@ -4242,7 +4344,7 @@ limitations under the License.</p></article>
                    <footer id="jsdoc-footer" class="jsdoc-footer">
                            <div id="jsdoc-footer-container">
                                    <p>
-                                      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on June 30, 2025.
+                                      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on August 8, 2025.
                                    </p>
                            </div>
                    </footer>