UNPKG

bot_genshin

Version:
1,528 lines (1,526 loc) 53 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; Globals</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"> <h1>Globals</h1> <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="global.html#ChatTypes">ChatTypes</a></dt> <dd> </dd> <dt><a href="global.html#Events">Events</a></dt> <dd> </dd> <dt><a href="global.html#GroupNotificationTypes">GroupNotificationTypes</a></dt> <dd> </dd> </dl> </div> <div class="summary-column"> <dl class="dl-summary-callout"> <dt><a href="global.html#MessageAck">MessageAck</a></dt> <dd> </dd> <dt><a href="global.html#MessageTypes">MessageTypes</a></dt> <dd> </dd> <dt><a href="global.html#Status">Status</a></dt> <dd> </dd> </dl> </div> <div class="summary-column"> <dl class="dl-summary-callout"> <dt><a href="global.html#WAState">WAState</a></dt> <dd> </dd> </dl> </div> </div> </div> <div class="summary-callout"> <h2 class="summary-callout-heading">Abstract types</h2> <div class="summary-content"> <div class="summary-column"> <dl class="dl-summary-callout"> <dt><a href="global.html#ContactId">ContactId</a></dt> <dd> </dd> <dt><a href="global.html#GroupParticipant">GroupParticipant</a></dt> <dd> </dd> </dl> </div> <div class="summary-column"> <dl class="dl-summary-callout"> <dt><a href="global.html#MessageInfo">MessageInfo</a></dt> <dd> </dd> <dt><a href="global.html#MessageSendOptions">MessageSendOptions</a></dt> <dd> </dd> </dl> </div> <div class="summary-column"> <dl class="dl-summary-callout"> <dt><a href="global.html#StickerMetadata">StickerMetadata</a></dt> <dd> </dd> </dl> </div> </div> </div> </section> <section> <h2>Properties</h2> <section> <div class="symbol-detail-labels"><span class="label label-readonly">read-only</span></div> <h3 id="ChatTypes"><span class="symbol-name">ChatTypes</span><small class="property-type"> &nbsp;string</small></h3> <p>Chat types</p> <section> <h4>Properties</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>SOLO</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>GROUP</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>UNKNOWN</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <div class="symbol-detail-labels"><span class="label label-readonly">read-only</span></div> <h3 id="Events"><span class="symbol-name">Events</span><small class="property-type"> &nbsp;string</small></h3> <p>Events that can be emitted by the client</p> <section> <h4>Properties</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>AUTHENTICATED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>AUTHENTICATION_FAILURE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>READY</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>MESSAGE_RECEIVED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>MESSAGE_CREATE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>MESSAGE_REVOKED_EVERYONE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>MESSAGE_REVOKED_ME</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>MESSAGE_ACK</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>MEDIA_UPLOADED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>GROUP_JOIN</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>GROUP_LEAVE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>GROUP_UPDATE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>QR_RECEIVED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>DISCONNECTED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>STATE_CHANGED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>BATTERY_CHANGED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>INCOMING_CALL</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <div class="symbol-detail-labels"><span class="label label-readonly">read-only</span></div> <h3 id="GroupNotificationTypes"><span class="symbol-name">GroupNotificationTypes</span><small class="property-type"> &nbsp;string</small></h3> <p>Group notification types</p> <section> <h4>Properties</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>ADD</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>INVITE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>REMOVE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>LEAVE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>SUBJECT</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>DESCRIPTION</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>PICTURE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>ANNOUNCE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>RESTRICT</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <div class="symbol-detail-labels"><span class="label label-readonly">read-only</span></div> <h3 id="MessageAck"><span class="symbol-name">MessageAck</span><small class="property-type"> &nbsp;number</small></h3> <p>Message ACK</p> <section> <h4>Properties</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>ACK_ERROR</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>ACK_PENDING</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>ACK_SERVER</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>ACK_DEVICE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>ACK_READ</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>ACK_PLAYED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <div class="symbol-detail-labels"><span class="label label-readonly">read-only</span></div> <h3 id="MessageTypes"><span class="symbol-name">MessageTypes</span><small class="property-type"> &nbsp;string</small></h3> <p>Message types</p> <section> <h4>Properties</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>TEXT</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>AUDIO</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>VOICE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>IMAGE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>VIDEO</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>DOCUMENT</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>STICKER</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>LOCATION</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>CONTACT_CARD</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>CONTACT_CARD_MULTI</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>ORDER</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>REVOKED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>PRODUCT</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>UNKNOWN</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>GROUP_INVITE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <div class="symbol-detail-labels"><span class="label label-readonly">read-only</span></div> <h3 id="Status"><span class="symbol-name">Status</span><small class="property-type"> &nbsp;number</small></h3> <p>Client status</p> <section> <h4>Properties</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>INITIALIZING</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>AUTHENTICATING</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>READY</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <div class="symbol-detail-labels"><span class="label label-readonly">read-only</span></div> <h3 id="WAState"><span class="symbol-name">WAState</span><small class="property-type"> &nbsp;string</small></h3> <p>WhatsApp state</p> <section> <h4>Properties</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>CONFLICT</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>CONNECTED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>DEPRECATED_VERSION</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>OPENING</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>PAIRING</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>PROXYBLOCK</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>SMB_TOS_BLOCK</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>TIMEOUT</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>TOS_BLOCK</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>UNLAUNCHED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>UNPAIRED</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>UNPAIRED_IDLE</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> </section> <h2>Abstract types</h2> <section> <h3 id="ContactId"><span class="symbol-name">ContactId</span><small class="property-type"> &nbsp;Object</small></h3> <p>ID that represents a contact</p> <section> <h4>Properties</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>server</p> </td> <td> <p>string</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>user</p> </td> <td> <p>string</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>_serialized</p> </td> <td> <p>string</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <h3 id="GroupParticipant"><span class="symbol-name">GroupParticipant</span><small class="property-type"> &nbsp;Object</small></h3> <p>Group participant information</p> <section> <h4>Properties</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>id</p> </td> <td> <p><a href="global.html#ContactId">ContactId</a></p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>isAdmin</p> </td> <td> <p>boolean</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> <tr> <td> <p>isSuperAdmin</p> </td> <td> <p>boolean</p> </td> <td> <p>&nbsp;</p> </td> <td> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <h3 id="MessageInfo"><span class="symbol-name">MessageInfo</span><small class="property-type"> &nbsp;Object</small></h3> <p>Message Info</p> <section> <h4>Properties</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>delivery</p> </td> <td> <p>Array of {id: <a href="global.html#ContactId">ContactId</a>, t: number}</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>Contacts to which the message has been delivered to</p> </td> </tr> <tr> <td> <p>deliveryRemaining</p> </td> <td> <p>number</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>Amount of people to whom the message has not been delivered to</p> </td> </tr> <tr> <td> <p>played</p> </td> <td> <p>Array of {id: <a href="global.html#ContactId">ContactId</a>, t: number}</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>Contacts who have listened to the voice message</p> </td> </tr> <tr> <td> <p>playedRemaining</p> </td> <td> <p>number</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>Amount of people who have not listened to the message</p> </td> </tr> <tr> <td> <p>read</p> </td> <td> <p>Array of {id: <a href="global.html#ContactId">ContactId</a>, t: number}</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>Contacts who have read the message</p> </td> </tr> <tr> <td> <p>readRemaining</p> </td> <td> <p>number</p> </td> <td> <p>&nbsp;</p> </td> <td> <p>Amount of people who have not read the message</p> </td> </tr> </tbody> </table> </section> <dl class="dl-compact"> </dl> <h3 id="MessageSendOptions"><span class="symbol-name">MessageSendOptions</span><small class="property-type"> &nbsp;Object</small></h3> <p>Message options.</p> <section> <h4>Properties</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>linkPreview</p> </td> <td> <p>boolean</p> </td> <td> <p>Yes</p> </td> <td> <p>Show links preview</p> <p>Defaults to <code>true</code>.</p> </td> </tr> <tr> <td> <p>sendAudioAsVoice</p> </td> <td> <p>boolean</p> </td> <td> <p>Yes</p> </td> <td> <p>Send audio as voice message</p> <p>Defaults to <code>false</code>.</p> </td> </tr> <tr> <td> <p>sendVideoAsGif</p> </td> <td> <p>boolean</p> </td> <td> <p>Yes</p> </td> <td> <p>Send video as gif</p> <p>Defaults to <code>false</code>.</p> </td> </tr> <tr> <td> <p>sendMediaAsSticker</p> </td> <td> <p>boolean</p> </td> <td> <p>Yes</p> </td> <td> <p>Send media as a sticker</p> <p>Defaults to <code>false</code>.</p> </td> </tr> <tr> <td> <p>sendMediaAsDocument</p> </td> <td> <p>boolean</p> </td> <td> <p>Yes</p> </td> <td> <p>Send media as a document</p> <p>Defaults to <code>false</code>.</p> </td> </tr> <tr> <td> <p>parseVCards</p> </td> <td> <p>boolean</p> </td> <td> <p>Yes</p> </td> <td> <p>Automatically parse vCards and send them as contacts</p> <p>Defaults to <code>true</code>.</p> </td> </tr> <tr> <td> <p>caption</p> </td> <td> <p>string</p> </td> <td> <p>Yes</p> </td> <td> <p>Image or video caption</p> </td> </tr> <tr> <td> <p>quotedMessageId</p> </td> <td> <p>string</p> </td> <td> <p>Yes</p> </td> <td> <p>Id of the message that is being quoted (or replied to)</p> </td> </tr> <tr> <td> <p>mentions</p> </td> <td> <p>Array of <a href="Contact.html">Contact</a></p> </td> <td> <p>Yes</p> </td> <td> <p>Contacts that are being mentioned in the message</p> </td> </tr> <tr> <td> <p>sendSeen</p> </td> <td> <p>boolean</p> </td> <td> <p>Yes</p> </td> <td> <p>Mark the conversation as seen after sending the message</p> <p>Defaults to <code>true</code>.</p> </td> </tr> <tr> <td> <p>stickerAuthor</p> </td> <td> <p>string</p> </td> <td> <p>Yes</p> </td> <td> <p>Sets the author of the sticker, (if sendMediaAsSticker is true).</p> </td> </tr> <tr> <td> <p>stickerName</p> </td> <td> <p>string</p> </td> <td> <p>Yes</p> </td> <td> <p>Sets the name of the sticker, (if sendMediaAsSticker is true).</p> </td> </tr> <tr> <td> <p>stickerCategories</p> </td> <td> <p>Array of string</p> </td> <td> <p>Yes</p> </td> <td> <p>Sets the categories of the sticker, (if sendMediaAsSticker is true). Provide emoji char array, can be null.</p> </td> </tr> <tr> <td> <p>media</p> </td> <td> <p><a href="