File

doc/roster_format.txt @ 8376:eb6a9c314c86

util.pubsub: Add method for retreiving the last item (useful for sending on subscribe)
author Kim Alvefur <zash@zash.se>
date Tue, 07 Nov 2017 00:40:52 +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.