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

index 82fe5ce420cb20623c2c10b842a3447f2c71d8f4..389fb87c5d264f183cfb4be0c1ce2a13380f1281 100644 (file)
@@ -14,8 +14,14 @@ session {
        resource -- the resource part of the client's full jid (not defined before resource binding)\r
        full_jid -- convenience for the above 3 as string in username@host/resource form (not defined before resource binding)\r
        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
        \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.presence then this is an "available resource"\r
+if session.interested then this is an "interested resource"\r