• file
• latest
• revisions
• annotate
• diff
• comparison
• raw

doc/roster_format.txt@13a5a8df7c34 (annotated)

doc/roster_format.txt

Wed, 05 Jan 2011 03:05:13 +0000

author

daurnimator <quae@daurnimator.com>

date

Wed, 05 Jan 2011 03:05:13 +0000

changeset 3998

13a5a8df7c34

parent 132

9a4aa57af367

permissions

-rw-r--r--

stanza_router: Replace xmlns == nil checks with 'not xmlns'

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.