-
Notifications
You must be signed in to change notification settings - Fork 0
/
data_index.html
1828 lines (1805 loc) · 210 KB
/
data_index.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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>Enums index — 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="prev" title="Client events" href="events.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"><a class="reference internal" href="basics.html">Basics</a></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 current"><a class="current reference internal" href="#">Enums index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ChatType">ChatType</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-GroupStatus">GroupStatus</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MarkupType">MarkupType</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Mediasubtype">Mediasubtype</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Mediatype">Mediatype</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TeamStatus">TeamStatus</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-UploadMediaType">UploadMediaType</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#type-aliases">Type aliases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ActiveUserDailyStatList">ActiveUserDailyStatList</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-BotCommands">BotCommands</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Err">Err</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ISODateTimeString">ISODateTimeString</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-JID">JID</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MessageLinks">MessageLinks</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-PushDeviceType">PushDeviceType</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-RGBColor">RGBColor</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-SharpLinks">SharpLinks</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskFilterKey">TaskFilterKey</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskSortKey">TaskSortKey</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskTabKey">TaskTabKey</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#json-objects-index">JSON objects index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-BotCommand">BotCommand</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ButtonColors">ButtonColors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-CallDevice">CallDevice</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-CallOnliner">CallOnliner</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Chat">Chat</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ChatShort">ChatShort</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ColorRule">ColorRule</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Contact">Contact</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ContactCustomFields">ContactCustomFields</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ContactShort">ContactShort</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Country">Country</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-DeletedChat">DeletedChat</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-DeletedRemind">DeletedRemind</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-DeletedSection">DeletedSection</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-DeletedTag">DeletedTag</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-DeletedTeam">DeletedTeam</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-EasyApiMessage">EasyApiMessage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Emoji">Emoji</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-FontColors">FontColors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-GroupMembership">GroupMembership</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ICEServer">ICEServer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-IconColors">IconColors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-IconData">IconData</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-InputColors">InputColors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Integration">Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-IntegrationField">IntegrationField</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-IntegrationForm">IntegrationForm</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-IntegrationKind">IntegrationKind</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Integrations">Integrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-InvitableUser">InvitableUser</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-JSEP">JSEP</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MarkupEntity">MarkupEntity</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Message">Message</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MessageColors">MessageColors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MessageContent">MessageContent</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MessageLink">MessageLink</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MessageLinkPreview">MessageLinkPreview</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MessageReaction">MessageReaction</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MessageReactionDetail">MessageReactionDetail</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-MyReactions">MyReactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Node">Node</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-OAuthService">OAuthService</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-OnlineCall">OnlineCall</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-OnlineContact">OnlineContact</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-PdfVersion">PdfVersion</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-PushDevice">PushDevice</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Reaction">Reaction</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ReceivedMessage">ReceivedMessage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Remind">Remind</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Resp">Resp</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Section">Section</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Session">Session</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-SharpLink">SharpLink</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-SharpLinkMeta">SharpLinkMeta</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-ShortMessage">ShortMessage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-SingleIcon">SingleIcon</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Subscription">Subscription</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Subtask">Subtask</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-SwitcherColors">SwitcherColors</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Tag">Tag</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Tariff">Tariff</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Task">Task</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskColor">TaskColor</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskCounters">TaskCounters</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskFilter">TaskFilter</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskItem">TaskItem</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskSort">TaskSort</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskStatus">TaskStatus</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TaskTab">TaskTab</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Team">Team</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TeamCounter">TeamCounter</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-TeamShort">TeamShort</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Terms">Terms</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Theme">Theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Unread">Unread</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Upload">Upload</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-UploadPreview">UploadPreview</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-UploadShortMessage">UploadShortMessage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-User">User</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-UserWithMe">UserWithMe</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tdmodels-Wallpaper">Wallpaper</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#http-queries">HTTP Queries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#taskfilter">TaskFilter</a></li>
</ul>
</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">Enums index</li>
<li class="wy-breadcrumbs-aside">
<a style="color:red;font-size:36px;" href="https://tada-team.github.io/tdproto-docs-ru/data_index">🇷🇺</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="enums-index">
<h1>Enums index<a class="headerlink" href="#enums-index" title="Permalink to this heading"></a></h1>
<section id="tdmodels-ChatType">
<h2>ChatType<a class="headerlink" href="#tdmodels-ChatType" title="Permalink to this heading"></a></h2>
<p><p><strong>Possible values</strong>:</p>
<ul class="simple">
<li><p>direct</p></li>
<li><p>group</p></li>
<li><p>task</p></li>
</ul>
</p>
</section>
<section id="tdmodels-GroupStatus">
<h2>GroupStatus<a class="headerlink" href="#tdmodels-GroupStatus" title="Permalink to this heading"></a></h2>
<p><p><strong>Possible values</strong>:</p>
<ul class="simple">
<li><p>admin</p></li>
<li><p>member</p></li>
</ul>
</p>
</section>
<section id="tdmodels-MarkupType">
<h2>MarkupType<a class="headerlink" href="#tdmodels-MarkupType" title="Permalink to this heading"></a></h2>
<p><p><strong>Possible values</strong>:</p>
<ul class="simple">
<li><p>bold</p></li>
<li><p>italic</p></li>
<li><p>underscore</p></li>
<li><p>strike</p></li>
<li><p>code</p></li>
<li><p>codeblock</p></li>
<li><p>quote</p></li>
<li><p>link</p></li>
<li><p>time</p></li>
<li><p>unsafe</p></li>
</ul>
</p>
</section>
<section id="tdmodels-Mediasubtype">
<h2>Mediasubtype<a class="headerlink" href="#tdmodels-Mediasubtype" title="Permalink to this heading"></a></h2>
<p><p><strong>Possible values</strong>:</p>
<ul class="simple">
<li><p>sticker</p></li>
<li><p>newtask</p></li>
</ul>
</p>
</section>
<section id="tdmodels-Mediatype">
<h2>Mediatype<a class="headerlink" href="#tdmodels-Mediatype" title="Permalink to this heading"></a></h2>
<p><p><strong>Possible values</strong>:</p>
<ul class="simple">
<li><p>plain</p></li>
<li><p>change</p></li>
<li><p>deleted</p></li>
<li><p>file</p></li>
<li><p>image</p></li>
<li><p>video</p></li>
<li><p>audiomsg</p></li>
<li><p>contact</p></li>
<li><p>pdf</p></li>
</ul>
</p>
</section>
<section id="tdmodels-TeamStatus">
<h2>TeamStatus<a class="headerlink" href="#tdmodels-TeamStatus" title="Permalink to this heading"></a></h2>
<p><p><strong>Possible values</strong>:</p>
<ul class="simple">
<li><p>owner</p></li>
<li><p>admin</p></li>
<li><p>member</p></li>
<li><p>guest</p></li>
</ul>
</p>
</section>
<section id="tdmodels-UploadMediaType">
<h2>UploadMediaType<a class="headerlink" href="#tdmodels-UploadMediaType" title="Permalink to this heading"></a></h2>
<p><p><strong>Possible values</strong>:</p>
<ul class="simple">
<li><p>file</p></li>
<li><p>image</p></li>
<li><p>video</p></li>
<li><p>audio</p></li>
<li><p>imagefile</p></li>
</ul>
</p>
</section>
</section>
<section id="type-aliases">
<h1>Type aliases<a class="headerlink" href="#type-aliases" title="Permalink to this heading"></a></h1>
<section id="tdmodels-ActiveUserDailyStatList">
<h2>ActiveUserDailyStatList<a class="headerlink" href="#tdmodels-ActiveUserDailyStatList" title="Permalink to this heading"></a></h2>
<p><p><strong>Base Type</strong>: ActiveUserDailyStat</p>
<p><strong>Is array</strong></p>
</p>
</section>
<section id="tdmodels-BotCommands">
<h2>BotCommands<a class="headerlink" href="#tdmodels-BotCommands" title="Permalink to this heading"></a></h2>
<p><p>Bot commands list</p>
<p><strong>Base Type</strong>: BotCommand</p>
<p><strong>Is array</strong></p>
</p>
</section>
<section id="tdmodels-Err">
<h2>Err<a class="headerlink" href="#tdmodels-Err" title="Permalink to this heading"></a></h2>
<p><p><strong>Base Type</strong>: string</p>
</p>
</section>
<section id="tdmodels-ISODateTimeString">
<h2>ISODateTimeString<a class="headerlink" href="#tdmodels-ISODateTimeString" title="Permalink to this heading"></a></h2>
<p><p>Date and time in RFC3339 format. Example: <code class="docutils literal notranslate"><span class="pre">2019-09-18T00:00:07.435409Z</span></code></p>
<p><strong>Base Type</strong>: string</p>
</p>
</section>
<section id="tdmodels-JID">
<h2>JID<a class="headerlink" href="#tdmodels-JID" title="Permalink to this heading"></a></h2>
<p><p><strong>Base Type</strong>: string</p>
</p>
</section>
<section id="tdmodels-MessageLinks">
<h2>MessageLinks<a class="headerlink" href="#tdmodels-MessageLinks" title="Permalink to this heading"></a></h2>
<p><p><strong>Base Type</strong>: MessageLink</p>
<p><strong>Is array</strong></p>
</p>
</section>
<section id="tdmodels-PushDeviceType">
<h2>PushDeviceType<a class="headerlink" href="#tdmodels-PushDeviceType" title="Permalink to this heading"></a></h2>
<p><p><strong>Base Type</strong>: int</p>
</p>
</section>
<section id="tdmodels-RGBColor">
<h2>RGBColor<a class="headerlink" href="#tdmodels-RGBColor" title="Permalink to this heading"></a></h2>
<p><p>Color in <code class="docutils literal notranslate"><span class="pre">#rrggbb</span></code> format where <code class="docutils literal notranslate"><span class="pre">rr</span></code>, <code class="docutils literal notranslate"><span class="pre">gg</span></code>, <code class="docutils literal notranslate"><span class="pre">bb</span></code> are hexadecimal numbers from 00 to ff of red, green and blue channels correspondingly. (yellow would be <code class="docutils literal notranslate"><span class="pre">#ffff00</span></code>)</p>
<p><strong>Base Type</strong>: string</p>
</p>
</section>
<section id="tdmodels-SharpLinks">
<h2>SharpLinks<a class="headerlink" href="#tdmodels-SharpLinks" title="Permalink to this heading"></a></h2>
<p><p>#-links autocomplete response</p>
<p><strong>Base Type</strong>: SharpLink</p>
<p><strong>Is array</strong></p>
</p>
</section>
<section id="tdmodels-TaskFilterKey">
<h2>TaskFilterKey<a class="headerlink" href="#tdmodels-TaskFilterKey" title="Permalink to this heading"></a></h2>
<p><p><strong>Base Type</strong>: string</p>
</p>
</section>
<section id="tdmodels-TaskSortKey">
<h2>TaskSortKey<a class="headerlink" href="#tdmodels-TaskSortKey" title="Permalink to this heading"></a></h2>
<p><p><strong>Base Type</strong>: string</p>
</p>
</section>
<section id="tdmodels-TaskTabKey">
<h2>TaskTabKey<a class="headerlink" href="#tdmodels-TaskTabKey" title="Permalink to this heading"></a></h2>
<p><p><strong>Base Type</strong>: string</p>
</p>
</section>
</section>
<section id="json-objects-index">
<h1>JSON objects index<a class="headerlink" href="#json-objects-index" title="Permalink to this heading"></a></h1>
<section id="tdmodels-BotCommand">
<h2>BotCommand<a class="headerlink" href="#tdmodels-BotCommand" title="Permalink to this heading"></a></h2>
<p><p>Bot commands information</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">key</span></code><span> (string)</span><span> — </span><span>What should be inserted to the chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">title</span></code><span> (string)</span><span> — </span><span>What should be visible by user</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">args</span></code><span> (array[string])</span><span> — </span><span>Command options, if any</span></div>
</ul>
</section>
<section id="tdmodels-ButtonColors">
<h2>ButtonColors<a class="headerlink" href="#tdmodels-ButtonColors" title="Permalink to this heading"></a></h2>
<p><p>ButtonColors button colors for app</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">brand_static</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Brand static color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">brand_active</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Brand active color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">brand_disable</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Brand disable color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">simple_static</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Simple static color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">simple_active</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Simple active color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">simple_disable</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Simple disable color</span></div>
</ul>
</section>
<section id="tdmodels-CallDevice">
<h2>CallDevice<a class="headerlink" href="#tdmodels-CallDevice" title="Permalink to this heading"></a></h2>
<p><p>Call participant device</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">muted</span></code><span> (boolean)</span><span> — </span><span>Device muted</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">useragent</span></code><span> (string)</span><span> — </span><span>Device description</span></div>
</ul>
</section>
<section id="tdmodels-CallOnliner">
<h2>CallOnliner<a class="headerlink" href="#tdmodels-CallOnliner" title="Permalink to this heading"></a></h2>
<p><p>Call participant</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">jid</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Contact id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">display_name</span></code><span> (string)</span><span> — </span><span>Contact name</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">role</span></code><span> (string)</span><span> — </span><span>Contact role</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">icon</span></code><span> (string)</span><span> — </span><span>Contact icon</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">muted</span></code><span> (boolean)</span><span> — </span><span>Microphone muted. Computed from devices muted states</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">devices</span></code><span> (array[<a class="reference external" href="#tdmodels-CallDevice">CallDevice</a><span>])</span></span><span> — </span><span>Member devices, strictly one for now</span></div>
</ul>
</section>
<section id="tdmodels-Chat">
<h2>Chat<a class="headerlink" href="#tdmodels-Chat" title="Permalink to this heading"></a></h2>
<p><p>Chat (direct, group, task) representation</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">jid</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Group/Task/Contact id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">chat_type</span></code><span> (<a class="reference external" href="#tdmodels-ChatType">ChatType</a><span>)</span></span><span> — </span><span>Chat type</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">base_gentime</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Base fields (not related to concrete participant) version</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">gentime</span></code><span> (number)</span><span> — </span><span>Chat fields related to concrete participant) version</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">created</span></code><span> (string)</span><span> — </span><span>Creation date, iso datetime</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">display_name</span></code><span> (string)</span><span> — </span><span>Title</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">icons</span></code><span> (<a class="reference external" href="#tdmodels-IconData">IconData</a><span>)</span></span><span> — </span><span>Icons info</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">counters_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Include unread messages to counters</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_call</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I call to this chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_send_message</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I send message to this chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">cant_send_message_reason</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Why I can’t send message to this chat (if can’t)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">collapsed</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Description collapsed. Used for tasks only</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">draft</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Last message draft, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">draft_gentime</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Last message draft version, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">hidden</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Hidden chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">notifications_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Push notifications enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">num_importants</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Number of important messages</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">num_unread</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Unread counter</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">num_unread_notices</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Mentions (@) counter</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">last_message</span></code><span> (<a class="reference external" href="#tdmodels-Message">Message</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Last message object</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">last_read_message_id</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Last read message id, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">section</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Project / section id, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">changeable_fields</span></code><span> (array[string])</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>List of editable fields</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">pinned</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Is chat pinned on top</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">pinned_sort_ordering</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Sort ordering for pinned chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">num_members</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Non-archive participants number</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_delete</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I delete this chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">description</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Group or task description</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">markup</span></code><span> (array[<a class="reference external" href="#tdmodels-MarkupEntity">MarkupEntity</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Markup entities for description field. Experimental</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">feed</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Present in feed (main screen)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">pinned_message</span></code><span> (<a class="reference external" href="#tdmodels-Message">Message</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Pinned message for this chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">color_index</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Custom color index from table of colors. Tasks only</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">num_items</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Items in checklist. Tasks only</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">num_checked_items</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Checked items in checklist. Tasks only</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">assignee</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Assignee contact id. Tasks only</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">num</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task number in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">observers</span></code><span> (array[<a class="reference external" href="#tdmodels-JID">JID</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task followers id’s. TODO: rename to “followers”</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">owner</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task creator</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_status</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task status. May be custom</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">title</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task title. Generated from number and description</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">done</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task done date in iso format, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">done_reason</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task done reason, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">deadline</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task deadline in iso format, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">deadline_expired</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Is task deadline expired</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">links</span></code><span> (<a class="reference external" href="#tdmodels-MessageLinks">MessageLinks</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Links in description</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">tags</span></code><span> (array[string])</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task tags list, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">importance</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task importance, if available in team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">urgency</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task urgency, if available in team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">spent_time</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task spent time, number</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">complexity</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task complexity, number</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">linked_messages</span></code><span> (array[any])</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Used for “Create task from messages…”</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">uploads</span></code><span> (array[<a class="reference external" href="#tdmodels-Upload">Upload</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Upload uids for request, upload objects for response</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">items</span></code><span> (array[<a class="reference external" href="#tdmodels-TaskItem">TaskItem</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Checklist items. Task only</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">parents</span></code><span> (array[<a class="reference external" href="#tdmodels-Subtask">Subtask</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Parent tasks</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">tabs</span></code><span> (array[<a class="reference external" href="#tdmodels-TaskTabKey">TaskTabKey</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Tab names</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">status</span></code><span> (<a class="reference external" href="#tdmodels-GroupStatus">GroupStatus</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>My status in group chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">members</span></code><span> (array[<a class="reference external" href="#tdmodels-GroupMembership">GroupMembership</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Group chat members</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_add_member</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I add member to this group chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_remove_member</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I remove member from this group chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_change_member_status</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I change member status in this group chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_change_settings</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>deprecated: use changeable fields</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">default_for_all</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Any new team member will be added to this group chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">readonly_for_members</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Readonly for non-admins group chat (Like Channels in Telegram but switchable)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">autocleanup_age</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Delete messages in this chat in seconds. Experimental function</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">public</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can other team member see this task/group chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_join</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I join to this public group/task</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_delete_any_message</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I delete any message in this chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_set_important_any_message</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I change Important flag in any message in this chat</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">last_activity</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Date of the last message sent even if it was deleted</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">draft_num</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Deprecated</span></div>
</ul>
</section>
<section id="tdmodels-ChatShort">
<h2>ChatShort<a class="headerlink" href="#tdmodels-ChatShort" title="Permalink to this heading"></a></h2>
<p><p>Minimal chat representation</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">jid</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Group/Task/Contact id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">chat_type</span></code><span> (<a class="reference external" href="#tdmodels-ChatType">ChatType</a><span>)</span></span><span> — </span><span>Chat type</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">display_name</span></code><span> (string)</span><span> — </span><span>Title</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">icons</span></code><span> (<a class="reference external" href="#tdmodels-IconData">IconData</a><span>)</span></span><span> — </span><span>Icon data</span></div>
</ul>
</section>
<section id="tdmodels-ColorRule">
<h2>ColorRule<a class="headerlink" href="#tdmodels-ColorRule" title="Permalink to this heading"></a></h2>
<p><p>Set of rules to apply to tasks for coloring</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">uid</span></code><span> (string)</span><span> — </span><span>Rule id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">priority</span></code><span> (number)</span><span> — </span><span>Rule priority</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">description</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Rule description</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">color_index</span></code><span> (number)</span><span> — </span><span>Color index</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">section_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Project filter enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">section</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Project id if project filter enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">tags_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Tags filter enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">tags</span></code><span> (array[string])</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Tag ids if tags filter enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_status</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task status</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_importance_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task importance filter enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_importance</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task importance if task importance filter enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_urgency_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task urgency filter enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_urgency</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Task urgency if task urgency filter enabled</span></div>
</ul>
</section>
<section id="tdmodels-Contact">
<h2>Contact<a class="headerlink" href="#tdmodels-Contact" title="Permalink to this heading"></a></h2>
<p><p>Contact</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">jid</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Contact Id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">node</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Node uid for external users</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">display_name</span></code><span> (string)</span><span> — </span><span>Full name in chats</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">short_name</span></code><span> (string)</span><span> — </span><span>Short name in chats</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">contact_email</span></code><span> (string)</span><span> — </span><span>Contact email in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">contact_phone</span></code><span> (string)</span><span> — </span><span>Contact phone in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">icons</span></code><span> (<a class="reference external" href="#tdmodels-IconData">IconData</a><span>)</span></span><span> — </span><span>Icons data</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">gentime</span></code><span> (number)</span><span> — </span><span>Object version</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">role</span></code><span> (string)</span><span> — </span><span>Role in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">mood</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Mood in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">status</span></code><span> (<a class="reference external" href="#tdmodels-TeamStatus">TeamStatus</a><span>)</span></span><span> — </span><span>Status in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">last_activity</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Last activity in this team (iso datetime)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">is_archive</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Contact deleted</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">botname</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Bot name. Empty for users</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">sections</span></code><span> (array[string])</span><span> — </span><span>Section ids</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_send_message</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I send message to this contact</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">cant_send_message_reason</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Why I can’t send message to this chat (if can’t)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_call</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I call to this contact</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_create_task</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I create task for this contact</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_import_tasks</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I import tasks in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_add_to_group</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I add this contact to group chats</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_delete</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I remove this contact from team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">changeable_fields</span></code><span> (array[string])</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Changeable fields</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">family_name</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Family name</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">given_name</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Given name</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">patronymic</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Patronymic, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">default_lang</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Default language code</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">debug_show_activity</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Enable debug messages in UI</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">dropall_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Enable remove all messages experimental features</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">alt_send</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Use Ctrl/Cmd + Enter instead Enter</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">asterisk_mention</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Use * as @ for mentions</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">always_send_pushes</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Send push notifications even contact is online</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">hide_pushes_content</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Hide pushes body</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">timezone</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Timezone, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">quiet_time_start</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Quiet time start</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">quiet_time_finish</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Quiet time finish</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">focus_until</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Focus mode enabled until</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">group_notifications_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Push notifications for group chats</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_notifications_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Push notifications for task chats</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">contact_short_view</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Short view in contact list</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">group_short_view</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Short view in group list</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_short_view</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Short view in task list</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">contact_mshort_view</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Short view in contact list in mobile app</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">group_mshort_view</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Short view in group list in mobile app</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">auth_2fa_enabled</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Two-factor authentication is configured and confirmed</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">auth_2fa_status</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Two-factor authentication status</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_mshort_view</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Short view in task list in mobile app</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">contact_show_archived</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Show archived contacts in contact list</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">unread_first</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Show unread chats first in feed</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">munread_first</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Show unread chats first in feed in mobile app</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_add_to_team</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I add new members to this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_manage_sections</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I manage contact sections in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_manage_projects</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I manage task projects in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_manage_tags</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I manage tags in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_manage_integrations</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I manage integrations in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_manage_color_rules</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I manage color rules in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_create_group</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I create group chats in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_join_public_groups</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I view/join public group in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_join_public_tasks</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I view/join public tasks in this team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">custom_fields</span></code><span> (<a class="reference external" href="#tdmodels-ContactCustomFields">ContactCustomFields</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Extra contact fields</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_delete_any_message</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Deprecated</span></div>
</ul>
</section>
<section id="tdmodels-ContactCustomFields">
<h2>ContactCustomFields<a class="headerlink" href="#tdmodels-ContactCustomFields" title="Permalink to this heading"></a></h2>
<p><p>Extra contact fields</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">company</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Company</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">department</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Department</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">title</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Title</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">mobile_phone</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>MobilePhone</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">source</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Import source</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">ad_uid</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>User UUID in Active Directory</span></div>
</ul>
</section>
<section id="tdmodels-ContactShort">
<h2>ContactShort<a class="headerlink" href="#tdmodels-ContactShort" title="Permalink to this heading"></a></h2>
<p><p>Short contact representation</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">jid</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Contact Id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">display_name</span></code><span> (string)</span><span> — </span><span>Full name in chats</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">short_name</span></code><span> (string)</span><span> — </span><span>Short name in chats</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">icons</span></code><span> (<a class="reference external" href="#tdmodels-IconData">IconData</a><span>)</span></span><span> — </span><span>Icons data</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">gentime</span></code><span> (number)</span><span> — </span><span>Object version</span></div>
</ul>
</section>
<section id="tdmodels-Country">
<h2>Country<a class="headerlink" href="#tdmodels-Country" title="Permalink to this heading"></a></h2>
<p><p>Country for phone numbers selection on login screen</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">code</span></code><span> (string)</span><span> — </span><span>Phone code</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">iso</span></code><span> (string)</span><span> — </span><span>Country ISO code</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">name</span></code><span> (string)</span><span> — </span><span>Country name</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">default</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Selected by default</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">popular</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Is popular, need to cache</span></div>
</ul>
</section>
<section id="tdmodels-DeletedChat">
<h2>DeletedChat<a class="headerlink" href="#tdmodels-DeletedChat" title="Permalink to this heading"></a></h2>
<p><p>Minimal chat representation for deletion</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">jid</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Group/Task/Contact id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">chat_type</span></code><span> (<a class="reference external" href="#tdmodels-ChatType">ChatType</a><span>)</span></span><span> — </span><span>Chat type</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">gentime</span></code><span> (number)</span><span> — </span><span>Chat fields (related to concrete participant) version</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">is_archive</span></code><span> (boolean)</span><span> — </span><span>Archive flag. Always true for this structure</span></div>
</ul>
</section>
<section id="tdmodels-DeletedRemind">
<h2>DeletedRemind<a class="headerlink" href="#tdmodels-DeletedRemind" title="Permalink to this heading"></a></h2>
<p><p>Remind deleted message</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">uid</span></code><span> (string)</span><span> — </span><span>Remind id</span></div>
</ul>
</section>
<section id="tdmodels-DeletedSection">
<h2>DeletedSection<a class="headerlink" href="#tdmodels-DeletedSection" title="Permalink to this heading"></a></h2>
<p><p>Deleted task project or contact section</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">uid</span></code><span> (string)</span><span> — </span><span>Section uid</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">gentime</span></code><span> (number)</span><span> — </span><span>Object version</span></div>
</ul>
</section>
<section id="tdmodels-DeletedTag">
<h2>DeletedTag<a class="headerlink" href="#tdmodels-DeletedTag" title="Permalink to this heading"></a></h2>
<p><p>Delete tag message</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">uid</span></code><span> (string)</span><span> — </span><span>Tag id</span></div>
</ul>
</section>
<section id="tdmodels-DeletedTeam">
<h2>DeletedTeam<a class="headerlink" href="#tdmodels-DeletedTeam" title="Permalink to this heading"></a></h2>
<p><p>Team deletion message. Readonly</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">uid</span></code><span> (string)</span><span> — </span><span>Team id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">is_archive</span></code><span> (boolean)</span><span> — </span><span>Team deleted</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">gentime</span></code><span> (number)</span><span> — </span><span>Object version</span></div>
</ul>
</section>
<section id="tdmodels-EasyApiMessage">
<h2>EasyApiMessage<a class="headerlink" href="#tdmodels-EasyApiMessage" title="Permalink to this heading"></a></h2>
<p><p>Simple api for integrations /api/message or /tasks/[team]/[num]/message</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">key</span></code><span> (string)</span><span> — </span><span>Comma separated api keys (for /api/message calls only)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">message</span></code><span> (string)</span><span> — </span><span>Message text. Required</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">message_id</span></code><span> (string)</span><span> — </span><span>Message uuid. Optional</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">nopreview</span></code><span> (boolean)</span><span> — </span><span>Disable links preview</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">important</span></code><span> (boolean)</span><span> — </span><span>Mark message as important</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">silently</span></code><span> (boolean)</span><span> — </span><span>Disable counters and push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">convert_linebreaks</span></code><span> (boolean)</span><span> — </span><span>Convert “\n” to “\n”</span></div>
</ul>
</section>
<section id="tdmodels-Emoji">
<h2>Emoji<a class="headerlink" href="#tdmodels-Emoji" title="Permalink to this heading"></a></h2>
<p><p>Emoji</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">char</span></code><span> (string)</span><span> — </span><span>Unicode symbol</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">key</span></code><span> (string)</span><span> — </span><span>Text representation</span></div>
</ul>
</section>
<section id="tdmodels-Features">
<h2>Features<a class="headerlink" href="#tdmodels-Features" title="Permalink to this heading"></a></h2>
<p><p>Server information. Readonly</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">host</span></code><span> (string)</span><span> — </span><span>Current host</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">build</span></code><span> (string)</span><span> — </span><span>Build/revision of server side</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">desktop_version</span></code><span> (string)</span><span> — </span><span>Desktop application version</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">front_version</span></code><span> (string)</span><span> — </span><span>Webclient version</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">app_title</span></code><span> (string)</span><span> — </span><span>Application title</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">landing_url</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Landing page address, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">app_schemes</span></code><span> (array[string])</span><span> — </span><span>Local applications urls</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">userver</span></code><span> (string)</span><span> — </span><span>Static files server address</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">ios_app</span></code><span> (string)</span><span> — </span><span>Link to AppStore</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">android_app</span></code><span> (string)</span><span> — </span><span>Link to Google Play</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">ios_corp_app</span></code><span> (string)</span><span> — </span><span>Link to AppStore for corporate app</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">android_corp_app</span></code><span> (string)</span><span> — </span><span>Link to Google Play for corporate app</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">theme</span></code><span> (string)</span><span> — </span><span>Default UI theme</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">min_ios_version</span></code><span> (string)</span><span> — </span><span>Minimal iOS application version required for this server. Used for breaking changes</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">min_android_version</span></code><span> (string)</span><span> — </span><span>Minimal android application version required for this server. Used for breaking changes</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">min_corp_ios_version</span></code><span> (string)</span><span> — </span><span>Minimal iOS corp application version required for this server. Used for breaking changes</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">min_corp_android_version</span></code><span> (string)</span><span> — </span><span>Minimal android corp application version required for this server. Used for breaking changes</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">free_registration</span></code><span> (boolean)</span><span> — </span><span>Free registration allowed</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_upload_mb</span></code><span> (number)</span><span> — </span><span>Maximum size of user’s upload</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_linked_messages</span></code><span> (number)</span><span> — </span><span>Maximum number of forwarded messages</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_message_uploads</span></code><span> (number)</span><span> — </span><span>Maximum number of message uploads</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_username_part_length</span></code><span> (number)</span><span> — </span><span>Maximum chars for: family_name, given_name, patronymic if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_group_title_length</span></code><span> (number)</span><span> — </span><span>Maximum chars for group chat name</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_team_title_length</span></code><span> (number)</span><span> — </span><span>Maximum chars for team name</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_role_length</span></code><span> (number)</span><span> — </span><span>Maximum chars for role in team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_mood_length</span></code><span> (number)</span><span> — </span><span>Maximum chars for mood in team</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_message_length</span></code><span> (number)</span><span> — </span><span>Maximum chars for text message</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_section_length</span></code><span> (number)</span><span> — </span><span>Maximum length for contact’s sections names</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_project_length</span></code><span> (number)</span><span> — </span><span>Maximum length for project</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_tag_length</span></code><span> (number)</span><span> — </span><span>Maximum length for tags</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_task_title_length</span></code><span> (number)</span><span> — </span><span>Maximum length for task title</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_color_rule_description_length</span></code><span> (number)</span><span> — </span><span>Maximum length for ColorRule description</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_url_length</span></code><span> (number)</span><span> — </span><span>Maximum length for urls</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_integration_comment_length</span></code><span> (number)</span><span> — </span><span>Maximum length for Integration comment</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_teams</span></code><span> (number)</span><span> — </span><span>Maximum teams for one account</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_message_search_limit</span></code><span> (number)</span><span> — </span><span>Maximum search result</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">multi_nodes</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Multi nodes mode (federation) enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">afk_age</span></code><span> (number)</span><span> — </span><span>Max inactivity seconds</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">auth_by_password</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Password authentication enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">auth_by_qr_code</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>QR-code / link authentication enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">auth_by_sms</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>SMS authentication enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">auth_2fa</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Two-factor authentication (2FA) enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">is_pin_code_required</span></code><span> (boolean)</span><span> — </span><span>Mandatory setting of the pin code in the application</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">pin_code_wrong_limit</span></code><span> (number)</span><span> — </span><span>Max number of attempts to enter an invalid PIN code</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">oauth_services</span></code><span> (array[<a class="reference external" href="#tdmodels-OAuthService">OAuthService</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>External services</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">ice_servers</span></code><span> (array[<a class="reference external" href="#tdmodels-ICEServer">ICEServer</a><span>])</span></span><span> — </span><span>ICE servers for WebRTC</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">custom_server</span></code><span> (boolean)</span><span> — </span><span>True for premise installation</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">installation_type</span></code><span> (string)</span><span> — </span><span>Name of installation</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">installation_title</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Installation title, used on login screen</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">custom_app_icon_name</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Custom application icon name, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">app_login_background</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>AppBackground image url, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">web_login_background</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>WebBackground image url, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">is_testing</span></code><span> (boolean)</span><span> — </span><span>Testing installation</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">metrika</span></code><span> (string)</span><span> — </span><span>Yandex metrika counter id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">amplitude_api_key</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Amplitude api key</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">min_search_length</span></code><span> (number)</span><span> — </span><span>Minimal chars number for starting global search</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">resend_timeout</span></code><span> (number)</span><span> — </span><span>Resend message in n seconds if no confirmation from server given</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">sentry_dsn_js</span></code><span> (string)</span><span> — </span><span>Frontend sentry.io settings</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">server_drafts</span></code><span> (boolean)</span><span> — </span><span>Message drafts saved on server</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">firebase_app_id</span></code><span> (string)</span><span> — </span><span>Firebase settings for web-push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">firebase_sender_id</span></code><span> (string)</span><span> — </span><span>Firebase settings for web-push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">firebase_api_key</span></code><span> (string)</span><span> — </span><span>Firebase settings for web-push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">firebase_auth_domain</span></code><span> (string)</span><span> — </span><span>Firebase settings for web-push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">firebase_database_url</span></code><span> (string)</span><span> — </span><span>Firebase settings for web-push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">firebase_project_id</span></code><span> (string)</span><span> — </span><span>Firebase settings for web-push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">firebase_storage_bucket</span></code><span> (string)</span><span> — </span><span>Firebase settings for web-push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">calls_version</span></code><span> (number)</span><span> — </span><span>Calls version. 0 = disabled, 1 = audio only, 2 = audio+video</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">mobile_calls</span></code><span> (boolean)</span><span> — </span><span>Calls functions enabled for mobile applications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">calls_record</span></code><span> (boolean)</span><span> — </span><span>Calls record enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">only_one_device_per_call</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Disallow call from multiple devices. Experimental</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">max_participants_per_call</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Maximum number of participants per call</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">safari_push_id</span></code><span> (string)</span><span> — </span><span>Safari push id for web-push notifications</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">message_uploads</span></code><span> (boolean)</span><span> — </span><span>Multiple message uploads</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">terms</span></code><span> (<a class="reference external" href="#tdmodels-Terms">Terms</a><span>)</span></span><span> — </span><span>Team entity naming. Experimental</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">single_group_teams</span></code><span> (boolean)</span><span> — </span><span>Cross team communication. Experimental</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">wiki_pages</span></code><span> (boolean)</span><span> — </span><span>Wiki pages in chats. Experimental</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">allow_admin_mute</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Wiki pages in chats. Experimental</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">default_wallpaper</span></code><span> (<a class="reference external" href="#tdmodels-Wallpaper">Wallpaper</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Default wallpaper url for mobile apps, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">support_email</span></code><span> (string)</span><span> — </span><span>Support email</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">custom_theme</span></code><span> (boolean)</span><span> — </span><span>True if server has custom theme</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_checklist</span></code><span> (boolean)</span><span> — </span><span>Deprecated</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">readonly_groups</span></code><span> (boolean)</span><span> — </span><span>Deprecated</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_dashboard</span></code><span> (boolean)</span><span> — </span><span>Deprecated</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_messages</span></code><span> (boolean)</span><span> — </span><span>Deprecated</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_public</span></code><span> (boolean)</span><span> — </span><span>Deprecated</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">task_tags</span></code><span> (boolean)</span><span> — </span><span>Deprecated</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">calls</span></code><span> (boolean)</span><span> — </span><span>Deprecated</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">min_app_version</span></code><span> (string)</span><span> — </span><span>Deprecated</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">file_extension_whitelist</span></code><span> (array[string])</span><span> — </span><span>File Extension Whitelist</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">file_extension_blacklist</span></code><span> (array[string])</span><span> — </span><span>File Extension Blacklist</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">file_extension_whitelist_priority</span></code><span> (boolean)</span><span> — </span><span>File Extension Whitelist Priority</span></div>
</ul>
</section>
<section id="tdmodels-FontColors">
<h2>FontColors<a class="headerlink" href="#tdmodels-FontColors" title="Permalink to this heading"></a></h2>
<p><p>FontColors font colors for app</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">text</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Text color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">title</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Title color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">sub</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Sub color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">brand_button</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Brand button color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">simple_button</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Simple button color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">bubble_sent</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Bubble sent color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">bubble_received</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Bubble received color</span></div>
</ul>
</section>
<section id="tdmodels-GroupMembership">
<h2>GroupMembership<a class="headerlink" href="#tdmodels-GroupMembership" title="Permalink to this heading"></a></h2>
<p><p>Group chat membership status</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">jid</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Contact id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">status</span></code><span> (<a class="reference external" href="#tdmodels-GroupStatus">GroupStatus</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Status in group</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">can_remove</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Can I remove this member</span></div>
</ul>
</section>
<section id="tdmodels-ICEServer">
<h2>ICEServer<a class="headerlink" href="#tdmodels-ICEServer" title="Permalink to this heading"></a></h2>
<p><p>Interactive Connectivity Establishment Server for WEB Rtc connection. Readonly</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">urls</span></code><span> (string)</span><span> — </span><span>URls</span></div>
</ul>
</section>
<section id="tdmodels-IconColors">
<h2>IconColors<a class="headerlink" href="#tdmodels-IconColors" title="Permalink to this heading"></a></h2>
<p><p>IconColors icon colors for app</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">title</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Title color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">brand</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Brand color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">other</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Other color</span></div>
</ul>
</section>
<section id="tdmodels-IconData">
<h2>IconData<a class="headerlink" href="#tdmodels-IconData" title="Permalink to this heading"></a></h2>
<p><p>Icon data. For icon generated from display name contains Letters + Color fields</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">sm</span></code><span> (<a class="reference external" href="#tdmodels-SingleIcon">SingleIcon</a><span>)</span></span><span> — </span><span>Small icon</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">lg</span></code><span> (<a class="reference external" href="#tdmodels-SingleIcon">SingleIcon</a><span>)</span></span><span> — </span><span>Large image</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">letters</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Letters (only for stub icon)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">color</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Icon background color (only for stub icon)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">blurhash</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Compact representation of a placeholder for an image (experimental)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">stub</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Deprecated</span></div>
</ul>
</section>
<section id="tdmodels-InputColors">
<h2>InputColors<a class="headerlink" href="#tdmodels-InputColors" title="Permalink to this heading"></a></h2>
<p><p>InputColors input colors for app</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Static color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">active</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Active color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">disable</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Disable color</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">error</span></code><span> (<a class="reference external" href="#tdmodels-RGBColor">RGBColor</a><span>)</span></span><span> — </span><span>Error color</span></div>
</ul>
</section>
<section id="tdmodels-Integration">
<h2>Integration<a class="headerlink" href="#tdmodels-Integration" title="Permalink to this heading"></a></h2>
<p><p>Integration for concrete chat</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">uid</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">comment</span></code><span> (string)</span><span> — </span><span>Comment, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">created</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Creation datetime, iso</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">enabled</span></code><span> (boolean)</span><span> — </span><span>Integration enabled</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">form</span></code><span> (<a class="reference external" href="#tdmodels-IntegrationForm">IntegrationForm</a><span>)</span></span><span> — </span><span>Integration form</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">group</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Chat id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">help</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Full description</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">kind</span></code><span> (string)</span><span> — </span><span>Unique integration name</span></div>
</ul>
</section>
<section id="tdmodels-IntegrationField">
<h2>IntegrationField<a class="headerlink" href="#tdmodels-IntegrationField" title="Permalink to this heading"></a></h2>
<p><p>Integration form field</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">label</span></code><span> (string)</span><span> — </span><span>Label</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">readonly</span></code><span> (boolean)</span><span> — </span><span>Is field readonly</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">value</span></code><span> (string)</span><span> — </span><span>Current value</span></div>
</ul>
</section>
<section id="tdmodels-IntegrationForm">
<h2>IntegrationForm<a class="headerlink" href="#tdmodels-IntegrationForm" title="Permalink to this heading"></a></h2>
<p><p>Integration form</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">api_key</span></code><span> (<a class="reference external" href="#tdmodels-IntegrationField">IntegrationField</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Api key field, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">webhook_url</span></code><span> (<a class="reference external" href="#tdmodels-IntegrationField">IntegrationField</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Webhook url, if any</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">url</span></code><span> (<a class="reference external" href="#tdmodels-IntegrationField">IntegrationField</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Url, if any</span></div>
</ul>
</section>
<section id="tdmodels-IntegrationKind">
<h2>IntegrationKind<a class="headerlink" href="#tdmodels-IntegrationKind" title="Permalink to this heading"></a></h2>
<p><p>Integration kind</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">kind</span></code><span> (string)</span><span> — </span><span>Integration unique name</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">title</span></code><span> (string)</span><span> — </span><span>Plugin title</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">template</span></code><span> (<a class="reference external" href="#tdmodels-Integration">Integration</a><span>)</span></span><span> — </span><span>Integration template</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">icon</span></code><span> (string)</span><span> — </span><span>Path to icon</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">description</span></code><span> (string)</span><span> — </span><span>Plugin description</span></div>
</ul>
</section>
<section id="tdmodels-Integrations">
<h2>Integrations<a class="headerlink" href="#tdmodels-Integrations" title="Permalink to this heading"></a></h2>
<p><p>Complete integrations data, as received from server</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">integrations</span></code><span> (array[<a class="reference external" href="#tdmodels-Integration">Integration</a><span>])</span></span><span> — </span><span>Currently existing integrations</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">kinds</span></code><span> (array[<a class="reference external" href="#tdmodels-IntegrationKind">IntegrationKind</a><span>])</span></span><span> — </span><span>Types of integrations available for setup</span></div>
</ul>
</section>
<section id="tdmodels-InvitableUser">
<h2>InvitableUser<a class="headerlink" href="#tdmodels-InvitableUser" title="Permalink to this heading"></a></h2>
<p><p>Account from other team, Active Directory or node</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">uid</span></code><span> (string)</span><span> — </span><span>Account id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">node</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Node uid for external users</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">display_name</span></code><span> (string)</span><span> — </span><span>Full name</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">icons</span></code><span> (<a class="reference external" href="#tdmodels-IconData">IconData</a><span>)</span></span><span> — </span><span>Icons</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">teams</span></code><span> (array[string])</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Common team uids, if any</span></div>
</ul>
</section>
<section id="tdmodels-JSEP">
<h2>JSEP<a class="headerlink" href="#tdmodels-JSEP" title="Permalink to this heading"></a></h2>
<p><p>JavaScript Session Establishment Protocol</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">sdp</span></code><span> (string)</span><span> — </span><span>Session Description Protocol information</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">type</span></code><span> (string)</span><span> — </span><span>See https://rtcweb-wg.github.io/jsep/#rfc.section.4.1.8</span></div>
</ul>
</section>
<section id="tdmodels-MarkupEntity">
<h2>MarkupEntity<a class="headerlink" href="#tdmodels-MarkupEntity" title="Permalink to this heading"></a></h2>
<p><p>Markup entity. Experimental</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">op</span></code><span> (number)</span><span> — </span><span>Open marker offset</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">oplen</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Open marker length</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">cl</span></code><span> (number)</span><span> — </span><span>Close marker offset</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">cllen</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Close marker length</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">typ</span></code><span> (<a class="reference external" href="#tdmodels-MarkupType">MarkupType</a><span>)</span></span><span> — </span><span>Marker type</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">url</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Url, for Link type</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">repl</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Text replacement</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">time</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Time, for Time type</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">childs</span></code><span> (array[<a class="reference external" href="#tdmodels-MarkupEntity">MarkupEntity</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>List of internal markup entities</span></div>
</ul>
</section>
<section id="tdmodels-Message">
<h2>Message<a class="headerlink" href="#tdmodels-Message" title="Permalink to this heading"></a></h2>
<p><p>Chat message</p>
</p>
<ul>
<div class="line">Fields:</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">content</span></code><span> (<a class="reference external" href="#tdmodels-MessageContent">MessageContent</a><span>)</span></span><span> — </span><span>Message content struct</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">push_text</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Simple plaintext message representation</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">from</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Sender contact id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">to</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Recipient id (group, task or contact)</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">message_id</span></code><span> (string)</span><span> — </span><span>Message uid</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">created</span></code><span> (string)</span><span> — </span><span>Message creation datetime (set by server side) or sending datetime in future for draft messages</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">drafted</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Creation datetime for draft messages</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">gentime</span></code><span> (number)</span><span> — </span><span>Object version</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">chat_type</span></code><span> (<a class="reference external" href="#tdmodels-ChatType">ChatType</a><span>)</span></span><span> — </span><span>Chat type</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">chat</span></code><span> (<a class="reference external" href="#tdmodels-JID">JID</a><span>)</span></span><span> — </span><span>Chat id</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">links</span></code><span> (<a class="reference external" href="#tdmodels-MessageLinks">MessageLinks</a><span>)</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>External/internals links</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">markup</span></code><span> (array[<a class="reference external" href="#tdmodels-MarkupEntity">MarkupEntity</a><span>])</span></span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Markup entities. Experimental</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">important</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Importance flag</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">edited</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>ISODateTimeString of message modification or deletion</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">received</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Message was seen by anybody in chat. True or null</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">num_received</span></code><span> (number)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Unused yet</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">nopreview</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Disable link previews. True or null</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">has_previews</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Has link previews. True or null</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">prev</span></code><span> (string)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>Previous message id in this chat. Uid or null</span></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">is_first</span></code><span> (boolean)</span><abbr title="Maybe omitted"> 💥 </abbr><span> — </span><span>This message is first in this chat. True or null</span></div>