doc/roster_format.txt
author Kim Alvefur <zash@zash.se>
Sat, 27 Apr 2013 19:14:22 +0200
changeset 5529 af58eea131b4
parent 132 9a4aa57af367
permissions -rw-r--r--
moduleapi: module:provides called without an item makes a copy of the environment instead. Fixes warnings about non-existent globals


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.