doc/roster_format.txt
changeset 100 ca7bad346cde
child 131 4bbbc7883ee6
equal deleted inserted replaced
97:c3f12fd0c823 100:ca7bad346cde
       
     1 
       
     2 This file documents the structure of the roster object.
       
     3 
       
     4 table roster {
       
     5   [string bare_jid] = roster_item
       
     6 }
       
     7 
       
     8 table roster_item {
       
     9   string subscription = "none" | "to" | "from" | "both"
       
    10   string name = Opaque string set by client. (optional)
       
    11   set groups = a set of opaque strings set by the client
       
    12 }
       
    13 
       
    14 The roster is available as
       
    15  hosts[host].sessions[username].roster
       
    16 and a copy is made to session.roster for all sessions.
       
    17 
       
    18 All modifications to a roster should be done through the rostermanager.