chore(): generate docs
This commit is contained in:
WWebJS Bot
parent
611b7c63d7
commit
376c60668c
76 changed files with 849 additions and 323 deletions
224
docs/Client.html
224
docs/Client.html
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta name="generator" content="JSDoc 3.6.11">
|
||||
<meta charset="utf-8">
|
||||
<title>whatsapp-web.js 1.34.2 » Class: Client</title>
|
||||
<title>whatsapp-web.js 1.34.3 » Class: Client</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>34.<wbr>2</a>
|
||||
<a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>34.<wbr>3</a>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
|
@ -23,7 +23,7 @@
|
|||
<div id="jsdoc-content-container">
|
||||
<div id="jsdoc-main" role="main">
|
||||
<header class="page-header">
|
||||
<div class="symbol-detail-labels"><span class="label label-kind">class</span></div><h1><small></small><span class="symbol-name">Client</span></h1> <p class="source-link">Source: <a href="Client.js.html#source-line-65">Client.<wbr>js:65</a></p>
|
||||
<div class="symbol-detail-labels"><span class="label label-kind">class</span></div><h1><small></small><span class="symbol-name">Client</span></h1> <p class="source-link">Source: <a href="Client.js.html#source-line-66">Client.<wbr>js:66</a></p>
|
||||
<div class="symbol-classdesc">
|
||||
<p>Starting point for interacting with the WhatsApp Web API</p>
|
||||
</div>
|
||||
|
|
@ -134,6 +134,9 @@
|
|||
<dt><a href="Client.html#getBlockedContacts">getBlockedContacts()</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getBroadcastById">getBroadcastById(contactId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getBroadcasts">getBroadcasts()</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -196,6 +199,9 @@
|
|||
<dt><a href="Client.html#getLabels">getLabels()</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getMessageById">getMessageById(messageId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getNumberId">getNumberId(number)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -252,6 +258,9 @@
|
|||
<dt><a href="Client.html#revokeChannelAdminInvite">revokeChannelAdminInvite(channelId, userId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#revokeStatusMessage">revokeStatusMessage(messageId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#saveOrEditAddressbookContact">saveOrEditAddressbookContact(phoneNumber, firstName, lastName[, syncToAddressbook])</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -539,6 +548,21 @@
|
|||
|
||||
<tr>
|
||||
<td>
|
||||
<p>evalOnNewDoc</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>function to eval on new doc</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<p>puppeteer</p>
|
||||
</td>
|
||||
<td>
|
||||
|
|
@ -2084,6 +2108,70 @@ Private function</p>
|
|||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="getBroadcastById"><span class="symbol-name">getBroadcastById</span><span class="signature"><span class="signature-params">(contactId)</span> → <span class="signature-returns"> Promise containing <a href="Broadcast.html">Broadcast</a></span></span></h3> <p>Get broadcast instance by current user ID</p>
|
||||
|
||||
|
||||
<section>
|
||||
<h4>Parameter</h4>
|
||||
<table class="jsdoc-details-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<p>contactId</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd><p><code>Promise containing <a href="Broadcast.html">Broadcast</a></code> </p></dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="getBroadcasts"><span class="symbol-name">getBroadcasts</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> Promise containing Array of <a href="Broadcast.html">Broadcast</a></span></span></h3> <p>Get all current Broadcast</p>
|
||||
|
|
@ -3161,6 +3249,70 @@ So for a non-enterprise user with one WaWeb connection it should return "2&
|
|||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="getMessageById"><span class="symbol-name">getMessageById</span><span class="signature"><span class="signature-params">(messageId)</span> → <span class="signature-returns"> Promise containing <a href="Message.html">Message</a></span></span></h3> <p>Get message by ID</p>
|
||||
|
||||
|
||||
<section>
|
||||
<h4>Parameter</h4>
|
||||
<table class="jsdoc-details-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<p>messageId</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd><p><code>Promise containing <a href="Message.html">Message</a></code> </p></dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="getNumberId"><span class="symbol-name">getNumberId</span><span class="signature"><span class="signature-params">(number)</span> → <span class="signature-returns"> Promise containing (Object or null)</span></span></h3> <p>Get the registered WhatsApp ID for a number.
|
||||
|
|
@ -4120,6 +4272,70 @@ Private function</p>
|
|||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="revokeStatusMessage"><span class="symbol-name">revokeStatusMessage</span><span class="signature"><span class="signature-params">(messageId)</span> → <span class="signature-returns"> Promise containing void</span></span></h3> <p>Revoke current own status messages</p>
|
||||
|
||||
|
||||
<section>
|
||||
<h4>Parameter</h4>
|
||||
<table class="jsdoc-details-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Optional</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<p>messageId</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd><p><code>Promise containing void</code> </p></dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="saveOrEditAddressbookContact"><span class="symbol-name">saveOrEditAddressbookContact</span><span class="signature"><span class="signature-params">(phoneNumber, firstName, lastName[, syncToAddressbook])</span> → <span class="signature-returns"> Promise containing void</span></span></h3> <p>Save new contact to user's addressbook or edit the existing one</p>
|
||||
|
|
@ -8021,7 +8237,7 @@ shows a user's current selected option(s) on the poll</p>
|
|||
<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 November 6, 2025.
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on December 13, 2025.
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
|||
Loading…
Reference in a new issue