-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
2611 lines (2610 loc) · 97.4 KB
/
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>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<title>Euphoria API</title>
<link href='https://fonts.googleapis.com/css?family=Noto+Sans:400,400italic,700,700italic' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="/css/api.css">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no" />
<script async src="/js/main.js"></script>
</head>
<body>
<div id="content">
<div id="noscript">
<h1 id="table-of-contents">Table of Contents</h1>
<ul>
<li><a href="#overview">Overview</a></li>
<li><a href="#field-types">Field Types</a><ul>
<li><a href="#basic-types">Basic Types</a></li>
<li><a href="#accountview">AccountView</a></li>
<li><a href="#authoption">AuthOption</a></li>
<li><a href="#message">Message</a></li>
<li><a href="#packettype">PacketType</a></li>
<li><a href="#personalaccountview">PersonalAccountView</a></li>
<li><a href="#sessionview">SessionView</a></li>
<li><a href="#snowflake">Snowflake</a></li>
<li><a href="#time">Time</a></li>
<li><a href="#userid">UserID</a></li>
</ul>
</li>
<li><a href="#asynchronous-events">Asynchronous Events</a><ul>
<li><a href="#bounce-event">bounce-event</a></li>
<li><a href="#disconnect-event">disconnect-event</a></li>
<li><a href="#edit-message-event">edit-message-event</a></li>
<li><a href="#hello-event">hello-event</a></li>
<li><a href="#join-event">join-event</a></li>
<li><a href="#login-event">login-event</a></li>
<li><a href="#logout-event">logout-event</a></li>
<li><a href="#network-event">network-event</a></li>
<li><a href="#nick-event">nick-event</a></li>
<li><a href="#part-event">part-event</a></li>
<li><a href="#ping-event">ping-event</a></li>
<li><a href="#pm-initiate-event">pm-initiate-event</a></li>
<li><a href="#send-event">send-event</a></li>
<li><a href="#snapshot-event">snapshot-event</a></li>
</ul>
</li>
<li><a href="#session-commands">Session Commands</a><ul>
<li><a href="#auth">auth</a></li>
<li><a href="#ping">ping</a></li>
</ul>
</li>
<li><a href="#chat-room-commands">Chat Room Commands</a><ul>
<li><a href="#get-message">get-message</a></li>
<li><a href="#log">log</a></li>
<li><a href="#nick">nick</a></li>
<li><a href="#pm-initiate">pm-initiate</a></li>
<li><a href="#send">send</a></li>
<li><a href="#who">who</a></li>
</ul>
</li>
<li><a href="#account-commands">Account Commands</a><ul>
<li><a href="#change-email">change-email</a></li>
<li><a href="#change-name">change-name</a></li>
<li><a href="#change-password">change-password</a></li>
<li><a href="#login">login</a></li>
<li><a href="#logout">logout</a></li>
<li><a href="#register-account">register-account</a></li>
<li><a href="#resend-verification-email">resend-verification-email</a></li>
<li><a href="#reset-password">reset-password</a></li>
</ul>
</li>
<li><a href="#room-host-commands">Room Host Commands</a><ul>
<li><a href="#ban">ban</a></li>
<li><a href="#edit-message">edit-message</a></li>
<li><a href="#grant-access">grant-access</a></li>
<li><a href="#grant-manager">grant-manager</a></li>
<li><a href="#revoke-access">revoke-access</a></li>
<li><a href="#revoke-manager">revoke-manager</a></li>
<li><a href="#unban">unban</a></li>
</ul>
</li>
<li><a href="#staff-commands">Staff Commands</a><ul>
<li><a href="#staff-create-room">staff-create-room</a></li>
<li><a href="#staff-grant-manager">staff-grant-manager</a></li>
<li><a href="#staff-enroll-otp">staff-enroll-otp</a></li>
<li><a href="#staff-invade">staff-invade</a></li>
<li><a href="#staff-lock-room">staff-lock-room</a></li>
<li><a href="#staff-revoke-access">staff-revoke-access</a></li>
<li><a href="#staff-revoke-manager">staff-revoke-manager</a></li>
<li><a href="#staff-validate-otp">staff-validate-otp</a></li>
<li><a href="#unlock-staff-capability">unlock-staff-capability</a></li>
</ul>
</li>
</ul>
<h1 id="overview">Overview</h1>
<p>Clients interact with Euphoria over a WebSocket-based API. The connection is to a specific
<em>room</em>. We call each instance of such a connection a <em>session</em>.</p>
<h2 id="packets">Packets</h2>
<p>Messages are sent back and forth between the client and server as packets, in the form of JSON objects.
Each packet has the following structure:</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">client-generated id for associating replies with commands</td>
</tr>
<tr>
<td style="text-align:left"><code>type</code></td>
<td style="text-align:left"><a href="#packettype">PacketType</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the name of the command, reply, or event</td>
</tr>
<tr>
<td style="text-align:left"><code>data</code></td>
<td style="text-align:left">object</td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the payload of the command, reply, or event</td>
</tr>
<tr>
<td style="text-align:left"><code>error</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">this field appears in replies if a command fails</td>
</tr>
<tr>
<td style="text-align:left"><code>throttled</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">this field appears in replies to warn the client that it may be flooding; the client should slow down its command rate</td>
</tr>
<tr>
<td style="text-align:left"><code>throttled_reason</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if throttled is true, this field describes why</td>
</tr>
</tbody>
</table>
<p>The <code>type</code> field determines the type of the <code>data</code> field. Packet types come in three flavors:</p>
<ol>
<li><em>Commands</em>. These names have no suffix. Examples: “<a href="#ping">ping</a>“, “<a href="#send">send</a>“</li>
<li><em>Replies</em>. Every command type has a corresponding reply type. Their names all have a <code>-reply</code> suffix. Examples: “<a href="#ping">ping-reply</a>“, “<a href="#send">send-reply</a>“</li>
<li><em>Events</em>. These names all have an <code>-event</code> suffix. Examples: “<a href="#snapshot-event">snapshot-event</a>“, “<a href="#ping-event">ping-event</a>“</li>
</ol>
<p>Almost all client-to-server packets must be commands. The only exception is <a href="#ping">ping-reply</a>,
which the client should send in response to a <a href="#ping-event">ping-event</a> from the server.
Any other reply or event sent by the client will have an error reply sent back in response.</p>
<p>All server-to-client packets must be either replies or events. All replies must correspond to a command
sent by the client. The server must never send more than one reply to a command.</p>
<p>When a client sends a command, it can choose to specify an <code>id</code>. This is an arbitrary string that
the server will include in its reply. This helps asynchronous clients identify which command a packet
is in reply to.</p>
<p>Here is an example <a href="#send">send</a> command sent from a client to the server:</p>
<pre><code>{
"id": "1",
"type": "send",
"data": {
"content": "hello world!"
}
}
</code></pre><p>In response, the server will send back a <a href="#send">send-reply</a>:</p>
<pre><code>{
"id": "1",
"type": "send-reply",
"data": {
"id": "00gd6yy9hvksg",
"time": 1418585715,
"sender": {
"id": "agent:4da8fa7375215589",
"name": "logan",
"server_id": "heim.1",
"server_era": "00g5fdwjzl91c",
"session_id": "4da8fa7375215589-00000246"
},
"content": "hello world!"
}
}
</code></pre><p>The server will also send a <a href="#send-event">send-event</a> to all the other sessions connected
to the same room:</p>
<pre><code>{
"type": "send-event",
"data": {
"id": "00gd6yy9hvksg",
"time": 1418585715,
"sender": {
"id": "agent:4da8fa7375215589",
"name": "logan",
"server_id": "heim.1",
"server_era": "00g5fdwjzl91c",
"session_id": "4da8fa7375215589-00000246"
},
"content": "hello world!"
}
}
</code></pre><h2 id="initial-handshake">Initial Handshake</h2>
<p>When a client connects to the websocket for a room, the server will begin the session
with a <a href="#ping-event">ping-event</a>:</p>
<pre><code>{
"type": "ping-event",
"data": {
"time": 1428979816,
"next": 1428979846
}
}
</code></pre><p>The client should immediately reply with the same timestamp:</p>
<pre><code>{
"type": "ping-reply",
"data": {
"time": 1428979816
}
}
</code></pre><p>Once the client replies to the ping, one of two possible events will be sent next.
If the room is a public room, or if the client is logged into an account that has
been granted access to the room, then the server will send a <a href="#snapshot-event">snapshot-event</a>:</p>
<pre><code>{
type: "snapshot-event",
data: {
identity: "agent:4da8fa7375215589",
session_id: "4da8fa7375215589-00000246",
version: "801ea89a4e410b11410eb61c91971439904e66c0",
listing: [...],
log:[...]
}
}
</code></pre><p>This event serves to fill the client in on recent room history, and lists all the sessions
currently joined in the room. From this point on, the session is <em>joined</em> with the room. A
joined session may use chat commands and will receive room events.</p>
<p>If the room is private and the client does not have access, the server will send a
<a href="#bounce-event">bounce-event</a> instead. At this point the client should obtain the
proper authentication credentials from the user and present them with the <a href="#auth">auth</a>
or <a href="#login">login</a> command.</p>
<h1 id="field-types">Field Types</h1>
<p>This section describes all the field types one can expect to see in packets.</p>
<h2 id="basic-types">Basic Types</h2>
<h4 id="bool">bool</h4>
<p>A boolean value: <code>true</code> or <code>false</code>.</p>
<h4 id="int">int</h4>
<p>A signed 64-bit integer value.</p>
<h4 id="string">string</h4>
<p>Strings are UTF-8 encoded text. Unless otherwise specified, a string may be of any length.</p>
<h4 id="object">object</h4>
<p>An arbitrary JSON object.</p>
<h2 id="accountview">AccountView</h2>
<p>AccountView describes an account and its preferred names.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the account</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the name that the holder of the account goes by</td>
</tr>
</tbody>
</table>
<h2 id="authoption">AuthOption</h2>
<p><code>AuthOption</code> is a string indicating a mode of authentication. It must be one of the
following values:</p>
<table>
<thead>
<tr>
<th style="text-align:left">Value</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>passcode</code></td>
<td style="text-align:left">Authentication with a passcode, where a key is derived from the passcode to unlock an access grant.</td>
</tr>
</tbody>
</table>
<h2 id="message">Message</h2>
<p>A Message is a node in a Room’s Log. It corresponds to a chat message, or
a post, or any broadcasted event in a room that should appear in the log.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the message (unique within a room)</td>
</tr>
<tr>
<td style="text-align:left"><code>parent</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the id of the message’s parent, or null if top-level</td>
</tr>
<tr>
<td style="text-align:left"><code>previous_edit_id</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the edit id of the most recent edit of this message, or null if it’s never been edited</td>
</tr>
<tr>
<td style="text-align:left"><code>time</code></td>
<td style="text-align:left"><a href="#time">Time</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the unix timestamp of when the message was posted</td>
</tr>
<tr>
<td style="text-align:left"><code>sender</code></td>
<td style="text-align:left"><a href="#sessionview">SessionView</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the view of the sender’s session</td>
</tr>
<tr>
<td style="text-align:left"><code>content</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the content of the message (client-defined)</td>
</tr>
<tr>
<td style="text-align:left"><code>encryption_key_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the id of the key that encrypts the message in storage</td>
</tr>
<tr>
<td style="text-align:left"><code>edited</code></td>
<td style="text-align:left"><a href="#time">Time</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the unix timestamp of when the message was last edited</td>
</tr>
<tr>
<td style="text-align:left"><code>deleted</code></td>
<td style="text-align:left"><a href="#time">Time</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the unix timestamp of when the message was deleted</td>
</tr>
<tr>
<td style="text-align:left"><code>truncated</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, then the full content of this message is not included (see <code>get-message</code> to obtain the message with full content)</td>
</tr>
</tbody>
</table>
<h2 id="packettype">PacketType</h2>
<p><code>PacketType</code> is a string describing the type of the packet. For example, “<a href="#ping">ping</a>“,
“<a href="#ping-reply">ping-reply</a>“, and “<a href="#ping-event">ping-event</a>“ are packet types.</p>
<h2 id="personalaccountview">PersonalAccountView</h2>
<p>PersonalAccountView describes an account to its owner.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the account</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the name that the holder of the account goes by</td>
</tr>
<tr>
<td style="text-align:left"><code>email</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the account’s email address</td>
</tr>
</tbody>
</table>
<h2 id="sessionview">SessionView</h2>
<p>SessionView describes a session and its identity.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#userid">UserID</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of an agent or account</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the name-in-use at the time this view was captured</td>
</tr>
<tr>
<td style="text-align:left"><code>server_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the server that captured this view</td>
</tr>
<tr>
<td style="text-align:left"><code>server_era</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the era of the server that captured this view</td>
</tr>
<tr>
<td style="text-align:left"><code>session_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">id of the session, unique across all sessions globally</td>
</tr>
<tr>
<td style="text-align:left"><code>is_staff</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, this session belongs to a member of staff</td>
</tr>
<tr>
<td style="text-align:left"><code>is_manager</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, this session belongs to a manager of the room</td>
</tr>
<tr>
<td style="text-align:left"><code>client_address</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">for hosts and staff, the virtual address of the client</td>
</tr>
<tr>
<td style="text-align:left"><code>real_client_address</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">for staff, the real address of the client</td>
</tr>
</tbody>
</table>
<h2 id="snowflake">Snowflake</h2>
<p>A snowflake is a 13-character string, usually used as a unique identifier for some type
of object. It is the base-36 encoding of an unsigned, 64-bit integer.</p>
<h2 id="time">Time</h2>
<p>Time is specified as a signed 64-bit integer, giving the number of seconds since the Unix Epoch.</p>
<h2 id="userid">UserID</h2>
<p>A UserID identifies a user. The prefix of this value (up to the colon) indicates a type of session,
while the suffix is a unique value for that type of session.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Prefix</th>
<th style="text-align:left">Suffix</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>agent:</code></td>
<td style="text-align:left"><em>agent identifier</em></td>
<td style="text-align:left">A user, not signed into any account, but tracked via cookie under this identifier.</td>
</tr>
<tr>
<td style="text-align:left"><code>account:</code></td>
<td style="text-align:left"><em>account identifier</em></td>
<td style="text-align:left">The id (<a href="#snowflake">Snowflake</a>) of the account the user is logged into.</td>
</tr>
</tbody>
</table>
<h1 id="asynchronous-events">Asynchronous Events</h1>
<p>The following events may be sent from the server to the client at any time.</p>
<h2 id="bounce-event">bounce-event</h2>
<p>A <code>bounce-event</code> indicates that access to a room is denied.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>reason</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the reason why access was denied</td>
</tr>
<tr>
<td style="text-align:left"><code>auth_options</code></td>
<td style="text-align:left">[<a href="#authoption">AuthOption</a>]</td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">authentication options that may be used; see <a href="#auth">auth</a></td>
</tr>
<tr>
<td style="text-align:left"><code>agent_id</code></td>
<td style="text-align:left"><a href="#userid">UserID</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">internal use only</td>
</tr>
<tr>
<td style="text-align:left"><code>ip</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">internal use only</td>
</tr>
</tbody>
</table>
<h2 id="disconnect-event">disconnect-event</h2>
<p>A <code>disconnect-event</code> indicates that the session is being closed. The client
will subsequently be disconnected.</p>
<p>If the disconnect reason is “authentication changed”, the client should
immediately reconnect.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>reason</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the reason for disconnection</td>
</tr>
</tbody>
</table>
<h2 id="hello-event">hello-event</h2>
<p>A <code>hello-event</code> is sent by the server to the client when a session is started.
It includes information about the client’s authentication and associated identity.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#userid">UserID</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the agent or account logged into this session</td>
</tr>
<tr>
<td style="text-align:left"><code>account</code></td>
<td style="text-align:left"><a href="#personalaccountview">PersonalAccountView</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">details about the user’s account, if the session is logged in</td>
</tr>
<tr>
<td style="text-align:left"><code>session</code></td>
<td style="text-align:left"><a href="#sessionview">SessionView</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">details about the session</td>
</tr>
<tr>
<td style="text-align:left"><code>account_has_access</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, then the account has an explicit access grant to the current room</td>
</tr>
<tr>
<td style="text-align:left"><code>account_email_verified</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">whether the account’s email address has been verified</td>
</tr>
<tr>
<td style="text-align:left"><code>room_is_private</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">if true, the session is connected to a private room</td>
</tr>
<tr>
<td style="text-align:left"><code>version</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the version of the code being run and served by the server</td>
</tr>
</tbody>
</table>
<h2 id="join-event">join-event</h2>
<p>A <code>join-event</code> indicates a session just joined the room.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#userid">UserID</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of an agent or account</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the name-in-use at the time this view was captured</td>
</tr>
<tr>
<td style="text-align:left"><code>server_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the server that captured this view</td>
</tr>
<tr>
<td style="text-align:left"><code>server_era</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the era of the server that captured this view</td>
</tr>
<tr>
<td style="text-align:left"><code>session_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">id of the session, unique across all sessions globally</td>
</tr>
<tr>
<td style="text-align:left"><code>is_staff</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, this session belongs to a member of staff</td>
</tr>
<tr>
<td style="text-align:left"><code>is_manager</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, this session belongs to a manager of the room</td>
</tr>
<tr>
<td style="text-align:left"><code>client_address</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">for hosts and staff, the virtual address of the client</td>
</tr>
<tr>
<td style="text-align:left"><code>real_client_address</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">for staff, the real address of the client</td>
</tr>
</tbody>
</table>
<h2 id="login-event">login-event</h2>
<p>The <code>login-event</code> packet is sent to all sessions of an agent when that
agent is logged in (except for the session that issued the login command).</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>account_id</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left">required</td>
</tr>
</tbody>
</table>
<h2 id="logout-event">logout-event</h2>
<p>The <code>logout-event</code> packet is sent to all sessions of an agent when that
agent is logged out (except for the session that issued the logout command).</p>
<p>This packet has no fields.</p>
<h2 id="network-event">network-event</h2>
<p>A <code>network-event</code> indicates some server-side event that impacts the presence
of sessions in a room.</p>
<p>If the network event type is <code>partition</code>, then this should be treated as
a <a href="#part-event">part-event</a> for all sessions connected to the same server
id/era combo.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>type</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the type of network event; for now, always <code>partition</code></td>
</tr>
<tr>
<td style="text-align:left"><code>server_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the affected server</td>
</tr>
<tr>
<td style="text-align:left"><code>server_era</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the era of the affected server</td>
</tr>
</tbody>
</table>
<h2 id="nick-event">nick-event</h2>
<p><code>nick-event</code> announces a nick change by another session in the room.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>session_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the session this name applies to</td>
</tr>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#userid">UserID</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the agent or account logged into the session</td>
</tr>
<tr>
<td style="text-align:left"><code>from</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the previous name associated with the session</td>
</tr>
<tr>
<td style="text-align:left"><code>to</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the name associated with the session henceforth</td>
</tr>
</tbody>
</table>
<h2 id="edit-message-event">edit-message-event</h2>
<p>An <code>edit-message-event</code> indicates that a message in the room has been
modified or deleted. If the client offers a user interface and the
indicated message is currently displayed, it should update its display
accordingly.</p>
<p>The event packet includes a snapshot of the message post-edit.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>edit_id</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the edit</td>
</tr>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the message (unique within a room)</td>
</tr>
<tr>
<td style="text-align:left"><code>parent</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the id of the message’s parent, or null if top-level</td>
</tr>
<tr>
<td style="text-align:left"><code>previous_edit_id</code></td>
<td style="text-align:left"><a href="#snowflake">Snowflake</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the edit id of the most recent edit of this message, or null if it’s never been edited</td>
</tr>
<tr>
<td style="text-align:left"><code>time</code></td>
<td style="text-align:left"><a href="#time">Time</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the unix timestamp of when the message was posted</td>
</tr>
<tr>
<td style="text-align:left"><code>sender</code></td>
<td style="text-align:left"><a href="#sessionview">SessionView</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the view of the sender’s session</td>
</tr>
<tr>
<td style="text-align:left"><code>content</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the content of the message (client-defined)</td>
</tr>
<tr>
<td style="text-align:left"><code>encryption_key_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the id of the key that encrypts the message in storage</td>
</tr>
<tr>
<td style="text-align:left"><code>edited</code></td>
<td style="text-align:left"><a href="#time">Time</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the unix timestamp of when the message was last edited</td>
</tr>
<tr>
<td style="text-align:left"><code>deleted</code></td>
<td style="text-align:left"><a href="#time">Time</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">the unix timestamp of when the message was deleted</td>
</tr>
<tr>
<td style="text-align:left"><code>truncated</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, then the full content of this message is not included (see <code>get-message</code> to obtain the message with full content)</td>
</tr>
</tbody>
</table>
<h2 id="part-event">part-event</h2>
<p>A <code>part-event</code> indicates a session just disconnected from the room.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>id</code></td>
<td style="text-align:left"><a href="#userid">UserID</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of an agent or account</td>
</tr>
<tr>
<td style="text-align:left"><code>name</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the name-in-use at the time this view was captured</td>
</tr>
<tr>
<td style="text-align:left"><code>server_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the server that captured this view</td>
</tr>
<tr>
<td style="text-align:left"><code>server_era</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the era of the server that captured this view</td>
</tr>
<tr>
<td style="text-align:left"><code>session_id</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">id of the session, unique across all sessions globally</td>
</tr>
<tr>
<td style="text-align:left"><code>is_staff</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, this session belongs to a member of staff</td>
</tr>
<tr>
<td style="text-align:left"><code>is_manager</code></td>
<td style="text-align:left"><a href="#bool">bool</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">if true, this session belongs to a manager of the room</td>
</tr>
<tr>
<td style="text-align:left"><code>client_address</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">for hosts and staff, the virtual address of the client</td>
</tr>
<tr>
<td style="text-align:left"><code>real_client_address</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left"><em>optional</em></td>
<td style="text-align:left">for staff, the real address of the client</td>
</tr>
</tbody>
</table>
<h2 id="ping-event">ping-event</h2>
<p>A <code>ping-event</code> represents a server-to-client ping. The client should send back
a <code>ping-reply</code> with the same value for the time field as soon as possible
(or risk disconnection).</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>time</code></td>
<td style="text-align:left"><a href="#time">Time</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">a unix timestamp according to the server’s clock</td>
</tr>
<tr>
<td style="text-align:left"><code>next</code></td>
<td style="text-align:left"><a href="#time">Time</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the expected time of the next ping-event, according to the server’s clock</td>
</tr>
</tbody>
</table>
<h2 id="pm-initiate-event">pm-initiate-event</h2>
<p>The <code>pm-initiate-event</code> informs the client that another user wants to chat
with them privately.</p>
<table>
<thead>
<tr>
<th style="text-align:left">Field</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Required?</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><code>from</code></td>
<td style="text-align:left"><a href="#userid">UserID</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the id of the user inviting the client to chat privately</td>
</tr>
<tr>
<td style="text-align:left"><code>from_nick</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the nick of the inviting user</td>
</tr>
<tr>
<td style="text-align:left"><code>from_room</code></td>
<td style="text-align:left"><a href="#string">string</a></td>
<td style="text-align:left">required</td>
<td style="text-align:left">the room where the invitation was sent from</td>
</tr>