Updated and fixed session documentation
authorWaqas Hussain <waqas20@gmail.com>
Wed, 22 Oct 2008 21:19:26 +0000 (02:19 +0500)
committerWaqas Hussain <waqas20@gmail.com>
Wed, 22 Oct 2008 21:19:26 +0000 (02:19 +0500)
doc/session.txt

index 389fb87c5d264f183cfb4be0c1ce2a13380f1281..e475e45b53f3bb4a129169e0ded1698d206893b1 100644 (file)
@@ -16,12 +16,13 @@ session {
        priority -- the resource priority, default: 0 (not defined before initial presence)\r
        presence -- the last non-directed presence. initially nil.\r
        interested -- true if the resource requested the roster. Interested resources recieve roster updates. Initially nil.\r
+       roster -- the user's roster. Loaded as soon as the resource is bound (session becomes a connected resource).\r
        \r
        -- methods --\r
        send(x) -- converts x to a string, and writes it to the connection\r
        disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases\r
 }\r
 \r
-A session is a "connected resource"\r
+if session.full_jid (also session.roster and session.resource) then this is a "connected resource"\r
 if session.presence then this is an "available resource"\r
 if session.interested then this is an "interested resource"\r