mod_storage_sql: Fix commit c806a599224a for compatibility with non-MySQL databases...
[prosody.git] / doc / session.txt
index 389fb87c5d264f183cfb4be0c1ce2a13380f1281..fc6eec17199af7b5b8cd52181d7086b4f0d15612 100644 (file)
@@ -13,15 +13,16 @@ session {
        host -- the host part of the client's jid (not defined before stream initiation)\r
        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
+       priority -- the resource priority, default: 0\r
+       presence -- the last non-directed presence with no type attribute. initially nil. reset to nil on unavailable presence.\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.presence then this is an "available resource"\r
-if session.interested then this is an "interested 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" (all available resources are connected resources)\r
+if session.interested then this is an "interested resource" (all interested resources are connected resources)\r