File

doc/roster_format.txt @ 12313:469e4453ed01

make: Split up install targets to allow different subset The prosody-trunk nightly packages currently use the Debian dh-lua framework to install core/, net/ and util/ into Lua-versioned directory trees, while plugins and executables should still be installed like before.
author Kim Alvefur <zash@zash.se>
date Sun, 13 Feb 2022 16:53:56 +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.