mirror of
https://github.com/cheveguerra/whatsapp-web.js.git
synced 2026-04-18 03:29:14 +00:00
397 lines
16 KiB
HTML
397 lines
16 KiB
HTML
<!doctype html>
|
|
<html>
|
|
|
|
<head>
|
|
<meta name="generator" content="JSDoc 3.6.7">
|
|
<meta charset="utf-8">
|
|
<title>whatsapp-web.js 1.15.0 » 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/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>15.<wbr>0</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">InterfaceController</span></h1>
|
|
<p class="source-link">Source: <a href="util_InterfaceController.js.html#source-line-6">util/<wbr>InterfaceController.<wbr>js:6</a></p>
|
|
<div class="symbol-classdesc">
|
|
<p>Interface Controller</p>
|
|
</div>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
</header>
|
|
<section id="summary">
|
|
<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="InterfaceController.html#checkFeatureStatus">checkFeatureStatus(feature)</a></dt>
|
|
<dd>
|
|
</dd>
|
|
<dt><a href="InterfaceController.html#closeRightDrawer">closeRightDrawer()</a></dt>
|
|
<dd>
|
|
</dd>
|
|
<dt><a href="InterfaceController.html#disableFeatures">disableFeatures(features)</a></dt>
|
|
<dd>
|
|
</dd>
|
|
<dt><a href="InterfaceController.html#enableFeatures">enableFeatures(features)</a></dt>
|
|
<dd>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="summary-column">
|
|
<dl class="dl-summary-callout">
|
|
<dt><a href="InterfaceController.html#getFeatures">getFeatures()</a></dt>
|
|
<dd>
|
|
</dd>
|
|
<dt><a href="InterfaceController.html#openChatDrawer">openChatDrawer(chatId)</a></dt>
|
|
<dd>
|
|
</dd>
|
|
<dt><a href="InterfaceController.html#openChatSearch">openChatSearch(chatId)</a></dt>
|
|
<dd>
|
|
</dd>
|
|
<dt><a href="InterfaceController.html#openChatWindow">openChatWindow(chatId)</a></dt>
|
|
<dd>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="summary-column">
|
|
<dl class="dl-summary-callout">
|
|
<dt><a href="InterfaceController.html#openChatWindowAt">openChatWindowAt(msgId)</a></dt>
|
|
<dd>
|
|
</dd>
|
|
<dt><a href="InterfaceController.html#openMessageDrawer">openMessageDrawer(msgId)</a></dt>
|
|
<dd>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section>
|
|
<h2 id="InterfaceController">new <span class="symbol-name">InterfaceController</span><span class="signature"><span class="signature-params">()</span></span></h2>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2>Methods</h2>
|
|
<section>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="checkFeatureStatus"><span class="symbol-name">checkFeatureStatus</span><span class="signature"><span class="signature-params">(feature)</span></span></h3>
|
|
<p>Check if Feature is enabled</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>feature</p>
|
|
</td>
|
|
<td>
|
|
<p>string</p>
|
|
</td>
|
|
<td>
|
|
<p> </p>
|
|
</td>
|
|
<td>
|
|
<p>status to check</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="closeRightDrawer"><span class="symbol-name">closeRightDrawer</span><span class="signature"><span class="signature-params">()</span></span></h3>
|
|
<p>Closes the Right Drawer</p>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="disableFeatures"><span class="symbol-name">disableFeatures</span><span class="signature"><span class="signature-params">(features)</span></span></h3>
|
|
<p>Disable Features</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>features</p>
|
|
</td>
|
|
<td>
|
|
<p>Array of string</p>
|
|
</td>
|
|
<td>
|
|
<p> </p>
|
|
</td>
|
|
<td>
|
|
<p>to be disabled</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="enableFeatures"><span class="symbol-name">enableFeatures</span><span class="signature"><span class="signature-params">(features)</span></span></h3>
|
|
<p>Enable Features</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>features</p>
|
|
</td>
|
|
<td>
|
|
<p>Array of string</p>
|
|
</td>
|
|
<td>
|
|
<p> </p>
|
|
</td>
|
|
<td>
|
|
<p>to be enabled</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="getFeatures"><span class="symbol-name">getFeatures</span><span class="signature"><span class="signature-params">()</span></span></h3>
|
|
<p>Get all Features</p>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="openChatDrawer"><span class="symbol-name">openChatDrawer</span><span class="signature"><span class="signature-params">(chatId)</span></span></h3>
|
|
<p>Opens the Chat Drawer</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>ID of the chat drawer that will be opened</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="openChatSearch"><span class="symbol-name">openChatSearch</span><span class="signature"><span class="signature-params">(chatId)</span></span></h3>
|
|
<p>Opens the Chat Search</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>ID of the chat search that will be opened</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="openChatWindow"><span class="symbol-name">openChatWindow</span><span class="signature"><span class="signature-params">(chatId)</span></span></h3>
|
|
<p>Opens the Chat Window</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>ID of the chat window that will be opened</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="openChatWindowAt"><span class="symbol-name">openChatWindowAt</span><span class="signature"><span class="signature-params">(msgId)</span></span></h3>
|
|
<p>Opens or Scrolls the Chat Window to the position of the message</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>msgId</p>
|
|
</td>
|
|
<td>
|
|
<p>string</p>
|
|
</td>
|
|
<td>
|
|
<p> </p>
|
|
</td>
|
|
<td>
|
|
<p>ID of the message that will be scrolled to</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<dl class="dl-compact">
|
|
</dl>
|
|
<div class="symbol-detail-labels"><span class="label label-async">async</span></div>
|
|
<h3 id="openMessageDrawer"><span class="symbol-name">openMessageDrawer</span><span class="signature"><span class="signature-params">(msgId)</span></span></h3>
|
|
<p>Opens the Message Drawer</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>msgId</p>
|
|
</td>
|
|
<td>
|
|
<p>string</p>
|
|
</td>
|
|
<td>
|
|
<p> </p>
|
|
</td>
|
|
<td>
|
|
<p>ID of the message drawer that will be opened</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<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.7 on October 30, 2021.
|
|
</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> |