Mercurial > lxmppd-hg-xmllex / annotate
doc/roster_format.txt@4c0dcd245d34 (annotated)
doc/roster_format.txt
Fri, 24 Oct 2008 07:27:36 +0100
- author
- Matthew Wild <mwild1@gmail.com>
- date
- Fri, 24 Oct 2008 07:27:36 +0100
- branch
- s2s
- changeset 148
- 4c0dcd245d34
- parent 100
- ca7bad346cde
- child 131
- 4bbbc7883ee6
- permissions
- -rw-r--r--
s2s works! \o/ \o/
|
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 |
|
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
12 | } |
|
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 | The roster is available as |
|
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
15 | hosts[host].sessions[username].roster |
|
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
16 | 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
|
17 | |
|
ca7bad346cde
Documented the roster object's structure
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
18 | All modifications to a roster should be done through the rostermanager. |
