doc/roster_format.txt
author Matthew Wild <mwild1@gmail.com>
Tue, 21 May 2013 09:57:36 +0100
changeset 5612 5404832d6f7a
parent 132 9a4aa57af367
permissions -rw-r--r--
mod_muc: Use stanza:maptags() instead of custom filtering functions, 7 insertions, 19 deletions!


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.