-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbasics.html
180 lines (157 loc) · 9.71 KB
/
basics.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
168
169
170
171
172
173
174
175
176
177
178
179
180
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<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>Basics — Tdproto docs documentation</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/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="How to create bot" href="bot_howto.html" />
<link rel="prev" title="Tdproto documentation" href="index.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="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<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="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Basics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#jid">JID</a></li>
<li class="toctree-l2"><a class="reference internal" href="#is-archive-field"><code class="docutils literal notranslate"><span class="pre">is_archive</span></code> field</a></li>
<li class="toctree-l2"><a class="reference internal" href="#can-fields"><code class="docutils literal notranslate"><span class="pre">can_*</span></code> fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="#features-json"><code class="docutils literal notranslate"><span class="pre">/features.json</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="bot_howto.html">How to create bot</a></li>
<li class="toctree-l1"><a class="reference internal" href="team_paths.html">Team related paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="chat_paths.html">Chat related paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="task_paths.html">Task related paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_paths.html">Group related paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc_paths.html">Miscellaneous paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="websocket.html">Websockets documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html">Client events</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html#server-events">Server events</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html">Enums index</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#type-aliases">Type aliases</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#json-objects-index">JSON objects index</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="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Basics</li>
<li class="wy-breadcrumbs-aside">
<a style="color:red;font-size:36px;" href="https://tada-team.github.io/tdproto-docs-ru/basics">🇷🇺</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="basics">
<h1>Basics<a class="headerlink" href="#basics" title="Permalink to this heading"></a></h1>
<section id="jid">
<h2>JID<a class="headerlink" href="#jid" title="Permalink to this heading"></a></h2>
<p>Basic unit is Team. Inside the team there are contacts, tasks,
group chats. Contact from one team cannot interact with contact from
another team.</p>
<p>Each user in the team has an identifier in the form of <code class="docutils literal notranslate"><span class="pre">d-<UID></span></code>.
For historical reasons it is called <code class="docutils literal notranslate"><span class="pre">JID</span></code>.</p>
<p>The number of <code class="docutils literal notranslate"><span class="pre">JID</span></code> that user has depends on how many teams they
are a part of. If the user is a part of 3 teams they have 3 <code class="docutils literal notranslate"><span class="pre">JID</span></code> s.
If the user is new they have no <code class="docutils literal notranslate"><span class="pre">JID</span></code> s.</p>
</section>
<section id="is-archive-field">
<h2><code class="docutils literal notranslate"><span class="pre">is_archive</span></code> field<a class="headerlink" href="#is-archive-field" title="Permalink to this heading"></a></h2>
<p>Nothing get deleted from the database. Instead the <code class="docutils literal notranslate"><span class="pre">is_archive</span></code> flag
will be set. The exception are devices.</p>
</section>
<section id="can-fields">
<h2><code class="docutils literal notranslate"><span class="pre">can_*</span></code> fields<a class="headerlink" href="#can-fields" title="Permalink to this heading"></a></h2>
<p>When a reply is received from a request there maybe an additional
fields in the form of <code class="docutils literal notranslate"><span class="pre">can_DO_SOMETHING</span></code>. They mean “can I do
something with the returned object?”</p>
<p>Examples:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">{"can_send_message":</span> <span class="pre">false}</span></code> in the self profile means that you
can’t send message to yourself.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">{"can_add_to_team":</span> <span class="pre">true}</span></code> in the team means that you can add
new participants to the team. (maybe you are the admin or owner)</p></li>
</ul>
<p>In reality those fields to not exists in database - they are calculated
on the fly.</p>
<p>They are needed to ensure that the logic is stored in a single place.</p>
<p>For example, we decided that its possible to send yourself a message.
We only need to change the server now without any additional changes.
Both web and mobile clients will change their logic.</p>
<p>Second example, eventually we might add new administrator role with
tunnable rights. Using the can_* flags it will be backward compatible.</p>
</section>
<section id="features-json">
<h2><code class="docutils literal notranslate"><span class="pre">/features.json</span></code><a class="headerlink" href="#features-json" title="Permalink to this heading"></a></h2>
<p>In the server root there is a <code class="docutils literal notranslate"><span class="pre">/features.json</span></code> file with fields that
depend on installation. On different nodes different features might
be enabled.</p>
<p>This file is not a part of API. API might have version changes, old
APIs might get disabled but this file will always be present.</p>
<p>There is also <code class="docutils literal notranslate"><span class="pre">features.js</span></code> wrapper. If you run it as script it will
automatically create window.FEATURES.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Tdproto documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="bot_howto.html" class="btn btn-neutral float-right" title="How to create bot" accesskey="n" rel="next">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>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>