From 36df1aac32d6530fdaec7fcaa5f80c8d48599aba Mon Sep 17 00:00:00 2001 From: Waqas Hussain Date: Sun, 12 Oct 2008 17:38:17 +0500 Subject: Documented the roster object's structure --- doc/roster_format.txt | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 doc/roster_format.txt (limited to 'doc/roster_format.txt') 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. -- cgit v1.2.3