doc/roster_format.txt
author Matthew Wild <mwild1@gmail.com>
Mon, 07 Jan 2019 15:34:23 +0000
branch0.11
changeset 9778 4f8b6c09e5f3
parent 132 9a4aa57af367
permissions -rw-r--r--
Merge 0.10->0.11


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.