doc/roster_format.txt

Fri, 04 Dec 2009 12:14:14 +0000

author
Brian Cully <bjc@junctionnetworks.com>
date
Fri, 04 Dec 2009 12:14:14 +0000
changeset 2319
8dca45e17438
parent 132
9a4aa57af367
permissions
-rw-r--r--

util-src/Makefile: Clean up makefile (re-commit because MattJ shouldn't commit anything at 3AM)


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