Updated session documentation

Thu, 23 Oct 2008 02:11:48 +0500

author
Waqas Hussain <waqas20@gmail.com>
date
Thu, 23 Oct 2008 02:11:48 +0500
changeset 115
db048883a522
parent 114
bed2a8508cf5
child 116
72e698cdabd7

Updated session documentation

doc/session.txt file | annotate | diff | comparison | revisions
--- a/doc/session.txt	Thu Oct 23 02:11:27 2008 +0500
+++ b/doc/session.txt	Thu Oct 23 02:11:48 2008 +0500
@@ -14,8 +14,14 @@
 	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 (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.
 	
 	-- 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.presence then this is an "available resource"
+if session.interested then this is an "interested resource"

mercurial