prosody
5c475f6e89a4
doc/roster_format.txt

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

File

doc/roster_format.txt @ 9571:5c475f6e89a4

mod_adhoc: Add compat marker for older handling of adhoc items Most modules use the module:provides() API which add the '-provides' suffix. Previously module:add_item() was used. See 58714123f600
author Kim Alvefur <zash@zash.se>
date Sat, 27 Oct 2018 17:25:50 +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.