chore(): generate docs

2025-05-31 18:37:38 +00:00 · 2025-05-31 18:37:38 +00:00 · 2128f97729
commit 2128f97729
parent 477db5a7c9
75 changed files with 10148 additions and 4112 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.28.1-alpha.0 &raquo; Home</title>
+        <title>whatsapp-web.js 1.29.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>28.<wbr>1-alpha.<wbr>0</a>
+            <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>29.<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.28.1-alpha.0
+            whatsapp-web.js 1.29.0
        </h1>
    </header>

@ -653,6 +653,178 @@ limitations under the License.</p></article>
                </div>
            </div>
        </section>
+        <section>
+            <div class="symbol-index-content">
+                <h2 id="Channel">Channel</h2>
+                <div class="symbol-index-section">
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Channel.html" class="!symbol-index-name">Channel()</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#_muteUnmuteChannel" class="!symbol-index-name">Channel#<wbr>_muteUnmuteChannel(action)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#_setChannelMetadata" class="!symbol-index-name">Channel#<wbr>_setChannelMetadata(value, property)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#acceptChannelAdminInvite" class="!symbol-index-name">Channel#<wbr>acceptChannelAdminInvite()</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#deleteChannel" class="!symbol-index-name">Channel#<wbr>deleteChannel()</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#demoteChannelAdmin" class="!symbol-index-name">Channel#<wbr>demoteChannelAdmin(userId)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#description" class="!symbol-index-name">Channel#<wbr>description</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#fetchMessages" class="!symbol-index-name">Channel#<wbr>fetchMessages(searchOptions)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#getSubscribers" class="!symbol-index-name">Channel#<wbr>getSubscribers(limit)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#id" class="!symbol-index-name">Channel#<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="Channel.html#isChannel" class="!symbol-index-name">Channel#<wbr>isChannel</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#isGroup" class="!symbol-index-name">Channel#<wbr>isGroup</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#isMuted" class="!symbol-index-name">Channel#<wbr>isMuted</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#isReadOnly" class="!symbol-index-name">Channel#<wbr>isReadOnly</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#lastMessage" class="!symbol-index-name">Channel#<wbr>lastMessage</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#mute" class="!symbol-index-name">Channel#<wbr>mute()</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#muteExpiration" class="!symbol-index-name">Channel#<wbr>muteExpiration</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#name" class="!symbol-index-name">Channel#<wbr>name</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#revokeChannelAdminInvite" class="!symbol-index-name">Channel#<wbr>revokeChannelAdminInvite(userId)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#sendChannelAdminInvite" class="!symbol-index-name">Channel#<wbr>sendChannelAdminInvite(chatId, options)</a>
+            </dt>
+            <dd>
+            </dd>
+    </dl>
+</div>
+
+                            <div class="symbol-index-column">
+    <dl class="symbol-index-list">
+            <dt class="symbol-index-name">
+                <a href="Channel.html#sendMessage" class="!symbol-index-name">Channel#<wbr>sendMessage(content, options)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#sendSeen" class="!symbol-index-name">Channel#<wbr>sendSeen()</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#setDescription" class="!symbol-index-name">Channel#<wbr>setDescription(newDescription)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#setProfilePicture" class="!symbol-index-name">Channel#<wbr>setProfilePicture(newProfilePicture)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#setReactionSetting" class="!symbol-index-name">Channel#<wbr>setReactionSetting(reactionCode)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#setSubject" class="!symbol-index-name">Channel#<wbr>setSubject(newSubject)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#timestamp" class="!symbol-index-name">Channel#<wbr>timestamp</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#transferChannelOwnership" class="!symbol-index-name">Channel#<wbr>transferChannelOwnership(newOwnerId, options)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#unmute" class="!symbol-index-name">Channel#<wbr>unmute()</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Channel.html#unreadCount" class="!symbol-index-name">Channel#<wbr>unreadCount</a>
+            </dt>
+            <dd>
+            </dd>
+    </dl>
+</div>
+
+                </div>
+            </div>
+        </section>
        <section>
            <div class="symbol-index-content">
                <h2 id="Chat">Chat</h2>
@ -883,6 +1055,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#acceptChannelAdminInvite" class="!symbol-index-name">Client#<wbr>acceptChannelAdminInvite(channelId)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#acceptGroupV4Invite" class="!symbol-index-name">Client#<wbr>acceptGroupV4Invite(inviteInfo)</a>
            </dt>
@ -913,6 +1090,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#createChannel" class="!symbol-index-name">Client#<wbr>createChannel(title, options)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#createGroup" class="!symbol-index-name">Client#<wbr>createGroup(title, participants, options)</a>
            </dt>
@ -923,11 +1105,21 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#deleteChannel" class="!symbol-index-name">Client#<wbr>deleteChannel(channelId)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#deleteProfilePicture" class="!symbol-index-name">Client#<wbr>deleteProfilePicture()</a>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#demoteChannelAdmin" class="!symbol-index-name">Client#<wbr>demoteChannelAdmin(channelId, userId)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#destroy" class="!symbol-index-name">Client#<wbr>destroy()</a>
            </dt>
@ -1078,6 +1270,16 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#getChannelByInviteCode" class="!symbol-index-name">Client#<wbr>getChannelByInviteCode(inviteCode)</a>
+            </dt>
+            <dd>
+            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#getChannels" class="!symbol-index-name">Client#<wbr>getChannels()</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#getChatById" class="!symbol-index-name">Client#<wbr>getChatById(chatId)</a>
            </dt>
@ -1178,11 +1380,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="Client.html#inject" class="!symbol-index-name">Client#<wbr>inject()</a>
            </dt>
@ -1193,6 +1390,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="Client.html#logout" class="!symbol-index-name">Client#<wbr>logout()</a>
            </dt>
@ -1238,16 +1440,31 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#revokeChannelAdminInvite" class="!symbol-index-name">Client#<wbr>revokeChannelAdminInvite(channelId, userId)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#saveOrEditAddressbookContact" class="!symbol-index-name">Client#<wbr>saveOrEditAddressbookContact(phoneNumber, firstName, lastName[, syncToAddressbook])</a>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#searchChannels" class="!symbol-index-name">Client#<wbr>searchChannels(searchOptions)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#searchMessages" class="!symbol-index-name">Client#<wbr>searchMessages(query[, options])</a>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#sendChannelAdminInvite" class="!symbol-index-name">Client#<wbr>sendChannelAdminInvite(chatId, channelId, options)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#sendMessage" class="!symbol-index-name">Client#<wbr>sendMessage(chatId, content[, options])</a>
            </dt>
@ -1308,11 +1525,21 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#subscribeToChannel" class="!symbol-index-name">Client#<wbr>subscribeToChannel(channelId)</a>
+            </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#transferChannelOwnership" class="!symbol-index-name">Client#<wbr>transferChannelOwnership(channelId, newOwnerId, options)</a>
+            </dt>
+            <dd>
+            </dd>
            <dt class="symbol-index-name">
                <a href="Client.html#unarchiveChat" class="!symbol-index-name">Client#<wbr>unarchiveChat()</a>
            </dt>
@ -1328,6 +1555,11 @@ limitations under the License.</p></article>
            </dt>
            <dd>
            </dd>
+            <dt class="symbol-index-name">
+                <a href="Client.html#unsubscribeFromChannel" class="!symbol-index-name">Client#<wbr>unsubscribeFromChannel(channelId, options)</a>
+            </dt>
+            <dd>
+            </dd>
    </dl>
 </div>

@ -3994,11 +4226,6 @@ limitations under the License.</p></article>

                            <div class="symbol-index-column">
    <dl class="symbol-index-list">
-            <dt class="symbol-index-name">
-                <a href="window.WWebJS.html#.generateWaveform" class="!symbol-index-name">window.<wbr>WWebJS.<wbr>generateWaveform()</a>
-            </dt>
-            <dd>
-            </dd>
    </dl>
 </div>

@ -4015,7 +4242,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 May 30, 2025.
+                                      Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on May 31, 2025.
                                    </p>
                            </div>
                    </footer>