UNPKG

bot_genshin

Version:
248 lines (245 loc) 11.2 kB
<!doctype html> <html> <head> <meta name="generator" content="JSDoc 3.6.7"> <meta charset="utf-8"> <title>whatsapp-web.js 1.14.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/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>14.<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">GroupNotification</span></h1> <p class="source-link">Source: <a href="structures_GroupNotification.js.html#source-line-9">structures/<wbr>GroupNotification.<wbr>js:9</a></p> <div class="symbol-classdesc"> <p>Represents a GroupNotification 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="GroupNotification.html#author">author</a></dt> <dd> </dd> <dt><a href="GroupNotification.html#body">body</a></dt> <dd> </dd> <dt><a href="GroupNotification.html#chatId">chatId</a></dt> <dd> </dd> </dl> </div> <div class="summary-column"> <dl class="dl-summary-callout"> <dt><a href="GroupNotification.html#id">id</a></dt> <dd> </dd> <dt><a href="GroupNotification.html#recipientIds">recipientIds</a></dt> <dd> </dd> <dt><a href="GroupNotification.html#timestamp">timestamp</a></dt> <dd> </dd> </dl> </div> <div class="summary-column"> <dl class="dl-summary-callout"> <dt><a href="GroupNotification.html#type">type</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="GroupNotification.html#getChat">getChat()</a></dt> <dd> </dd> <dt><a href="GroupNotification.html#getContact">getContact()</a></dt> <dd> </dd> </dl> </div> <div class="summary-column"> <dl class="dl-summary-callout"> <dt><a href="GroupNotification.html#getRecipients">getRecipients()</a></dt> <dd> </dd> <dt><a href="GroupNotification.html#reply">reply(content, options)</a></dt> <dd> </dd> </dl> </div> <div class="summary-column"> </div> </div> </div> </section> <section> <h2 id="GroupNotification">new&nbsp;<span class="symbol-name">GroupNotification</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="author"><span class="symbol-name">author</span><small class="property-type"> &nbsp;string</small></h3> <p>ContactId for the user that produced the GroupNotification.</p> <dl class="dl-compact"> </dl> <h3 id="body"><span class="symbol-name">body</span><small class="property-type"> &nbsp;string</small></h3> <p>Extra content</p> <dl class="dl-compact"> </dl> <h3 id="chatId"><span class="symbol-name">chatId</span><small class="property-type"> &nbsp;string</small></h3> <p>ID for the Chat that this groupNotification was sent for.</p> <dl class="dl-compact"> </dl> <h3 id="id"><span class="symbol-name">id</span><small class="property-type"> &nbsp;object</small></h3> <p>ID that represents the groupNotification</p> <dl class="dl-compact"> </dl> <h3 id="recipientIds"><span class="symbol-name">recipientIds</span><small class="property-type"> &nbsp;Array of string</small></h3> <p>Contact IDs for the users that were affected by this GroupNotification.</p> <dl class="dl-compact"> </dl> <h3 id="timestamp"><span class="symbol-name">timestamp</span><small class="property-type"> &nbsp;number</small></h3> <p>Unix timestamp for when the groupNotification was created</p> <dl class="dl-compact"> </dl> <h3 id="type"><span class="symbol-name">type</span><small class="property-type"> &nbsp;<a href="global.html#GroupNotificationTypes">GroupNotificationTypes</a></small></h3> <p>GroupNotification type</p> <dl class="dl-compact"> </dl> </section> <h2>Methods</h2> <section> <h3 id="getChat"><span class="symbol-name">getChat</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing <a href="Chat.html">Chat</a></span></span></h3> <p>Returns the Chat this groupNotification was sent in</p> <dl class="dl-compact"> <dt>Returns</dt> <dd> <p><code>Promise containing <a href="Chat.html">Chat</a></code> </p> </dd> </dl> <h3 id="getContact"><span class="symbol-name">getContact</span><span class="signature"><span class="signature-params">()</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing <a href="Contact.html">Contact</a></span></span></h3> <p>Returns the Contact this GroupNotification was produced by</p> <dl class="dl-compact"> <dt>Returns</dt> <dd> <p><code>Promise containing <a href="Contact.html">Contact</a></code> </p> </dd> </dl> <div class="symbol-detail-labels"><span class="label label-async">async</span></div> <h3 id="getRecipients"><span class="symbol-name">getRecipients</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>Returns the Contacts affected by this GroupNotification.</p> <dl class="dl-compact"> <dt>Returns</dt> <dd> <p><code>Promise containing Array of <a href="Contact.html">Contact</a></code> </p> </dd> </dl> <div class="symbol-detail-labels"><span class="label label-async">async</span></div> <h3 id="reply"><span class="symbol-name">reply</span><span class="signature"><span class="signature-params">(content, options)</span>&nbsp;&rarr; <span class="signature-returns"> Promise containing <a href="Message.html">Message</a></span></span></h3> <p>Sends a message to the same chat this GroupNotification was produced in.</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>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>options</p> </td> <td> <p>object</p> </td> <td> <p>&nbsp;</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> </dd> </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 August 1, 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>