Home       Trees       Index       Help   

PyXMPP

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

Type VCard

         object --+    
                  |    
StanzaPayloadObject --+
                      |
                     VCard


Jabber (vcard-temp) or RFC2426 vCard.

:Ivariables:
    - `fn`: full name.
    - `n`: structural name.
    - `nickname`: nickname(s).
    - `photo`: photo(s).
    - `bday`: birthday date(s).
    - `adr`: address(es).
    - `label`: address label(s).
    - `tel`: phone number(s).
    - `email`: e-mail address(es).
    - `jabberid`: JID(s).
    - `mailer`: mailer(s).
    - `tz`: timezone(s).
    - `geo`: geolocation(s).
    - `title`: title(s).
    - `role`: role(s).
    - `logo`: logo(s).
    - `org`: organization(s).
    - `categories`: categories.
    - `note`: note(s).
    - `prodid`: product id(s).
    - `rev`: revision(s).
    - `sort-string`: sort string(s).
    - `sound`: sound(s).
    - `uid`: user identifier(s).
    - `url`: URL(s).
    - `class`: class(es).
    - `key`: key(s).
    - `desc`: description.
:Types:
    - `fn`: `VCardString`,
    - `n`: `VCardName`,
    - `nickname`: `list` of `VCardString`
    - `photo`: `list` of `VCardImage`
    - `bday`: `list` of `VCardString`
    - `adr`: `list` of `VCardAdr`
    - `label`: `list` of `VCardLabel`
    - `tel`: `list` of `VCardTel`
    - `email`: `list` of `VCardEmail`
    - `jabberid`: `list` of `VCardJID`
    - `mailer`: `list` of `VCardString`
    - `tz`: `list` of `VCardString`
    - `geo`: `list` of `VCardGeo`
    - `title`: `list` of `VCardString`
    - `role`: `list` of `VCardString`
    - `logo`: `list` of `VCardImage`
    - `org`: `list` of `VCardOrg`
    - `categories`: `list` of `VCardCategories`
    - `note`: `list` of `VCardString`
    - `prodid`: `list` of `VCardString`
    - `rev`: `list` of `VCardString`
    - `sort-string`: `list` of `VCardString`
    - `sound`: `list` of `VCardSound`
    - `uid`: `list` of `VCardString`
    - `url`: `list` of `VCardString`
    - `class`: `list` of `VCardString`
    - `key`: `list` of `VCardKey`
    - `desc`: `list` of `VCardXString`
Method Summary
  __init__(self, data)
Initialize a VCard object from data which may be XML node or an RFC2426 string.
  __getattr__(self, name)
  __getitem__(self, name)
  __repr__(self)
  complete_xml_element(self, xmlnode, _unused)
Complete the XML node with `self` content.
  rfc2426(self)
Get the RFC2426 representation of `self`.
    Inherited from StanzaPayloadObject
  as_xml(self, parent, doc)
Get the XML representation of `self`.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
dict components = {'SOUND': (<class pyxmpp.jabber.vcard.VCard...
str xml_element_name = 'vCard'
str xml_element_namespace = 'vcard-temp'

Method Details

__init__(self, data)
(Constructor) 

Initialize a VCard object from data which may be XML node
or an RFC2426 string.

:Parameters:
    - `data`: vcard to parse.
:Types:
    - `data`: `libxml2.xmlNode`, `unicode` or `str`
Overrides:
__builtin__.object.__init__

complete_xml_element(self, xmlnode, _unused) 

Complete the XML node with `self` content.

Should be overriden in classes derived from `StanzaPayloadObject`.

:Parameters:
    - `xmlnode`: XML node with the element being built. It has already
      right name and namespace, but no attributes or content.
    - `_unused`: document to which the element belongs.
:Types:
    - `xmlnode`: `libxml2.xmlNode`
    - `_unused`: `libxml2.xmlDoc`
Overrides:
pyxmpp.objects.StanzaPayloadObject.complete_xml_element

rfc2426(self) 

Get the RFC2426 representation of `self`.

:return: the UTF-8 encoded RFC2426 representation.
:returntype: `str`

Class Variable Details

components

Type:
dict
Value:
{'ADR': (<class pyxmpp.jabber.vcard.VCardAdr at 0xb74b1d1c>, 'multi'),
 'AGENT': ('VCardAgent', 'ignore'),
 'BDAY': (<class pyxmpp.jabber.vcard.VCardString at 0xb74b1c2c>, 'mult\
i'),
 'CATEGORIES': (<class pyxmpp.jabber.vcard.VCardCategories at 0xb74b1e\
3c>,
                'multi'),
 'CLASS': (<class pyxmpp.jabber.vcard.VCardString at 0xb74b1c2c>, 'mul\
...

xml_element_name

Type:
str
Value:
'vCard'

xml_element_namespace

Type:
str
Value:
'vcard-temp'

   Home       Trees       Index       Help   

PyXMPP

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