X-Git-Url: https://git.enpas.org/?a=blobdiff_plain;f=doc%2Fsession.txt;h=fc6eec17199af7b5b8cd52181d7086b4f0d15612;hb=4be16eb74842d95b0de34c989c7653278c224e28;hp=3b4a4958fb521903ebe9b5e4ff72c228dd0a7136;hpb=da938e46986d93a2f08aea7bf621099ddf827084;p=prosody.git

diff --git a/doc/session.txt b/doc/session.txt
index 3b4a4958..fc6eec17 100644
--- a/doc/session.txt
+++ b/doc/session.txt
@@ -6,14 +6,23 @@ session {
 	-- properties --
 	conn -- the tcp connection
 	notopen -- true if stream has not been initiated, removed after receiving <stream:steam>
-	priority -- the resource priority, default: 0
 	type -- the connection type. Valid values include:
 			-- "c2s_unauthed" - connection has not been authenticated yet
 			-- "c2s" - from a local client to the server
 	username -- the node part of the client's jid (not defined before auth)
 	host -- the host part of the client's jid (not defined before stream initiation)
 	resource -- the resource part of the client's full jid (not defined before resource binding)
+	full_jid -- convenience for the above 3 as string in username@host/resource form (not defined before resource binding)
+	priority -- the resource priority, default: 0
+	presence -- the last non-directed presence with no type attribute. initially nil. reset to nil on unavailable presence.
+	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
-}
\ 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
+}
+
+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" (all available resources are connected resources)
+if session.interested then this is an "interested resource" (all interested resources are connected resources)