docs: add generated docs

2026-04-17 19:26:20 +00:00 · 2020-02-05 01:07:56 -04:00
parent 2f0480c80e
commit 62e264231d
38 changed files with 6852 additions and 2 deletions
--- a/docs/structures_ClientInfo.js.html
+++ b/docs/structures_ClientInfo.js.html
@@ -0,0 +1,104 @@
+<!doctype html>
+<html>
+
+<head>
+  <meta name="generator" content="JSDoc 3.6.3">
+  <meta charset="utf-8">
+  <title>whatsapp-web.js 0.3.2 &raquo; Source: structures/ClientInfo.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/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 0.<wbr>3.<wbr>2</a>
+      </div>
+    </div>
+  </nav>
+  <div id="jsdoc-body-container">
+    <div id="jsdoc-content">
+      <div id="jsdoc-content-container">
+        <div id="jsdoc-banner" role="banner">
+        </div>
+        <div id="jsdoc-main" role="main">
+          <header class="page-header">
+            <h1>Source: structures/ClientInfo.js</h1>
+          </header>
+          <article>
+            <pre class="prettyprint linenums"><code>&#x27;use strict&#x27;;
+
+const Base &#x3D; require(&#x27;./Base&#x27;);
+
+/**
+ * Current connection information
+ * @extends {Base}
+ */
+class ClientInfo extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if(data) this._patch(data);
+    }
+
+    _patch(data) {
+        /**
+         * Name configured to be shown in push notifications
+         * @type {string}
+         */
+        this.pushname &#x3D; data.pushname;
+
+        /**
+         * Current user ID
+         * @type {object}
+         */
+        this.me &#x3D; data.me;
+
+        /**
+         * Information about the phone this client is connected to
+         * @type {object}
+         * @property {string} wa_version WhatsApp Version running on the phone
+         * @property {string} os_version OS Version running on the phone (iOS or Android version)
+         * @property {string} device_manufacturer Device manufacturer
+         * @property {string} device_model Device model
+         * @property {string} os_build_number OS build number
+         */
+        this.phone &#x3D; data.phone;
+
+        /**
+         * Platform the phone is running on
+         * @type {string}
+         */
+        this.platform &#x3D; data.platform;
+
+        return super._patch(data);
+    }
+
+}
+
+module.exports &#x3D; ClientInfo;</code></pre>
+          </article>
+        </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 February 5, 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>