Package xmpp :: Module protocol :: Class DataItem
[hide private]
[frames] | no frames]

Class DataItem

source code


This class is used in the DataForm class to describe data items which are used in 'multiple item form results' (as described in XEP-0004).

Instance Methods [hide private]
 
__init__(self, node=None)
Create new empty data item.
source code
 
getField(self, name)
Return the datafield object with name 'name' (if exists).
source code
 
setField(self, name)
Create if nessessary or get the existing datafield object with name 'name' and return it.
source code
 
asDict(self)
Represent dataitem as simple dictionary mapping of datafield names to their values.
source code
 
__getitem__(self, name)
Simple dictionary interface for getting datafields values by their names.
source code
 
__setitem__(self, name, val)
Simple dictionary interface for setting datafields values by their names.
source code

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

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]

Inherited from simplexml.Node: FORCE_NODE_RECREATION

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, node=None)
(Constructor)

source code 

Create new empty data item. However, note that, according XEP-0004, DataItem MUST contain ALL DataFields described in DataReported. Alternatively other XML object can be passed in as the 'node' parameted to replicate it as a new dataitem.

Overrides: object.__init__

__getitem__(self, name)
(Indexing operator)

source code 

Simple dictionary interface for getting datafields values by their names.

Overrides: simplexml.Node.__getitem__

__setitem__(self, name, val)
(Index assignment operator)

source code 

Simple dictionary interface for setting datafields values by their names.

Overrides: simplexml.Node.__setitem__