diff options
| author | Valentin Popov <info@valentineus.link> | 2017-05-29 02:00:21 +0300 |
|---|---|---|
| committer | Valentin Popov <info@valentineus.link> | 2017-05-29 02:00:21 +0300 |
| commit | 3d66eeb3019175211a5cd148fdaf1c4d33a748de (patch) | |
| tree | e7edbf30e9f513a59fcde85feeaeae2f154665e9 /docs/global.html | |
| parent | af3cb9f8f7e14137787dfb8c964265f67feec12d (diff) | |
| download | iii-client-3d66eeb3019175211a5cd148fdaf1c4d33a748de.tar.xz iii-client-3d66eeb3019175211a5cd148fdaf1c4d33a748de.zip | |
Release of version 0.0.2.
Diffstat (limited to 'docs/global.html')
| -rw-r--r-- | docs/global.html | 813 |
1 files changed, 446 insertions, 367 deletions
diff --git a/docs/global.html b/docs/global.html index 77c7f85..3d2919f 100644 --- a/docs/global.html +++ b/docs/global.html @@ -2,22 +2,35 @@ <html lang="en"> <head> <meta charset="utf-8"> - <title>JSDoc: Global</title> + <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> + <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> -<div id="main"> +<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#_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-function">F</span><span class="nav-item-name"><a href="global.html#_merger">_merger</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#_verification">_verification</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#connect">connect</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#send">send</a></span></li> +</nav> +<div id="main"> + <h1 class="page-title">Global</h1> + @@ -28,7 +41,9 @@ <header> - <h2></h2> + <h2> + + </h2> </header> @@ -96,6 +111,7 @@ +<div class="section-members"> <h4 class="name" id="http"><span class="type-signature"></span>http<span class="type-signature"></span></h4> @@ -105,8 +121,6 @@ - - <dl class="details"> @@ -162,6 +176,9 @@ + +</div> + @@ -170,6 +187,7 @@ +<div class="section-method"> @@ -187,6 +205,50 @@ +<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#line149">line 149</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + @@ -222,7 +284,7 @@ <td class="type"> -<span class="param-type">Object</span> +<span class="param-type"><code>Object</code></span> @@ -232,9 +294,10 @@ - <td class="description last">The data to send. - <h6>Properties</h6> + <td class="description last"> + The data to send. + <table class="params"> <thead> @@ -264,7 +327,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -274,7 +337,10 @@ - <td class="description last">Session identifier.</td> + <td class="description last"> + Session identifier. + + </td> </tr> @@ -287,7 +353,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -297,13 +363,17 @@ - <td class="description last">Message text.</td> + <td class="description last"> + Message text. + + </td> </tr> </tbody> </table> + </td> </tr> @@ -316,97 +386,101 @@ -<dl class="details"> - - - - - - - - +<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> - - <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#line149">line 149</a> - </li></ul></dd> - - +<div class="param-desc"> + - Encrypted string. +</div> +</div> - -</dl> +</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> -<h5>Returns:</h5> +<dl class="details"> - -<div class="param-desc"> - - Encrypted string. -</div> + + + -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> + + - </dd> -</dl> + + + - - + - <h4 class="name" id="_decrypt"><span class="type-signature"></span>_decrypt<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> + + <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#line98">line 98</a> + </li></ul></dd> + + + -<div class="description"> - Decrypts the incoming data. -</div> + +</dl> @@ -447,7 +521,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -457,7 +531,10 @@ - <td class="description last">Encrypted data.</td> + <td class="description last"> + Encrypted data. + + </td> </tr> @@ -469,97 +546,101 @@ -<dl class="details"> - - - - - - - - +<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> - - <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#line98">line 98</a> - </li></ul></dd> - - +<div class="param-desc"> + - Decrypted string. +</div> +</div> - -</dl> +</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> -<h5>Returns:</h5> +<dl class="details"> - -<div class="param-desc"> - - Decrypted string. -</div> + + + -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> + + - </dd> -</dl> + + + - - + - <h4 class="name" id="_decryptJSON"><span class="type-signature"></span>_decryptJSON<span class="signature">(raw)</span><span class="type-signature"> → {Object}</span></h4> + + <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#line113">line 113</a> + </li></ul></dd> + + + -<div class="description"> - Decrypts an encrypted JSON object. -</div> + +</dl> @@ -600,7 +681,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -610,7 +691,10 @@ - <td class="description last">Encrypted data.</td> + <td class="description last"> + Encrypted data. + + </td> </tr> @@ -622,97 +706,101 @@ -<dl class="details"> - - - - - - - - +<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> - - <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#line113">line 113</a> - </li></ul></dd> - - +<div class="param-desc"> + - Decrypted JSON. +</div> +</div> - -</dl> +</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> -<h5>Returns:</h5> +<dl class="details"> - -<div class="param-desc"> - - Decrypted JSON. -</div> + + + -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Object</span> + + - </dd> -</dl> + + + - - + - <h4 class="name" id="_encrypt"><span class="type-signature"></span>_encrypt<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> + + <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> + + + -<div class="description"> - Encrypts the incoming data. -</div> + +</dl> @@ -753,7 +841,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -763,7 +851,10 @@ - <td class="description last">Decrypted data.</td> + <td class="description last"> + Decrypted data. + + </td> </tr> @@ -775,97 +866,101 @@ -<dl class="details"> - - - - - - - - +<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> - - <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> - - +<div class="param-desc"> + - Encrypted string. +</div> +</div> - -</dl> +</div> + + +<div class="section-method"> + + <h4 class="name" id="_merger"><span class="type-signature"></span>_merger<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> + +<div class="description"> + Merge and convert a string. +</div> -<h5>Returns:</h5> +<dl class="details"> - -<div class="param-desc"> - - Encrypted string. -</div> + + + -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> + + - </dd> -</dl> + + + - - + - <h4 class="name" id="_merger"><span class="type-signature"></span>_merger<span class="signature">(raw)</span><span class="type-signature"> → {String}</span></h4> + + <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#line128">line 128</a> + </li></ul></dd> + + + -<div class="description"> - Merge and convert a string. -</div> + +</dl> @@ -906,7 +1001,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -916,7 +1011,10 @@ - <td class="description last">The string to convert.</td> + <td class="description last"> + The string to convert. + + </td> </tr> @@ -928,97 +1026,101 @@ -<dl class="details"> - - - - - - - - +<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> - - <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#line128">line 128</a> - </li></ul></dd> - - +<div class="param-desc"> + - The converted string. +</div> +</div> - -</dl> +</div> + + +<div class="section-method"> + + <h4 class="name" id="_verification"><span class="type-signature"></span>_verification<span class="signature">(data)</span><span class="type-signature"> → {Boolean}</span></h4> + +<div class="description"> + Validation UUID format string. +</div> -<h5>Returns:</h5> +<dl class="details"> - -<div class="param-desc"> - - The converted string. -</div> + + + -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">String</span> + + - </dd> -</dl> + + + - - + - <h4 class="name" id="_verification"><span class="type-signature"></span>_verification<span class="signature">(data)</span><span class="type-signature"> → {Boolean}</span></h4> + + <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#line175">line 175</a> + </li></ul></dd> + + + -<div class="description"> - Validation UUID format string. -</div> + +</dl> @@ -1059,7 +1161,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -1069,7 +1171,10 @@ - <td class="description last">The string to check.</td> + <td class="description last"> + The string to check. + + </td> </tr> @@ -1081,93 +1186,97 @@ -<dl class="details"> - - - - - - - - +<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> - - <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#line175">line 175</a> - </li></ul></dd> - +</div> - - -</dl> +</div> + + +<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"> -<h5>Returns:</h5> + - + + -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Boolean</span> + + - </dd> -</dl> + + + - - + - <h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(uuid, callback)</span><span class="type-signature"></span></h4> + + <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> + + + -<div class="description"> - Connects to the server and returns the connection data. -</div> + +</dl> @@ -1208,7 +1317,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -1218,7 +1327,10 @@ - <td class="description last">The bot UUID.</td> + <td class="description last"> + The bot UUID. + + </td> </tr> @@ -1231,7 +1343,7 @@ <td class="type"> -<span class="param-type">requestCallback</span> +<span class="param-type"><code>requestCallback</code></span> @@ -1241,7 +1353,10 @@ - <td class="description last">The callback that handles the response.</td> + <td class="description last"> + The callback that handles the response. + + </td> </tr> @@ -1253,75 +1368,76 @@ -<dl class="details"> - - - - - - - - - - - - +</div> + + +<div class="section-method"> - - <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> - + <h4 class="name" id="send"><span class="type-signature"></span>send<span class="signature">(raw, callback)</span><span class="type-signature"></span></h4> - - -</dl> +<div class="description"> + Send a message to the server and return a response. +</div> +<dl class="details"> + + + + + + + + + - - + - <h4 class="name" id="send"><span class="type-signature"></span>send<span class="signature">(raw, callback)</span><span class="type-signature"></span></h4> + + <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> + + + -<div class="description"> - Send a message to the server and return a response. -</div> + +</dl> @@ -1362,7 +1478,7 @@ <td class="type"> -<span class="param-type">Object</span> +<span class="param-type"><code>Object</code></span> @@ -1372,9 +1488,10 @@ - <td class="description last">The data to send. - <h6>Properties</h6> + <td class="description last"> + The data to send. + <table class="params"> <thead> @@ -1404,7 +1521,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -1414,7 +1531,10 @@ - <td class="description last">Session identifier.</td> + <td class="description last"> + Session identifier. + + </td> </tr> @@ -1427,7 +1547,7 @@ <td class="type"> -<span class="param-type">String</span> +<span class="param-type"><code>String</code></span> @@ -1437,13 +1557,17 @@ - <td class="description last">Message text.</td> + <td class="description last"> + Message text. + + </td> </tr> </tbody> </table> + </td> </tr> @@ -1457,7 +1581,7 @@ <td class="type"> -<span class="param-type">requestCallback</span> +<span class="param-type"><code>requestCallback</code></span> @@ -1467,7 +1591,10 @@ - <td class="description last">The callback that handles the response.</td> + <td class="description last"> + The callback that handles the response. + + </td> </tr> @@ -1479,51 +1606,6 @@ -<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> - - - - - - @@ -1534,6 +1616,7 @@ +</div> @@ -1549,17 +1632,13 @@ </div> -<nav> - <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#_createPackage">_createPackage</a></li><li><a href="global.html#_decrypt">_decrypt</a></li><li><a href="global.html#_decryptJSON">_decryptJSON</a></li><li><a href="global.html#_encrypt">_encrypt</a></li><li><a href="global.html#_merger">_merger</a></li><li><a href="global.html#_verification">_verification</a></li><li><a href="global.html#connect">connect</a></li><li><a href="global.html#http">http</a></li><li><a href="global.html#send">send</a></li></ul> -</nav> - <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon May 29 2017 01:45:41 GMT+0300 (MSK) + Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon May 29 2017 02:00:06 GMT+0300 (MSK) using the Minami theme. </footer> -<script> prettyPrint(); </script> -<script src="scripts/linenumber.js"> </script> +<script>prettyPrint();</script> +<script src="scripts/linenumber.js"></script> </body> </html>
\ No newline at end of file |