doc/roster_format.txt
author Kim Alvefur <zash@zash.se>
Thu, 04 Apr 2024 19:39:33 +0200
branch0.12
changeset 13474 19a9ec94f575
parent 132 9a4aa57af367
permissions -rw-r--r--
mod_invites_adhoc: Fix result form type (thanks betarays)


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.