doc/roster_format.txt

Sat, 15 Nov 2008 22:36:22 +0100

author
Tobias Markmann <tm@ayena.de>
date
Sat, 15 Nov 2008 22:36:22 +0100
changeset 297
15b375870b40
parent 132
9a4aa57af367
permissions
-rw-r--r--

Providing some human readable error messages and some fixes.


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
  boolean ask = nil | "subscribe" - a value of true indicates subscription is pending
}

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.

mercurial