gdata.contacts
index
/usr/local/svn/gdata-python-client-release/src/gdata/contacts/__init__.py

Contains extensions to ElementWrapper objects used with Google Contacts.

 
Package Contents
       
service

 
Classes
       
atom.AtomBase(atom.ExtensionContainer)
Deleted
Email
IM
OrgName
OrgTitle
Organization
PhoneNumber
PostalAddress
gdata.BatchEntry(gdata.GDataEntry)
ContactEntry
gdata.GDataFeed(atom.Feed, gdata.LinkFinder)
ContactsFeed(gdata.GDataFeed, gdata.LinkFinder)
gdata.LinkFinder(atom.LinkFinder)
ContactsFeed(gdata.GDataFeed, gdata.LinkFinder)

 
class ContactEntry(gdata.BatchEntry)
    A Google Contact flavor of an Atom Entry
 
 
Method resolution order:
ContactEntry
gdata.BatchEntry
gdata.GDataEntry
atom.Entry
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods defined here:
__init__(self, author=None, category=None, content=None, atom_id=None, link=None, published=None, title=None, updated=None, transparency=None, comments=None, email=None, postal_address=None, deleted=None, organization=None, phone_number=None, im=None, extended_property=None, original_event=None, batch_operation=None, batch_id=None, batch_status=None, extension_elements=None, extension_attributes=None, text=None)

Methods inherited from gdata.GDataEntry:
GetMediaURL(self)
Returns the URL to the media content, if the entry is a media entry.
Otherwise returns None.
IsMedia(self)
Determines whether or not an entry is a GData Media entry.

Properties inherited from gdata.GDataEntry:
id
get = __GetId(self)
set = __SetId(self, id)
# This method was created to strip the unwanted whitespace from the id's 
# text node.

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class ContactsFeed(gdata.GDataFeed, gdata.LinkFinder)
    A Google Contacts feed flavor of an Atom Feed
 
 
Method resolution order:
ContactsFeed
gdata.GDataFeed
atom.Feed
atom.Source
atom.FeedEntryParent
atom.AtomBase
atom.ExtensionContainer
gdata.LinkFinder
atom.LinkFinder
__builtin__.object

Methods defined here:
__init__(self, author=None, category=None, contributor=None, generator=None, icon=None, atom_id=None, link=None, logo=None, rights=None, subtitle=None, title=None, updated=None, entry=None, total_results=None, start_index=None, items_per_page=None, extension_elements=None, extension_attributes=None, text=None)

Properties inherited from gdata.GDataFeed:
generator
get = __GetGenerator(self)
set = __SetGenerator(self, generator)
id
get = __GetId(self)
set = __SetId(self, id)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

Methods inherited from gdata.LinkFinder:
GetAclLink(self)
GetEditLink(self)
GetEditMediaLink(self)
The Picasa API mistakenly returns media-edit rather than edit-media, but
this may change soon.
GetFeedLink(self)
GetHtmlLink(self)
Find the first link with rel of alternate and type of text/html
 
Returns:
  An atom.Link or None if no links matched
GetNextLink(self)
GetPostLink(self)
Get a link containing the POST target URL.
 
The POST target URL is used to insert new entries.
 
Returns:
  A link object with a rel matching the POST type.
GetSelfLink(self)
Find the first link with rel set to 'self'
 
Returns:
  An atom.Link or none if none of the links had rel equal to 'self'

Methods inherited from atom.LinkFinder:
GetAlternateLink(self)
GetLicenseLink(self)

 
class Deleted(atom.AtomBase)
    
Method resolution order:
Deleted
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

 
class Email(atom.AtomBase)
    
Method resolution order:
Email
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, primary=None, rel=None, address=None, text=None, label=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

 
class IM(atom.AtomBase)
    
Method resolution order:
IM
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, primary=None, rel=None, address=None, protocol=None, label=None, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

 
class OrgName(atom.AtomBase)
    
Method resolution order:
OrgName
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

 
class OrgTitle(atom.AtomBase)
    
Method resolution order:
OrgTitle
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

 
class Organization(atom.AtomBase)
    
Method resolution order:
Organization
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, rel=None, primary='false', org_name=None, org_title=None, label=None, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

 
class PhoneNumber(atom.AtomBase)
    
Method resolution order:
PhoneNumber
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, primary=None, rel=None, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

 
class PostalAddress(atom.AtomBase)
    
Method resolution order:
PostalAddress
atom.AtomBase
atom.ExtensionContainer
__builtin__.object

Methods defined here:
__init__(self, primary=None, rel=None, text=None, extension_elements=None, extension_attributes=None)

Methods inherited from atom.AtomBase:
ToString(self, string_encoding='UTF-8')
Converts the Atom object to a string containing XML.
__str__(self)

Methods inherited from atom.ExtensionContainer:
FindExtensions(self, tag=None, namespace=None)
Searches extension elements for child nodes with the desired name.
 
Returns a list of extension elements within this object whose tag
and/or namespace match those passed in. To find all extensions in
a particular namespace, specify the namespace but not the tag name.
If you specify only the tag, the result list may contain extension
elements in multiple namespaces.
 
Args:
  tag: str (optional) The desired tag
  namespace: str (optional) The desired namespace
 
Returns:
  A list of elements whose tag and/or namespace match the parameters
  values

Data and other attributes inherited from atom.ExtensionContainer:
__dict__ = <dictproxy object>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'ExtensionContainer' objects>
list of weak references to the object (if defined)

 
Functions
       
ContactEntryFromString(xml_string)
ContactsFeedFromString(xml_string)

 
Data
        IM_AIM = 'http://schemas.google.com/g/2005#AIM'
IM_GOOGLE_TALK = 'http://schemas.google.com/g/2005#GOOGLE_TALK'
IM_ICQ = 'http://schemas.google.com/g/2005#ICQ'
IM_JABBER = 'http://schemas.google.com/g/2005#JABBER'
IM_MSN = 'http://schemas.google.com/g/2005#MSN'
IM_QQ = 'http://schemas.google.com/g/2005#QQ'
IM_SKYPE = 'http://schemas.google.com/g/2005#SKYPE'
IM_YAHOO = 'http://schemas.google.com/g/2005#YAHOO'
REL_HOME = 'http://schemas.google.com/g/2005#home'
REL_OTHER = 'http://schemas.google.com/g/2005#other'
REL_WORK = 'http://schemas.google.com/g/2005#work'
__author__ = 'dbrattli (Dag Brattli)'

 
Author
        dbrattli (Dag Brattli)