gdata.contacts.data | index /usr/local/svn/gdata-python-client/src/gdata/contacts/data.py

`Data model classes for parsing and generating XML for the Contacts API.`

Modules
`` |  |
atom | gdata |  |

Classes
`` |  | atom.core.XmlElement(__builtin__.object) BillingInformation Birthday CalendarLink City Country Deleted DirectoryServer Event ExternalId Gender GroupMembershipInfo Hobby HouseName Initials Jot Language MaidenName Mileage Neighborhood NickName Occupation POBox PostalCode Priority Region Relation Sensitivity Street SubRegion SystemGroup UserDefinedField Website gdata.data.BatchEntry(gdata.data.GDEntry) GroupEntry PersonEntry ContactEntry ProfileEntry gdata.data.BatchFeed(gdata.data.GDFeed) ContactsFeed GroupsFeed ProfilesFeed
class BillingInformation(atom.core.XmlElement)
`` | `gContact:billingInformation Specifies billing information of the entity represented by the contact. The element cannot be repeated.`
| Method resolution order: BillingInformation atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Birthday(atom.core.XmlElement)
`` | `Stores birthday date of the person represented by the contact. The element cannot be repeated.`
| Method resolution order: Birthday atom.core.XmlElement __builtin__.object Data and other attributes defined here: when = 'when' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class CalendarLink(atom.core.XmlElement)
`` | `Storage for URL of the contact's calendar. The element can be repeated.`
| Method resolution order: CalendarLink atom.core.XmlElement __builtin__.object Data and other attributes defined here: href = 'href' label = 'label' primary = 'primary' rel = 'rel' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class City(atom.core.XmlElement)
`` | `Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.`
| Method resolution order: City atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class ContactEntry(PersonEntry)
`` | `A Google Contacts flavor of an Atom Entry.`
| Method resolution order: ContactEntry PersonEntry gdata.data.BatchEntry gdata.data.GDEntry atom.data.Entry atom.data.FeedEntryParent atom.core.XmlElement gdata.data.LinkFinder atom.data.LinkFinder __builtin__.object Methods defined here: GetPhotoEditLink(self) GetPhotoLink(self) Data and other attributes defined here: deleted = <class 'gdata.contacts.data.Deleted'> `If present, indicates that this contact has been deleted.` group_membership_info = [<class 'gdata.contacts.data.GroupMembershipInfo'>] organization = <class 'gdata.data.Organization'> `The gd:organization element. An organization, typically associated with a contact.` Data and other attributes inherited from PersonEntry: billing_information = <class 'gdata.contacts.data.BillingInformation'> `gContact:billingInformation Specifies billing information of the entity represented by the contact. The element cannot be repeated.` birthday = <class 'gdata.contacts.data.Birthday'> `Stores birthday date of the person represented by the contact. The element cannot be repeated.` calendar_link = [<class 'gdata.contacts.data.CalendarLink'>] directory_server = <class 'gdata.contacts.data.DirectoryServer'> `A directory server associated with this contact. May not be repeated.` email = [<class 'gdata.data.Email'>] event = [<class 'gdata.contacts.data.Event'>] extended_property = [<class 'gdata.data.ExtendedProperty'>] external_id = [<class 'gdata.contacts.data.ExternalId'>] gender = <class 'gdata.contacts.data.Gender'> `Specifies the gender of the person represented by the contact. The element cannot be repeated.` hobby = [<class 'gdata.contacts.data.Hobby'>] im = [<class 'gdata.data.Im'>] initals = <class 'gdata.contacts.data.Initials'> `Specifies the initials of the person represented by the contact. The element cannot be repeated.` jot = [<class 'gdata.contacts.data.Jot'>] language = [<class 'gdata.contacts.data.Language'>] maiden_name = <class 'gdata.contacts.data.MaidenName'> `Specifies maiden name of the person represented by the contact. The element cannot be repeated.` mileage = <class 'gdata.contacts.data.Mileage'> `Specifies the mileage for the entity represented by the contact. Can be used for example to document distance needed for reimbursement purposes. The value is not interpreted. The element cannot be repeated.` name = <class 'gdata.data.Name'> `The gd:name element. Allows storing person's name in a structured way. Consists of given name, additional name, family name, prefix, suffix and full name.` nickname = <class 'gdata.contacts.data.NickName'> `Specifies the nickname of the person represented by the contact. The element cannot be repeated.` occupation = <class 'gdata.contacts.data.Occupation'> `Specifies the occupation/profession of the person specified by the contact. The element cannot be repeated.` phone_number = [<class 'gdata.data.PhoneNumber'>] postal_address = [<class 'gdata.data.PostalAddress'>] priority = <class 'gdata.contacts.data.Priority'> `Classifies importance of the contact into 3 categories: * Low * Normal * High The priority element cannot be repeated.` relation = [<class 'gdata.contacts.data.Relation'>] sensitivity = <class 'gdata.contacts.data.Sensitivity'> `Classifies sensitivity of the contact into the following categories: * Confidential * Normal * Personal * Private The sensitivity element cannot be repeated.` structured_postal_address = [<class 'gdata.data.StructuredPostalAddress'>] user_defined_field = [<class 'gdata.contacts.data.UserDefinedField'>] website = [<class 'gdata.contacts.data.Website'>] Data and other attributes inherited from gdata.data.BatchEntry: batch_id = <class 'gdata.data.BatchId'> `Identifies a single operation in a batch request.` batch_operation = <class 'gdata.data.BatchOperation'> `The CRUD operation which this batch entry represents.` batch_status = <class 'gdata.data.BatchStatus'> `The batch:status element present in a batch response entry. A status element contains the code (HTTP response code) and reason as elements. In a single request these fields would be part of the HTTP response, but in a batch request each Entry operation has a corresponding Entry in the response feed which includes status information. See http://code.google.com/apis/gdata/batch.html#Handling_Errors` Methods inherited from gdata.data.GDEntry: FindMediaLink = find_media_link(self) `Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.` GetId = get_id(self) IsMedia = is_media(self) find_media_link(self) `Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.` get_id(self) is_media(self) Data and other attributes inherited from gdata.data.GDEntry: etag = '{http://schemas.google.com/g/2005}etag' Data and other attributes inherited from atom.data.Entry: content = <class 'atom.data.Content'> `The atom:content element.` control = <class 'atom.data.Control'> `The app:control element indicating restrictions on publication. The APP control element may contain a draft element indicating whether or not this entry should be publicly available.` published = <class 'atom.data.Published'> `The atom:published element.` source = <class 'atom.data.Source'> `The atom:source element.` summary = <class 'atom.data.Summary'> `The atom:summary element.` Methods inherited from atom.data.FeedEntryParent: __init__(self, atom_id=None, text=None, *args, **kwargs) Data and other attributes inherited from atom.data.FeedEntryParent: author = [<class 'atom.data.Author'>] category = [<class 'atom.data.Category'>] contributor = [<class 'atom.data.Contributor'>] id = <class 'atom.data.Id'> `The atom:id element.` link = [<class 'atom.data.Link'>] rights = <class 'atom.data.Rights'> `The atom:rights element.` title = <class 'atom.data.Title'> `The atom:title element.` updated = <class 'atom.data.Updated'> `The atom:updated element.` Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None Methods inherited from gdata.data.LinkFinder: FindAclLink = find_acl_link(self) FindFeedLink = find_feed_link(self) FindHtmlLink = find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` FindPostLink = find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` FindPreviousLink = find_previous_link(self) GetAclLink = get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` GetFeedLink = get_feed_link(self) GetHtmlLink = get_html_link(self) GetPostLink = get_post_link(self) GetPreviousLink = get_previous_link(self) find_acl_link(self) find_feed_link(self) find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` find_previous_link(self) get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` get_feed_link(self) get_html_link(self) get_post_link(self) get_previous_link(self) Methods inherited from atom.data.LinkFinder: FindAlternateLink = find_alternate_link(self) FindEditLink = find_edit_link(self) FindEditMediaLink = find_edit_media_link(self) FindLicenseLink = find_license_link(self) FindNextLink = find_next_link(self) FindSelfLink = find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` FindUrl = find_url(self, rel) `Returns the URL in a link with the desired rel value.` GetAlternateLink = get_alternate_link(self) GetEditLink = get_edit_link(self) GetEditMediaLink = get_edit_media_link(self) GetLicenseLink = get_license_link(self) GetLink = get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` GetNextLink = get_next_link(self) GetSelfLink = get_self_link(self) find_alternate_link(self) find_edit_link(self) find_edit_media_link(self) find_license_link(self) find_next_link(self) find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` find_url(self, rel) `Returns the URL in a link with the desired rel value.` get_alternate_link(self) get_edit_link(self) get_edit_media_link(self) get_license_link(self) get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` get_next_link(self) get_self_link(self)
class ContactsFeed(gdata.data.BatchFeed)
`` | `A collection of Contacts.`
| Method resolution order: ContactsFeed gdata.data.BatchFeed gdata.data.GDFeed atom.data.Feed atom.data.Source atom.data.FeedEntryParent atom.core.XmlElement gdata.data.LinkFinder atom.data.LinkFinder __builtin__.object Data and other attributes defined here: entry = [<class 'gdata.contacts.data.ContactEntry'>] Methods inherited from gdata.data.BatchFeed: AddBatchEntry = add_batch_entry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None) `Logic for populating members of a BatchEntry and adding to the feed. If the entry is not a BatchEntry, it is converted to a BatchEntry so that the batch specific members will be present. The id_url_string can be used in place of an entry if the batch operation applies to a URL. For example query and delete operations require just the URL of an entry, no body is sent in the HTTP request. If an id_url_string is sent instead of an entry, a BatchEntry is created and added to the feed. This method also assigns the desired batch id to the entry so that it can be referenced in the server's response. If the batch_id_string is None, this method will assign a batch_id to be the index at which this entry will be in the feed's entry list. Args: entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional) The entry which will be sent to the server as part of the batch request. The item must have a valid atom id so that the server knows which entry this request references. id_url_string: str (optional) The URL of the entry to be acted on. You can find this URL in the text member of the atom id for an entry. If an entry is not sent, this id will be used to construct a new BatchEntry which will be added to the request feed. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids. operation_string: str (optional) The desired batch operation which will set the batch_operation.type member of the entry. Options are 'insert', 'update', 'delete', and 'query' Raises: MissingRequiredParameters: Raised if neither an id_ url_string nor an entry are provided in the request. Returns: The added entry.` AddDelete = add_delete(self, url_string=None, entry=None, batch_id_string=None) `Adds a delete request to the batch request feed. This method takes either the url_string which is the atom id of the item to be deleted, or the entry itself. The atom id of the entry must be present so that the server knows which entry should be deleted. Args: url_string: str (optional) The URL of the entry to be deleted. You can find this URL in the text member of the atom id for an entry. entry: BatchEntry (optional) The entry to be deleted. batch_id_string: str (optional) Raises: MissingRequiredParameters: Raised if neither a url_string nor an entry are provided in the request.` AddInsert = add_insert(self, entry, batch_id_string=None) `Add an insert request to the operations in this batch request feed. If the entry doesn't yet have an operation or a batch id, these will be set to the insert operation and a batch_id specified as a parameter. Args: entry: BatchEntry The entry which will be sent in the batch feed as an insert request. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.` AddQuery = add_query(self, url_string=None, entry=None, batch_id_string=None) `Adds a query request to the batch request feed. This method takes either the url_string which is the query URL whose results will be added to the result feed. The query URL will be encapsulated in a BatchEntry, and you may pass in the BatchEntry with a query URL instead of sending a url_string. Args: url_string: str (optional) entry: BatchEntry (optional) batch_id_string: str (optional) Raises: MissingRequiredParameters` AddUpdate = add_update(self, entry, batch_id_string=None) `Add an update request to the list of batch operations in this feed. Sets the operation type of the entry to insert if it is not already set and assigns the desired batch id to the entry so that it can be referenced in the server's response. Args: entry: BatchEntry The entry which will be sent to the server as an update (HTTP PUT) request. The item must have a valid atom id so that the server knows which entry to replace. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. See also comments for AddInsert.` FindBatchLink = find_batch_link(self) add_batch_entry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None) `Logic for populating members of a BatchEntry and adding to the feed. If the entry is not a BatchEntry, it is converted to a BatchEntry so that the batch specific members will be present. The id_url_string can be used in place of an entry if the batch operation applies to a URL. For example query and delete operations require just the URL of an entry, no body is sent in the HTTP request. If an id_url_string is sent instead of an entry, a BatchEntry is created and added to the feed. This method also assigns the desired batch id to the entry so that it can be referenced in the server's response. If the batch_id_string is None, this method will assign a batch_id to be the index at which this entry will be in the feed's entry list. Args: entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional) The entry which will be sent to the server as part of the batch request. The item must have a valid atom id so that the server knows which entry this request references. id_url_string: str (optional) The URL of the entry to be acted on. You can find this URL in the text member of the atom id for an entry. If an entry is not sent, this id will be used to construct a new BatchEntry which will be added to the request feed. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids. operation_string: str (optional) The desired batch operation which will set the batch_operation.type member of the entry. Options are 'insert', 'update', 'delete', and 'query' Raises: MissingRequiredParameters: Raised if neither an id_ url_string nor an entry are provided in the request. Returns: The added entry.` add_delete(self, url_string=None, entry=None, batch_id_string=None) `Adds a delete request to the batch request feed. This method takes either the url_string which is the atom id of the item to be deleted, or the entry itself. The atom id of the entry must be present so that the server knows which entry should be deleted. Args: url_string: str (optional) The URL of the entry to be deleted. You can find this URL in the text member of the atom id for an entry. entry: BatchEntry (optional) The entry to be deleted. batch_id_string: str (optional) Raises: MissingRequiredParameters: Raised if neither a url_string nor an entry are provided in the request.` add_insert(self, entry, batch_id_string=None) `Add an insert request to the operations in this batch request feed. If the entry doesn't yet have an operation or a batch id, these will be set to the insert operation and a batch_id specified as a parameter. Args: entry: BatchEntry The entry which will be sent in the batch feed as an insert request. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.` add_query(self, url_string=None, entry=None, batch_id_string=None) `Adds a query request to the batch request feed. This method takes either the url_string which is the query URL whose results will be added to the result feed. The query URL will be encapsulated in a BatchEntry, and you may pass in the BatchEntry with a query URL instead of sending a url_string. Args: url_string: str (optional) entry: BatchEntry (optional) batch_id_string: str (optional) Raises: MissingRequiredParameters` add_update(self, entry, batch_id_string=None) `Add an update request to the list of batch operations in this feed. Sets the operation type of the entry to insert if it is not already set and assigns the desired batch id to the entry so that it can be referenced in the server's response. Args: entry: BatchEntry The entry which will be sent to the server as an update (HTTP PUT) request. The item must have a valid atom id so that the server knows which entry to replace. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. See also comments for AddInsert.` find_batch_link(self) Data and other attributes inherited from gdata.data.BatchFeed: interrupted = <class 'gdata.data.BatchInterrupted'> `The batch:interrupted element sent if batch request was interrupted. Only appears in a feed if some of the batch entries could not be processed. See: http://code.google.com/apis/gdata/batch.html#Handling_Errors` Methods inherited from gdata.data.GDFeed: GetId = get_id(self) get_generator(self) get_id(self) Data and other attributes inherited from gdata.data.GDFeed: etag = '{http://schemas.google.com/g/2005}etag' items_per_page = <class 'gdata.data.ItemsPerPage'> `The opensearch:itemsPerPage element in GData feed.` start_index = <class 'gdata.data.StartIndex'> `The opensearch:startIndex element in GData feed.` total_results = <class 'gdata.data.TotalResults'> `opensearch:TotalResults for a GData feed.` Data and other attributes inherited from atom.data.Source: generator = <class 'atom.data.Generator'> `The atom:generator element.` icon = <class 'atom.data.Icon'> `The atom:icon element.` logo = <class 'atom.data.Logo'> `The atom:logo element.` subtitle = <class 'atom.data.Subtitle'> `The atom:subtitle element.` Methods inherited from atom.data.FeedEntryParent: __init__(self, atom_id=None, text=None, *args, **kwargs) Data and other attributes inherited from atom.data.FeedEntryParent: author = [<class 'atom.data.Author'>] category = [<class 'atom.data.Category'>] contributor = [<class 'atom.data.Contributor'>] id = <class 'atom.data.Id'> `The atom:id element.` link = [<class 'atom.data.Link'>] rights = <class 'atom.data.Rights'> `The atom:rights element.` title = <class 'atom.data.Title'> `The atom:title element.` updated = <class 'atom.data.Updated'> `The atom:updated element.` Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None Methods inherited from gdata.data.LinkFinder: FindAclLink = find_acl_link(self) FindFeedLink = find_feed_link(self) FindHtmlLink = find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` FindPostLink = find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` FindPreviousLink = find_previous_link(self) GetAclLink = get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` GetFeedLink = get_feed_link(self) GetHtmlLink = get_html_link(self) GetPostLink = get_post_link(self) GetPreviousLink = get_previous_link(self) find_acl_link(self) find_feed_link(self) find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` find_previous_link(self) get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` get_feed_link(self) get_html_link(self) get_post_link(self) get_previous_link(self) Methods inherited from atom.data.LinkFinder: FindAlternateLink = find_alternate_link(self) FindEditLink = find_edit_link(self) FindEditMediaLink = find_edit_media_link(self) FindLicenseLink = find_license_link(self) FindNextLink = find_next_link(self) FindSelfLink = find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` FindUrl = find_url(self, rel) `Returns the URL in a link with the desired rel value.` GetAlternateLink = get_alternate_link(self) GetEditLink = get_edit_link(self) GetEditMediaLink = get_edit_media_link(self) GetLicenseLink = get_license_link(self) GetLink = get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` GetNextLink = get_next_link(self) GetSelfLink = get_self_link(self) find_alternate_link(self) find_edit_link(self) find_edit_media_link(self) find_license_link(self) find_next_link(self) find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` find_url(self, rel) `Returns the URL in a link with the desired rel value.` get_alternate_link(self) get_edit_link(self) get_edit_media_link(self) get_license_link(self) get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` get_next_link(self) get_self_link(self)
class Country(atom.core.XmlElement)
`` | `The name or code of the country.`
| Method resolution order: Country atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Deleted(atom.core.XmlElement)
`` | `If present, indicates that this contact has been deleted.`
| Method resolution order: Deleted atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class DirectoryServer(atom.core.XmlElement)
`` | `A directory server associated with this contact. May not be repeated.`
| Method resolution order: DirectoryServer atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Event(atom.core.XmlElement)
`` | `These elements describe events associated with a contact. They may be repeated`
| Method resolution order: Event atom.core.XmlElement __builtin__.object Data and other attributes defined here: label = 'label' rel = 'rel' when = <class 'gdata.data.When'> `The gd:when element. Represents a period of time or an instant.` Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class ExternalId(atom.core.XmlElement)
`` | `Describes an ID of the contact in an external system of some kind. This element may be repeated.`
| Method resolution order: ExternalId atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Gender(atom.core.XmlElement)
`` | `Specifies the gender of the person represented by the contact. The element cannot be repeated.`
| Method resolution order: Gender atom.core.XmlElement __builtin__.object Data and other attributes defined here: value = 'value' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class GroupEntry(gdata.data.BatchEntry)
`` | `Represents a contact group.`
| Method resolution order: GroupEntry gdata.data.BatchEntry gdata.data.GDEntry atom.data.Entry atom.data.FeedEntryParent atom.core.XmlElement gdata.data.LinkFinder atom.data.LinkFinder __builtin__.object Data and other attributes defined here: extended_property = [<class 'gdata.data.ExtendedProperty'>] system_group = <class 'gdata.contacts.data.SystemGroup'> `The contacts systemGroup element. When used within a contact group entry, indicates that the group in question is one of the predefined system groups.` Data and other attributes inherited from gdata.data.BatchEntry: batch_id = <class 'gdata.data.BatchId'> `Identifies a single operation in a batch request.` batch_operation = <class 'gdata.data.BatchOperation'> `The CRUD operation which this batch entry represents.` batch_status = <class 'gdata.data.BatchStatus'> `The batch:status element present in a batch response entry. A status element contains the code (HTTP response code) and reason as elements. In a single request these fields would be part of the HTTP response, but in a batch request each Entry operation has a corresponding Entry in the response feed which includes status information. See http://code.google.com/apis/gdata/batch.html#Handling_Errors` Methods inherited from gdata.data.GDEntry: FindMediaLink = find_media_link(self) `Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.` GetId = get_id(self) IsMedia = is_media(self) find_media_link(self) `Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.` get_id(self) is_media(self) Data and other attributes inherited from gdata.data.GDEntry: etag = '{http://schemas.google.com/g/2005}etag' Data and other attributes inherited from atom.data.Entry: content = <class 'atom.data.Content'> `The atom:content element.` control = <class 'atom.data.Control'> `The app:control element indicating restrictions on publication. The APP control element may contain a draft element indicating whether or not this entry should be publicly available.` published = <class 'atom.data.Published'> `The atom:published element.` source = <class 'atom.data.Source'> `The atom:source element.` summary = <class 'atom.data.Summary'> `The atom:summary element.` Methods inherited from atom.data.FeedEntryParent: __init__(self, atom_id=None, text=None, *args, **kwargs) Data and other attributes inherited from atom.data.FeedEntryParent: author = [<class 'atom.data.Author'>] category = [<class 'atom.data.Category'>] contributor = [<class 'atom.data.Contributor'>] id = <class 'atom.data.Id'> `The atom:id element.` link = [<class 'atom.data.Link'>] rights = <class 'atom.data.Rights'> `The atom:rights element.` title = <class 'atom.data.Title'> `The atom:title element.` updated = <class 'atom.data.Updated'> `The atom:updated element.` Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None Methods inherited from gdata.data.LinkFinder: FindAclLink = find_acl_link(self) FindFeedLink = find_feed_link(self) FindHtmlLink = find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` FindPostLink = find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` FindPreviousLink = find_previous_link(self) GetAclLink = get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` GetFeedLink = get_feed_link(self) GetHtmlLink = get_html_link(self) GetPostLink = get_post_link(self) GetPreviousLink = get_previous_link(self) find_acl_link(self) find_feed_link(self) find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` find_previous_link(self) get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` get_feed_link(self) get_html_link(self) get_post_link(self) get_previous_link(self) Methods inherited from atom.data.LinkFinder: FindAlternateLink = find_alternate_link(self) FindEditLink = find_edit_link(self) FindEditMediaLink = find_edit_media_link(self) FindLicenseLink = find_license_link(self) FindNextLink = find_next_link(self) FindSelfLink = find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` FindUrl = find_url(self, rel) `Returns the URL in a link with the desired rel value.` GetAlternateLink = get_alternate_link(self) GetEditLink = get_edit_link(self) GetEditMediaLink = get_edit_media_link(self) GetLicenseLink = get_license_link(self) GetLink = get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` GetNextLink = get_next_link(self) GetSelfLink = get_self_link(self) find_alternate_link(self) find_edit_link(self) find_edit_media_link(self) find_license_link(self) find_next_link(self) find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` find_url(self, rel) `Returns the URL in a link with the desired rel value.` get_alternate_link(self) get_edit_link(self) get_edit_media_link(self) get_license_link(self) get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` get_next_link(self) get_self_link(self)
class GroupMembershipInfo(atom.core.XmlElement)
`` | `Identifies the group to which the contact belongs or belonged. The group is referenced by its id.`
| Method resolution order: GroupMembershipInfo atom.core.XmlElement __builtin__.object Data and other attributes defined here: deleted = 'deleted' href = 'href' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class GroupsFeed(gdata.data.BatchFeed)
`` | `A Google contact groups feed flavor of an Atom Feed.`
| Method resolution order: GroupsFeed gdata.data.BatchFeed gdata.data.GDFeed atom.data.Feed atom.data.Source atom.data.FeedEntryParent atom.core.XmlElement gdata.data.LinkFinder atom.data.LinkFinder __builtin__.object Data and other attributes defined here: entry = [<class 'gdata.contacts.data.GroupEntry'>] Methods inherited from gdata.data.BatchFeed: AddBatchEntry = add_batch_entry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None) `Logic for populating members of a BatchEntry and adding to the feed. If the entry is not a BatchEntry, it is converted to a BatchEntry so that the batch specific members will be present. The id_url_string can be used in place of an entry if the batch operation applies to a URL. For example query and delete operations require just the URL of an entry, no body is sent in the HTTP request. If an id_url_string is sent instead of an entry, a BatchEntry is created and added to the feed. This method also assigns the desired batch id to the entry so that it can be referenced in the server's response. If the batch_id_string is None, this method will assign a batch_id to be the index at which this entry will be in the feed's entry list. Args: entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional) The entry which will be sent to the server as part of the batch request. The item must have a valid atom id so that the server knows which entry this request references. id_url_string: str (optional) The URL of the entry to be acted on. You can find this URL in the text member of the atom id for an entry. If an entry is not sent, this id will be used to construct a new BatchEntry which will be added to the request feed. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids. operation_string: str (optional) The desired batch operation which will set the batch_operation.type member of the entry. Options are 'insert', 'update', 'delete', and 'query' Raises: MissingRequiredParameters: Raised if neither an id_ url_string nor an entry are provided in the request. Returns: The added entry.` AddDelete = add_delete(self, url_string=None, entry=None, batch_id_string=None) `Adds a delete request to the batch request feed. This method takes either the url_string which is the atom id of the item to be deleted, or the entry itself. The atom id of the entry must be present so that the server knows which entry should be deleted. Args: url_string: str (optional) The URL of the entry to be deleted. You can find this URL in the text member of the atom id for an entry. entry: BatchEntry (optional) The entry to be deleted. batch_id_string: str (optional) Raises: MissingRequiredParameters: Raised if neither a url_string nor an entry are provided in the request.` AddInsert = add_insert(self, entry, batch_id_string=None) `Add an insert request to the operations in this batch request feed. If the entry doesn't yet have an operation or a batch id, these will be set to the insert operation and a batch_id specified as a parameter. Args: entry: BatchEntry The entry which will be sent in the batch feed as an insert request. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.` AddQuery = add_query(self, url_string=None, entry=None, batch_id_string=None) `Adds a query request to the batch request feed. This method takes either the url_string which is the query URL whose results will be added to the result feed. The query URL will be encapsulated in a BatchEntry, and you may pass in the BatchEntry with a query URL instead of sending a url_string. Args: url_string: str (optional) entry: BatchEntry (optional) batch_id_string: str (optional) Raises: MissingRequiredParameters` AddUpdate = add_update(self, entry, batch_id_string=None) `Add an update request to the list of batch operations in this feed. Sets the operation type of the entry to insert if it is not already set and assigns the desired batch id to the entry so that it can be referenced in the server's response. Args: entry: BatchEntry The entry which will be sent to the server as an update (HTTP PUT) request. The item must have a valid atom id so that the server knows which entry to replace. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. See also comments for AddInsert.` FindBatchLink = find_batch_link(self) add_batch_entry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None) `Logic for populating members of a BatchEntry and adding to the feed. If the entry is not a BatchEntry, it is converted to a BatchEntry so that the batch specific members will be present. The id_url_string can be used in place of an entry if the batch operation applies to a URL. For example query and delete operations require just the URL of an entry, no body is sent in the HTTP request. If an id_url_string is sent instead of an entry, a BatchEntry is created and added to the feed. This method also assigns the desired batch id to the entry so that it can be referenced in the server's response. If the batch_id_string is None, this method will assign a batch_id to be the index at which this entry will be in the feed's entry list. Args: entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional) The entry which will be sent to the server as part of the batch request. The item must have a valid atom id so that the server knows which entry this request references. id_url_string: str (optional) The URL of the entry to be acted on. You can find this URL in the text member of the atom id for an entry. If an entry is not sent, this id will be used to construct a new BatchEntry which will be added to the request feed. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids. operation_string: str (optional) The desired batch operation which will set the batch_operation.type member of the entry. Options are 'insert', 'update', 'delete', and 'query' Raises: MissingRequiredParameters: Raised if neither an id_ url_string nor an entry are provided in the request. Returns: The added entry.` add_delete(self, url_string=None, entry=None, batch_id_string=None) `Adds a delete request to the batch request feed. This method takes either the url_string which is the atom id of the item to be deleted, or the entry itself. The atom id of the entry must be present so that the server knows which entry should be deleted. Args: url_string: str (optional) The URL of the entry to be deleted. You can find this URL in the text member of the atom id for an entry. entry: BatchEntry (optional) The entry to be deleted. batch_id_string: str (optional) Raises: MissingRequiredParameters: Raised if neither a url_string nor an entry are provided in the request.` add_insert(self, entry, batch_id_string=None) `Add an insert request to the operations in this batch request feed. If the entry doesn't yet have an operation or a batch id, these will be set to the insert operation and a batch_id specified as a parameter. Args: entry: BatchEntry The entry which will be sent in the batch feed as an insert request. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.` add_query(self, url_string=None, entry=None, batch_id_string=None) `Adds a query request to the batch request feed. This method takes either the url_string which is the query URL whose results will be added to the result feed. The query URL will be encapsulated in a BatchEntry, and you may pass in the BatchEntry with a query URL instead of sending a url_string. Args: url_string: str (optional) entry: BatchEntry (optional) batch_id_string: str (optional) Raises: MissingRequiredParameters` add_update(self, entry, batch_id_string=None) `Add an update request to the list of batch operations in this feed. Sets the operation type of the entry to insert if it is not already set and assigns the desired batch id to the entry so that it can be referenced in the server's response. Args: entry: BatchEntry The entry which will be sent to the server as an update (HTTP PUT) request. The item must have a valid atom id so that the server knows which entry to replace. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. See also comments for AddInsert.` find_batch_link(self) Data and other attributes inherited from gdata.data.BatchFeed: interrupted = <class 'gdata.data.BatchInterrupted'> `The batch:interrupted element sent if batch request was interrupted. Only appears in a feed if some of the batch entries could not be processed. See: http://code.google.com/apis/gdata/batch.html#Handling_Errors` Methods inherited from gdata.data.GDFeed: GetId = get_id(self) get_generator(self) get_id(self) Data and other attributes inherited from gdata.data.GDFeed: etag = '{http://schemas.google.com/g/2005}etag' items_per_page = <class 'gdata.data.ItemsPerPage'> `The opensearch:itemsPerPage element in GData feed.` start_index = <class 'gdata.data.StartIndex'> `The opensearch:startIndex element in GData feed.` total_results = <class 'gdata.data.TotalResults'> `opensearch:TotalResults for a GData feed.` Data and other attributes inherited from atom.data.Source: generator = <class 'atom.data.Generator'> `The atom:generator element.` icon = <class 'atom.data.Icon'> `The atom:icon element.` logo = <class 'atom.data.Logo'> `The atom:logo element.` subtitle = <class 'atom.data.Subtitle'> `The atom:subtitle element.` Methods inherited from atom.data.FeedEntryParent: __init__(self, atom_id=None, text=None, *args, **kwargs) Data and other attributes inherited from atom.data.FeedEntryParent: author = [<class 'atom.data.Author'>] category = [<class 'atom.data.Category'>] contributor = [<class 'atom.data.Contributor'>] id = <class 'atom.data.Id'> `The atom:id element.` link = [<class 'atom.data.Link'>] rights = <class 'atom.data.Rights'> `The atom:rights element.` title = <class 'atom.data.Title'> `The atom:title element.` updated = <class 'atom.data.Updated'> `The atom:updated element.` Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None Methods inherited from gdata.data.LinkFinder: FindAclLink = find_acl_link(self) FindFeedLink = find_feed_link(self) FindHtmlLink = find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` FindPostLink = find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` FindPreviousLink = find_previous_link(self) GetAclLink = get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` GetFeedLink = get_feed_link(self) GetHtmlLink = get_html_link(self) GetPostLink = get_post_link(self) GetPreviousLink = get_previous_link(self) find_acl_link(self) find_feed_link(self) find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` find_previous_link(self) get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` get_feed_link(self) get_html_link(self) get_post_link(self) get_previous_link(self) Methods inherited from atom.data.LinkFinder: FindAlternateLink = find_alternate_link(self) FindEditLink = find_edit_link(self) FindEditMediaLink = find_edit_media_link(self) FindLicenseLink = find_license_link(self) FindNextLink = find_next_link(self) FindSelfLink = find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` FindUrl = find_url(self, rel) `Returns the URL in a link with the desired rel value.` GetAlternateLink = get_alternate_link(self) GetEditLink = get_edit_link(self) GetEditMediaLink = get_edit_media_link(self) GetLicenseLink = get_license_link(self) GetLink = get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` GetNextLink = get_next_link(self) GetSelfLink = get_self_link(self) find_alternate_link(self) find_edit_link(self) find_edit_media_link(self) find_license_link(self) find_next_link(self) find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` find_url(self, rel) `Returns the URL in a link with the desired rel value.` get_alternate_link(self) get_edit_link(self) get_edit_media_link(self) get_license_link(self) get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` get_next_link(self) get_self_link(self)
class Hobby(atom.core.XmlElement)
`` | `Describes an ID of the contact in an external system of some kind. This element may be repeated.`
| Method resolution order: Hobby atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class HouseName(atom.core.XmlElement)
`` | `Used in places where houses or buildings have names (and not necessarily numbers), eg. "The Pillars".`
| Method resolution order: HouseName atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Initials(atom.core.XmlElement)
`` | `Specifies the initials of the person represented by the contact. The element cannot be repeated.`
| Method resolution order: Initials atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Jot(atom.core.XmlElement)
`` | `Storage for arbitrary pieces of information about the contact. Each jot has a type specified by the rel attribute and a text value. The element can be repeated.`
| Method resolution order: Jot atom.core.XmlElement __builtin__.object Data and other attributes defined here: rel = 'rel' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Language(atom.core.XmlElement)
`` | `Specifies the preferred languages of the contact. The element can be repeated. The language must be specified using one of two mutually exclusive methods: using the freeform @label attribute, or using the @code attribute, whose value must conform to the IETF BCP 47 specification.`
| Method resolution order: Language atom.core.XmlElement __builtin__.object Data and other attributes defined here: code = 'code' label = 'label' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class MaidenName(atom.core.XmlElement)
`` | `Specifies maiden name of the person represented by the contact. The element cannot be repeated.`
| Method resolution order: MaidenName atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Mileage(atom.core.XmlElement)
`` | `Specifies the mileage for the entity represented by the contact. Can be used for example to document distance needed for reimbursement purposes. The value is not interpreted. The element cannot be repeated.`
| Method resolution order: Mileage atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Neighborhood(atom.core.XmlElement)
`` | `This is used to disambiguate a street address when a city contains more than one street with the same name, or to specify a small place whose mail is routed through a larger postal town. In China it could be a county or a minor city.`
| Method resolution order: Neighborhood atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class NickName(atom.core.XmlElement)
`` | `Specifies the nickname of the person represented by the contact. The element cannot be repeated.`
| Method resolution order: NickName atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Occupation(atom.core.XmlElement)
`` | `Specifies the occupation/profession of the person specified by the contact. The element cannot be repeated.`
| Method resolution order: Occupation atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class POBox(atom.core.XmlElement)
`` | `Covers actual P.O. boxes, drawers, locked bags, etc. This is usually but not always mutually exclusive with street`
| Method resolution order: POBox atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class PersonEntry(gdata.data.BatchEntry)
`` | `Represents a google contact`
| Method resolution order: PersonEntry gdata.data.BatchEntry gdata.data.GDEntry atom.data.Entry atom.data.FeedEntryParent atom.core.XmlElement gdata.data.LinkFinder atom.data.LinkFinder __builtin__.object Data and other attributes defined here: billing_information = <class 'gdata.contacts.data.BillingInformation'> `gContact:billingInformation Specifies billing information of the entity represented by the contact. The element cannot be repeated.` birthday = <class 'gdata.contacts.data.Birthday'> `Stores birthday date of the person represented by the contact. The element cannot be repeated.` calendar_link = [<class 'gdata.contacts.data.CalendarLink'>] directory_server = <class 'gdata.contacts.data.DirectoryServer'> `A directory server associated with this contact. May not be repeated.` email = [<class 'gdata.data.Email'>] event = [<class 'gdata.contacts.data.Event'>] extended_property = [<class 'gdata.data.ExtendedProperty'>] external_id = [<class 'gdata.contacts.data.ExternalId'>] gender = <class 'gdata.contacts.data.Gender'> `Specifies the gender of the person represented by the contact. The element cannot be repeated.` hobby = [<class 'gdata.contacts.data.Hobby'>] im = [<class 'gdata.data.Im'>] initals = <class 'gdata.contacts.data.Initials'> `Specifies the initials of the person represented by the contact. The element cannot be repeated.` jot = [<class 'gdata.contacts.data.Jot'>] language = [<class 'gdata.contacts.data.Language'>] maiden_name = <class 'gdata.contacts.data.MaidenName'> `Specifies maiden name of the person represented by the contact. The element cannot be repeated.` mileage = <class 'gdata.contacts.data.Mileage'> `Specifies the mileage for the entity represented by the contact. Can be used for example to document distance needed for reimbursement purposes. The value is not interpreted. The element cannot be repeated.` name = <class 'gdata.data.Name'> `The gd:name element. Allows storing person's name in a structured way. Consists of given name, additional name, family name, prefix, suffix and full name.` nickname = <class 'gdata.contacts.data.NickName'> `Specifies the nickname of the person represented by the contact. The element cannot be repeated.` occupation = <class 'gdata.contacts.data.Occupation'> `Specifies the occupation/profession of the person specified by the contact. The element cannot be repeated.` organization = <class 'gdata.data.Organization'> `The gd:organization element. An organization, typically associated with a contact.` phone_number = [<class 'gdata.data.PhoneNumber'>] postal_address = [<class 'gdata.data.PostalAddress'>] priority = <class 'gdata.contacts.data.Priority'> `Classifies importance of the contact into 3 categories: * Low * Normal * High The priority element cannot be repeated.` relation = [<class 'gdata.contacts.data.Relation'>] sensitivity = <class 'gdata.contacts.data.Sensitivity'> `Classifies sensitivity of the contact into the following categories: * Confidential * Normal * Personal * Private The sensitivity element cannot be repeated.` structured_postal_address = [<class 'gdata.data.StructuredPostalAddress'>] user_defined_field = [<class 'gdata.contacts.data.UserDefinedField'>] website = [<class 'gdata.contacts.data.Website'>] Data and other attributes inherited from gdata.data.BatchEntry: batch_id = <class 'gdata.data.BatchId'> `Identifies a single operation in a batch request.` batch_operation = <class 'gdata.data.BatchOperation'> `The CRUD operation which this batch entry represents.` batch_status = <class 'gdata.data.BatchStatus'> `The batch:status element present in a batch response entry. A status element contains the code (HTTP response code) and reason as elements. In a single request these fields would be part of the HTTP response, but in a batch request each Entry operation has a corresponding Entry in the response feed which includes status information. See http://code.google.com/apis/gdata/batch.html#Handling_Errors` Methods inherited from gdata.data.GDEntry: FindMediaLink = find_media_link(self) `Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.` GetId = get_id(self) IsMedia = is_media(self) find_media_link(self) `Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.` get_id(self) is_media(self) Data and other attributes inherited from gdata.data.GDEntry: etag = '{http://schemas.google.com/g/2005}etag' Data and other attributes inherited from atom.data.Entry: content = <class 'atom.data.Content'> `The atom:content element.` control = <class 'atom.data.Control'> `The app:control element indicating restrictions on publication. The APP control element may contain a draft element indicating whether or not this entry should be publicly available.` published = <class 'atom.data.Published'> `The atom:published element.` source = <class 'atom.data.Source'> `The atom:source element.` summary = <class 'atom.data.Summary'> `The atom:summary element.` Methods inherited from atom.data.FeedEntryParent: __init__(self, atom_id=None, text=None, *args, **kwargs) Data and other attributes inherited from atom.data.FeedEntryParent: author = [<class 'atom.data.Author'>] category = [<class 'atom.data.Category'>] contributor = [<class 'atom.data.Contributor'>] id = <class 'atom.data.Id'> `The atom:id element.` link = [<class 'atom.data.Link'>] rights = <class 'atom.data.Rights'> `The atom:rights element.` title = <class 'atom.data.Title'> `The atom:title element.` updated = <class 'atom.data.Updated'> `The atom:updated element.` Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None Methods inherited from gdata.data.LinkFinder: FindAclLink = find_acl_link(self) FindFeedLink = find_feed_link(self) FindHtmlLink = find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` FindPostLink = find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` FindPreviousLink = find_previous_link(self) GetAclLink = get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` GetFeedLink = get_feed_link(self) GetHtmlLink = get_html_link(self) GetPostLink = get_post_link(self) GetPreviousLink = get_previous_link(self) find_acl_link(self) find_feed_link(self) find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` find_previous_link(self) get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` get_feed_link(self) get_html_link(self) get_post_link(self) get_previous_link(self) Methods inherited from atom.data.LinkFinder: FindAlternateLink = find_alternate_link(self) FindEditLink = find_edit_link(self) FindEditMediaLink = find_edit_media_link(self) FindLicenseLink = find_license_link(self) FindNextLink = find_next_link(self) FindSelfLink = find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` FindUrl = find_url(self, rel) `Returns the URL in a link with the desired rel value.` GetAlternateLink = get_alternate_link(self) GetEditLink = get_edit_link(self) GetEditMediaLink = get_edit_media_link(self) GetLicenseLink = get_license_link(self) GetLink = get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` GetNextLink = get_next_link(self) GetSelfLink = get_self_link(self) find_alternate_link(self) find_edit_link(self) find_edit_media_link(self) find_license_link(self) find_next_link(self) find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` find_url(self, rel) `Returns the URL in a link with the desired rel value.` get_alternate_link(self) get_edit_link(self) get_edit_media_link(self) get_license_link(self) get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` get_next_link(self) get_self_link(self)
class PostalCode(atom.core.XmlElement)
`` | `Postal code. Usually country-wide, but sometimes specific to the city (e.g. "2" in "Dublin 2, Ireland" addresses).`
| Method resolution order: PostalCode atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Priority(atom.core.XmlElement)
`` | `Classifies importance of the contact into 3 categories: * Low * Normal * High The priority element cannot be repeated.`
| Method resolution order: Priority atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class ProfileEntry(PersonEntry)
`` | `A Google Profiles flavor of an Atom Entry.`
| Method resolution order: ProfileEntry PersonEntry gdata.data.BatchEntry gdata.data.GDEntry atom.data.Entry atom.data.FeedEntryParent atom.core.XmlElement gdata.data.LinkFinder atom.data.LinkFinder __builtin__.object Data and other attributes inherited from PersonEntry: billing_information = <class 'gdata.contacts.data.BillingInformation'> `gContact:billingInformation Specifies billing information of the entity represented by the contact. The element cannot be repeated.` birthday = <class 'gdata.contacts.data.Birthday'> `Stores birthday date of the person represented by the contact. The element cannot be repeated.` calendar_link = [<class 'gdata.contacts.data.CalendarLink'>] directory_server = <class 'gdata.contacts.data.DirectoryServer'> `A directory server associated with this contact. May not be repeated.` email = [<class 'gdata.data.Email'>] event = [<class 'gdata.contacts.data.Event'>] extended_property = [<class 'gdata.data.ExtendedProperty'>] external_id = [<class 'gdata.contacts.data.ExternalId'>] gender = <class 'gdata.contacts.data.Gender'> `Specifies the gender of the person represented by the contact. The element cannot be repeated.` hobby = [<class 'gdata.contacts.data.Hobby'>] im = [<class 'gdata.data.Im'>] initals = <class 'gdata.contacts.data.Initials'> `Specifies the initials of the person represented by the contact. The element cannot be repeated.` jot = [<class 'gdata.contacts.data.Jot'>] language = [<class 'gdata.contacts.data.Language'>] maiden_name = <class 'gdata.contacts.data.MaidenName'> `Specifies maiden name of the person represented by the contact. The element cannot be repeated.` mileage = <class 'gdata.contacts.data.Mileage'> `Specifies the mileage for the entity represented by the contact. Can be used for example to document distance needed for reimbursement purposes. The value is not interpreted. The element cannot be repeated.` name = <class 'gdata.data.Name'> `The gd:name element. Allows storing person's name in a structured way. Consists of given name, additional name, family name, prefix, suffix and full name.` nickname = <class 'gdata.contacts.data.NickName'> `Specifies the nickname of the person represented by the contact. The element cannot be repeated.` occupation = <class 'gdata.contacts.data.Occupation'> `Specifies the occupation/profession of the person specified by the contact. The element cannot be repeated.` organization = <class 'gdata.data.Organization'> `The gd:organization element. An organization, typically associated with a contact.` phone_number = [<class 'gdata.data.PhoneNumber'>] postal_address = [<class 'gdata.data.PostalAddress'>] priority = <class 'gdata.contacts.data.Priority'> `Classifies importance of the contact into 3 categories: * Low * Normal * High The priority element cannot be repeated.` relation = [<class 'gdata.contacts.data.Relation'>] sensitivity = <class 'gdata.contacts.data.Sensitivity'> `Classifies sensitivity of the contact into the following categories: * Confidential * Normal * Personal * Private The sensitivity element cannot be repeated.` structured_postal_address = [<class 'gdata.data.StructuredPostalAddress'>] user_defined_field = [<class 'gdata.contacts.data.UserDefinedField'>] website = [<class 'gdata.contacts.data.Website'>] Data and other attributes inherited from gdata.data.BatchEntry: batch_id = <class 'gdata.data.BatchId'> `Identifies a single operation in a batch request.` batch_operation = <class 'gdata.data.BatchOperation'> `The CRUD operation which this batch entry represents.` batch_status = <class 'gdata.data.BatchStatus'> `The batch:status element present in a batch response entry. A status element contains the code (HTTP response code) and reason as elements. In a single request these fields would be part of the HTTP response, but in a batch request each Entry operation has a corresponding Entry in the response feed which includes status information. See http://code.google.com/apis/gdata/batch.html#Handling_Errors` Methods inherited from gdata.data.GDEntry: FindMediaLink = find_media_link(self) `Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.` GetId = get_id(self) IsMedia = is_media(self) find_media_link(self) `Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.` get_id(self) is_media(self) Data and other attributes inherited from gdata.data.GDEntry: etag = '{http://schemas.google.com/g/2005}etag' Data and other attributes inherited from atom.data.Entry: content = <class 'atom.data.Content'> `The atom:content element.` control = <class 'atom.data.Control'> `The app:control element indicating restrictions on publication. The APP control element may contain a draft element indicating whether or not this entry should be publicly available.` published = <class 'atom.data.Published'> `The atom:published element.` source = <class 'atom.data.Source'> `The atom:source element.` summary = <class 'atom.data.Summary'> `The atom:summary element.` Methods inherited from atom.data.FeedEntryParent: __init__(self, atom_id=None, text=None, *args, **kwargs) Data and other attributes inherited from atom.data.FeedEntryParent: author = [<class 'atom.data.Author'>] category = [<class 'atom.data.Category'>] contributor = [<class 'atom.data.Contributor'>] id = <class 'atom.data.Id'> `The atom:id element.` link = [<class 'atom.data.Link'>] rights = <class 'atom.data.Rights'> `The atom:rights element.` title = <class 'atom.data.Title'> `The atom:title element.` updated = <class 'atom.data.Updated'> `The atom:updated element.` Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None Methods inherited from gdata.data.LinkFinder: FindAclLink = find_acl_link(self) FindFeedLink = find_feed_link(self) FindHtmlLink = find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` FindPostLink = find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` FindPreviousLink = find_previous_link(self) GetAclLink = get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` GetFeedLink = get_feed_link(self) GetHtmlLink = get_html_link(self) GetPostLink = get_post_link(self) GetPreviousLink = get_previous_link(self) find_acl_link(self) find_feed_link(self) find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` find_previous_link(self) get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` get_feed_link(self) get_html_link(self) get_post_link(self) get_previous_link(self) Methods inherited from atom.data.LinkFinder: FindAlternateLink = find_alternate_link(self) FindEditLink = find_edit_link(self) FindEditMediaLink = find_edit_media_link(self) FindLicenseLink = find_license_link(self) FindNextLink = find_next_link(self) FindSelfLink = find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` FindUrl = find_url(self, rel) `Returns the URL in a link with the desired rel value.` GetAlternateLink = get_alternate_link(self) GetEditLink = get_edit_link(self) GetEditMediaLink = get_edit_media_link(self) GetLicenseLink = get_license_link(self) GetLink = get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` GetNextLink = get_next_link(self) GetSelfLink = get_self_link(self) find_alternate_link(self) find_edit_link(self) find_edit_media_link(self) find_license_link(self) find_next_link(self) find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` find_url(self, rel) `Returns the URL in a link with the desired rel value.` get_alternate_link(self) get_edit_link(self) get_edit_media_link(self) get_license_link(self) get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` get_next_link(self) get_self_link(self)
class ProfilesFeed(gdata.data.BatchFeed)
`` | `A Google Profiles feed flavor of an Atom Feed.`
| Method resolution order: ProfilesFeed gdata.data.BatchFeed gdata.data.GDFeed atom.data.Feed atom.data.Source atom.data.FeedEntryParent atom.core.XmlElement gdata.data.LinkFinder atom.data.LinkFinder __builtin__.object Data and other attributes defined here: entry = [<class 'gdata.contacts.data.ProfileEntry'>] Methods inherited from gdata.data.BatchFeed: AddBatchEntry = add_batch_entry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None) `Logic for populating members of a BatchEntry and adding to the feed. If the entry is not a BatchEntry, it is converted to a BatchEntry so that the batch specific members will be present. The id_url_string can be used in place of an entry if the batch operation applies to a URL. For example query and delete operations require just the URL of an entry, no body is sent in the HTTP request. If an id_url_string is sent instead of an entry, a BatchEntry is created and added to the feed. This method also assigns the desired batch id to the entry so that it can be referenced in the server's response. If the batch_id_string is None, this method will assign a batch_id to be the index at which this entry will be in the feed's entry list. Args: entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional) The entry which will be sent to the server as part of the batch request. The item must have a valid atom id so that the server knows which entry this request references. id_url_string: str (optional) The URL of the entry to be acted on. You can find this URL in the text member of the atom id for an entry. If an entry is not sent, this id will be used to construct a new BatchEntry which will be added to the request feed. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids. operation_string: str (optional) The desired batch operation which will set the batch_operation.type member of the entry. Options are 'insert', 'update', 'delete', and 'query' Raises: MissingRequiredParameters: Raised if neither an id_ url_string nor an entry are provided in the request. Returns: The added entry.` AddDelete = add_delete(self, url_string=None, entry=None, batch_id_string=None) `Adds a delete request to the batch request feed. This method takes either the url_string which is the atom id of the item to be deleted, or the entry itself. The atom id of the entry must be present so that the server knows which entry should be deleted. Args: url_string: str (optional) The URL of the entry to be deleted. You can find this URL in the text member of the atom id for an entry. entry: BatchEntry (optional) The entry to be deleted. batch_id_string: str (optional) Raises: MissingRequiredParameters: Raised if neither a url_string nor an entry are provided in the request.` AddInsert = add_insert(self, entry, batch_id_string=None) `Add an insert request to the operations in this batch request feed. If the entry doesn't yet have an operation or a batch id, these will be set to the insert operation and a batch_id specified as a parameter. Args: entry: BatchEntry The entry which will be sent in the batch feed as an insert request. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.` AddQuery = add_query(self, url_string=None, entry=None, batch_id_string=None) `Adds a query request to the batch request feed. This method takes either the url_string which is the query URL whose results will be added to the result feed. The query URL will be encapsulated in a BatchEntry, and you may pass in the BatchEntry with a query URL instead of sending a url_string. Args: url_string: str (optional) entry: BatchEntry (optional) batch_id_string: str (optional) Raises: MissingRequiredParameters` AddUpdate = add_update(self, entry, batch_id_string=None) `Add an update request to the list of batch operations in this feed. Sets the operation type of the entry to insert if it is not already set and assigns the desired batch id to the entry so that it can be referenced in the server's response. Args: entry: BatchEntry The entry which will be sent to the server as an update (HTTP PUT) request. The item must have a valid atom id so that the server knows which entry to replace. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. See also comments for AddInsert.` FindBatchLink = find_batch_link(self) add_batch_entry(self, entry=None, id_url_string=None, batch_id_string=None, operation_string=None) `Logic for populating members of a BatchEntry and adding to the feed. If the entry is not a BatchEntry, it is converted to a BatchEntry so that the batch specific members will be present. The id_url_string can be used in place of an entry if the batch operation applies to a URL. For example query and delete operations require just the URL of an entry, no body is sent in the HTTP request. If an id_url_string is sent instead of an entry, a BatchEntry is created and added to the feed. This method also assigns the desired batch id to the entry so that it can be referenced in the server's response. If the batch_id_string is None, this method will assign a batch_id to be the index at which this entry will be in the feed's entry list. Args: entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional) The entry which will be sent to the server as part of the batch request. The item must have a valid atom id so that the server knows which entry this request references. id_url_string: str (optional) The URL of the entry to be acted on. You can find this URL in the text member of the atom id for an entry. If an entry is not sent, this id will be used to construct a new BatchEntry which will be added to the request feed. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids. operation_string: str (optional) The desired batch operation which will set the batch_operation.type member of the entry. Options are 'insert', 'update', 'delete', and 'query' Raises: MissingRequiredParameters: Raised if neither an id_ url_string nor an entry are provided in the request. Returns: The added entry.` add_delete(self, url_string=None, entry=None, batch_id_string=None) `Adds a delete request to the batch request feed. This method takes either the url_string which is the atom id of the item to be deleted, or the entry itself. The atom id of the entry must be present so that the server knows which entry should be deleted. Args: url_string: str (optional) The URL of the entry to be deleted. You can find this URL in the text member of the atom id for an entry. entry: BatchEntry (optional) The entry to be deleted. batch_id_string: str (optional) Raises: MissingRequiredParameters: Raised if neither a url_string nor an entry are provided in the request.` add_insert(self, entry, batch_id_string=None) `Add an insert request to the operations in this batch request feed. If the entry doesn't yet have an operation or a batch id, these will be set to the insert operation and a batch_id specified as a parameter. Args: entry: BatchEntry The entry which will be sent in the batch feed as an insert request. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. Note that batch_ids should either always be specified or never, mixing could potentially result in duplicate batch ids.` add_query(self, url_string=None, entry=None, batch_id_string=None) `Adds a query request to the batch request feed. This method takes either the url_string which is the query URL whose results will be added to the result feed. The query URL will be encapsulated in a BatchEntry, and you may pass in the BatchEntry with a query URL instead of sending a url_string. Args: url_string: str (optional) entry: BatchEntry (optional) batch_id_string: str (optional) Raises: MissingRequiredParameters` add_update(self, entry, batch_id_string=None) `Add an update request to the list of batch operations in this feed. Sets the operation type of the entry to insert if it is not already set and assigns the desired batch id to the entry so that it can be referenced in the server's response. Args: entry: BatchEntry The entry which will be sent to the server as an update (HTTP PUT) request. The item must have a valid atom id so that the server knows which entry to replace. batch_id_string: str (optional) The batch ID to be used to reference this batch operation in the results feed. If this parameter is None, the current length of the feed's entry array will be used as a count. See also comments for AddInsert.` find_batch_link(self) Data and other attributes inherited from gdata.data.BatchFeed: interrupted = <class 'gdata.data.BatchInterrupted'> `The batch:interrupted element sent if batch request was interrupted. Only appears in a feed if some of the batch entries could not be processed. See: http://code.google.com/apis/gdata/batch.html#Handling_Errors` Methods inherited from gdata.data.GDFeed: GetId = get_id(self) get_generator(self) get_id(self) Data and other attributes inherited from gdata.data.GDFeed: etag = '{http://schemas.google.com/g/2005}etag' items_per_page = <class 'gdata.data.ItemsPerPage'> `The opensearch:itemsPerPage element in GData feed.` start_index = <class 'gdata.data.StartIndex'> `The opensearch:startIndex element in GData feed.` total_results = <class 'gdata.data.TotalResults'> `opensearch:TotalResults for a GData feed.` Data and other attributes inherited from atom.data.Source: generator = <class 'atom.data.Generator'> `The atom:generator element.` icon = <class 'atom.data.Icon'> `The atom:icon element.` logo = <class 'atom.data.Logo'> `The atom:logo element.` subtitle = <class 'atom.data.Subtitle'> `The atom:subtitle element.` Methods inherited from atom.data.FeedEntryParent: __init__(self, atom_id=None, text=None, *args, **kwargs) Data and other attributes inherited from atom.data.FeedEntryParent: author = [<class 'atom.data.Author'>] category = [<class 'atom.data.Category'>] contributor = [<class 'atom.data.Contributor'>] id = <class 'atom.data.Id'> `The atom:id element.` link = [<class 'atom.data.Link'>] rights = <class 'atom.data.Rights'> `The atom:rights element.` title = <class 'atom.data.Title'> `The atom:title element.` updated = <class 'atom.data.Updated'> `The atom:updated element.` Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None Methods inherited from gdata.data.LinkFinder: FindAclLink = find_acl_link(self) FindFeedLink = find_feed_link(self) FindHtmlLink = find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` FindPostLink = find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` FindPreviousLink = find_previous_link(self) GetAclLink = get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` GetFeedLink = get_feed_link(self) GetHtmlLink = get_html_link(self) GetPostLink = get_post_link(self) GetPreviousLink = get_previous_link(self) find_acl_link(self) find_feed_link(self) find_html_link(self) `Finds the first link with rel of alternate and type of text/html.` find_post_link(self) `Get the URL to which new entries should be POSTed. The POST target URL is used to insert new entries. Returns: A str for the URL in the link with a rel matching the POST type.` find_previous_link(self) get_acl_link(self) `Searches for a link or feed_link (if present) with the rel for ACL.` get_feed_link(self) get_html_link(self) get_post_link(self) get_previous_link(self) Methods inherited from atom.data.LinkFinder: FindAlternateLink = find_alternate_link(self) FindEditLink = find_edit_link(self) FindEditMediaLink = find_edit_media_link(self) FindLicenseLink = find_license_link(self) FindNextLink = find_next_link(self) FindSelfLink = find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` FindUrl = find_url(self, rel) `Returns the URL in a link with the desired rel value.` GetAlternateLink = get_alternate_link(self) GetEditLink = get_edit_link(self) GetEditMediaLink = get_edit_media_link(self) GetLicenseLink = get_license_link(self) GetLink = get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` GetNextLink = get_next_link(self) GetSelfLink = get_self_link(self) find_alternate_link(self) find_edit_link(self) find_edit_media_link(self) find_license_link(self) find_next_link(self) find_self_link(self) `Find the first link with rel set to 'self' Returns: A str containing the link's href or None if none of the links had rel equal to 'self'` find_url(self, rel) `Returns the URL in a link with the desired rel value.` get_alternate_link(self) get_edit_link(self) get_edit_media_link(self) get_license_link(self) get_link(self, rel) `Returns a link object which has the desired rel value. If you are interested in the URL instead of the link object, consider using find_url instead.` get_next_link(self) get_self_link(self)
class Region(atom.core.XmlElement)
`` | `A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.`
| Method resolution order: Region atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Relation(atom.core.XmlElement)
`` | `This element describe another entity (usually a person) that is in a relation of some kind with the contact.`
| Method resolution order: Relation atom.core.XmlElement __builtin__.object Data and other attributes defined here: label = 'label' rel = 'rel' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Sensitivity(atom.core.XmlElement)
`` | `Classifies sensitivity of the contact into the following categories: * Confidential * Normal * Personal * Private The sensitivity element cannot be repeated.`
| Method resolution order: Sensitivity atom.core.XmlElement __builtin__.object Data and other attributes defined here: rel = 'rel' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Street(atom.core.XmlElement)
`` | `Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.`
| Method resolution order: Street atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class SubRegion(atom.core.XmlElement)
`` | `Handles administrative districts such as U.S. or U.K. counties that are not used for mail addressing purposes. Subregion is not intended for delivery addresses.`
| Method resolution order: SubRegion atom.core.XmlElement __builtin__.object Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class SystemGroup(atom.core.XmlElement)
`` | `The contacts systemGroup element. When used within a contact group entry, indicates that the group in question is one of the predefined system groups.`
| Method resolution order: SystemGroup atom.core.XmlElement __builtin__.object Data and other attributes defined here: id = 'id' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class UserDefinedField(atom.core.XmlElement)
`` | `Represents an arbitrary key-value pair attached to the contact.`
| Method resolution order: UserDefinedField atom.core.XmlElement __builtin__.object Data and other attributes defined here: key = 'key' value = 'value' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None
class Website(atom.core.XmlElement)
`` | `Describes websites associated with the contact, including links. May be repeated.`
| Method resolution order: Website atom.core.XmlElement __builtin__.object Data and other attributes defined here: href = 'href' label = 'label' primary = 'primary' rel = 'rel' Methods inherited from atom.core.XmlElement: FindChildren = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` FindExtensions = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` GetAttributes = get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` GetElements = get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` ToString = to_string(self, version=1, encoding=None) `Converts this object to XML.` __init__(self, text=None, *args, **kwargs) __str__(self) get_attributes(self, tag=None, namespace=None, version=1) `Find all attributes which match the tag and namespace. To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object's members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching attributes. Returns: A list of XmlAttribute objects for the matching attributes.` get_elements(self, tag=None, namespace=None, version=1) `Find all sub elements which match the tag and namespace. To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object's members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class. Args: tag: str namespace: str version: int Specifies the version of the XML rules to be used when searching for matching elements. Returns: A list of the matching XmlElements.` to_string(self, version=1, encoding=None) `Converts this object to XML.` Data descriptors inherited from atom.core.XmlElement: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` attributes children extension_attributes extension_elements namespace tag Data and other attributes inherited from atom.core.XmlElement: text = None

Functions
`` |  | ExternalIdFromString(xml_string) ProfileEntryFromString(xml_string) `Converts an XML string into a ProfileEntry object. Args: xml_string: string The XML describing a Profile entry. Returns: A ProfileEntry object corresponding to the given XML.` ProfilesFeedFromString(xml_string) `Converts an XML string into a ProfilesFeed object. Args: xml_string: string The XML describing a Profiles feed. Returns: A ProfilesFeed object corresponding to the given XML.` UserDefinedFieldFromString(xml_string) WebsiteFromString(xml_string)

Data
`` |  | CONTACTS_NAMESPACE = 'http://schemas.google.com/contact/2008' CONTACTS_TEMPLATE = '{http://schemas.google.com/contact/2008}%s' EXTERNAL_ID_ORGANIZATION = 'organization' PHOTO_EDIT_LINK_REL = 'http://schemas.google.com/contacts/2008/rel#edit-photo' PHOTO_LINK_REL = 'http://schemas.google.com/contacts/2008/rel#photo' RELATION_MANAGER = 'manager' __author__ = 'vinces1979@gmail.com (Vince Spicer)'

Author
`` |  | vinces1979@gmail.com (Vince Spicer)