chore(): generate docs
This commit is contained in:
WWebJS Bot
parent
2dbcf8ab5d
commit
28a2d3630c
76 changed files with 890 additions and 313 deletions
238
docs/Client.html
238
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.1 » Class: Client</title>
|
||||
<title>whatsapp-web.js 1.34.2 » 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>1</a>
|
||||
<a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>34.<wbr>2</a>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
|
@ -92,6 +92,9 @@
|
|||
<dt><a href="Client.html#acceptInvite">acceptInvite(inviteCode)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#addOrEditCustomerNote">addOrEditCustomerNote(userId, note)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#addOrRemoveLabels">addOrRemoveLabels(labelIds, chatIds)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -175,6 +178,9 @@
|
|||
<dt><a href="Client.html#getCountryCode">getCountryCode(number)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getCustomerNote">getCustomerNote(userId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getFormattedNumber">getFormattedNumber(number)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -196,6 +202,9 @@
|
|||
<dt><a href="Client.html#getPinnedMessages">getPinnedMessages(chatId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getPollVotes">getPollVotes(messageId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getProfilePicUrl">getProfilePicUrl(contactId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -232,14 +241,14 @@
|
|||
<dt><a href="Client.html#requestPairingCode">requestPairingCode(phoneNumber[, showNotification][, intervalMs])</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#resetState">resetState()</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="summary-column">
|
||||
<dl class="dl-summary-callout">
|
||||
<dt><a href="Client.html#resetState">resetState()</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#revokeChannelAdminInvite">revokeChannelAdminInvite(channelId, userId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -1173,6 +1182,88 @@
|
|||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="addOrEditCustomerNote"><span class="symbol-name">addOrEditCustomerNote</span><span class="signature"><span class="signature-params">(userId, note)</span> → <span class="signature-returns"> Promise containing void</span></span></h3> <p>Add or edit a customer note</p>
|
||||
|
||||
|
||||
<section>
|
||||
<h4>Parameters</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>userId</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The ID of a customer to add a note to</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<p>note</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The note to add</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>See also</dt>
|
||||
<dd><a href="https://faq.whatsapp.com/1433099287594476">https://faq.whatsapp.com/1433099287594476</a></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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="addOrRemoveLabels"><span class="symbol-name">addOrRemoveLabels</span><span class="signature"><span class="signature-params">(labelIds, chatIds)</span> → <span class="signature-returns"> Promise containing void</span></span></h3> <p>Change labels in chats</p>
|
||||
|
|
@ -2711,6 +2802,73 @@ 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="getCustomerNote"><span class="symbol-name">getCustomerNote</span><span class="signature"><span class="signature-params">(userId)</span> → <span class="signature-returns"> Promise containing {chatId: string, content: string, createdAt: number, id: string, modifiedAt: number, type: string}</span></span></h3> <p>Get a customer note</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>userId</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The ID of a customer to get a note from</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>See also</dt>
|
||||
<dd><a href="https://faq.whatsapp.com/1433099287594476">https://faq.whatsapp.com/1433099287594476</a></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd><p><code>Promise containing {chatId: string, content: string, createdAt: number, id: string, modifiedAt: number, type: string}</code> </p></dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="getFormattedNumber"><span class="symbol-name">getFormattedNumber</span><span class="signature"><span class="signature-params">(number)</span> → <span class="signature-returns"> Promise containing string</span></span></h3> <p>Get the formatted number of a WhatsApp ID.</p>
|
||||
|
|
@ -3134,6 +3292,70 @@ Will return null if the number is not registered on WhatsApp.</p>
|
|||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="getPollVotes"><span class="symbol-name">getPollVotes</span><span class="signature"><span class="signature-params">(messageId)</span> → <span class="signature-returns"> Promise containing Array of <a href="PollVote.html">PollVote</a></span></span></h3> <p>Get Poll Votes</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 Array of <a href="PollVote.html">PollVote</a></code> </p></dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="getProfilePicUrl"><span class="symbol-name">getProfilePicUrl</span><span class="signature"><span class="signature-params">(contactId)</span> → <span class="signature-returns"> Promise containing string</span></span></h3> <p>Returns the contact ID's profile picture URL, if privacy settings allow it</p>
|
||||
|
|
@ -3900,7 +4122,7 @@ Private function</p>
|
|||
|
||||
</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></h3> <p>Save new contact to user's addressbook or edit the existing one</p>
|
||||
<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>
|
||||
|
||||
|
||||
<section>
|
||||
|
|
@ -4003,7 +4225,7 @@ Private function</p>
|
|||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd></dd>
|
||||
<dd><p><code>Promise containing void</code> </p></dd>
|
||||
|
||||
|
||||
|
||||
|
|
@ -7799,7 +8021,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 September 10, 2025.
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on November 6, 2025.
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
|||
Loading…
Reference in a new issue