Package nbxmpp :: Module protocol :: Class DataField

Class DataField

This class is used in the DataForm class to describe the single data item

If you are working with jabber:x:data (XEP-0004, XEP-0068, XEP-0122) then you will need to work with instances of this class.

Instance Methods

[hide private]

__init__(self, name=None, value=None, typ=None, required=0, desc=None, options=[], node=None)
Create new data field of specified name,value and type source code

setRequired(self, req=1)
Change the state of the 'required' flag

source code

isRequired(self)
Return in this field a required one

source code

setDesc(self, desc)
Set the description of this field

source code

getDesc(self)
Return the description of this field

source code

setValue(self, val)
Set the value of this field

source code

getValue(self)

source code

setValues(self, lst)
Set the values of this field as values-list. Replaces all previous filed values! If you need to just add a value - use addValue method

source code

addValue(self, val)
Add one more value to this field. Used in 'get' iq's or such

source code

getValues(self)
Return the list of values associated with this field

source code

getOptions(self)
Return label-option pairs list associated with this field

source code

setOptions(self, lst)
Set label-option pairs list associated with this field

source code

addOption(self, opt)
Add one more label-option pair to this field

source code

getType(self)
Get type of this field

source code

setType(self, val)
Set type of this field

source code

getVar(self)
Get 'var' attribute value of this field

source code

setVar(self, val)
Set 'var' attribute value of this field

source code

Inherited from simplexml.Node: __contains__, __delitem__, __getattr__, __getitem__, __setitem__, __str__, addChild, addData, clearData, delAttr, delChild, getAttr, getAttrs, 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

Class DataField

__init__(self, name=None, value=None, typ=None, required=0, desc=None, options=[], node=None) (Constructor)

setRequired(self, req=1)

isRequired(self)

setDesc(self, desc)

getDesc(self)

setValue(self, val)

getValue(self)

setValues(self, lst)

addValue(self, val)

getValues(self)

getOptions(self)

setOptions(self, lst)

addOption(self, opt)

getType(self)

setType(self, val)

getVar(self)

setVar(self, val)

init(self, name=None, value=None, typ=None, required=0, desc=None, options=`[]`, node=None)
(Constructor)