Package xmpp :: Module features
[show private | hide private]
[frames | no frames]

Module xmpp.features

This module contains variable stuff that is not worth splitting into separate modules.
Here is:
    DISCO client and agents-to-DISCO and browse-to-DISCO emulators.
    IBR and password manager.
    jabber:iq:privacy methods
All these methods takes 'disp' first argument that should be already connected
(and in most cases already authorised) dispatcher instance.

Function Summary
  changePasswordTo(disp, newpassword, host)
Changes password on specified or current (if not specified) server.
  delPrivacyList(disp, listname)
Deletes privacy list 'listname'.
  discoverInfo(disp, jid, node)
Query remote object about info that it publishes.
  discoverItems(disp, jid, node)
Query remote object about any items that it contains.
  getPrivacyList(disp, listname)
Requests specific privacy list listname.
  getPrivacyLists(disp)
Requests privacy lists from connected server.
  getRegInfo(disp, host, info, sync)
Gets registration form from remote host.
  register(disp, host, info)
Perform registration on remote server with provided info.
  setActivePrivacyList(disp, listname, typ)
Switches privacy list 'listname' to specified type.
  setDefaultPrivacyList(disp, listname)
Sets the default privacy list as 'listname'.
  setPrivacyList(disp, list)
Set the ruleset.
  unregister(disp, host)
Unregisters with host (permanently removes account).

Variable Summary
str REGISTER_DATA_RECEIVED = 'REGISTER DATA RECEIVED'

Function Details

changePasswordTo(disp, newpassword, host=None)

Changes password on specified or current (if not specified) server. disp must be connected and authorized dispatcher instance. Returns true on success.

delPrivacyList(disp, listname)

Deletes privacy list 'listname'. Returns true on success.

discoverInfo(disp, jid, node=None)

Query remote object about info that it publishes. Returns identities and features lists.

discoverItems(disp, jid, node=None)

Query remote object about any items that it contains. Return items list.

getPrivacyList(disp, listname)

Requests specific privacy list listname. Returns list of XML nodes (rules) taken from the server responce.

getPrivacyLists(disp)

Requests privacy lists from connected server. Returns dictionary of existing lists on success.

getRegInfo(disp, host, info={}, sync=True)

Gets registration form from remote host. You can pre-fill the info dictionary. F.e. if you are requesting info on registering user joey than specify info as {'username':'joey'}. See JEP-0077 for details. 'disp' must be connected dispatcher instance.

register(disp, host, info)

Perform registration on remote server with provided info. disp must be connected dispatcher instance. Returns true or false depending on registration result. If registration fails you can get additional info from the dispatcher's owner attributes lastErrNode, lastErr and lastErrCode.

setActivePrivacyList(disp, listname=None, typ='active')

Switches privacy list 'listname' to specified type. By default the type is 'active'. Returns true on success.

setDefaultPrivacyList(disp, listname=None)

Sets the default privacy list as 'listname'. Returns true on success.

setPrivacyList(disp, list)

Set the ruleset. 'list' should be the simpleXML node formatted according to RFC 3921 (XMPP-IM) (I.e. Node('list',{'name':listname},payload=[...]) ) Returns true on success.

unregister(disp, host)

Unregisters with host (permanently removes account). disp must be connected and authorized dispatcher instance. Returns true on success.

Variable Details

REGISTER_DATA_RECEIVED

Type:
str
Value:
'REGISTER DATA RECEIVED'                                               

Generated by Epydoc 2.1 on Thu Oct 5 23:57:43 2006 http://epydoc.sf.net