RetailCRM-Mirror/mg-bot-api-client-js
1
0
Fork 0
mirror of synced 2024-11-26 14:26:02 +03:00
Code Issues Projects Releases Wiki Activity
59985da78b
mg-bot-api-client-js/global.html

2131 lines
24 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<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>
<h4 class="name" id="messageScopePrivate"><span class="type-signature">(constant) </span>messageScopePrivate<span class="type-signature"> :string</span></h4>
<div class="description">
Public message scope
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line155">line 155</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().messageScopePrivate</code></pre>
<h4 class="name" id="messageScopePublic"><span class="type-signature">(constant) </span>messageScopePublic<span class="type-signature"> :string</span></h4>
<div class="description">
Public message scope
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line147">line 147</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().messageScopePublic</code></pre>
<h4 class="name" id="msgTypeCommand"><span class="type-signature">(constant) </span>msgTypeCommand<span class="type-signature"> :string</span></h4>
<div class="description">
Command message type
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line180">line 180</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().msgTypeCommand</code></pre>
<h4 class="name" id="msgTypeFile"><span class="type-signature">(constant) </span>msgTypeFile<span class="type-signature"> :string</span></h4>
<div class="description">
File message type
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line204">line 204</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().msgTypeFile</code></pre>
<h4 class="name" id="msgTypeImage"><span class="type-signature">(constant) </span>msgTypeImage<span class="type-signature"> :string</span></h4>
<div class="description">
Image message type
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line212">line 212</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().msgTypeImage</code></pre>
<h4 class="name" id="msgTypeOrder"><span class="type-signature">(constant) </span>msgTypeOrder<span class="type-signature"> :string</span></h4>
<div class="description">
Order message type
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line188">line 188</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().msgTypeOrder</code></pre>
<h4 class="name" id="msgTypeProduct"><span class="type-signature">(constant) </span>msgTypeProduct<span class="type-signature"> :string</span></h4>
<div class="description">
Product message type
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line196">line 196</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().msgTypeProduct</code></pre>
<h4 class="name" id="msgTypeSystem"><span class="type-signature">(constant) </span>msgTypeSystem<span class="type-signature"> :string</span></h4>
<div class="description">
System message type
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line172">line 172</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().msgTypeSystem</code></pre>
<h4 class="name" id="msgTypeText"><span class="type-signature">(constant) </span>msgTypeText<span class="type-signature"> :string</span></h4>
<div class="description">
Text message type
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line164">line 164</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().msgTypeText</code></pre>
<h4 class="name" id="wsBotUpdated"><span class="type-signature">(constant) </span>wsBotUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
Bot updating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsBotUpdated</code></pre>
<h4 class="name" id="wsChannelUpdated"><span class="type-signature">(constant) </span>wsChannelUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
Channel updating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line130">line 130</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsChannelUpdated</code></pre>
<h4 class="name" id="wsChatCreated"><span class="type-signature">(constant) </span>wsChatCreated<span class="type-signature"> :string</span></h4>
<div class="description">
Chat creating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line56">line 56</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsChatCreated</code></pre>
<h4 class="name" id="wsChatUnreadUpdated"><span class="type-signature">(constant) </span>wsChatUnreadUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
Unread chat updating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line72">line 72</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsChatUnreadUpdated</code></pre>
<h4 class="name" id="wsChatUpdated"><span class="type-signature">(constant) </span>wsChatUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
Chat updating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line64">line 64</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsChatUpdated</code></pre>
<h4 class="name" id="wsCustomerUpdated"><span class="type-signature">(constant) </span>wsCustomerUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
Customer updating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line113">line 113</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsCustomerUpdated</code></pre>
<h4 class="name" id="wsDialogAssign"><span class="type-signature">(constant) </span>wsDialogAssign<span class="type-signature"> :string</span></h4>
<div class="description">
Dialogue appointment websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line48">line 48</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsDialogAssign</code></pre>
<h4 class="name" id="wsDialogClosed"><span class="type-signature">(constant) </span>wsDialogClosed<span class="type-signature"> :string</span></h4>
<div class="description">
Dialogue closing websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsDialogClosed</code></pre>
<h4 class="name" id="wsDialogOpened"><span class="type-signature">(constant) </span>wsDialogOpened<span class="type-signature"> :string</span></h4>
<div class="description">
Dialogue opening websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line32">line 32</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsDialogOpened</code></pre>
<h4 class="name" id="wsMessageDeleted"><span class="type-signature">(constant) </span>wsMessageDeleted<span class="type-signature"> :string</span></h4>
<div class="description">
Websocket event delete message
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsMessageDeleted</code></pre>
<h4 class="name" id="wsMessageNew"><span class="type-signature">(constant) </span>wsMessageNew<span class="type-signature"> :string</span></h4>
<div class="description">
New message websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsMessageNew</code></pre>
<h4 class="name" id="wsMessageUpdated"><span class="type-signature">(constant) </span>wsMessageUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
Updating message websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsMessageUpdated</code></pre>
<h4 class="name" id="wsSettingsUpdated"><span class="type-signature">(constant) </span>wsSettingsUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
Settings updating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line138">line 138</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsSettingsUpdated</code></pre>
<h4 class="name" id="wsUserJoinedChat"><span class="type-signature">(constant) </span>wsUserJoinedChat<span class="type-signature"> :string</span></h4>
<div class="description">
User joined chat websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line88">line 88</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsUserJoinedChat</code></pre>
<h4 class="name" id="wsUserLeftChat"><span class="type-signature">(constant) </span>wsUserLeftChat<span class="type-signature"> :string</span></h4>
<div class="description">
User left chat websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line97">line 97</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsUserLeftChat</code></pre>
<h4 class="name" id="wsUserOnlineUpdated"><span class="type-signature">(constant) </span>wsUserOnlineUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
User online status updating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsUserOnlineUpdated</code></pre>
<h4 class="name" id="wsUserUpdated"><span class="type-signature">(constant) </span>wsUserUpdated<span class="type-signature"> :string</span></h4>
<div class="description">
User updating websocket event
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="consts.js.html">consts.js</a>, <a href="consts.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>MgBotApiClient.types().wsUserUpdated</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li></ul><h3>Global</h3><ul><li><a href="global.html#messageScopePrivate">messageScopePrivate</a></li><li><a href="global.html#messageScopePublic">messageScopePublic</a></li><li><a href="global.html#msgTypeCommand">msgTypeCommand</a></li><li><a href="global.html#msgTypeFile">msgTypeFile</a></li><li><a href="global.html#msgTypeImage">msgTypeImage</a></li><li><a href="global.html#msgTypeOrder">msgTypeOrder</a></li><li><a href="global.html#msgTypeProduct">msgTypeProduct</a></li><li><a href="global.html#msgTypeSystem">msgTypeSystem</a></li><li><a href="global.html#msgTypeText">msgTypeText</a></li><li><a href="global.html#wsBotUpdated">wsBotUpdated</a></li><li><a href="global.html#wsChannelUpdated">wsChannelUpdated</a></li><li><a href="global.html#wsChatCreated">wsChatCreated</a></li><li><a href="global.html#wsChatUnreadUpdated">wsChatUnreadUpdated</a></li><li><a href="global.html#wsChatUpdated">wsChatUpdated</a></li><li><a href="global.html#wsCustomerUpdated">wsCustomerUpdated</a></li><li><a href="global.html#wsDialogAssign">wsDialogAssign</a></li><li><a href="global.html#wsDialogClosed">wsDialogClosed</a></li><li><a href="global.html#wsDialogOpened">wsDialogOpened</a></li><li><a href="global.html#wsMessageDeleted">wsMessageDeleted</a></li><li><a href="global.html#wsMessageNew">wsMessageNew</a></li><li><a href="global.html#wsMessageUpdated">wsMessageUpdated</a></li><li><a href="global.html#wsSettingsUpdated">wsSettingsUpdated</a></li><li><a href="global.html#wsUserJoinedChat">wsUserJoinedChat</a></li><li><a href="global.html#wsUserLeftChat">wsUserLeftChat</a></li><li><a href="global.html#wsUserOnlineUpdated">wsUserOnlineUpdated</a></li><li><a href="global.html#wsUserUpdated">wsUserUpdated</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 07 2019 08:08:57 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink