pyjabber.plugins.xep_0004 package

Submodules

pyjabber.plugins.xep_0004.field module

class pyjabber.plugins.xep_0004.field.FieldRequest(field_type, var, label=None, values=None, options=None, desc=None, required=False)[source]

Bases: object

property desc: str
property label: str
property options: List[str]
property required: bool
property type: FieldTypes
property values: List[str]
property var: str
class pyjabber.plugins.xep_0004.field.FieldResponse(field_type, var, values=None)[source]

Bases: object

property type: FieldTypes
property values: List[str]
property var: str
class pyjabber.plugins.xep_0004.field.FieldTypes(value)[source]

Bases: Enum

An enumeration.

BOOLEAN = 'boolean'
FIXED = 'fixed'
HIDDEN = 'hidden'
JID_MULTI = 'jid-multi'
JID_SINGLE = 'jid-single'
LIST_MULTI = 'list-multi'
LIST_SINGLE = 'list-single'
TEXT_MULTI = 'text-multi'
TEXT_PRIVATE = 'text-private'
TEXT_SINGLE = 'text-single'
classmethod from_value(value)[source]
class pyjabber.plugins.xep_0004.field.Option(label, value)[source]

Bases: object

pyjabber.plugins.xep_0004.xep_0004 module

class pyjabber.plugins.xep_0004.xep_0004.FormType(value)[source]

Bases: Enum

An enumeration.

CANCEL = 'cancel'
FORM = 'form'
RESULT = 'result'
SUBMIT = 'submit'
exception pyjabber.plugins.xep_0004.xep_0004.MissingDataForms[source]

Bases: Exception

No dataforms founded in a stanza, when it was expected

pyjabber.plugins.xep_0004.xep_0004.generate_form(form_type, title=None, instructions=None, fields=None)[source]
Return type:

Element

pyjabber.plugins.xep_0004.xep_0004.generate_form_multi_res()[source]
pyjabber.plugins.xep_0004.xep_0004.parse_form(element)[source]

If a proper dataforms is passes, it returns a list of field submitted by the client @param element: @return: List of dicts in format {type, var, values[]}

Module contents