doc/roster_format.txt

   1 \r
   2 This file documents the structure of the roster object.\r
   3 \r
   4 table roster {\r
   5   [string bare_jid] = roster_item\r
   6 }\r
   7 \r
   8 table roster_item {\r
   9   string subscription = "none" | "to" | "from" | "both"\r
  10   string name = Opaque string set by client. (optional)\r
  11   set groups = a set of opaque strings set by the client\r
  12   boolean ask = nil | "subscribe" - a value of true indicates subscription is pending\r
  13 }\r
  14 \r
  15 The roster is available as\r
  16  hosts[host].sessions[username].roster\r
  17 and a copy is made to session.roster for all sessions.\r
  18 \r
  19 All modifications to a roster should be done through the rostermanager.\r