File

doc/roster_format.txt @ 11826:e1c4cc5d0ef8

prosodyctl: Use HTTP client in promise mode for connectivity check Feels a bit cleaner to hide away the async.waiter() and return value handling. Also line count reduction!
author Kim Alvefur <zash@zash.se>
date Thu, 30 Sep 2021 17:33:49 +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.