File

doc/roster_format.txt @ 4268:c249f10eb9bb

Advertise in-band registration support. Implement optional registration support advertisement according to XEP-0077 sec8: <features> <register xmlns='http://jabber.org/features/iq-register'/> </features> --- plugins/mod_register.lua | 12 ++++++++++++ 1 files changed, 12 insertions(+), 0 deletions(-)
author Glenn Maynard <glenn@zewt.org>
date Fri, 27 May 2011 17:04:43 +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.