diff options
Diffstat (limited to 'docs/global.html')
| -rw-r--r-- | docs/global.html | 1644 |
1 files changed, 0 insertions, 1644 deletions
diff --git a/docs/global.html b/docs/global.html deleted file mode 100644 index 49827b3..0000000 --- a/docs/global.html +++ /dev/null @@ -1,1644 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width,initial-scale=1"> - <title>Global - Documentation</title> - - <script src="scripts/prettify/prettify.js"></script> - <script src="scripts/prettify/lang-css.js"></script> - <!--[if lt IE 9]> - <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> - <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> - <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> -</head> -<body> - -<input type="checkbox" id="nav-trigger" class="nav-trigger" /> -<label for="nav-trigger" class="navicon-button x"> - <div class="navicon"></div> -</label> - -<label for="nav-trigger" class="overlay"></label> - -<nav> - <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#connect">connect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createPackage">createPackage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#decrypt">decrypt</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#decryptJSON">decryptJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#encrypt">encrypt</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#http">http</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isVerification">isVerification</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#mergerString">mergerString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#send">send</a></span></li> -</nav> - -<div id="main"> - - <h1 class="page-title">Global</h1> - - - - - - - -<section> - -<header> - - <h2> - - </h2> - - -</header> - -<article> - <div class="container-overview"> - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - </div> - - - - - - - - - - - - - <h3 class="subsection-title">Members</h3> - - - -<div class="section-members"> -<h4 class="name" id="http"><span class="type-signature"></span>http<span class="type-signature"></span></h4> - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - <dt class="tag-author">Author:</dt> - <dd class="tag-author"> - <ul> - <li><a href="mailto:info@valentineus.link">Valentin Popov</a></li> - </ul> - </dd> - - - - - - <dt class="tag-license">License:</dt> - <dd class="tag-license"><ul class="dummy"><li>See LICENSE.md file included in this distribution.</li></ul></dd> - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line6">line 6</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - -</div> - - - - - - <h3 class="subsection-title">Methods</h3> - - - -<div class="section-method"> - - - - <h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(uuid, callback)</span><span class="type-signature"></span></h4> - - - - - -<div class="description"> - Connects to the server and returns the connection data. -</div> - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line14">line 14</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>uuid</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - The bot UUID. - - </td> - </tr> - - - - <tr> - - <td class="name"><code>callback</code></td> - - - <td class="type"> - - -<span class="param-type"><code>requestCallback</code></span> - - - - </td> - - - - - - <td class="description last"> - The callback that handles the response. - - </td> - </tr> - - - </tbody> -</table> - - - - - - - - - - - - - - - - -</div> - - -<div class="section-method"> - - - - <h4 class="name" id="createPackage"><span class="type-signature"></span>createPackage<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> - - - - - -<div class="description"> - Creates an encrypted package to send. -</div> - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line145">line 145</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>raw</code></td> - - - <td class="type"> - - -<span class="param-type"><code>Object</code></span> - - - - </td> - - - - - - <td class="description last"> - The data to send. - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>cuid</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - Session identifier. - - </td> - </tr> - - - - <tr> - - <td class="name"><code>text</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - Message text. - - </td> - </tr> - - - </tbody> -</table> - - - </td> - </tr> - - - </tbody> -</table> - - - - - - - - - - - - - - -<div class="section-returns"> -<h5>Returns:</h5> - - - -<dl class="param-type"> - <dt> - Type: - </dt> - <dd> - -<span class="param-type"><code>String</code></span> - - - </dd> -</dl> - - -<div class="param-desc"> - - Encrypted string. -</div> - - -</div> - - - -</div> - - -<div class="section-method"> - - - - <h4 class="name" id="decrypt"><span class="type-signature"></span>decrypt<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> - - - - - -<div class="description"> - Decrypts the incoming data. -</div> - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line97">line 97</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>raw</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - Encrypted data. - - </td> - </tr> - - - </tbody> -</table> - - - - - - - - - - - - - - -<div class="section-returns"> -<h5>Returns:</h5> - - - -<dl class="param-type"> - <dt> - Type: - </dt> - <dd> - -<span class="param-type"><code>String</code></span> - - - </dd> -</dl> - - -<div class="param-desc"> - - Decrypted string. -</div> - - -</div> - - - -</div> - - -<div class="section-method"> - - - - <h4 class="name" id="decryptJSON"><span class="type-signature"></span>decryptJSON<span class="signature">(raw)</span><span class="type-signature"> → {Object}</span></h4> - - - - - -<div class="description"> - Decrypts an encrypted JSON object. -</div> - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line111">line 111</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>raw</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - Encrypted data. - - </td> - </tr> - - - </tbody> -</table> - - - - - - - - - - - - - - -<div class="section-returns"> -<h5>Returns:</h5> - - - -<dl class="param-type"> - <dt> - Type: - </dt> - <dd> - -<span class="param-type"><code>Object</code></span> - - - </dd> -</dl> - - -<div class="param-desc"> - - Decrypted JSON. -</div> - - -</div> - - - -</div> - - -<div class="section-method"> - - - - <h4 class="name" id="encrypt"><span class="type-signature"></span>encrypt<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> - - - - - -<div class="description"> - Encrypts the incoming data. -</div> - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line83">line 83</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>raw</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - Decrypted data. - - </td> - </tr> - - - </tbody> -</table> - - - - - - - - - - - - - - -<div class="section-returns"> -<h5>Returns:</h5> - - - -<dl class="param-type"> - <dt> - Type: - </dt> - <dd> - -<span class="param-type"><code>String</code></span> - - - </dd> -</dl> - - -<div class="param-desc"> - - Encrypted string. -</div> - - -</div> - - - -</div> - - -<div class="section-method"> - - - - <h4 class="name" id="isVerification"><span class="type-signature"></span>isVerification<span class="signature">(data)</span><span class="type-signature"> → {Boolean}</span></h4> - - - - - -<div class="description"> - Validation UUID format string. -</div> - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line170">line 170</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>data</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - The string to check. - - </td> - </tr> - - - </tbody> -</table> - - - - - - - - - - - - - - -<div class="section-returns"> -<h5>Returns:</h5> - - - -<dl class="param-type"> - <dt> - Type: - </dt> - <dd> - -<span class="param-type"><code>Boolean</code></span> - - - </dd> -</dl> - - - -</div> - - - -</div> - - -<div class="section-method"> - - - - <h4 class="name" id="mergerString"><span class="type-signature"></span>mergerString<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> - - - - - -<div class="description"> - Merge and convert a string. -</div> - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line125">line 125</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>raw</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - The string to convert. - - </td> - </tr> - - - </tbody> -</table> - - - - - - - - - - - - - - -<div class="section-returns"> -<h5>Returns:</h5> - - - -<dl class="param-type"> - <dt> - Type: - </dt> - <dd> - -<span class="param-type"><code>String</code></span> - - - </dd> -</dl> - - -<div class="param-desc"> - - The converted string. -</div> - - -</div> - - - -</div> - - -<div class="section-method"> - - - - <h4 class="name" id="send"><span class="type-signature"></span>send<span class="signature">(raw, callback)</span><span class="type-signature"></span></h4> - - - - - -<div class="description"> - Send a message to the server and return a response. -</div> - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - - - - - - - <dt class="tag-source">Source:</dt> - <dd class="tag-source"><ul class="dummy"><li> - <a href="index.js.html">index.js</a>, <a href="index.js.html#line50">line 50</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>raw</code></td> - - - <td class="type"> - - -<span class="param-type"><code>Object</code></span> - - - - </td> - - - - - - <td class="description last"> - The data to send. - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>cuid</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - Session identifier. - - </td> - </tr> - - - - <tr> - - <td class="name"><code>text</code></td> - - - <td class="type"> - - -<span class="param-type"><code>String</code></span> - - - - </td> - - - - - - <td class="description last"> - Message text. - - </td> - </tr> - - - </tbody> -</table> - - - </td> - </tr> - - - - <tr> - - <td class="name"><code>callback</code></td> - - - <td class="type"> - - -<span class="param-type"><code>requestCallback</code></span> - - - - </td> - - - - - - <td class="description last"> - The callback that handles the response. - - </td> - </tr> - - - </tbody> -</table> - - - - - - - - - - - - - - - - -</div> - - - - - - -</article> - -</section> - - - - -</div> - -<br class="clear"> - -<footer> - Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Jun 14 2017 22:00:09 GMT+0000 (UTC) using the Minami theme. -</footer> - -<script>prettyPrint();</script> -<script src="scripts/linenumber.js"></script> -</body> -</html>
\ No newline at end of file |