Software /
code /
prosody
File
doc/roster_format.txt @ 11365:5eb817cdd5cd
mod_admin_shell: Add help section with (top level) MUC commands
These were previously only documented on the site.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 05 Feb 2021 15:52:46 +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.