chore(): generate docs

This commit is contained in:
WWebJS Bot 2025-08-08 21:39:18 +00:00
commit 30b3f5e82e
77 changed files with 1732 additions and 368 deletions

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Base</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Base</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -50,7 +50,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: BaseAuthStrategy</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: BaseAuthStrategy</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -50,7 +50,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Broadcast</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Broadcast</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -152,7 +152,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: BusinessContact</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: BusinessContact</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -326,7 +326,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Buttons</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Buttons</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -234,7 +234,7 @@ Returns: [{ buttonId:&#x27;customId&#x27;,buttonText:{&#x27;displayText&#x27;:&#
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Call</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Call</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -168,7 +168,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Channel</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Channel</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -896,7 +896,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Chat</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Chat</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -117,6 +117,9 @@
<dt><a href="Chat.html#getLabels">getLabels()</a></dt> <dt><a href="Chat.html#getLabels">getLabels()</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="Chat.html#getPinnedMessages">getPinnedMessages()</a></dt>
<dd>
</dd>
<dt><a href="Chat.html#markUnread">markUnread()</a></dt> <dt><a href="Chat.html#markUnread">markUnread()</a></dt>
<dd> <dd>
</dd> </dd>
@ -132,13 +135,13 @@
<dt><a href="Chat.html#sendSeen">sendSeen()</a></dt> <dt><a href="Chat.html#sendSeen">sendSeen()</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="Chat.html#sendStateRecording">sendStateRecording()</a></dt>
<dd>
</dd>
</dl> </dl>
</div> </div>
<div class="summary-column"> <div class="summary-column">
<dl class="dl-summary-callout"> <dl class="dl-summary-callout">
<dt><a href="Chat.html#sendStateRecording">sendStateRecording()</a></dt>
<dd>
</dd>
<dt><a href="Chat.html#sendStateTyping">sendStateTyping()</a></dt> <dt><a href="Chat.html#sendStateTyping">sendStateTyping()</a></dt>
<dd> <dd>
</dd> </dd>
@ -394,6 +397,13 @@
</dd> </dd>
</dl> </dl>
<div class="symbol-detail-labels"><span class="label label-async">async</span></div> <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">()</span></span></h3>
<p>Gets instances of all pinned messages in a chat</p>
<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="markUnread"><span class="symbol-name">markUnread</span><span class="signature"><span class="signature-params">()</span></span></h3> <h3 id="markUnread"><span class="symbol-name">markUnread</span><span class="signature"><span class="signature-params">()</span></span></h3>
<p>Mark this chat as unread</p> <p>Mark this chat as unread</p>
<dl class="dl-compact"> <dl class="dl-compact">
@ -567,7 +577,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -3,7 +3,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Client</title> <title>whatsapp-web.js 1.32.0 &raquo; 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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" 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"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -23,7 +23,7 @@
<div id="jsdoc-content-container"> <div id="jsdoc-content-container">
<div id="jsdoc-main" role="main"> <div id="jsdoc-main" role="main">
<header class="page-header"> <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"> <div class="symbol-classdesc">
<p>Starting point for interacting with the WhatsApp Web API</p> <p>Starting point for interacting with the WhatsApp Web API</p>
</div> </div>
@ -104,6 +104,9 @@
<dt><a href="Client.html#attachEventListeners">attachEventListeners()</a></dt> <dt><a href="Client.html#attachEventListeners">attachEventListeners()</a></dt>
<dd> <dd>
</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> <dt><a href="Client.html#createChannel">createChannel(title, options)</a></dt>
<dd> <dd>
</dd> </dd>
@ -163,6 +166,9 @@
<dt><a href="Client.html#getContactDeviceCount">getContactDeviceCount(userId)</a></dt> <dt><a href="Client.html#getContactDeviceCount">getContactDeviceCount(userId)</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="Client.html#getContactLidAndPhone">getContactLidAndPhone(userIds)</a></dt>
<dd>
</dd>
<dt><a href="Client.html#getContacts">getContacts()</a></dt> <dt><a href="Client.html#getContacts">getContacts()</a></dt>
<dd> <dd>
</dd> </dd>
@ -187,6 +193,9 @@
<dt><a href="Client.html#getNumberId">getNumberId(number)</a></dt> <dt><a href="Client.html#getNumberId">getNumberId(number)</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="Client.html#getPinnedMessages">getPinnedMessages(chatId)</a></dt>
<dd>
</dd>
<dt><a href="Client.html#getProfilePicUrl">getProfilePicUrl(contactId)</a></dt> <dt><a href="Client.html#getProfilePicUrl">getProfilePicUrl(contactId)</a></dt>
<dd> <dd>
</dd> </dd>
@ -220,20 +229,20 @@
<dt><a href="Client.html#rejectGroupMembershipRequests">rejectGroupMembershipRequests(groupId, options)</a></dt> <dt><a href="Client.html#rejectGroupMembershipRequests">rejectGroupMembershipRequests(groupId, options)</a></dt>
<dd> <dd>
</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>
</dd> </dd>
<dt><a href="Client.html#resetState">resetState()</a></dt> <dt><a href="Client.html#resetState">resetState()</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="Client.html#revokeChannelAdminInvite">revokeChannelAdminInvite(channelId, userId)</a></dt>
<dd>
</dd>
</dl> </dl>
</div> </div>
<div class="summary-column"> <div class="summary-column">
<dl class="dl-summary-callout"> <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> <dt><a href="Client.html#saveOrEditAddressbookContact">saveOrEditAddressbookContact(phoneNumber, firstName, lastName[, syncToAddressbook])</a></dt>
<dd> <dd>
</dd> </dd>
@ -255,6 +264,9 @@
<dt><a href="Client.html#sendPresenceUnavailable">sendPresenceUnavailable()</a></dt> <dt><a href="Client.html#sendPresenceUnavailable">sendPresenceUnavailable()</a></dt>
<dd> <dd>
</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> <dt><a href="Client.html#sendSeen">sendSeen(chatId)</a></dt>
<dd> <dd>
</dd> </dd>
@ -335,20 +347,23 @@
<dt><a href="Client.html#event:chat_removed">chat_removed</a></dt> <dt><a href="Client.html#event:chat_removed">chat_removed</a></dt>
<dd> <dd>
</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> <dt><a href="Client.html#event:contact_changed">contact_changed</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="Client.html#event:disconnected">disconnected</a></dt> <dt><a href="Client.html#event:disconnected">disconnected</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="Client.html#event:group_admin_changed">group_admin_changed</a></dt>
<dd>
</dd>
</dl> </dl>
</div> </div>
<div class="summary-column"> <div class="summary-column">
<dl class="dl-summary-callout"> <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> <dt><a href="Client.html#event:group_join">group_join</a></dt>
<dd> <dd>
</dd> </dd>
@ -373,14 +388,14 @@
<dt><a href="Client.html#event:message_ack">message_ack</a></dt> <dt><a href="Client.html#event:message_ack">message_ack</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="Client.html#event:message_ciphertext">message_ciphertext</a></dt>
<dd>
</dd>
</dl> </dl>
</div> </div>
<div class="summary-column"> <div class="summary-column">
<dl class="dl-summary-callout"> <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> <dt><a href="Client.html#event:message_create">message_create</a></dt>
<dd> <dd>
</dd> </dd>
@ -650,6 +665,36 @@
<tr> <tr>
<td> <td>
<p>deviceName</p>
</td>
<td>
<p>&nbsp;</p>
</td>
<td>
<p>&nbsp;</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>&nbsp;</p>
</td>
<td>
<p>&nbsp;</p>
</td>
<td>
<p>Sets the browser name of a current linked device, i.e.: 'Firefox'.</p>
</td>
</tr>
<tr>
<td>
<p>proxyAuthentication</p> <p>proxyAuthentication</p>
</td> </td>
<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>&nbsp;&rarr; <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>&nbsp;</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>&nbsp;</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 &quot;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>&nbsp;&rarr; <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>&nbsp;</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> </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>&nbsp;&rarr; <span class="signature-returns"> Promise containing Array of <a href="Contact.html">Contact</a></span></span></h3> <p>Get all current contact instances</p> <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>&nbsp;&rarr; <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>&nbsp;</p>
</td>
<td>
<p>The chat ID</p>
</td>
</tr>
</tbody>
</table>
</section>
<dl class="dl-compact">
<dt>Returns</dt>
<dd></dd>
</dl> </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>&nbsp;&rarr; <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> <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>&nbsp;&rarr; <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> </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>&nbsp;&rarr; <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>&nbsp;&rarr; <span class="signature-returns"> Promise containing string</span></span></h3> <p>Request authentication via pairing code instead of QR code</p>
<section> <section>
@ -3472,7 +3727,7 @@ Private function</p>
<p>boolean</p> <p>boolean</p>
</td> </td>
<td> <td>
<p>&nbsp;</p> <p>Yes</p>
</td> </td>
<td> <td>
<p>Show notification to pair on phone number</p> <p>Show notification to pair on phone number</p>
@ -3480,6 +3735,22 @@ Private function</p>
</td> </td>
</tr> </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> </tbody>
</table> </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>&nbsp;&rarr; <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>&nbsp;</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>&nbsp;</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>&nbsp;</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"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Source: Client.js</title> <title>whatsapp-web.js 1.32.0 &raquo; Source: Client.js</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -46,7 +46,7 @@ const { LoadUtils } &#x3D; require(&#x27;./util/Injected/Utils&#x27;);
const ChatFactory &#x3D; require(&#x27;./factories/ChatFactory&#x27;); const ChatFactory &#x3D; require(&#x27;./factories/ChatFactory&#x27;);
const ContactFactory &#x3D; require(&#x27;./factories/ContactFactory&#x27;); const ContactFactory &#x3D; require(&#x27;./factories/ContactFactory&#x27;);
const WebCacheFactory &#x3D; require(&#x27;./webCache/WebCacheFactory&#x27;); const WebCacheFactory &#x3D; require(&#x27;./webCache/WebCacheFactory&#x27;);
const { Broadcast, Buttons, Call, ClientInfo, Contact, GroupNotification, Label, List, Location, Message, MessageMedia, Poll, PollVote, Reaction } &#x3D; require(&#x27;./structures&#x27;); const { ClientInfo, Message, MessageMedia, Contact, Location, Poll, PollVote, GroupNotification, Label, Call, Buttons, List, Reaction, Broadcast, ScheduledEvent } &#x3D; require(&#x27;./structures&#x27;);
const NoAuth &#x3D; require(&#x27;./authStrategies/NoAuth&#x27;); const NoAuth &#x3D; require(&#x27;./authStrategies/NoAuth&#x27;);
const {exposeFunctionIfAbsent} &#x3D; require(&#x27;./util/Puppeteer&#x27;); const {exposeFunctionIfAbsent} &#x3D; require(&#x27;./util/Puppeteer&#x27;);
@ -67,6 +67,8 @@ const {exposeFunctionIfAbsent} &#x3D; require(&#x27;./util/Puppeteer&#x27;);
* @param {string} options.userAgent - User agent to use in puppeteer * @param {string} options.userAgent - User agent to use in puppeteer
* @param {string} options.ffmpegPath - Ffmpeg path to use when formatting videos to webp while sending stickers * @param {string} options.ffmpegPath - Ffmpeg path to use when formatting videos to webp while sending stickers
* @param {boolean} options.bypassCSP - Sets bypassing of page&#x27;s Content-Security-Policy. * @param {boolean} options.bypassCSP - Sets bypassing of page&#x27;s Content-Security-Policy.
* @param {string} options.deviceName - Sets the device name of a current linked device., i.e.: &#x27;TEST&#x27;.
* @param {string} options.browserName - Sets the browser name of a current linked device, i.e.: &#x27;Firefox&#x27;.
* @param {object} options.proxyAuthentication - Proxy Authentication object. * @param {object} options.proxyAuthentication - Proxy Authentication object.
* *
* @fires Client#qr * @fires Client#qr
@ -125,7 +127,8 @@ class Client extends EventEmitter {
*/ */
async inject() { async inject() {
await this.pupPage.waitForFunction(&#x27;window.Debug?.VERSION !&#x3D; undefined&#x27;, {timeout: this.options.authTimeoutMs}); await this.pupPage.waitForFunction(&#x27;window.Debug?.VERSION !&#x3D; undefined&#x27;, {timeout: this.options.authTimeoutMs});
await this.setDeviceName(this.options.deviceName, this.options.browserName);
const pairWithPhoneNumber &#x3D; this.options.pairWithPhoneNumber;
const version &#x3D; await this.getWWebVersion(); const version &#x3D; await this.getWWebVersion();
const isCometOrAbove &#x3D; parseInt(version.split(&#x27;.&#x27;)?.[1]) &gt;&#x3D; 3000; const isCometOrAbove &#x3D; parseInt(version.split(&#x27;.&#x27;)?.[1]) &gt;&#x3D; 3000;
@ -171,7 +174,20 @@ class Client extends EventEmitter {
return; return;
} }
// Register qr events // Register qr/code events
if (pairWithPhoneNumber.phoneNumber) {
await exposeFunctionIfAbsent(this.pupPage, &#x27;onCodeReceivedEvent&#x27;, async (code) &#x3D;&gt; {
/**
* Emitted when a pairing code is received
* @event Client#code
* @param {string} code Code
* @returns {string} Code that was just received
*/
this.emit(Events.CODE_RECEIVED, code);
return code;
});
this.requestPairingCode(pairWithPhoneNumber.phoneNumber, pairWithPhoneNumber.showNotification, pairWithPhoneNumber.intervalMs);
} else {
let qrRetries &#x3D; 0; let qrRetries &#x3D; 0;
await exposeFunctionIfAbsent(this.pupPage, &#x27;onQRChangedEvent&#x27;, async (qr) &#x3D;&gt; { await exposeFunctionIfAbsent(this.pupPage, &#x27;onQRChangedEvent&#x27;, async (qr) &#x3D;&gt; {
/** /**
@ -203,9 +219,10 @@ class Client extends EventEmitter {
window.AuthStore.Conn.on(&#x27;change:ref&#x27;, (_, ref) &#x3D;&gt; { window.onQRChangedEvent(getQR(ref)); }); // future QR changes window.AuthStore.Conn.on(&#x27;change:ref&#x27;, (_, ref) &#x3D;&gt; { window.onQRChangedEvent(getQR(ref)); }); // future QR changes
}); });
} }
}
await exposeFunctionIfAbsent(this.pupPage, &#x27;onAuthAppStateChangedEvent&#x27;, async (state) &#x3D;&gt; { await exposeFunctionIfAbsent(this.pupPage, &#x27;onAuthAppStateChangedEvent&#x27;, async (state) &#x3D;&gt; {
if (state &#x3D;&#x3D; &#x27;UNPAIRED_IDLE&#x27;) { if (state &#x3D;&#x3D; &#x27;UNPAIRED_IDLE&#x27; &amp;amp;&amp;amp; !pairWithPhoneNumber.phoneNumber) {
// refresh qr code // refresh qr code
window.Store.Cmd.refreshQR(); window.Store.Cmd.refreshQR();
} }
@ -374,15 +391,32 @@ class Client extends EventEmitter {
/** /**
* Request authentication via pairing code instead of QR code * Request authentication via pairing code instead of QR code
* @param {string} phoneNumber - Phone number in international, symbol-free format (e.g. 12025550108 for US, 551155501234 for Brazil) * @param {string} phoneNumber - Phone number in international, symbol-free format (e.g. 12025550108 for US, 551155501234 for Brazil)
* @param {boolean} showNotification - Show notification to pair on phone number * @param {boolean} [showNotification &#x3D; true] - Show notification to pair on phone number
* @param {number} [intervalMs &#x3D; 180000] - The interval in milliseconds on how frequent to generate pairing code (WhatsApp default to 3 minutes)
* @returns {Promise&amp;lt;string&gt;} - Returns a pairing code in format &quot;ABCDEFGH&quot; * @returns {Promise&amp;lt;string&gt;} - Returns a pairing code in format &quot;ABCDEFGH&quot;
*/ */
async requestPairingCode(phoneNumber, showNotification &#x3D; true) { async requestPairingCode(phoneNumber, showNotification &#x3D; true, intervalMs &#x3D; 180000) {
return await this.pupPage.evaluate(async (phoneNumber, showNotification) &#x3D;&gt; { return await this.pupPage.evaluate(async (phoneNumber, showNotification, intervalMs) &#x3D;&gt; {
const getCode &#x3D; async () &#x3D;&gt; {
while (!window.AuthStore.PairingCodeLinkUtils) {
await new Promise(resolve &#x3D;&gt; setTimeout(resolve, 250));
}
window.AuthStore.PairingCodeLinkUtils.setPairingType(&#x27;ALT_DEVICE_LINKING&#x27;); window.AuthStore.PairingCodeLinkUtils.setPairingType(&#x27;ALT_DEVICE_LINKING&#x27;);
await window.AuthStore.PairingCodeLinkUtils.initializeAltDeviceLinking(); await window.AuthStore.PairingCodeLinkUtils.initializeAltDeviceLinking();
return window.AuthStore.PairingCodeLinkUtils.startAltLinkingFlow(phoneNumber, showNotification); return window.AuthStore.PairingCodeLinkUtils.startAltLinkingFlow(phoneNumber, showNotification);
}, phoneNumber, showNotification); };
if (window.codeInterval) {
clearInterval(window.codeInterval); // remove existing interval
}
window.codeInterval &#x3D; setInterval(async () &#x3D;&gt; {
if (window.AuthStore.AppState.state !&#x3D; &#x27;UNPAIRED&#x27; &amp;amp;&amp;amp; window.AuthStore.AppState.state !&#x3D; &#x27;UNPAIRED_IDLE&#x27;) {
clearInterval(window.codeInterval);
return;
}
window.onCodeReceivedEvent(await getCode());
}, intervalMs);
return window.onCodeReceivedEvent(await getCode());
}, phoneNumber, showNotification, intervalMs);
} }
/** /**
@ -844,6 +878,19 @@ class Client extends EventEmitter {
}); });
} }
async setDeviceName(deviceName, browserName) {
(deviceName || browserName) &amp;amp;&amp;amp; await this.pupPage.evaluate((deviceName, browserName) &#x3D;&gt; {
const func &#x3D; window.require(&#x27;WAWebMiscBrowserUtils&#x27;).info;
window.require(&#x27;WAWebMiscBrowserUtils&#x27;).info &#x3D; () &#x3D;&gt; {
return {
...func(),
...(deviceName ? { os: deviceName } : {}),
...(browserName ? { name: browserName } : {})
};
};
}, deviceName, browserName);
}
/** /**
* Mark as seen for the Chat * Mark as seen for the Chat
* @param {string} chatId * @param {string} chatId
@ -954,6 +1001,9 @@ class Client extends EventEmitter {
} else if (content instanceof Poll) { } else if (content instanceof Poll) {
internalOptions.poll &#x3D; content; internalOptions.poll &#x3D; content;
content &#x3D; &#x27;&#x27;; content &#x3D; &#x27;&#x27;;
} else if (content instanceof ScheduledEvent) {
internalOptions.event &#x3D; content;
content &#x3D; &#x27;&#x27;;
} else if (content instanceof Contact) { } else if (content instanceof Contact) {
internalOptions.contactCard &#x3D; content.id._serialized; internalOptions.contactCard &#x3D; content.id._serialized;
content &#x3D; &#x27;&#x27;; content &#x3D; &#x27;&#x27;;
@ -1158,6 +1208,29 @@ class Client extends EventEmitter {
return null; return null;
} }
/**
* Gets instances of all pinned messages in a chat
* @param {string} chatId The chat ID
* @returns {Promise&amp;lt;[Message]|[]&gt;}
*/
async getPinnedMessages(chatId) {
const pinnedMsgs &#x3D; await this.pupPage.evaluate(async (chatId) &#x3D;&gt; {
const chatWid &#x3D; window.Store.WidFactory.createWid(chatId);
const chat &#x3D; window.Store.Chat.get(chatWid) ?? await window.Store.Chat.find(chatWid);
if (!chat) return [];
const msgs &#x3D; await window.Store.PinnedMsgUtils.getTable().equals([&#x27;chatId&#x27;], chatWid.toString());
const pinnedMsgs &#x3D; msgs.map((msg) &#x3D;&gt; window.Store.Msg.get(msg.parentMsgKey));
return !pinnedMsgs.length
? []
: pinnedMsgs.map((msg) &#x3D;&gt; window.WWebJS.getMessageModel(msg));
}, chatId);
return pinnedMsgs.map((msg) &#x3D;&gt; new Message(this, msg));
}
/** /**
* Returns an object with information about the invite code&#x27;s group * Returns an object with information about the invite code&#x27;s group
* @param {string} inviteCode * @param {string} inviteCode
@ -1559,6 +1632,10 @@ class Client extends EventEmitter {
* @property {string|undefined} parentGroupId The ID of a parent community group to link the newly created group with (won&#x27;t take an effect if the group is been creating with myself only) * @property {string|undefined} parentGroupId The ID of a parent community group to link the newly created group with (won&#x27;t take an effect if the group is been creating with myself only)
* @property {boolean} [autoSendInviteV4 &#x3D; true] If true, the inviteV4 will be sent to those participants who have restricted others from being automatically added to groups, otherwise the inviteV4 won&#x27;t be sent (true by default) * @property {boolean} [autoSendInviteV4 &#x3D; true] If true, the inviteV4 will be sent to those participants who have restricted others from being automatically added to groups, otherwise the inviteV4 won&#x27;t be sent (true by default)
* @property {string} [comment &#x3D; &#x27;&#x27;] The comment to be added to an inviteV4 (empty string by default) * @property {string} [comment &#x3D; &#x27;&#x27;] The comment to be added to an inviteV4 (empty string by default)
* @property {boolean} [memberAddMode &#x3D; false] If true, only admins can add members to the group (false by default)
* @property {boolean} [membershipApprovalMode &#x3D; false] If true, group admins will be required to approve anyone who wishes to join the group (false by default)
* @property {boolean} [isRestrict &#x3D; true] If true, only admins can change group group info (true by default)
* @property {boolean} [isAnnounce &#x3D; false] If true, only admins can send messages (false by default)
*/ */
/** /**
@ -1573,7 +1650,12 @@ class Client extends EventEmitter {
participants.map(p &#x3D;&gt; (p instanceof Contact) ? p.id._serialized : p); participants.map(p &#x3D;&gt; (p instanceof Contact) ? p.id._serialized : p);
return await this.pupPage.evaluate(async (title, participants, options) &#x3D;&gt; { return await this.pupPage.evaluate(async (title, participants, options) &#x3D;&gt; {
const { messageTimer &#x3D; 0, parentGroupId, autoSendInviteV4 &#x3D; true, comment &#x3D; &#x27;&#x27; } &#x3D; options; const {
messageTimer &#x3D; 0,
parentGroupId,
autoSendInviteV4 &#x3D; true,
comment &#x3D; &#x27;&#x27;,
} &#x3D; options;
const participantData &#x3D; {}, participantWids &#x3D; [], failedParticipants &#x3D; []; const participantData &#x3D; {}, participantWids &#x3D; [], failedParticipants &#x3D; [];
let createGroupResult, parentGroupWid; let createGroupResult, parentGroupWid;
@ -1586,7 +1668,9 @@ class Client extends EventEmitter {
for (const participant of participants) { for (const participant of participants) {
const pWid &#x3D; window.Store.WidFactory.createWid(participant); const pWid &#x3D; window.Store.WidFactory.createWid(participant);
if ((await window.Store.QueryExist(pWid))?.wid) participantWids.push(pWid); if ((await window.Store.QueryExist(pWid))?.wid) {
participantWids.push({ phoneNumber: pWid });
}
else failedParticipants.push(participant); else failedParticipants.push(participant);
} }
@ -1595,14 +1679,13 @@ class Client extends EventEmitter {
try { try {
createGroupResult &#x3D; await window.Store.GroupUtils.createGroup( createGroupResult &#x3D; await window.Store.GroupUtils.createGroup(
{ {
&#x27;memberAddMode&#x27;: options.memberAddMode &#x3D;&#x3D;&#x3D; undefined ? true : options.memberAddMode, &#x27;addressingModeOverride&#x27;: &#x27;lid&#x27;,
&#x27;membershipApprovalMode&#x27;: options.membershipApprovalMode &#x3D;&#x3D;&#x3D; undefined ? false : options.membershipApprovalMode, &#x27;memberAddMode&#x27;: options.memberAddMode ?? false,
&#x27;announce&#x27;: options.announce &#x3D;&#x3D;&#x3D; undefined ? true : options.announce, &#x27;membershipApprovalMode&#x27;: options.membershipApprovalMode ?? false,
&#x27;announce&#x27;: options.announce ?? false,
&#x27;restrict&#x27;: options.isRestrict !&#x3D;&#x3D; undefined ? !options.isRestrict : false,
&#x27;ephemeralDuration&#x27;: messageTimer, &#x27;ephemeralDuration&#x27;: messageTimer,
&#x27;full&#x27;: undefined,
&#x27;parentGroupId&#x27;: parentGroupWid, &#x27;parentGroupId&#x27;: parentGroupWid,
&#x27;restrict&#x27;: options.restrict &#x3D;&#x3D;&#x3D; undefined ? true : options.restrict,
&#x27;thumb&#x27;: undefined,
&#x27;title&#x27;: title, &#x27;title&#x27;: title,
}, },
participantWids participantWids
@ -1613,13 +1696,14 @@ class Client extends EventEmitter {
for (const participant of createGroupResult.participants) { for (const participant of createGroupResult.participants) {
let isInviteV4Sent &#x3D; false; let isInviteV4Sent &#x3D; false;
participant.wid.server &#x3D;&#x3D; &#x27;lid&#x27; &amp;amp;&amp;amp; (participant.wid &#x3D; window.Store.LidUtils.getPhoneNumber(participant.wid));
const participantId &#x3D; participant.wid._serialized; const participantId &#x3D; participant.wid._serialized;
const statusCode &#x3D; participant.error || 200; const statusCode &#x3D; participant.error || 200;
if (autoSendInviteV4 &amp;amp;&amp;amp; statusCode &#x3D;&#x3D;&#x3D; 403) { if (autoSendInviteV4 &amp;amp;&amp;amp; statusCode &#x3D;&#x3D;&#x3D; 403) {
window.Store.Contact.gadd(participant.wid, { silent: true }); window.Store.Contact.gadd(participant.wid, { silent: true });
const addParticipantResult &#x3D; await window.Store.GroupInviteV4.sendGroupInviteMessage( const addParticipantResult &#x3D; await window.Store.GroupInviteV4.sendGroupInviteMessage(
await window.Store.Chat.find(participant.wid), window.Store.Chat.get(participant.wid) || await window.Store.Chat.find(participant.wid),
createGroupResult.wid._serialized, createGroupResult.wid._serialized,
createGroupResult.subject, createGroupResult.subject,
participant.invite_code, participant.invite_code,
@ -1627,9 +1711,7 @@ class Client extends EventEmitter {
comment, comment,
await window.WWebJS.getProfilePicThumbToBase64(createGroupResult.wid) await window.WWebJS.getProfilePicThumbToBase64(createGroupResult.wid)
); );
isInviteV4Sent &#x3D; window.compareWwebVersions(window.Debug.VERSION, &#x27;&amp;lt;&#x27;, &#x27;2.2335.6&#x27;) isInviteV4Sent &#x3D; addParticipantResult.messageSendResult &#x3D;&#x3D;&#x3D; &#x27;OK&#x27;;
? addParticipantResult &#x3D;&#x3D;&#x3D; &#x27;OK&#x27;
: addParticipantResult.messageSendResult &#x3D;&#x3D;&#x3D; &#x27;OK&#x27;;
} }
participantData[participantId] &#x3D; { participantData[participantId] &#x3D; {
@ -2179,6 +2261,45 @@ class Client extends EventEmitter {
}, chatId); }, chatId);
} }
/**
* Generates a WhatsApp call link (video call or voice call)
* @param {Date} startTime The start time of the call
* @param {string} callType The type of a WhatsApp call link to generate, valid values are: &#x60;video&#x60; | &#x60;voice&#x60;
* @returns {Promise&amp;lt;string&gt;} The WhatsApp call link (https://call.whatsapp.com/video/XxXxXxXxXxXxXx) or an empty string if a generation failed.
*/
async createCallLink(startTime, callType) {
if (![&#x27;video&#x27;, &#x27;voice&#x27;].includes(callType)) {
throw new class CreateCallLinkError extends Error {
constructor(m) { super(m); }
}(&#x27;Invalid \&#x27;callType\&#x27; parameter value is provided. Valid values are: \&#x27;voice\&#x27; | \&#x27;video\&#x27;.&#x27;);
}
startTime &#x3D; Math.floor(startTime.getTime() / 1000);
return await this.pupPage.evaluate(async (startTimeTs, callType) &#x3D;&gt; {
const response &#x3D; await window.Store.ScheduledEventMsgUtils.createEventCallLink(startTimeTs, callType);
return response ?? &#x27;&#x27;;
}, startTime, callType);
}
/**
* Sends a response to the scheduled event message, indicating whether a user is going to attend the event or not
* @param {number} response The response code to the scheduled event message. Valid values are: &#x60;0&#x60; for NONE response (removes a previous response) | &#x60;1&#x60; for GOING | &#x60;2&#x60; for NOT GOING | &#x60;3&#x60; for MAYBE going
* @param {string} eventMessageId The scheduled event message ID
* @returns {Promise&amp;lt;boolean&gt;}
*/
async sendResponseToScheduledEvent(response, eventMessageId) {
if (![0, 1, 2, 3].includes(response)) return false;
return await this.pupPage.evaluate(async (response, msgId) &#x3D;&gt; {
const eventMsg &#x3D; window.Store.Msg.get(msgId) || (await window.Store.Msg.getMessagesById([msgId]))?.messages?.[0];
if (!eventMsg) return false;
await window.Store.ScheduledEventMsgUtils.sendEventResponseMsg(response, eventMsg);
return true;
}, response, eventMessageId);
}
/** /**
* Save new contact to user&#x27;s addressbook or edit the existing one * Save new contact to user&#x27;s addressbook or edit the existing one
* @param {string} phoneNumber The contact&#x27;s phone number in a format &quot;17182222222&quot;, where &quot;1&quot; is a country code * @param {string} phoneNumber The contact&#x27;s phone number in a format &quot;17182222222&quot;, where &quot;1&quot; is a country code
@ -2211,6 +2332,28 @@ class Client extends EventEmitter {
return await window.Store.AddressbookContactUtils.deleteContactAction(phoneNumber); return await window.Store.AddressbookContactUtils.deleteContactAction(phoneNumber);
}, phoneNumber); }, phoneNumber);
} }
/**
* Get lid and phone number for multiple users
* @param {string[]} userIds - Array of user IDs
* @returns {Promise&amp;lt;Array&amp;lt;{ lid: string, pn: string }&gt;&gt;}
*/
async getContactLidAndPhone(userIds) {
return await this.pupPage.evaluate((userIds) &#x3D;&gt; {
!Array.isArray(userIds) &amp;amp;&amp;amp; (userIds &#x3D; [userIds]);
return userIds.map(userId &#x3D;&gt; {
const wid &#x3D; window.Store.WidFactory.createWid(userId);
const isLid &#x3D; wid.server &#x3D;&#x3D;&#x3D; &#x27;lid&#x27;;
const lid &#x3D; isLid ? wid : window.Store.LidUtils.getCurrentLid(wid);
const phone &#x3D; isLid ? window.Store.LidUtils.getPhoneNumber(wid) : wid;
return {
lid: lid._serialized,
pn: phone._serialized
};
});
}, userIds);
}
} }
module.exports &#x3D; Client; module.exports &#x3D; Client;
@ -2224,7 +2367,7 @@ module.exports &#x3D; Client;
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: ClientInfo</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: ClientInfo</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -242,7 +242,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Contact</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Contact</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -293,7 +293,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: GroupChat</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: GroupChat</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -137,14 +137,17 @@
<dt><a href="GroupChat.html#getGroupMembershipRequests">getGroupMembershipRequests()</a></dt> <dt><a href="GroupChat.html#getGroupMembershipRequests">getGroupMembershipRequests()</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="GroupChat.html#getInviteCode">getInviteCode()</a></dt>
<dd>
</dd>
</dl> </dl>
</div> </div>
<div class="summary-column"> <div class="summary-column">
<dl class="dl-summary-callout"> <dl class="dl-summary-callout">
<dt><a href="GroupChat.html#getInviteCode">getInviteCode()</a></dt> <dt><a href="GroupChat.html#getLabels">getLabels()</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="GroupChat.html#getLabels">getLabels()</a></dt> <dt><a href="GroupChat.html#getPinnedMessages">getPinnedMessages()</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="GroupChat.html#leave">leave()</a></dt> <dt><a href="GroupChat.html#leave">leave()</a></dt>
@ -177,13 +180,13 @@
<dt><a href="GroupChat.html#sendSeen">sendSeen()</a></dt> <dt><a href="GroupChat.html#sendSeen">sendSeen()</a></dt>
<dd> <dd>
</dd> </dd>
<dt><a href="GroupChat.html#sendStateRecording">sendStateRecording()</a></dt>
<dd>
</dd>
</dl> </dl>
</div> </div>
<div class="summary-column"> <div class="summary-column">
<dl class="dl-summary-callout"> <dl class="dl-summary-callout">
<dt><a href="GroupChat.html#sendStateRecording">sendStateRecording()</a></dt>
<dd>
</dd>
<dt><a href="GroupChat.html#sendStateTyping">sendStateTyping()</a></dt> <dt><a href="GroupChat.html#sendStateTyping">sendStateTyping()</a></dt>
<dd> <dd>
</dd> </dd>
@ -668,6 +671,15 @@
<dd></dd> <dd></dd>
</dl> </dl>
<div class="symbol-detail-labels"><span class="label label-async">async</span></div> <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">()</span></span></h3>
<p>Gets instances of all pinned messages in a chat</p>
<dl class="dl-compact">
<dt>Inherited from</dt>
<dd><a href="Chat.html#getPinnedMessages">Chat#getPinnedMessages</a></dd>
<dt>Returns</dt>
<dd></dd>
</dl>
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
<h3 id="leave"><span class="symbol-name">leave</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise</span></span></h3> <h3 id="leave"><span class="symbol-name">leave</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise</span></span></h3>
<p>Makes the bot leave the group</p> <p>Makes the bot leave the group</p>
<dl class="dl-compact"> <dl class="dl-compact">
@ -1225,7 +1237,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: GroupNotification</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: GroupNotification</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -233,7 +233,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: InterfaceController</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: InterfaceController</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -382,7 +382,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Label</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Label</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -163,7 +163,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: List</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: List</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -256,7 +256,7 @@ Returns: [{&#x27;title&#x27;:&#x27;sectionTitle&#x27;,&#x27;rows&#x27;:[{&#x27;r
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: LocalAuth</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: LocalAuth</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -134,7 +134,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: LocalWebCache</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: LocalWebCache</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -120,7 +120,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

View file

@ -4,7 +4,7 @@
<head> <head>
<meta name="generator" content="JSDoc 3.6.11"> <meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8"> <meta charset="utf-8">
<title>whatsapp-web.js 1.31.1-alpha.0 &raquo; Class: Location</title> <title>whatsapp-web.js 1.32.0 &raquo; Class: Location</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/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/Noto+Serif:400,400i,700,700i" type="text/css">
<link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css"> <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
@ -15,7 +15,7 @@
<nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar"> <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
<div id="jsdoc-navbar-container"> <div id="jsdoc-navbar-container">
<div id="jsdoc-navbar-content"> <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>
</div> </div>
</nav> </nav>
@ -173,7 +173,7 @@
<footer id="jsdoc-footer" class="jsdoc-footer"> <footer id="jsdoc-footer" class="jsdoc-footer">
<div id="jsdoc-footer-container"> <div id="jsdoc-footer-container">
<p> <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> </p>
</div> </div>
</footer> </footer>

Some files were not shown because too many files have changed in this diff Show more