From 3d66eeb3019175211a5cd148fdaf1c4d33a748de Mon Sep 17 00:00:00 2001 From: Valentin Popov Date: Mon, 29 May 2017 02:00:21 +0300 Subject: Release of version 0.0.2. --- docs/global.html | 813 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 446 insertions(+), 367 deletions(-) (limited to 'docs/global.html') 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 @@ - JSDoc: Global + + Global - Documentation - - + + + - -
+ + + + + + +
+

Global

+ @@ -28,7 +41,9 @@
-

+

+ +

@@ -96,6 +111,7 @@ +

http

@@ -105,8 +121,6 @@ - -
@@ -162,6 +176,9 @@ + +
+ @@ -170,6 +187,7 @@ +
@@ -187,6 +205,50 @@ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + @@ -222,7 +284,7 @@ -Object +Object @@ -232,9 +294,10 @@ - The data to send. -
Properties
+ + The data to send. + @@ -264,7 +327,7 @@ + @@ -287,7 +353,7 @@ +
-String +String @@ -274,7 +337,10 @@ - Session identifier. + Session identifier. + +
-String +String @@ -297,13 +363,17 @@ - Message text. + Message text. + +
+ @@ -316,97 +386,101 @@ -
- - - - - - - - +
+
Returns:
- + - +
+
+ Type: +
+
+ +String - - +
+
- -
Source:
-
- - +
+ - Encrypted string. +
+
- -
+
+ + +
+ +

_decrypt(raw) → {String}

+ +
+ Decrypts the incoming data. +
-
Returns:
+
- -
- - Encrypted string. -
+ + + -
-
- Type -
-
- -String + + -
-
+ + + - - + -

_decrypt(raw) → {String}

+ + +
Source:
+
+ + -
- Decrypts the incoming data. -
+ +
@@ -447,7 +521,7 @@ -String +String @@ -457,7 +531,10 @@ - Encrypted data. + + Encrypted data. + + @@ -469,97 +546,101 @@ -
- - - - - - - - +
+
Returns:
- + - +
+
+ Type: +
+
+ +String - - +
+
- -
Source:
-
- - +
+ - Decrypted string. +
+
- -
+
+ + +
+ +

_decryptJSON(raw) → {Object}

+ +
+ Decrypts an encrypted JSON object. +
-
Returns:
+
- -
- - Decrypted string. -
+ + + -
-
- Type -
-
- -String + + -
-
+ + + - - + -

_decryptJSON(raw) → {Object}

+ + +
Source:
+
+ + -
- Decrypts an encrypted JSON object. -
+ +
@@ -600,7 +681,7 @@ -String +String @@ -610,7 +691,10 @@ - Encrypted data. + + Encrypted data. + + @@ -622,97 +706,101 @@ -
- - - - - - - - +
+
Returns:
- + - +
+
+ Type: +
+
+ +Object - - +
+
- -
Source:
-
- - +
+ - Decrypted JSON. +
+
- -
+
+ + +
+ +

_encrypt(raw) → {String}

+ +
+ Encrypts the incoming data. +
-
Returns:
+
- -
- - Decrypted JSON. -
+ + + -
-
- Type -
-
- -Object + + -
-
+ + + - - + -

_encrypt(raw) → {String}

+ + +
Source:
+
+ + -
- Encrypts the incoming data. -
+ +
@@ -753,7 +841,7 @@ -String +String @@ -763,7 +851,10 @@ - Decrypted data. + + Decrypted data. + + @@ -775,97 +866,101 @@ -
- - - - - - - - +
+
Returns:
- + - +
+
+ Type: +
+
+ +String - - +
+
- -
Source:
-
- - +
+ - Encrypted string. +
+
- -
+
+ + +
+ +

_merger(raw) → {String}

+ +
+ Merge and convert a string. +
-
Returns:
+
- -
- - Encrypted string. -
+ + + -
-
- Type -
-
- -String + + -
-
+ + + - - + -

_merger(raw) → {String}

+ + +
Source:
+
+ + -
- Merge and convert a string. -
+ +
@@ -906,7 +1001,7 @@ -String +String @@ -916,7 +1011,10 @@ - The string to convert. + + The string to convert. + + @@ -928,97 +1026,101 @@ -
- - - - - - - - +
+
Returns:
- + - +
+
+ Type: +
+
+ +String - - +
+
- -
Source:
-
- - +
+ - The converted string. +
+
- -
+
+ + +
+ +

_verification(data) → {Boolean}

+ +
+ Validation UUID format string. +
-
Returns:
+
- -
- - The converted string. -
+ + + -
-
- Type -
-
- -String + + -
-
+ + + - - + -

_verification(data) → {Boolean}

+ + +
Source:
+
+ + -
- Validation UUID format string. -
+ +
@@ -1059,7 +1161,7 @@ -String +String @@ -1069,7 +1171,10 @@ - The string to check. + + The string to check. + + @@ -1081,93 +1186,97 @@ -
- - - - - - - - +
+
Returns:
- + - +
+
+ Type: +
+
+ +Boolean - - +
+
- -
Source:
-
- +
- - -
+
+ + +
+ +

connect(uuid, callback)

+ +
+ Connects to the server and returns the connection data. +
+
-
Returns:
+ - + + -
-
- Type -
-
- -Boolean + + -
-
+ + + - - + -

connect(uuid, callback)

+ + +
Source:
+
+ + -
- Connects to the server and returns the connection data. -
+ +
@@ -1208,7 +1317,7 @@ -String +String @@ -1218,7 +1327,10 @@ - The bot UUID. + + The bot UUID. + + @@ -1231,7 +1343,7 @@ -requestCallback +requestCallback @@ -1241,7 +1353,10 @@ - The callback that handles the response. + + The callback that handles the response. + + @@ -1253,75 +1368,76 @@ -
- - - - - - - - - - - - +
+ + +
- -
Source:
-
- +

send(raw, callback)

- - - +
+ Send a message to the server and return a response. +
+
+ + + + + + + + + - - + -

send(raw, callback)

+ + +
Source:
+
+ + -
- Send a message to the server and return a response. -
+ +
@@ -1362,7 +1478,7 @@ -Object +Object @@ -1372,9 +1488,10 @@ - The data to send. -
Properties
+ + The data to send. + @@ -1404,7 +1521,7 @@ + @@ -1427,7 +1547,7 @@ +
-String +String @@ -1414,7 +1531,10 @@ - Session identifier. + Session identifier. + +
-String +String @@ -1437,13 +1557,17 @@ - Message text. + Message text. + +
+ @@ -1457,7 +1581,7 @@ -requestCallback +requestCallback @@ -1467,7 +1591,10 @@ - The callback that handles the response. + + The callback that handles the response. + + @@ -1479,51 +1606,6 @@ -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - @@ -1534,6 +1616,7 @@ +
@@ -1549,17 +1632,13 @@
- -
- Documentation generated by JSDoc 3.4.3 on Mon May 29 2017 01:45:41 GMT+0300 (MSK) + Generated by JSDoc 3.4.3 on Mon May 29 2017 02:00:06 GMT+0300 (MSK) using the Minami theme.
- - + + \ No newline at end of file -- cgit v1.2.3