Package xmpp :: Module protocol :: Class Presence

[hide private]
[frames] | no frames]

# Class Presence

source code

    simplexml.Node --+
                     |
              Protocol --+
                         |
                        Presence

XMPP Presence object.

Instance Methods | [hide private]

__init__(self, to=None, typ=None, priority=None, show=None, status=None, attrs=`{``}`, frm=None, timestamp=None, payload=`[``]`, xmlns=`'``jabber:client``'`, node=None) Create presence object. | source code

getPriority(self) Returns the priority of the message. | source code

getShow(self) Returns the show value of the message. | source code

getStatus(self) Returns the status string of the message. | source code

setPriority(self, val) Sets the priority of the message. | source code

setShow(self, val) Sets the show value of the message. | source code

setStatus(self, val) Sets the status string of the message. | source code

_muc_getItemAttr(self, tag, attr) | source code

_muc_getSubTagDataAttr(self, tag, attr) | source code

getRole(self) Returns the presence role (for groupchat) | source code

getAffiliation(self) Returns the presence affiliation (for groupchat) | source code

getNick(self) Returns the nick value (for nick change in groupchat) | source code

getJid(self) Returns the presence jid (for groupchat) | source code

getReason(self) Returns the reason of the presence (for groupchat) | source code

getActor(self) Returns the reason of the presence (for groupchat) | source code

getStatusCode(self) Returns the status code of the presence (for groupchat) | source code

Inherited from `Protocol`: `__setitem__`, `getError`, `getErrorCode`, `getFrom`, `getID`, `getProperties`, `getTimestamp`, `getTo`, `getType`, `setError`, `setFrom`, `setID`, `setTimestamp`, `setTo`, `setType`

Inherited from `simplexml.Node`: `__delitem__`, `__getattr__`, `__getitem__`, `__str__`, `addChild`, `addData`, `clearData`, `delAttr`, `delChild`, `getAttr`, `getAttrs`, `getCDATA`, `getChildren`, `getData`, `getName`, `getNamespace`, `getParent`, `getPayload`, `getTag`, `getTagAttr`, `getTagData`, `getTags`, `has_attr`, `setAttr`, `setData`, `setName`, `setNamespace`, `setParent`, `setPayload`, `setTag`, `setTagAttr`, `setTagData`

Class Variables | [hide private]

Inherited from `simplexml.Node`: `FORCE_NODE_RECREATION`

Method Details | [hide private]

### __init__(self, to=None, typ=None, priority=None, show=None, status=None, attrs=`{``}`, frm=None, timestamp=None, payload=`[``]`, xmlns=`'``jabber:client``'`, node=None)
(Constructor)

source code

Create presence object. You can specify recipient, type of message, priority, show and status values any additional attributes, sender of the presence, timestamp, any additional payload (f.e. jabber:x:delay element) and namespace in one go. Alternatively you can pass in the other XML object as the 'node' parameted to replicate it as presence.

Overrides: Protocol.__init__