chore(): generate docs
This commit is contained in:
WWebJS Bot
parent
b296ea8d5a
commit
30b3f5e82e
77 changed files with 1732 additions and 368 deletions
448
docs/Client.html
448
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.31.1-alpha.0 » Class: Client</title>
|
||||
<title>whatsapp-web.js 1.32.0 » 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>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>
|
||||
|
|
@ -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-63">Client.<wbr>js:63</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-65">Client.<wbr>js:65</a></p>
|
||||
<div class="symbol-classdesc">
|
||||
<p>Starting point for interacting with the WhatsApp Web API</p>
|
||||
</div>
|
||||
|
|
@ -104,6 +104,9 @@
|
|||
<dt><a href="Client.html#attachEventListeners">attachEventListeners()</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#createCallLink">createCallLink(startTime, callType)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#createChannel">createChannel(title, options)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -163,6 +166,9 @@
|
|||
<dt><a href="Client.html#getContactDeviceCount">getContactDeviceCount(userId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getContactLidAndPhone">getContactLidAndPhone(userIds)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getContacts">getContacts()</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -187,6 +193,9 @@
|
|||
<dt><a href="Client.html#getNumberId">getNumberId(number)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getPinnedMessages">getPinnedMessages(chatId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#getProfilePicUrl">getProfilePicUrl(contactId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -220,20 +229,20 @@
|
|||
<dt><a href="Client.html#rejectGroupMembershipRequests">rejectGroupMembershipRequests(groupId, options)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#requestPairingCode">requestPairingCode(phoneNumber, showNotification)</a></dt>
|
||||
<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>
|
||||
<dt><a href="Client.html#revokeChannelAdminInvite">revokeChannelAdminInvite(channelId, userId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="summary-column">
|
||||
<dl class="dl-summary-callout">
|
||||
<dt><a href="Client.html#revokeChannelAdminInvite">revokeChannelAdminInvite(channelId, userId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#saveOrEditAddressbookContact">saveOrEditAddressbookContact(phoneNumber, firstName, lastName[, syncToAddressbook])</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -255,6 +264,9 @@
|
|||
<dt><a href="Client.html#sendPresenceUnavailable">sendPresenceUnavailable()</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#sendResponseToScheduledEvent">sendResponseToScheduledEvent(response, eventMessageId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#sendSeen">sendSeen(chatId)</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -335,20 +347,23 @@
|
|||
<dt><a href="Client.html#event:chat_removed">chat_removed</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#event:code">code</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#event:contact_changed">contact_changed</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#event:disconnected">disconnected</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#event:group_admin_changed">group_admin_changed</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="summary-column">
|
||||
<dl class="dl-summary-callout">
|
||||
<dt><a href="Client.html#event:group_admin_changed">group_admin_changed</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#event:group_join">group_join</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -373,14 +388,14 @@
|
|||
<dt><a href="Client.html#event:message_ack">message_ack</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#event:message_ciphertext">message_ciphertext</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="summary-column">
|
||||
<dl class="dl-summary-callout">
|
||||
<dt><a href="Client.html#event:message_ciphertext">message_ciphertext</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt><a href="Client.html#event:message_create">message_create</a></dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -650,6 +665,36 @@
|
|||
|
||||
<tr>
|
||||
<td>
|
||||
<p>deviceName</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Sets the device name of a current linked device., i.e.: 'TEST'.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<p>browserName</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Sets the browser name of a current linked device, i.e.: 'Firefox'.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<p>proxyAuthentication</p>
|
||||
</td>
|
||||
<td>
|
||||
|
|
@ -1381,6 +1426,86 @@ Private function</p>
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="createCallLink"><span class="symbol-name">createCallLink</span><span class="signature"><span class="signature-params">(startTime, callType)</span> → <span class="signature-returns"> Promise containing string</span></span></h3> <p>Generates a WhatsApp call link (video call or voice call)</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>startTime</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Date</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The start time of the call</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<p>callType</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The type of a WhatsApp call link to generate, valid values are: <code>video</code> | <code>voice</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd><p><code>Promise containing string</code> <p>The WhatsApp call link (https://call.whatsapp.com/video/XxXxXxXxXxXxXx) or an empty string if a generation failed.</p></p></dd>
|
||||
|
||||
|
||||
|
||||
|
|
@ -2422,6 +2547,71 @@ 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="getContactLidAndPhone"><span class="symbol-name">getContactLidAndPhone</span><span class="signature"><span class="signature-params">(userIds)</span> → <span class="signature-returns"> Promise containing Array of {lid: string, pn: string}</span></span></h3> <p>Get lid and phone number for multiple users</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>userIds</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Array of string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Array of user IDs</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd><p><code>Promise containing Array of {lid: string, pn: string}</code> </p></dd>
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="getContacts"><span class="symbol-name">getContacts</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> Promise containing Array of <a href="Contact.html">Contact</a></span></span></h3> <p>Get all current contact instances</p>
|
||||
|
|
@ -2879,6 +3069,71 @@ 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="getPinnedMessages"><span class="symbol-name">getPinnedMessages</span><span class="signature"><span class="signature-params">(chatId)</span></span></h3> <p>Gets instances of all pinned messages in a chat</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>chatId</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The chat ID</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd></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>
|
||||
|
|
@ -3434,7 +3689,7 @@ Private function</p>
|
|||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="requestPairingCode"><span class="symbol-name">requestPairingCode</span><span class="signature"><span class="signature-params">(phoneNumber, showNotification)</span> → <span class="signature-returns"> Promise containing string</span></span></h3> <p>Request authentication via pairing code instead of QR code</p>
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="requestPairingCode"><span class="symbol-name">requestPairingCode</span><span class="signature"><span class="signature-params">(phoneNumber[, showNotification][, intervalMs])</span> → <span class="signature-returns"> Promise containing string</span></span></h3> <p>Request authentication via pairing code instead of QR code</p>
|
||||
|
||||
|
||||
<section>
|
||||
|
|
@ -3472,7 +3727,7 @@ Private function</p>
|
|||
<p>boolean</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
<p>Yes</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Show notification to pair on phone number</p>
|
||||
|
|
@ -3480,6 +3735,22 @@ Private function</p>
|
|||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<p>intervalMs</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>number</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Yes</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The interval in milliseconds on how frequent to generate pairing code (WhatsApp default to 3 minutes)</p>
|
||||
<p>Defaults to <code>180000</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
|
@ -4287,6 +4558,86 @@ the lastMessage property of a found channel will be 'null'</li>
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div><h3 id="sendResponseToScheduledEvent"><span class="symbol-name">sendResponseToScheduledEvent</span><span class="signature"><span class="signature-params">(response, eventMessageId)</span> → <span class="signature-returns"> Promise containing boolean</span></span></h3> <p>Sends a response to the scheduled event message, indicating whether a user is going to attend the event or not</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>response</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>number</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The response code to the scheduled event message. Valid values are: <code>0</code> for NONE response (removes a previous response) | <code>1</code> for GOING | <code>2</code> for NOT GOING | <code>3</code> for MAYBE going</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<p>eventMessageId</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The scheduled event message ID</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd><p><code>Promise containing boolean</code> </p></dd>
|
||||
|
||||
|
||||
|
||||
|
|
@ -5720,6 +6071,71 @@ Note: the user you are transferring the channel ownership to must be a channel a
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
<h3 id="event:code"><span class="symbol-name">code</span></h3> <p>Emitted when a pairing code is received</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>code</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>string</p>
|
||||
</td>
|
||||
<td>
|
||||
<p> </p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Code</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<dl class="dl-compact">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd><p><code>string</code> <p>Code that was just received</p></p></dd>
|
||||
|
||||
|
||||
|
||||
|
|
@ -7383,7 +7799,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 June 30, 2025.
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on August 8, 2025.
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
|||
Loading…
Reference in a new issue