Mercurial Mercurial > prosody > prosody / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/roster_format.txt
author Matthew Wild <mwild1@gmail.com>
Wed, 27 Mar 2024 15:35:15 +0000
branch0.12
changeset 13469 54a936345aaa
parent 132 9a4aa57af367
permissions -rw-r--r--
prosodyctl check: Warn about invalid domain names in the config file This ensures that domain names of virtual hosts and components are valid in XMPP, and that they are encoded correctly.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
100
ca7bad346cde Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset 
     1
 












ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




     2


This file documents the structure of the roster object.













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




     3














ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




     4


table roster {













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




     5


  [string bare_jid] = roster_item













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




     6


}













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




     7














ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




     8


table roster_item {













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




     9


  string subscription = "none" | "to" | "from" | "both"













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    10


  string name = Opaque string set by client. (optional)













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    11


  set groups = a set of opaque strings set by the client








132






9a4aa57af367
Roster updates



Waqas Hussain <waqas20@gmail.com>


parents: 
131

diff
changeset




    12


  boolean ask = nil | "subscribe" - a value of true indicates subscription is pending








100






ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    13


}













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    14














ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    15


The roster is available as













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    16


 hosts[host].sessions[username].roster













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    17


and a copy is made to session.roster for all sessions.













ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    18














ca7bad346cde
Documented the roster object's structure



Waqas Hussain <waqas20@gmail.com>


parents: 

diff
changeset




    19


All modifications to a roster should be done through the rostermanager.















prosody