File

doc/roster_format.txt @ 1027:fe2e3d3dba6a

util.array: Add array.collect() to collect results from iterators into an array, and use module() to correctly set the module name
author Matthew Wild <mwild1@gmail.com>
date Wed, 22 Apr 2009 17:46:17 +0100
parent 132:9a4aa57af367
line wrap: on
line source


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.