File

doc/roster_format.txt @ 11885:197642f9972f

mod_admin_shell: New table based implementation of c2s and s2s:show() Nicer and more readable. Thanks jonas’ and prosody@ for JID length stats to inform column widths.
author Kim Alvefur <zash@zash.se>
date Wed, 10 Nov 2021 17:59:35 +0100
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.