Home       Trees       Index       Help   

PyXMPP

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

Class VCardName

VCardField --+
             |
            VCardName


Name vCard field.

:Ivariables:
    - `family`: family name.
    - `given`: given name.
    - `middle`: middle name.
    - `prefix`: name prefix.
    - `suffix`: name suffix.
:Types:
    - `family`: `unicode`
    - `given`: `unicode`
    - `middle`: `unicode`
    - `prefix`: `unicode`
    - `suffix`: `unicode`
Method Summary
  __init__(self, name, value, rfc2425parameters)
Initialize a `VCardName` object.
  __str__(self)
  __unicode__(self)
  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 `VCardName` 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

   Home       Trees       Index       Help   

PyXMPP

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