mirror of
https://github.com/cheveguerra/whatsapp-web.js.git
synced 2026-04-18 11:39:14 +00:00
365 lines
16 KiB
HTML
365 lines
16 KiB
HTML
<!doctype html>
|
||
<html>
|
||
|
||
<head>
|
||
<meta name="generator" content="JSDoc 3.6.3">
|
||
<meta charset="utf-8">
|
||
<title>whatsapp-web.js 1.2.3 » 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/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 href="css/baseline.css" rel="stylesheet">
|
||
</head>
|
||
|
||
<body onload="prettyPrint()">
|
||
<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>2.<wbr>3</a>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
<div id="jsdoc-body-container">
|
||
<div id="jsdoc-content">
|
||
<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">Chat</span></h1>
|
||
<p class="source-link">Source: <a href="structures_Chat.js.html#source-line-11">structures/<wbr>Chat.<wbr>js:11</a></p>
|
||
<div class="symbol-classdesc">
|
||
<p>Represents a Chat on WhatsApp</p>
|
||
</div>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
</header>
|
||
<section id="summary">
|
||
<div class="summary-callout">
|
||
<h2 class="summary-callout-heading">Properties</h2>
|
||
<div class="summary-content">
|
||
<div class="summary-column">
|
||
<dl class="dl-summary-callout">
|
||
<dt><a href="Chat.html#archived">archived</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#id">id</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#isGroup">isGroup</a></dt>
|
||
<dd>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div class="summary-column">
|
||
<dl class="dl-summary-callout">
|
||
<dt><a href="Chat.html#isReadOnly">isReadOnly</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#name">name</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#timestamp">timestamp</a></dt>
|
||
<dd>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div class="summary-column">
|
||
<dl class="dl-summary-callout">
|
||
<dt><a href="Chat.html#unreadCount">unreadCount</a></dt>
|
||
<dd>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="summary-callout">
|
||
<h2 class="summary-callout-heading">Methods</h2>
|
||
<div class="summary-content">
|
||
<div class="summary-column">
|
||
<dl class="dl-summary-callout">
|
||
<dt><a href="Chat.html#archive">archive()</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#clearMessages">clearMessages()</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#clearState">clearState()</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#delete">delete()</a></dt>
|
||
<dd>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div class="summary-column">
|
||
<dl class="dl-summary-callout">
|
||
<dt><a href="Chat.html#fetchMessages">fetchMessages(searchOptions)</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#sendMessage">sendMessage(content, options)</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#sendSeen">sendSeen()</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#sendStateRecording">sendStateRecording()</a></dt>
|
||
<dd>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div class="summary-column">
|
||
<dl class="dl-summary-callout">
|
||
<dt><a href="Chat.html#sendStateTyping">sendStateTyping()</a></dt>
|
||
<dd>
|
||
</dd>
|
||
<dt><a href="Chat.html#unarchive">unarchive()</a></dt>
|
||
<dd>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section>
|
||
<h2 id="Chat">new <span class="symbol-name">Chat</span><span class="signature"><span class="signature-params">()</span></span></h2>
|
||
<dl class="dl-compact">
|
||
<dt>Extends</dt>
|
||
<dd><a href="Base.html">Base</a></dd>
|
||
</dl>
|
||
</section>
|
||
<section>
|
||
<h2>Properties</h2>
|
||
<section>
|
||
<h3 id="archived"><span class="symbol-name">archived</span><small class="property-type">
|
||
boolean</small></h3>
|
||
<p>Indicates if the Chat is archived</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<h3 id="id"><span class="symbol-name">id</span><small class="property-type">
|
||
object</small></h3>
|
||
<p>ID that represents the chat</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<h3 id="isGroup"><span class="symbol-name">isGroup</span><small class="property-type">
|
||
boolean</small></h3>
|
||
<p>Indicates if the Chat is a Group Chat</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<h3 id="isReadOnly"><span class="symbol-name">isReadOnly</span><small class="property-type">
|
||
boolean</small></h3>
|
||
<p>Indicates if the Chat is readonly</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<h3 id="name"><span class="symbol-name">name</span><small class="property-type">
|
||
string</small></h3>
|
||
<p>Title of the chat</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<h3 id="timestamp"><span class="symbol-name">timestamp</span><small class="property-type">
|
||
number</small></h3>
|
||
<p>Unix timestamp for when the chat was created</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<h3 id="unreadCount"><span class="symbol-name">unreadCount</span><small class="property-type">
|
||
number</small></h3>
|
||
<p>Amount of messages unread</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
</section>
|
||
<h2>Methods</h2>
|
||
<section>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="archive"><span class="symbol-name">archive</span><span class="signature"><span class="signature-params">()</span></span></h3>
|
||
<p>Archives this chat</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="clearMessages"><span class="symbol-name">clearMessages</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> Promise containing Boolean</span></span></h3>
|
||
<p>Clears all messages from the chat</p>
|
||
<dl class="dl-compact">
|
||
<dt>Returns</dt>
|
||
<dd>
|
||
<p><code>Promise containing Boolean</code> <p>result</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="clearState"><span class="symbol-name">clearState</span><span class="signature"><span class="signature-params">()</span></span></h3>
|
||
<p>Stops typing or recording in chat immediately.</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="delete"><span class="symbol-name">delete</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> Promise containing Boolean</span></span></h3>
|
||
<p>Deletes the chat</p>
|
||
<dl class="dl-compact">
|
||
<dt>Returns</dt>
|
||
<dd>
|
||
<p><code>Promise containing Boolean</code> <p>result</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="fetchMessages"><span class="symbol-name">fetchMessages</span><span class="signature"><span class="signature-params">(searchOptions)</span> → <span class="signature-returns"> Promise containing Array of <a href="Message.html">Message</a></span></span></h3>
|
||
<p>Loads chat messages, sorted from earliest to latest.</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>searchOptions</p>
|
||
</td>
|
||
<td>
|
||
<p>Object</p>
|
||
</td>
|
||
<td>
|
||
<p> </p>
|
||
</td>
|
||
<td>
|
||
<p>Options for searching messages. Right now only limit is supported.</p>
|
||
<p>Values in <code>searchOptions</code> have the following properties:</p>
|
||
<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>limit</p>
|
||
</td>
|
||
<td>
|
||
<p>Number</p>
|
||
</td>
|
||
<td>
|
||
<p>Yes</p>
|
||
</td>
|
||
<td>
|
||
<p>The amount of messages to return. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.</p>
|
||
<p>Defaults to <code>50</code>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<dl class="dl-compact">
|
||
<dt>Returns</dt>
|
||
<dd>
|
||
<p><code>Promise containing Array of <a href="Message.html">Message</a></code> </p>
|
||
</dd>
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="sendMessage"><span class="symbol-name">sendMessage</span><span class="signature"><span class="signature-params">(content, options)</span> → <span class="signature-returns"> Promise containing <a href="Message.html">Message</a></span></span></h3>
|
||
<p>Send a message to this chat</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>content</p>
|
||
</td>
|
||
<td>
|
||
<p>(string, <a href="MessageMedia.html">MessageMedia</a>, or <a href="Location.html">Location</a>)</p>
|
||
</td>
|
||
<td>
|
||
<p> </p>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<p>options</p>
|
||
</td>
|
||
<td>
|
||
<p>object</p>
|
||
</td>
|
||
<td>
|
||
<p> </p>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<dl class="dl-compact">
|
||
<dt>Returns</dt>
|
||
<dd>
|
||
<p><code>Promise containing <a href="Message.html">Message</a></code> <p>Message that was just sent</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="sendSeen"><span class="symbol-name">sendSeen</span><span class="signature"><span class="signature-params">()</span> → <span class="signature-returns"> Promise containing Boolean</span></span></h3>
|
||
<p>Set the message as seen</p>
|
||
<dl class="dl-compact">
|
||
<dt>Returns</dt>
|
||
<dd>
|
||
<p><code>Promise containing Boolean</code> <p>result</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="sendStateRecording"><span class="symbol-name">sendStateRecording</span><span class="signature"><span class="signature-params">()</span></span></h3>
|
||
<p>Simulate recording audio in chat. This will last for 25 seconds.</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="sendStateTyping"><span class="symbol-name">sendStateTyping</span><span class="signature"><span class="signature-params">()</span></span></h3>
|
||
<p>Simulate typing in chat. This will last for 25 seconds.</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
||
<h3 id="unarchive"><span class="symbol-name">unarchive</span><span class="signature"><span class="signature-params">()</span></span></h3>
|
||
<p>un-archives this chat</p>
|
||
<dl class="dl-compact">
|
||
</dl>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<nav id="jsdoc-toc-nav" role="navigation"></nav>
|
||
</div>
|
||
</div>
|
||
<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.3 on March 13, 2020.
|
||
</p>
|
||
</div>
|
||
</footer>
|
||
<script src="scripts/jquery.min.js"></script>
|
||
<script src="scripts/tree.jquery.js"></script>
|
||
<script src="scripts/prettify.js"></script>
|
||
<script src="scripts/jsdoc-toc.js"></script>
|
||
<script src="scripts/linenumber.js"></script>
|
||
<script src="scripts/scrollanchor.js"></script>
|
||
</body>
|
||
|
||
</html> |