File

doc/roster_format.txt @ 11733:27699cc148df

mod_bosh: Add todo to use util.session to create session object So that we get single point where shared session properties can be added. But not now. One day. Maybe. Patches welcome.
author Kim Alvefur <zash@zash.se>
date Thu, 29 Jul 2021 20:04:57 +0200
parent 132:9a4aa57af367
line wrap: on
line source


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.