diff options
| author | Waqas Hussain <waqas20@gmail.com> | 2008-10-12 17:38:17 +0500 |
|---|---|---|
| committer | Waqas Hussain <waqas20@gmail.com> | 2008-10-12 17:38:17 +0500 |
| commit | 36df1aac32d6530fdaec7fcaa5f80c8d48599aba (patch) | |
| tree | 9371ba553a526ea632012ddd2b49390cf3d42fb2 /doc | |
| parent | 288aaa38ead4996a7a8a3b0cd64aaf0a1505f18f (diff) | |
| download | prosody-36df1aac32d6530fdaec7fcaa5f80c8d48599aba.tar.gz prosody-36df1aac32d6530fdaec7fcaa5f80c8d48599aba.zip | |
Documented the roster object's structure
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/roster_format.txt | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/roster_format.txt b/doc/roster_format.txt new file mode 100644 index 00000000..9094b5a1 --- /dev/null +++ b/doc/roster_format.txt @@ -0,0 +1,18 @@ +
+This file documents the structure of the roster object.
+
+table roster {
+ [string bare_jid] = roster_item
+}
+
+table roster_item {
+ string subscription = "none" | "to" | "from" | "both"
+ string name = Opaque string set by client. (optional)
+ set groups = a set of opaque strings set by the client
+}
+
+The roster is available as
+ hosts[host].sessions[username].roster
+and a copy is made to session.roster for all sessions.
+
+All modifications to a roster should be done through the rostermanager.
|