Package pyxmpp :: Package jabber :: Module vcard :: Class VCardAdr
[show private | hide private]
[frames | no frames]

Class VCardAdr

VCardField --+
             |
            VCardAdr


Address vCard field.

:Ivariables:
    - `type`: type of the address.
    - `pobox`: the post office box.
    - `extadr`: the extended address.
    - `street`: the street address.
    - `locality`: the locality (e.g. city).
    - `region`: the region.
    - `pcode`: the postal code.
    - `ctry`: the country.
:Types:
    - `type`: `list` of "home","work","postal","parcel","dom","intl" or "pref"
    - `pobox`: `unicode`
    - `extadr`: `unicode`
    - `street`: `unicode`
    - `locality`: `unicode`
    - `region`: `unicode`
    - `pcode`: `unicode`
    - `ctry`: `unicode`

Method Summary
  __init__(self, name, value, rfc2425parameters)
Initialize a `VCardAdr` object.
  as_xml(self, parent)
Create vcard-tmp XML representation of the field.
  rfc2426(self)
RFC2426-encode the field content.
    Inherited from VCardField
  __repr__(self)

Method Details

__init__(self, name, value, rfc2425parameters=None)
(Constructor)

Initialize a `VCardAdr` object.

:Parameters:
    - `name`: field name
    - `value`: field value as string or an XML node
    - `rfc2425parameters`: optional RFC 2425 parameters
:Types:
    - `name`: `str`
    - `value`: `str` or `libxml2.xmlNode`
    - `rfc2425parameters`: `dict`
Overrides:
pyxmpp.jabber.vcard.VCardField.__init__

as_xml(self, parent)

Create vcard-tmp XML representation of the field.

:Parameters:
    - `parent`: parent node for the element
:Types:
    - `parent`: `libxml2.xmlNode`

:return: xml node with the field data.
:returntype: `libxml2.xmlNode`

rfc2426(self)

RFC2426-encode the field content.

:return: the field in the RFC 2426 format.
:returntype: `str`
Overrides:
pyxmpp.jabber.vcard.VCardField.rfc2426

Generated by Epydoc 2.1 on Wed May 31 22:36:59 2006 http://epydoc.sf.net