forked from processone/xmpp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xmpp_codec.hrl
1446 lines (1219 loc) · 58 KB
/
xmpp_codec.hrl
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
%% Created automatically by XML generator (fxml_gen.erl)
%% Source: xmpp_codec.spec
-record(text, {lang = <<>> :: binary(),
data = <<>> :: binary()}).
-type text() :: #text{}.
-type iq_type() :: get | set | result | error.
-type message_type() :: chat | error | groupchat | headline | normal.
-type presence_type() :: available | error | probe | subscribe |
subscribed | unavailable | unsubscribe |
unsubscribed.
-record(iq, {id = <<>> :: binary(),
type :: iq_type(),
lang = <<>> :: binary(),
from :: undefined | jid:jid(),
to :: undefined | jid:jid(),
sub_els = [] :: [xmpp_element() | fxml:xmlel()],
meta = #{} :: map()}).
-type iq() :: #iq{}.
-record(message, {id = <<>> :: binary(),
type = normal :: message_type(),
lang = <<>> :: binary(),
from :: undefined | jid:jid(),
to :: undefined | jid:jid(),
subject = [] :: [#text{}],
body = [] :: [#text{}],
thread :: undefined | message_thread(),
sub_els = [] :: [xmpp_element() | fxml:xmlel()],
meta = #{} :: map()}).
-type message() :: #message{}.
-record(presence, {id = <<>> :: binary(),
type = available :: presence_type(),
lang = <<>> :: binary(),
from :: undefined | jid:jid(),
to :: undefined | jid:jid(),
show :: undefined | 'away' | 'chat' | 'dnd' | 'xa',
status = [] :: [#text{}],
priority :: undefined | integer(),
sub_els = [] :: [xmpp_element() | fxml:xmlel()],
meta = #{} :: map()}).
-type presence() :: #presence{}.
-record(ps_affiliation, {xmlns = <<>> :: binary(),
node = <<>> :: binary(),
type :: member | none | outcast |
owner | publisher | publish_only,
jid :: undefined | jid:jid()}).
-type ps_affiliation() :: #ps_affiliation{}.
-type ps_error_type() :: 'closed-node' | 'configuration-required' |
'invalid-jid' | 'invalid-options' |
'invalid-payload' | 'invalid-subid' |
'item-forbidden' | 'item-required' | 'jid-required' |
'max-items-exceeded' | 'max-nodes-exceeded' |
'nodeid-required' | 'not-in-roster-group' |
'not-subscribed' | 'payload-too-big' |
'payload-required' | 'pending-subscription' |
'precondition-not-met' |
'presence-subscription-required' | 'subid-required' |
'too-many-subscriptions' | 'unsupported' |
'unsupported-access-model'.
-type ps_feature() :: 'access-authorize' | 'access-open' |
'access-presence' | 'access-roster' |
'access-whitelist' | 'auto-create' |
'auto-subscribe' | 'collections' | 'config-node' |
'create-and-configure' | 'create-nodes' |
'delete-items' | 'delete-nodes' |
'filtered-notifications' | 'get-pending' |
'instant-nodes' | 'item-ids' | 'last-published' |
'leased-subscription' | 'manage-subscriptions' |
'member-affiliation' | 'meta-data' |
'modify-affiliations' | 'multi-collection' |
'multi-subscribe' | 'outcast-affiliation' |
'persistent-items' | 'presence-notifications' |
'presence-subscribe' | 'publish' |
'publish-options' | 'publish-only-affiliation' |
'publisher-affiliation' | 'purge-nodes' |
'retract-items' | 'retrieve-affiliations' |
'retrieve-default' | 'retrieve-items' |
'retrieve-subscriptions' | 'subscribe' |
'subscription-options' | 'subscription-notifications' |
'multi-items' | undefined.
-record(ps_error, {type :: ps_error_type(), feature :: ps_feature()}).
-type ps_error() :: #ps_error{}.
-record(chatstate, {type :: active | composing | gone | inactive | paused}).
-type chatstate() :: #chatstate{}.
-record(csi, {type :: active | inactive}).
-type csi() :: #csi{}.
-record(hint, {type :: 'no-copy' | 'no-store' | 'no-storage' | 'store' |
'no-permanent-store' | 'no-permanent-storage'}).
-type hint() :: #hint{}.
-record(jingle_error, {reason :: 'out-of-order' | 'tie-break' |
'unknown-session' | 'unsupported-info' |
'security-required'}).
-type jingle_error() :: #jingle_error{}.
-record(jingle_ft_error, {reason :: 'file-not-available' | 'file-too-large'}).
-type jingle_ft_error() :: #jingle_ft_error{}.
-type xmpp_host() :: binary() | inet:ip_address() |
{binary() | inet:ip_address(), inet:port_number()}.
-record(avatar_data, {data = <<>> :: binary()}).
-type avatar_data() :: #avatar_data{}.
-record(feature_register, {}).
-type feature_register() :: #feature_register{}.
-record(address, {type :: 'bcc' | 'cc' | 'noreply' | 'ofrom' | 'replyroom' | 'replyto' | 'to',
jid :: undefined | jid:jid(),
desc = <<>> :: binary(),
node = <<>> :: binary(),
delivered :: 'false' | 'true' | 'undefined'}).
-type address() :: #address{}.
-record(sasl_success, {text = <<>> :: binary()}).
-type sasl_success() :: #sasl_success{}.
-record(adhoc_note, {type = info :: 'error' | 'info' | 'warn',
data = <<>> :: binary()}).
-type adhoc_note() :: #adhoc_note{}.
-record(mam_result, {xmlns = <<>> :: binary(),
queryid = <<>> :: binary(),
id = <<>> :: binary(),
sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type mam_result() :: #mam_result{}.
-record(rsm_first, {index :: 'undefined' | non_neg_integer(),
data = <<>> :: binary()}).
-type rsm_first() :: #rsm_first{}.
-record(mark_received, {id = <<>> :: binary()}).
-type mark_received() :: #mark_received{}.
-record(streamhost, {jid :: jid:jid(),
host = <<>> :: binary(),
port = 1080 :: non_neg_integer()}).
-type streamhost() :: #streamhost{}.
-record(x509_challenge_failed, {}).
-type x509_challenge_failed() :: #x509_challenge_failed{}.
-record(mark_displayed, {id = <<>> :: binary()}).
-type mark_displayed() :: #mark_displayed{}.
-record(mark_acknowledged, {id = <<>> :: binary()}).
-type mark_acknowledged() :: #mark_acknowledged{}.
-record(carbons_enable, {}).
-type carbons_enable() :: #carbons_enable{}.
-record(mix_create, {channel = <<>> :: binary()}).
-type mix_create() :: #mix_create{}.
-record(carbons_private, {}).
-type carbons_private() :: #carbons_private{}.
-record(receipt_response, {id = <<>> :: binary()}).
-type receipt_response() :: #receipt_response{}.
-record(expire, {seconds :: non_neg_integer(),
stored :: 'undefined' | non_neg_integer()}).
-type expire() :: #expire{}.
-record(mix_leave, {}).
-type mix_leave() :: #mix_leave{}.
-record(muc_unsubscribe, {nick = <<>> :: binary(),
jid :: undefined | jid:jid()}).
-type muc_unsubscribe() :: #muc_unsubscribe{}.
-record(ps_unsubscribe, {node = <<>> :: binary(),
jid :: jid:jid(),
subid = <<>> :: binary()}).
-type ps_unsubscribe() :: #ps_unsubscribe{}.
-record(sm_resume, {h :: non_neg_integer(),
previd = <<>> :: binary(),
xmlns = <<>> :: binary()}).
-type sm_resume() :: #sm_resume{}.
-record(ping, {}).
-type ping() :: #ping{}.
-record(delay, {stamp :: erlang:timestamp(),
from :: undefined | jid:jid(),
desc = <<>> :: binary()}).
-type delay() :: #delay{}.
-record(muc_history, {maxchars :: 'undefined' | non_neg_integer(),
maxstanzas :: 'undefined' | non_neg_integer(),
seconds :: 'undefined' | non_neg_integer(),
since :: undefined | erlang:timestamp()}).
-type muc_history() :: #muc_history{}.
-record(thumbnail, {uri = <<>> :: binary(),
'media-type' = <<>> :: binary(),
width :: 'undefined' | non_neg_integer(),
height :: 'undefined' | non_neg_integer()}).
-type thumbnail() :: #thumbnail{}.
-record(privilege_perm, {access :: 'message' | 'presence' | 'roster',
type :: 'both' | 'get' | 'managed_entity' | 'none' | 'outgoing' | 'roster' | 'set'}).
-type privilege_perm() :: #privilege_perm{}.
-record(ibb_open, {sid = <<>> :: binary(),
'block-size' :: non_neg_integer(),
stanza = iq :: 'iq' | 'message'}).
-type ibb_open() :: #ibb_open{}.
-record(muc_decline, {reason = <<>> :: binary(),
from :: undefined | jid:jid(),
to :: undefined | jid:jid()}).
-type muc_decline() :: #muc_decline{}.
-record(upload_slot_0, {get :: binary(),
put :: binary(),
xmlns = <<>> :: binary()}).
-type upload_slot_0() :: #upload_slot_0{}.
-record(upload_request_0, {filename = <<>> :: binary(),
size :: pos_integer(),
'content-type' = <<>> :: binary(),
xmlns = <<>> :: binary()}).
-type upload_request_0() :: #upload_request_0{}.
-record(ibb_data, {sid = <<>> :: binary(),
seq :: non_neg_integer(),
data = <<>> :: binary()}).
-type ibb_data() :: #ibb_data{}.
-record(sm_a, {h :: non_neg_integer(),
xmlns = <<>> :: binary()}).
-type sm_a() :: #sm_a{}.
-record(x509_csr, {name = <<>> :: binary(),
der = <<>> :: binary()}).
-type x509_csr() :: #x509_csr{}.
-record(jingle_ft_received, {creator :: 'initiator' | 'responder' | 'undefined',
name = <<>> :: binary()}).
-type jingle_ft_received() :: #jingle_ft_received{}.
-record(starttls_proceed, {}).
-type starttls_proceed() :: #starttls_proceed{}.
-record(sm_resumed, {h :: non_neg_integer(),
previd = <<>> :: binary(),
xmlns = <<>> :: binary()}).
-type sm_resumed() :: #sm_resumed{}.
-record(x509_request, {transaction = <<>> :: binary(),
csr :: #x509_csr{},
cert :: 'undefined' | binary(),
signature :: 'undefined' | binary()}).
-type x509_request() :: #x509_request{}.
-record(stream_start, {from :: undefined | jid:jid(),
to :: undefined | jid:jid(),
id = <<>> :: binary(),
version :: 'undefined' | {non_neg_integer(),non_neg_integer()},
xmlns = <<>> :: binary(),
stream_xmlns = <<>> :: binary(),
db_xmlns = <<>> :: binary(),
lang = <<>> :: binary()}).
-type stream_start() :: #stream_start{}.
-record(muc_subscribe, {nick = <<>> :: binary(),
password = <<>> :: binary(),
jid :: undefined | jid:jid(),
events = [] :: [binary()]}).
-type muc_subscribe() :: #muc_subscribe{}.
-record(jingle_ibb_transport, {sid = <<>> :: binary(),
'block-size' :: non_neg_integer(),
stanza = iq :: 'iq' | 'message'}).
-type jingle_ibb_transport() :: #jingle_ibb_transport{}.
-record(stanza_id, {by :: jid:jid(),
id = <<>> :: binary()}).
-type stanza_id() :: #stanza_id{}.
-record(forwarded, {delay :: 'undefined' | #delay{},
sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type forwarded() :: #forwarded{}.
-record(privilege, {perms = [] :: [#privilege_perm{}],
forwarded :: 'undefined' | #forwarded{}}).
-type privilege() :: #privilege{}.
-record(message_thread, {parent = <<>> :: binary(),
data = <<>> :: binary()}).
-type message_thread() :: #message_thread{}.
-record(jingle_content, {creator :: 'initiator' | 'responder',
disposition = <<>> :: binary(),
name = <<>> :: binary(),
senders = both :: 'both' | 'initiator' | 'none' | 'responder',
sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type jingle_content() :: #jingle_content{}.
-record(sasl_challenge, {text = <<>> :: binary()}).
-type sasl_challenge() :: #sasl_challenge{}.
-record(handshake, {data = <<>> :: binary()}).
-type handshake() :: #handshake{}.
-record(db_feature, {errors = false :: boolean()}).
-type db_feature() :: #db_feature{}.
-record(x_conference, {jid :: jid:jid(),
password = <<>> :: binary(),
reason = <<>> :: binary(),
continue :: 'false' | 'true' | 'undefined',
thread = <<>> :: binary()}).
-type x_conference() :: #x_conference{}.
-record(private, {sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type private() :: #private{}.
-record(ibb_close, {sid = <<>> :: binary()}).
-type ibb_close() :: #ibb_close{}.
-record(sm_enable, {max :: 'undefined' | non_neg_integer(),
resume = false :: boolean(),
xmlns = <<>> :: binary()}).
-type sm_enable() :: #sm_enable{}.
-record(starttls_failure, {}).
-type starttls_failure() :: #starttls_failure{}.
-record(gone, {uri = <<>> :: binary()}).
-type gone() :: #gone{}.
-record(hash, {algo = <<>> :: binary(),
data = <<>> :: binary()}).
-type hash() :: #hash{}.
-record(jingle_ft_range, {offset = 0 :: non_neg_integer(),
length :: 'undefined' | non_neg_integer(),
hash = [] :: [#hash{}]}).
-type jingle_ft_range() :: #jingle_ft_range{}.
-record(delegation_query, {to :: jid:jid(),
delegate = [] :: [binary()]}).
-type delegation_query() :: #delegation_query{}.
-record(db_verify, {from = <<>> :: binary(),
to = <<>> :: binary(),
id = <<>> :: binary(),
type :: 'error' | 'invalid' | 'undefined' | 'valid',
key = <<>> :: binary(),
sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type db_verify() :: #db_verify{}.
-record(nick, {name = <<>> :: binary()}).
-type nick() :: #nick{}.
-record(roster_item, {jid :: jid:jid(),
name = <<>> :: binary(),
groups = [] :: [binary()],
subscription = none :: 'both' | 'from' | 'none' | 'remove' | 'to',
ask :: 'subscribe' | 'undefined'}).
-type roster_item() :: #roster_item{}.
-record(roster_query, {items = [] :: [#roster_item{}],
ver :: 'undefined' | binary()}).
-type roster_query() :: #roster_query{}.
-record(feature_sm, {xmlns = <<>> :: binary()}).
-type feature_sm() :: #feature_sm{}.
-record(ps_item, {xmlns = <<>> :: binary(),
id = <<>> :: binary(),
sub_els = [] :: [xmpp_element() | fxml:xmlel()],
node = <<>> :: binary(),
publisher = <<>> :: binary()}).
-type ps_item() :: #ps_item{}.
-record(ps_publish, {node = <<>> :: binary(),
items = [] :: [#ps_item{}]}).
-type ps_publish() :: #ps_publish{}.
-record(avatar_pointer, {bytes :: 'undefined' | non_neg_integer(),
id = <<>> :: binary(),
type = <<>> :: binary(),
height :: 'undefined' | non_neg_integer(),
width :: 'undefined' | non_neg_integer(),
sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type avatar_pointer() :: #avatar_pointer{}.
-record(sm_r, {xmlns = <<>> :: binary()}).
-type sm_r() :: #sm_r{}.
-record(muc_actor, {jid :: undefined | jid:jid(),
nick = <<>> :: binary()}).
-type muc_actor() :: #muc_actor{}.
-record(stat_error, {code :: integer(),
reason = <<>> :: binary()}).
-type stat_error() :: #stat_error{}.
-record(stat, {name = <<>> :: binary(),
units = <<>> :: binary(),
value = <<>> :: binary(),
error :: 'undefined' | #stat_error{}}).
-type stat() :: #stat{}.
-record(addresses, {list = [] :: [#address{}]}).
-type addresses() :: #addresses{}.
-record(starttls, {required = false :: boolean()}).
-type starttls() :: #starttls{}.
-record(last, {seconds :: 'undefined' | non_neg_integer(),
status = <<>> :: binary()}).
-type last() :: #last{}.
-record('see-other-host', {host :: binary() | inet:ip_address() | {binary() | inet:ip_address(),inet:port_number()}}).
-type 'see-other-host'() :: #'see-other-host'{}.
-record(compress, {methods = [] :: [binary()]}).
-type compress() :: #compress{}.
-record(redirect, {uri = <<>> :: binary()}).
-type redirect() :: #redirect{}.
-record(sm_enabled, {id = <<>> :: binary(),
location = <<>> :: binary(),
max :: 'undefined' | non_neg_integer(),
resume = false :: boolean(),
xmlns = <<>> :: binary()}).
-type sm_enabled() :: #sm_enabled{}.
-record(upload_file_too_large, {'max-file-size' :: 'undefined' | integer(),
xmlns = <<>> :: binary()}).
-type upload_file_too_large() :: #upload_file_too_large{}.
-record(legacy_auth, {username :: 'undefined' | binary(),
password :: 'undefined' | binary(),
digest :: 'undefined' | binary(),
resource :: 'undefined' | binary()}).
-type legacy_auth() :: #legacy_auth{}.
-record(ps_subscribe, {node = <<>> :: binary(),
jid :: jid:jid()}).
-type ps_subscribe() :: #ps_subscribe{}.
-record(idle, {since :: erlang:timestamp()}).
-type idle() :: #idle{}.
-record(muc_unique, {name = <<>> :: binary()}).
-type muc_unique() :: #muc_unique{}.
-record(sasl_response, {text = <<>> :: binary()}).
-type sasl_response() :: #sasl_response{}.
-record(x509_revoke, {cert :: binary(),
signature :: binary()}).
-type x509_revoke() :: #x509_revoke{}.
-record(sasl_auth, {mechanism = <<>> :: binary(),
text = <<>> :: binary()}).
-type sasl_auth() :: #sasl_auth{}.
-record(upload_retry, {stamp :: undefined | erlang:timestamp()}).
-type upload_retry() :: #upload_retry{}.
-record(feature_csi, {}).
-type feature_csi() :: #feature_csi{}.
-record(disco_item, {jid :: jid:jid(),
name = <<>> :: binary(),
node = <<>> :: binary()}).
-type disco_item() :: #disco_item{}.
-record(report, {reason :: 'abuse' | 'spam' | 'undefined',
text = [] :: [#text{}]}).
-type report() :: #report{}.
-record(block_item, {jid :: jid:jid(),
spam_report :: 'undefined' | #report{}}).
-type block_item() :: #block_item{}.
-record(unblock, {items = [] :: [#block_item{}]}).
-type unblock() :: #unblock{}.
-record(block, {items = [] :: [#block_item{}]}).
-type block() :: #block{}.
-record(compression, {methods = [] :: [binary()]}).
-type compression() :: #compression{}.
-record(muc_subscription, {jid :: undefined | jid:jid(),
nick = <<>> :: binary(),
events = [] :: [binary()]}).
-type muc_subscription() :: #muc_subscription{}.
-record(muc_subscriptions, {list = [] :: [#muc_subscription{}]}).
-type muc_subscriptions() :: #muc_subscriptions{}.
-record(x509_cert_chain, {name = <<>> :: binary(),
certs = [] :: [binary()]}).
-type x509_cert_chain() :: #x509_cert_chain{}.
-record(ps_subscription, {xmlns = <<>> :: binary(),
jid :: jid:jid(),
type :: 'none' | 'pending' | 'subscribed' | 'unconfigured' | 'undefined',
node = <<>> :: binary(),
subid = <<>> :: binary(),
expiry :: undefined | erlang:timestamp()}).
-type ps_subscription() :: #ps_subscription{}.
-record(avatar_info, {bytes :: non_neg_integer(),
id = <<>> :: binary(),
type = <<>> :: binary(),
height :: 'undefined' | non_neg_integer(),
width :: 'undefined' | non_neg_integer(),
url = <<>> :: binary()}).
-type avatar_info() :: #avatar_info{}.
-record(avatar_meta, {info = [] :: [#avatar_info{}],
pointer :: 'undefined' | #avatar_pointer{}}).
-type avatar_meta() :: #avatar_meta{}.
-record(jidprep, {jid :: jid:jid()}).
-type jidprep() :: #jidprep{}.
-record(bob_data, {cid = <<>> :: binary(),
'max-age' :: 'undefined' | non_neg_integer(),
type = <<>> :: binary(),
data = <<>> :: binary()}).
-type bob_data() :: #bob_data{}.
-record(x509_register, {}).
-type x509_register() :: #x509_register{}.
-record(muc_item, {actor :: 'undefined' | #muc_actor{},
continue :: 'undefined' | binary(),
reason = <<>> :: binary(),
affiliation :: 'admin' | 'member' | 'none' | 'outcast' | 'owner' | 'undefined',
role :: 'moderator' | 'none' | 'participant' | 'undefined' | 'visitor',
jid :: undefined | jid:jid(),
nick = <<>> :: binary()}).
-type muc_item() :: #muc_item{}.
-record(muc_admin, {items = [] :: [#muc_item{}]}).
-type muc_admin() :: #muc_admin{}.
-record(shim, {headers = [] :: [{binary(),binary()}]}).
-type shim() :: #shim{}.
-record(caps, {node = <<>> :: binary(),
version = <<>> :: binary(),
hash = <<>> :: binary(),
exts = [] :: [binary()]}).
-type caps() :: #caps{}.
-record(muc, {history :: 'undefined' | #muc_history{},
password :: 'undefined' | binary()}).
-type muc() :: #muc{}.
-record(stats, {list = [] :: [#stat{}],
node = <<>> :: binary()}).
-type stats() :: #stats{}.
-record(ps_items, {xmlns = <<>> :: binary(),
node = <<>> :: binary(),
items = [] :: [#ps_item{}],
max_items :: 'undefined' | non_neg_integer(),
subid = <<>> :: binary(),
retract :: 'undefined' | binary()}).
-type ps_items() :: #ps_items{}.
-record(mam_prefs, {xmlns = <<>> :: binary(),
default :: 'always' | 'never' | 'roster' | 'undefined',
always :: undefined | [jid:jid()],
never :: undefined | [jid:jid()]}).
-type mam_prefs() :: #mam_prefs{}.
-record(stream_features, {sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type stream_features() :: #stream_features{}.
-record(sic, {ip :: undefined | inet:ip_address(),
port :: 'undefined' | non_neg_integer(),
xmlns = <<>> :: binary()}).
-type sic() :: #sic{}.
-record(sasl_abort, {}).
-type sasl_abort() :: #sasl_abort{}.
-record(receipt_request, {}).
-type receipt_request() :: #receipt_request{}.
-record(vcard_email, {home = false :: boolean(),
work = false :: boolean(),
internet = false :: boolean(),
pref = false :: boolean(),
x400 = false :: boolean(),
userid :: 'undefined' | binary()}).
-type vcard_email() :: #vcard_email{}.
-record(db_result, {from = <<>> :: binary(),
to = <<>> :: binary(),
type :: 'error' | 'invalid' | 'undefined' | 'valid',
key = <<>> :: binary(),
sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type db_result() :: #db_result{}.
-record(carbons_received, {forwarded :: #forwarded{}}).
-type carbons_received() :: #carbons_received{}.
-record(ps_retract, {node = <<>> :: binary(),
notify = false :: boolean(),
items = [] :: [#ps_item{}]}).
-type ps_retract() :: #ps_retract{}.
-record(upload_slot, {get :: 'undefined' | binary(),
put :: 'undefined' | binary(),
xmlns = <<>> :: binary()}).
-type upload_slot() :: #upload_slot{}.
-record(vcard_geo, {lat :: 'undefined' | binary(),
lon :: 'undefined' | binary()}).
-type vcard_geo() :: #vcard_geo{}.
-record(sasl_failure, {reason :: 'aborted' | 'account-disabled' | 'bad-protocol' | 'credentials-expired' | 'encryption-required' | 'incorrect-encoding' | 'invalid-authzid' | 'invalid-mechanism' | 'malformed-request' | 'mechanism-too-weak' | 'not-authorized' | 'temporary-auth-failure' | 'undefined',
text = [] :: [#text{}]}).
-type sasl_failure() :: #sasl_failure{}.
-record(hash_used, {algo = <<>> :: binary()}).
-type hash_used() :: #hash_used{}.
-record(xevent, {offline = false :: boolean(),
delivered = false :: boolean(),
displayed = false :: boolean(),
composing = false :: boolean(),
id :: 'undefined' | binary()}).
-type xevent() :: #xevent{}.
-record(mix, {submission_id = <<>> :: binary(),
jid :: undefined | jid:jid(),
nick = <<>> :: binary()}).
-type mix() :: #mix{}.
-record(carbons_sent, {forwarded :: #forwarded{}}).
-type carbons_sent() :: #carbons_sent{}.
-record(mam_archived, {by :: jid:jid(),
id = <<>> :: binary()}).
-type mam_archived() :: #mam_archived{}.
-record(compress_failure, {reason :: 'processing-failed' | 'setup-failed' | 'undefined' | 'unsupported-method'}).
-type compress_failure() :: #compress_failure{}.
-record(origin_id, {id = <<>> :: binary()}).
-type origin_id() :: #origin_id{}.
-record(x509_ca_list, {certs = [] :: [binary()]}).
-type x509_ca_list() :: #x509_ca_list{}.
-record(mix_participant, {jid :: jid:jid(),
nick = <<>> :: binary()}).
-type mix_participant() :: #mix_participant{}.
-record(compressed, {}).
-type compressed() :: #compressed{}.
-record(block_list, {items = [] :: [#block_item{}]}).
-type block_list() :: #block_list{}.
-record(version, {name :: 'undefined' | binary(),
ver :: 'undefined' | binary(),
os :: 'undefined' | binary()}).
-type version() :: #version{}.
-record(jingle_ft_file, {date :: undefined | erlang:timestamp(),
desc = [] :: [#text{}],
hash = [] :: [#hash{}],
'hash-used' :: 'undefined' | #hash_used{},
'media-type' :: 'undefined' | binary(),
name :: 'undefined' | binary(),
size :: 'undefined' | non_neg_integer(),
range :: 'undefined' | #jingle_ft_range{}}).
-type jingle_ft_file() :: #jingle_ft_file{}.
-record(jingle_ft_checksum, {creator :: 'initiator' | 'responder' | 'undefined',
name = <<>> :: binary(),
file :: #jingle_ft_file{}}).
-type jingle_ft_checksum() :: #jingle_ft_checksum{}.
-record(jingle_ft_description, {file :: 'undefined' | #jingle_ft_file{}}).
-type jingle_ft_description() :: #jingle_ft_description{}.
-record(mix_client_leave, {channel :: undefined | jid:jid(),
leave :: #mix_leave{}}).
-type mix_client_leave() :: #mix_client_leave{}.
-record(legacy_auth_feature, {}).
-type legacy_auth_feature() :: #legacy_auth_feature{}.
-record(bind, {jid :: undefined | jid:jid(),
resource = <<>> :: binary()}).
-type bind() :: #bind{}.
-record(rosterver_feature, {}).
-type rosterver_feature() :: #rosterver_feature{}.
-record(x509_challenge, {transaction = <<>> :: binary(),
uri = <<>> :: binary(),
signature :: binary()}).
-type x509_challenge() :: #x509_challenge{}.
-record(muc_invite, {reason = <<>> :: binary(),
from :: undefined | jid:jid(),
to :: undefined | jid:jid(),
continue :: 'undefined' | binary()}).
-type muc_invite() :: #muc_invite{}.
-record(vcard_xupdate, {hash :: 'undefined' | binary()}).
-type vcard_xupdate() :: #vcard_xupdate{}.
-record(bytestreams, {hosts = [] :: [#streamhost{}],
used :: undefined | jid:jid(),
activate :: undefined | jid:jid(),
dstaddr = <<>> :: binary(),
mode = tcp :: 'tcp' | 'udp',
sid = <<>> :: binary()}).
-type bytestreams() :: #bytestreams{}.
-record(upload_request, {filename :: binary(),
size :: non_neg_integer(),
'content-type' = <<>> :: binary(),
xmlns = <<>> :: binary()}).
-type upload_request() :: #upload_request{}.
-record(xdata_option, {label = <<>> :: binary(),
value :: binary()}).
-type xdata_option() :: #xdata_option{}.
-record(xdata_field, {label = <<>> :: binary(),
type :: 'boolean' | 'fixed' | 'hidden' | 'jid-multi' | 'jid-single' | 'list-multi' | 'list-single' | 'text-multi' | 'text-private' | 'text-single' | 'undefined',
var = <<>> :: binary(),
required = false :: boolean(),
desc = <<>> :: binary(),
values = [] :: [binary()],
options = [] :: [#xdata_option{}],
sub_els = [] :: [xmpp_element() | fxml:xmlel()]}).
-type xdata_field() :: #xdata_field{}.
-record(push_disable, {jid :: jid:jid(),
node = <<>> :: binary()}).
-type push_disable() :: #push_disable{}.
-record(jingle_s5b_candidate, {cid = <<>> :: binary(),
host :: inet:ip_address(),
port :: 'undefined' | non_neg_integer(),
jid :: jid:jid(),
type = direct :: 'assisted' | 'direct' | 'proxy' | 'tunnel',
priority :: non_neg_integer()}).
-type jingle_s5b_candidate() :: #jingle_s5b_candidate{}.
-record(jingle_s5b_transport, {sid = <<>> :: binary(),
dstaddr = <<>> :: binary(),
mode = tcp :: 'tcp' | 'udp',
candidates = [] :: [#jingle_s5b_candidate{}],
'candidate-used' :: 'undefined' | binary(),
activated :: 'undefined' | binary(),
error :: 'candidate-error' | 'proxy-error' | 'undefined'}).
-type jingle_s5b_transport() :: #jingle_s5b_transport{}.
-record(delegated, {ns = <<>> :: binary(),
attrs = [] :: [binary()]}).
-type delegated() :: #delegated{}.
-record(carbons_disable, {}).
-type carbons_disable() :: #carbons_disable{}.
-record(adhoc_actions, {execute :: 'complete' | 'next' | 'prev' | 'undefined',
prev = false :: boolean(),
next = false :: boolean(),
complete = false :: boolean()}).
-type adhoc_actions() :: #adhoc_actions{}.
-record(vcard_org, {name :: 'undefined' | binary(),
units = [] :: [binary()]}).
-type vcard_org() :: #vcard_org{}.
-record(vcard_tel, {home = false :: boolean(),
work = false :: boolean(),
voice = false :: boolean(),
fax = false :: boolean(),
pager = false :: boolean(),
msg = false :: boolean(),
cell = false :: boolean(),
video = false :: boolean(),
bbs = false :: boolean(),
modem = false :: boolean(),
isdn = false :: boolean(),
pcs = false :: boolean(),
pref = false :: boolean(),
number :: 'undefined' | binary()}).
-type vcard_tel() :: #vcard_tel{}.
-record(rsm_set, {'after' :: 'undefined' | binary(),
before :: 'undefined' | binary(),
count :: 'undefined' | non_neg_integer(),
first :: 'undefined' | #rsm_first{},
index :: 'undefined' | non_neg_integer(),
last :: 'undefined' | binary(),
max :: 'undefined' | non_neg_integer()}).
-type rsm_set() :: #rsm_set{}.
-record(mam_fin, {xmlns = <<>> :: binary(),
id = <<>> :: binary(),
rsm :: 'undefined' | #rsm_set{},
stable :: 'false' | 'true' | 'undefined',
complete :: 'false' | 'true' | 'undefined'}).
-type mam_fin() :: #mam_fin{}.
-record(disco_items, {node = <<>> :: binary(),
items = [] :: [#disco_item{}],
rsm :: 'undefined' | #rsm_set{}}).
-type disco_items() :: #disco_items{}.
-record(muc_destroy, {xmlns = <<>> :: binary(),
jid :: undefined | jid:jid(),
reason = <<>> :: binary(),
password :: 'undefined' | binary()}).
-type muc_destroy() :: #muc_destroy{}.
-record(muc_user, {decline :: 'undefined' | #muc_decline{},
destroy :: 'undefined' | #muc_destroy{},
invites = [] :: [#muc_invite{}],
items = [] :: [#muc_item{}],
status_codes = [] :: [pos_integer()],
password :: 'undefined' | binary()}).
-type muc_user() :: #muc_user{}.
-record(vcard_name, {family :: 'undefined' | binary(),
given :: 'undefined' | binary(),
middle :: 'undefined' | binary(),
prefix :: 'undefined' | binary(),
suffix :: 'undefined' | binary()}).
-type vcard_name() :: #vcard_name{}.
-record(inbox_entry, {unread :: 'undefined' | non_neg_integer(),
jid :: undefined | jid:jid(),
id = <<>> :: binary()}).
-type inbox_entry() :: #inbox_entry{}.
-record(media_uri, {type = <<>> :: binary(),
uri = <<>> :: binary()}).
-type media_uri() :: #media_uri{}.
-record(media, {height :: 'undefined' | non_neg_integer(),
width :: 'undefined' | non_neg_integer(),
uri = [] :: [#media_uri{}]}).
-type media() :: #media{}.
-record(mix_destroy, {channel :: any()}).
-type mix_destroy() :: #mix_destroy{}.
-record(vcard_key, {type :: 'undefined' | binary(),
cred :: 'undefined' | binary()}).
-type vcard_key() :: #vcard_key{}.
-record(inbox_query, {rsm :: 'undefined' | #rsm_set{}}).
-type inbox_query() :: #inbox_query{}.
-record(identity, {category = <<>> :: binary(),
type = <<>> :: binary(),
lang = <<>> :: binary(),
name = <<>> :: binary()}).
-type identity() :: #identity{}.
-record(bookmark_conference, {name = <<>> :: binary(),
jid :: jid:jid(),
autojoin = false :: boolean(),
nick :: 'undefined' | binary(),
password :: 'undefined' | binary()}).
-type bookmark_conference() :: #bookmark_conference{}.
-record(mix_setnick, {nick :: binary()}).
-type mix_setnick() :: #mix_setnick{}.
-record(xmpp_session, {optional = false :: boolean()}).
-type xmpp_session() :: #xmpp_session{}.
-record(bookmark_url, {name = <<>> :: binary(),
url = <<>> :: binary()}).
-type bookmark_url() :: #bookmark_url{}.
-record(bookmark_storage, {conference = [] :: [#bookmark_conference{}],
url = [] :: [#bookmark_url{}]}).
-type bookmark_storage() :: #bookmark_storage{}.
-record(oob_x, {url :: binary(),
desc = <<>> :: binary(),
sid = <<>> :: binary()}).
-type oob_x() :: #oob_x{}.
-record(vcard_sound, {phonetic :: 'undefined' | binary(),
binval :: 'undefined' | binary(),
extval :: 'undefined' | binary()}).
-type vcard_sound() :: #vcard_sound{}.
-record(vcard_photo, {type :: 'undefined' | binary(),
binval :: 'undefined' | binary(),
extval :: 'undefined' | binary()}).
-type vcard_photo() :: #vcard_photo{}.
-record(vcard_label, {home = false :: boolean(),
work = false :: boolean(),
postal = false :: boolean(),
parcel = false :: boolean(),
dom = false :: boolean(),
intl = false :: boolean(),
pref = false :: boolean(),
line = [] :: [binary()]}).
-type vcard_label() :: #vcard_label{}.
-record(vcard_adr, {home = false :: boolean(),
work = false :: boolean(),
postal = false :: boolean(),
parcel = false :: boolean(),
dom = false :: boolean(),
intl = false :: boolean(),
pref = false :: boolean(),
pobox :: 'undefined' | binary(),
extadd :: 'undefined' | binary(),
street :: 'undefined' | binary(),
locality :: 'undefined' | binary(),
region :: 'undefined' | binary(),
pcode :: 'undefined' | binary(),
ctry :: 'undefined' | binary()}).
-type vcard_adr() :: #vcard_adr{}.
-record(search_item, {jid :: jid:jid(),
first :: 'undefined' | binary(),
last :: 'undefined' | binary(),
nick :: 'undefined' | binary(),
email :: 'undefined' | binary()}).
-type search_item() :: #search_item{}.
-record(xdata, {type :: 'cancel' | 'form' | 'result' | 'submit',
instructions = [] :: [binary()],
title :: 'undefined' | binary(),
reported :: 'undefined' | [#xdata_field{}],
items = [] :: [[#xdata_field{}]],
fields = [] :: [#xdata_field{}]}).
-type xdata() :: #xdata{}.
-record(service, {action :: 'add' | 'modify' | 'remove' | 'undefined',
expires :: undefined | erlang:timestamp(),
host :: binary() | inet:ip_address(),
name = <<>> :: binary(),
password = <<>> :: binary(),
port :: 'undefined' | non_neg_integer(),
restricted :: 'false' | 'true' | 'undefined',
transport :: 'tcp' | 'udp' | 'undefined',
type :: 'stun' | 'stuns' | 'turn' | 'turns',
username = <<>> :: binary(),
xdata :: 'undefined' | #xdata{}}).
-type service() :: #service{}.
-record(credentials, {services = [] :: [#service{}]}).
-type credentials() :: #credentials{}.
-record(services, {type :: 'stun' | 'stuns' | 'turn' | 'turns' | 'undefined',
list = [] :: [#service{}]}).
-type services() :: #services{}.
-record(push_enable, {jid :: jid:jid(),
node = <<>> :: binary(),
xdata :: 'undefined' | #xdata{}}).
-type push_enable() :: #push_enable{}.
-record(xcaptcha, {xdata :: #xdata{}}).
-type xcaptcha() :: #xcaptcha{}.
-record(adhoc_command, {node = <<>> :: binary(),
action = execute :: 'cancel' | 'complete' | 'execute' | 'next' | 'prev',
sid = <<>> :: binary(),
status :: 'canceled' | 'completed' | 'executing' | 'undefined',
lang = <<>> :: binary(),
actions :: 'undefined' | #adhoc_actions{},
notes = [] :: [#adhoc_note{}],
xdata :: 'undefined' | #xdata{}}).
-type adhoc_command() :: #adhoc_command{}.