mirror of
https://github.com/bjc/prosody.git
synced 2025-04-04 21:57:45 +03:00
Documented the roster object's structure
This commit is contained in:
parent
288aaa38ea
commit
36df1aac32
1 changed files with 18 additions and 0 deletions
18
doc/roster_format.txt
Normal file
18
doc/roster_format.txt
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
|
||||||
|
This file documents the structure of the roster object.
|
||||||
|
|
||||||
|
table roster {
|
||||||
|
[string bare_jid] = roster_item
|
||||||
|
}
|
||||||
|
|
||||||
|
table roster_item {
|
||||||
|
string subscription = "none" | "to" | "from" | "both"
|
||||||
|
string name = Opaque string set by client. (optional)
|
||||||
|
set groups = a set of opaque strings set by the client
|
||||||
|
}
|
||||||
|
|
||||||
|
The roster is available as
|
||||||
|
hosts[host].sessions[username].roster
|
||||||
|
and a copy is made to session.roster for all sessions.
|
||||||
|
|
||||||
|
All modifications to a roster should be done through the rostermanager.
|
Loading…
Add table
Add a link
Reference in a new issue