moduleapi: in module:provides(), add the name of the module in item._provided_by

[prosody.git] / doc / session.txt

diff --git a/doc/session.txt b/doc/session.txt
index 3b4a4958fb521903ebe9b5e4ff72c228dd0a7136..fc6eec17199af7b5b8cd52181d7086b4f0d15612 100644 (file)
--- a/doc/session.txt
+++ b/doc/session.txt
@@ -6,14 +6,23 @@ session {
        -- properties --\r
        conn -- the tcp connection\r
        notopen -- true if stream has not been initiated, removed after receiving <stream:steam>\r
-       priority -- the resource priority, default: 0\r
        type -- the connection type. Valid values include:\r
                        -- "c2s_unauthed" - connection has not been authenticated yet\r
                        -- "c2s" - from a local client to the server\r
        username -- the node part of the client's jid (not defined before auth)\r
        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\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
-}
\ No newline at end of file
+       disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases\r
+}\r
+\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