Software /
code /
prosody
Annotate
doc/roster_format.txt @ 13479:d1b7edf4e2de
net.unbound: Show canonical name in textual format (e.g. in shell)
libunbound does not tell us the whole chain of CNAMEs, only the final
canonical name.
This is to aid in debugging since it will only be shown in the shell.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 14 Apr 2024 14:06:57 +0200 |
parent | 132:9a4aa57af367 |
rev | line source |
---|---|
100
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
1 |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
2 This file documents the structure of the roster object. |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
3 |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
4 table roster { |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
5 [string bare_jid] = roster_item |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
6 } |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
7 |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
8 table roster_item { |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
9 string subscription = "none" | "to" | "from" | "both" |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
10 string name = Opaque string set by client. (optional) |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
11 set groups = a set of opaque strings set by the client |
132 | 12 boolean ask = nil | "subscribe" - a value of true indicates subscription is pending |
100
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
13 } |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
14 |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
15 The roster is available as |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
16 hosts[host].sessions[username].roster |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
17 and a copy is made to session.roster for all sessions. |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
18 |
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
19 All modifications to a roster should be done through the rostermanager. |