doc/roster_format.txt

Wed, 25 Nov 2009 23:45:45 +0000

author
Matthew Wild <mwild1@gmail.com>
date
Wed, 25 Nov 2009 23:45:45 +0000
changeset 2222
81b4e738e4d3
parent 132
9a4aa57af367
permissions
-rw-r--r--

util.serialization: Correctly serialize tables with 'false' as a key, fixes an issue with rosters not saving (thanks mathias, Tobias)


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