Updated and fixed session documentation

Thu, 23 Oct 2008 02:19:26 +0500

author
Waqas Hussain <waqas20@gmail.com>
date
Thu, 23 Oct 2008 02:19:26 +0500
changeset 116
72e698cdabd7
parent 115
db048883a522
child 117
8e5c5e6a3240

Updated and fixed session documentation

doc/session.txt file | annotate | diff | comparison | revisions
--- a/doc/session.txt	Thu Oct 23 02:11:48 2008 +0500
+++ b/doc/session.txt	Thu Oct 23 02:19:26 2008 +0500
@@ -16,12 +16,13 @@
 	priority -- the resource priority, default: 0 (not defined before initial presence)
 	presence -- the last non-directed presence. initially nil.
 	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
 	disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases
 }
 
-A session is a "connected resource"
+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"
 if session.interested then this is an "interested resource"

mercurial