doc/roster_format.txt
author Waqas Hussain <waqas20@gmail.com>
Thu, 23 Oct 2008 19:53:02 +0500
changeset 131 4bbbc7883ee6
parent 100 ca7bad346cde
child 132 9a4aa57af367
permissions -rw-r--r--
Docs update - 'ask' property available on roster items


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 | true - 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.