Software / code / prosody
Changeset
100:ca7bad346cde
Documented the roster object's structure
| author | Waqas Hussain <waqas20@gmail.com> |
|---|---|
| date | Sun, 12 Oct 2008 17:38:17 +0500 |
| parents | 97:c3f12fd0c823 |
| children | 101:c690fa382743 |
| files | doc/roster_format.txt |
| diffstat | 1 files changed, 18 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/roster_format.txt Sun Oct 12 17:38:17 2008 +0500 @@ -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.
