doc/roster_format.txt
author Kim Alvefur <zash@zash.se>
Wed, 28 Feb 2024 22:31:06 +0100
changeset 13452 93b4ce0115f0
parent 132 9a4aa57af367
permissions -rw-r--r--
util.signal: Fail signalfd() if unable to change signal mask By aborting early, the failure should be brought to the attention somehow.


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.