doc/roster_format.txt
author Kim Alvefur <zash@zash.se>
Sun, 25 Nov 2018 13:16:17 +0100
changeset 9647 bb8486491b48
parent 132 9a4aa57af367
permissions -rw-r--r--
mod_proxy65: Check what port is used at the time of the query Could have changed between startup and time of request


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.