diff options
| author | Waqas Hussain <waqas20@gmail.com> | 2008-10-23 02:19:26 +0500 |
|---|---|---|
| committer | Waqas Hussain <waqas20@gmail.com> | 2008-10-23 02:19:26 +0500 |
| commit | 9bcfe122c05a7082b83e8b0aa002c936e5b0ec8c (patch) | |
| tree | 35cb0aa2d1d1c87e5ed73498067308f6ca693285 /doc/session.txt | |
| parent | aa212bcf2424521485e02110da93fd84bef743f7 (diff) | |
| download | prosody-9bcfe122c05a7082b83e8b0aa002c936e5b0ec8c.tar.gz prosody-9bcfe122c05a7082b83e8b0aa002c936e5b0ec8c.zip | |
Updated and fixed session documentation
Diffstat (limited to 'doc/session.txt')
| -rw-r--r-- | doc/session.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/session.txt b/doc/session.txt index 389fb87c..e475e45b 100644 --- a/doc/session.txt +++ b/doc/session.txt @@ -16,12 +16,13 @@ session { priority -- the resource priority, default: 0 (not defined before initial presence)
presence -- the last non-directed presence. initially nil.
interested -- true if the resource requested the roster. Interested resources recieve roster updates. Initially nil.
+ roster -- the user's roster. Loaded as soon as the resource is bound (session becomes a connected resource).
-- methods --
send(x) -- converts x to a string, and writes it to the connection
disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases
}
-A session is a "connected resource"
+if session.full_jid (also session.roster and session.resource) then this is a "connected resource"
if session.presence then this is an "available resource"
if session.interested then this is an "interested resource"
|