File

doc/roster_format.txt @ 8211:5cbbe825d9d1

util.pubsub: Add a node parameter to itemstore(). This allows the backend to know the node name, when it needs to differentiate it at storage for example.
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Sun, 02 Apr 2017 19:08:54 +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.