File

doc/roster_format.txt @ 9090:56c52cb4d44e

util.dataforms: Exclude descriptive text fields from forms of type 'submit' The receiving end presumably already have the original form, so these potentially long text fields are of little value.
author Kim Alvefur <zash@zash.se>
date Fri, 03 Aug 2018 21:45:55 +0200
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.