doc/roster_format.txt

Mon, 23 Nov 2009 16:07:33 +0000

author
Matthew Wild <mwild1@gmail.com>
date
Mon, 23 Nov 2009 16:07:33 +0000
changeset 2147
3bb7c1daa93f
parent 132
9a4aa57af367
permissions
-rw-r--r--

modulemanager: New module API methods for getting config options with type conversion, get_option_string, get_option_number, get_option_boolean, get_option_array, get_option_set


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