From 9c0a7f8bee1ed3f3aa924e592225d9b9cf2e18bf Mon Sep 17 00:00:00 2001 From: Valentin Popov Date: Mon, 29 May 2017 01:46:00 +0300 Subject: Release of version 0.0.1. --- docs/global.html | 1565 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1565 insertions(+) create mode 100644 docs/global.html (limited to 'docs/global.html') diff --git a/docs/global.html b/docs/global.html new file mode 100644 index 0000000..77c7f85 --- /dev/null +++ b/docs/global.html @@ -0,0 +1,1565 @@ + + + + + JSDoc: Global + + + + + + + + + + +
+ +

Global

+ + + + + + +
+ +
+ +

+ + +
+ +
+
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + +

Members

+ + + +

http

+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + +
Author:
+
+ +
+ + + + + +
License:
+
  • See LICENSE.md file included in this distribution.
+ + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + +

_createPackage(raw) → {String}

+ + + + + +
+ Creates an encrypted package to send. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
raw + + +Object + + + + The data to send. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
cuid + + +String + + + + Session identifier.
text + + +String + + + + Message text.
+ +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ - Encrypted string. +
+ + + +
+
+ Type +
+
+ +String + + +
+
+ + + + + + + + + + +

_decrypt(raw) → {String}

+ + + + + +
+ Decrypts the incoming data. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
raw + + +String + + + + Encrypted data.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ - Decrypted string. +
+ + + +
+
+ Type +
+
+ +String + + +
+
+ + + + + + + + + + +

_decryptJSON(raw) → {Object}

+ + + + + +
+ Decrypts an encrypted JSON object. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
raw + + +String + + + + Encrypted data.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ - Decrypted JSON. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + +

_encrypt(raw) → {String}

+ + + + + +
+ Encrypts the incoming data. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
raw + + +String + + + + Decrypted data.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ - Encrypted string. +
+ + + +
+
+ Type +
+
+ +String + + +
+
+ + + + + + + + + + +

_merger(raw) → {String}

+ + + + + +
+ Merge and convert a string. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
raw + + +String + + + + The string to convert.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ - The converted string. +
+ + + +
+
+ Type +
+
+ +String + + +
+
+ + + + + + + + + + +

_verification(data) → {Boolean}

+ + + + + +
+ Validation UUID format string. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +String + + + + The string to check.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + +

connect(uuid, callback)

+ + + + + +
+ Connects to the server and returns the connection data. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +String + + + + The bot UUID.
callback + + +requestCallback + + + + The callback that handles the response.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

send(raw, callback)

+ + + + + +
+ Send a message to the server and return a response. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
raw + + +Object + + + + The data to send. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
cuid + + +String + + + + Session identifier.
text + + +String + + + + Message text.
+ +
callback + + +requestCallback + + + + The callback that handles the response.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file -- cgit v1.2.3