diff options
author | Waqas Hussain <waqas20@gmail.com> | 2008-10-23 02:11:48 +0500 |
---|---|---|
committer | Waqas Hussain <waqas20@gmail.com> | 2008-10-23 02:11:48 +0500 |
commit | aa212bcf2424521485e02110da93fd84bef743f7 (patch) | |
tree | de27440a194862cc6454d9f28402897ceb489e82 | |
parent | 6701f399ad2e7aa07683d5612dd7e32635fdcee3 (diff) | |
download | prosody-aa212bcf2424521485e02110da93fd84bef743f7.tar.gz prosody-aa212bcf2424521485e02110da93fd84bef743f7.zip |
Updated session documentation
-rw-r--r-- | doc/session.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/session.txt b/doc/session.txt index 82fe5ce4..389fb87c 100644 --- a/doc/session.txt +++ b/doc/session.txt @@ -14,8 +14,14 @@ session { 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"
|