-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwebsocket.html
167 lines (144 loc) · 11.1 KB
/
websocket.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<!DOCTYPE html>
<html class="writer-html5" lang="ru" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Документация Websocket — документация Tdproto docs </title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.svg"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/translations.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Алфавитный указатель" href="genindex.html" />
<link rel="search" title="Поиск" href="search.html" />
<link rel="next" title="События клиента" href="events.html" />
<link rel="prev" title="Остальные пути" href="misc_paths.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Tdproto docs
<img src="_static/logo.svg" class="logo" alt="Логотип"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Поиск в документации" aria-label="Поиск в документации" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Меню навигации">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="basics.html">Основы</a></li>
<li class="toctree-l1"><a class="reference internal" href="bot_howto.html">Как создать бота</a></li>
<li class="toctree-l1"><a class="reference internal" href="team_paths.html">Пути относящиеся к командам</a></li>
<li class="toctree-l1"><a class="reference internal" href="chat_paths.html">Пути относящиеся в чатам</a></li>
<li class="toctree-l1"><a class="reference internal" href="task_paths.html">Пути относящиеся к задачам</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_paths.html">Пути относящиеся к группам</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc_paths.html">Остальные пути</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Документация Websocket</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#connecting-to-websocket">Подключение к websocket</a></li>
<li class="toctree-l2"><a class="reference internal" href="#event-json-objects">JSON объекты событий</a></li>
<li class="toctree-l2"><a class="reference internal" href="#list-of-events">Список событий</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="events.html">События клиента</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html#server-events">События сервера</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html">Индекс Enum</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#type-aliases">Псевдонимы типов</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#json-objects-index">Индекс JSON объектов</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#http-queries">HTTP Queries</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Меню навигации для мобильных устройств" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Tdproto docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Навигация по страницам">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Документация Websocket</li>
<li class="wy-breadcrumbs-aside">
<a style="color:red;font-size:36px;" href="https://tada-team.github.io/tdproto-docs-en/websocket">🇺🇸</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="websockets-documentation">
<h1>Документация Websocket<a class="headerlink" href="#websockets-documentation" title="Permalink to this heading"></a></h1>
<p>Websocket - это полно-дуплексный протокол связи. <a class="reference external" href="https://ru.wikipedia.org/wiki/WebSocket">Страница в Википедии</a> об этом протоколе.</p>
<p>В tada.team websockets используются для уведомления клиентов о событиях и голосовых вызовах.</p>
<section id="connecting-to-websocket">
<h2>Подключение к websocket<a class="headerlink" href="#connecting-to-websocket" title="Permalink to this heading"></a></h2>
<p>Ссылка чтобы присоединиться к websocket имеет форму <code class="docutils literal notranslate"><span class="pre">wss://web.tada.team/messaging/{team_id}</span></code> где team_id это JID команды для которой создать websocket. Это значит что для каждой команды нужен отдельное websocket соединение чтобы получать события из нескольких команд.</p>
<p><code class="docutils literal notranslate"><span class="pre">web.tada.team</span></code> может быть заменено на другой домен.</p>
<p>Для соединения с websocket необходима авторизация. Для авторизации нужно включить HTTP header <code class="docutils literal notranslate"><span class="pre">token</span></code> с токеном бота в запросе на соединение. Смотрите <a class="reference internal" href="bot_howto.html"><span class="doc">Как создать бота</span></a> o том как создать токен бота.</p>
</section>
<section id="event-json-objects">
<h2>JSON объекты событий<a class="headerlink" href="#event-json-objects" title="Permalink to this heading"></a></h2>
<p>Все события с сервера или на сервер должны быть завернуты в объект события.</p>
<p>Объект события имеет следующие поля:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">event</span></code> (string) - Название события. Например, <code class="docutils literal notranslate"><span class="pre">"client.activity"</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">confirm_id</span></code> (string) - В основном используется для отладки. Должно быть случайная строка.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">params</span></code> (object) - Сам объект события.</p></li>
</ul>
<p>Пример:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="nt">"confirm_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"75a406625c58"</span><span class="p">,</span>
<span class="w"> </span><span class="nt">"event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"client.activity"</span><span class="p">,</span>
<span class="w"> </span><span class="nt">"params"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">"afk"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Это пример <a class="reference internal" href="events.html#client-activity"><span class="std std-ref">client.activity</span></a> события отправленного клиентом чтобы поставить статус AFK.</p>
</section>
<section id="list-of-events">
<h2>Список событий<a class="headerlink" href="#list-of-events" title="Permalink to this heading"></a></h2>
<p><a class="reference internal" href="events.html#client-events"><span class="std std-ref">События клиента</span></a>. Эти события клиент может отправить на сервер.</p>
<p><a class="reference internal" href="events.html#server-events"><span class="std std-ref">События сервера</span></a>. Эти события приходят с сервера.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Нижняя область">
<a href="misc_paths.html" class="btn btn-neutral float-left" title="Остальные пути" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Предыдущая</a>
<a href="events.html" class="btn btn-neutral float-right" title="События клиента" accesskey="n" rel="next">Следующая <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<li><a href="https://github.com/tada-team/tdproto-sphinx/">Project Homepage</a> »</li>
<p>© Copyright .</p>
</div>
Собрано при помощи <a href="https://www.sphinx-doc.org/">Sphinx</a> с использованием
<a href="https://github.com/readthedocs/sphinx_rtd_theme">темы,</a>
предоставленной <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>