chore(): generate docs

2024-10-04 04:29:49 +00:00 · 2024-10-04 04:29:49 +00:00 · fc722dd1d3
commit fc722dd1d3
parent 4694e8337f
74 changed files with 1179 additions and 539 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.26.0 &raquo; Home</title>
+        <title>whatsapp-web.js 1.26.1-alpha.2 &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>25.<wbr>0</a>
+            <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>26.<wbr>1-alpha.<wbr>2</a>
        </div>
    </div>
 </nav>
@ -26,7 +26,7 @@
                                        <div id="jsdoc-main" role="main">
                <header class="page-header">
        <h1>
-            whatsapp-web.js 1.26.0
+            whatsapp-web.js 1.26.1-alpha.2
        </h1>
    </header>

@ -39,7 +39,7 @@
    <p>
 		<a href="https://www.npmjs.com/package/whatsapp-web.js"><img src="https://img.shields.io/npm/v/whatsapp-web.js.svg" alt="npm" /></a>
        <a href="https://depfu.com/github/pedroslopez/whatsapp-web.js?project_id=9765"><img src="https://badges.depfu.com/badges/4a65a0de96ece65fdf39e294e0c8dcba/overview.svg" alt="Depfu" /></a>
-        <img src="https://img.shields.io/badge/WhatsApp_Web-2.2346.52-brightgreen.svg" alt="WhatsApp_Web 2.2346.52" />
+        <img src="https://img.shields.io/badge/WhatsApp_Web-2.3000.1017054665-brightgreen.svg" alt="WhatsApp_Web 2.2346.52" />
        <a href="https://discord.gg/H7DqQs4"><img src="https://img.shields.io/discord/698610475432411196.svg?logo=discord" alt="Discord server" /></a>
 	</p>
    <br />
@ -325,6 +325,68 @@ limitations under the License.</p></article>
                </div>
            </div>
        </section>
+        <section>
+            <div class="symbol-index-content">
+                <h2 id="Broadcast">Broadcast</h2>
+                <div class="symbol-index-section">
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Broadcast.html" class="!symbol-index-name">Broadcast()</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Broadcast.html#getChat" class="!symbol-index-name">Broadcast#<wbr>getChat()</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Broadcast.html#getContact" class="!symbol-index-name">Broadcast#<wbr>getContact()</a>
+            </dt>
+            <dd>
+            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Broadcast.html#id" class="!symbol-index-name">Broadcast#<wbr>id</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Broadcast.html#msgs" class="!symbol-index-name">Broadcast#<wbr>msgs</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Broadcast.html#timestamp" class="!symbol-index-name">Broadcast#<wbr>timestamp</a>
+            </dt>
+            <dd>
+            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Broadcast.html#totalCount" class="!symbol-index-name">Broadcast#<wbr>totalCount</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Broadcast.html#unreadCount" class="!symbol-index-name">Broadcast#<wbr>unreadCount</a>
+            </dt>
+            <dd>
+            </dd>
+    </dl>
+</div>
+
+                </div>
+            </div>
+        </section>
        <section>
            <div class="symbol-index-content">
                <h2 id="BusinessContact">BusinessContact</h2>
@ -647,16 +709,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="Chat.html#id" class="!symbol-index-name">Chat#<wbr>id</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#isGroup" class="!symbol-index-name">Chat#<wbr>isGroup</a>
            </dt>
@ -702,11 +764,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="Chat.html#pinned" class="!symbol-index-name">Chat#<wbr>pinned</a>
            </dt>
@ -717,6 +774,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="Chat.html#sendSeen" class="!symbol-index-name">Chat#<wbr>sendSeen()</a>
            </dt>
@ -732,6 +794,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Chat.html#syncHistory" class="!symbol-index-name">Chat#<wbr>syncHistory()</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Chat.html#timestamp" class="!symbol-index-name">Chat#<wbr>timestamp</a>
            </dt>
@ -946,16 +1013,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="Client.html#event:message_create" class="!symbol-index-name">Client#<wbr>event:message_create</a>
            </dt>
            <dd>
            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
            <dt class="symbol-index-name">
                <a href="Client.html#event:message_edit" class="!symbol-index-name">Client#<wbr>event:message_edit</a>
            </dt>
@ -996,6 +1063,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#getBroadcasts" class="!symbol-index-name">Client#<wbr>getBroadcasts()</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#getChatById" class="!symbol-index-name">Client#<wbr>getChatById(chatId)</a>
            </dt>
@ -1027,7 +1099,7 @@ limitations under the License.</p></article>
            <dd>
            </dd>
            <dt class="symbol-index-name">
-                <a href="Client.html#getContactDeviceCount" class="!symbol-index-name">Client#<wbr>getContactDeviceCount(contactId)</a>
+                <a href="Client.html#getContactDeviceCount" class="!symbol-index-name">Client#<wbr>getContactDeviceCount(userId)</a>
            </dt>
            <dd>
            </dd>
@ -1091,16 +1163,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="Client.html#initialize" class="!symbol-index-name">Client#<wbr>initialize()</a>
            </dt>
            <dd>
            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
            <dt class="symbol-index-name">
                <a href="Client.html#inject" class="!symbol-index-name">Client#<wbr>inject()</a>
            </dt>
@ -1216,6 +1288,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#syncHistory" class="!symbol-index-name">Client#<wbr>syncHistory(chatId)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#unarchiveChat" class="!symbol-index-name">Client#<wbr>unarchiveChat()</a>
            </dt>
@ -1684,16 +1761,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="GroupChat.html#getLabels" class="!symbol-index-name">GroupChat#<wbr>getLabels()</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#id" class="!symbol-index-name">GroupChat#<wbr>id</a>
            </dt>
@ -1774,11 +1851,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="GroupChat.html#removeParticipants" class="!symbol-index-name">GroupChat#<wbr>removeParticipants(participantIds)</a>
            </dt>
@ -1789,6 +1861,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="GroupChat.html#sendMessage" class="!symbol-index-name">GroupChat#<wbr>sendMessage(content[, options])</a>
            </dt>
@ -1839,6 +1916,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="GroupChat.html#syncHistory" class="!symbol-index-name">GroupChat#<wbr>syncHistory()</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="GroupChat.html#timestamp" class="!symbol-index-name">GroupChat#<wbr>timestamp</a>
            </dt>
@ -3190,16 +3272,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="PrivateChat.html#id" class="!symbol-index-name">PrivateChat#<wbr>id</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#isGroup" class="!symbol-index-name">PrivateChat#<wbr>isGroup</a>
            </dt>
@ -3245,11 +3327,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="PrivateChat.html#pinned" class="!symbol-index-name">PrivateChat#<wbr>pinned</a>
            </dt>
@ -3260,6 +3337,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="PrivateChat.html#sendSeen" class="!symbol-index-name">PrivateChat#<wbr>sendSeen()</a>
            </dt>
@ -3275,6 +3357,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="PrivateChat.html#syncHistory" class="!symbol-index-name">PrivateChat#<wbr>syncHistory()</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="PrivateChat.html#timestamp" class="!symbol-index-name">PrivateChat#<wbr>timestamp</a>
            </dt>
@ -3908,7 +3995,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 September 18, 2024.
+                                      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on October 4, 2024.
                                    </p>
                            </div>
                    </footer>