| | |
- gdata.apps.apps_property_entry.AppsPropertyEntry(gdata.data.GDEntry)
-
- AliasEntry
- UserEntry
- UserRenameRequest
- gdata.data.GDFeed(atom.data.Feed, gdata.data.LinkFinder)
-
- AliasFeed
- UserFeed
class AliasEntry(gdata.apps.apps_property_entry.AppsPropertyEntry) |
| |
Represents an Alias in object form.
|
| |
- Method resolution order:
- AliasEntry
- gdata.apps.apps_property_entry.AppsPropertyEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- GetAliasEmail(self)
- Get the alias email address of the Alias object.
Returns:
The alias email address of this Alias object as a string or None.
- GetUserEmail(self)
- Get the user email address of the Alias object.
Returns:
The user email address of this Alias object as a string or None.
- SetAliasEmail(self, value)
- Set the alias email address of this Alias object.
Args:
value: string The new alias email address to give this object.
- SetUserEmail(self, value)
- Set the user email address of this Alias object.
Args:
value: string The new user email address to give this object.
- __init__(self, user_email=None, alias_email=None, *args, **kwargs)
- Constructs a new AliasEntry object with the given arguments.
Args:
user_email: string (optional) The user email address for the object.
alias_email: string (optional) The alias email address for the object.
args: The other parameters to pass to gdata.entry.GDEntry constructor.
kwargs: The other parameters to pass to gdata.entry.GDEntry constructor.
Data descriptors defined here:
- alias_email
- Get the alias email address of the Alias object.
Returns:
The alias email address of this Alias object as a string or None.
- user_email
- Get the user email address of the Alias object.
Returns:
The user email address of this Alias object as a string or None.
Data and other attributes inherited from gdata.apps.apps_property_entry.AppsPropertyEntry:
- property = [<class 'gdata.apps_property.AppsProperty'>]
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.
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, pretty_print=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, pretty_print=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 (as a string) 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 (as a string) 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 AliasFeed(gdata.data.GDFeed) |
| |
Represents a feed of AliasEntry objects.
|
| |
- Method resolution order:
- AliasFeed
- 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.apps.multidomain.data.AliasEntry'>]
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, pretty_print=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, pretty_print=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 (as a string) 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 (as a string) 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 UserEntry(gdata.apps.apps_property_entry.AppsPropertyEntry) |
| |
Represents an User in object form.
|
| |
- Method resolution order:
- UserEntry
- gdata.apps.apps_property_entry.AppsPropertyEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- GetAgreedToTerms(self)
- Get the agreed to terms flag of the User object.
Returns:
The agreed to terms flag of this User object as a string or None.
- GetChangePasswordAtNextLogin(self)
- Get the change password at next login flag of the User object.
Returns:
The change password at next login flag of this User object as a string or
None.
- GetEmail(self)
- Get the email address of the User object.
Returns:
The email address of this User object as a string or None.
- GetFirstName(self)
- Get the first name of the User object.
Returns:
The first name of this User object as a string or None.
- GetHashFunction(self)
- Get the hash function of the User object.
Returns:
The hash function of this User object as a string or None.
- GetIpWhitelisted(self)
- Get the ipWhitelisted flag of the User object.
Returns:
The ipWhitelisted flag of this User object as a string or None.
- GetIsAdmin(self)
- Get the isAdmin flag of the User object.
Returns:
The isAdmin flag of this User object as a string or None.
- GetLastName(self)
- Get the last name of the User object.
Returns:
The last name of this User object as a string or None.
- GetPassword(self)
- Get the password of the User object.
Returns:
The password of this User object as a string or None.
- GetQuota(self)
- Get the quota of the User object.
Returns:
The quota of this User object as a string or None.
- GetSuspended(self)
- Get the suspended flag of the User object.
Returns:
The suspended flag of this User object as a string or None.
- SetChangePasswordAtNextLogin(self, value)
- Set the change password at next login flag of this User object.
Args:
value: string The new change password at next login flag to give this
object.
- SetEmail(self, value)
- Set the email address of this User object.
Args:
value: string The new email address to give this object.
- SetFirstName(self, value)
- Set the first name of this User object.
Args:
value: string The new first name to give this object.
- SetHashFunction(self, value)
- Set the hash function of this User object.
Args:
value: string The new hash function to give this object.
- SetIpWhitelisted(self, value)
- Set the ipWhitelisted flag of this User object.
Args:
value: string The new ipWhitelisted flag to give this object.
- SetIsAdmin(self, value)
- Set the isAdmin flag of this User object.
Args:
value: string The new isAdmin flag to give this object.
- SetLastName(self, value)
- Set the last name of this User object.
Args:
value: string The new last name to give this object.
- SetPassword(self, value)
- Set the password of this User object.
Args:
value: string The new password to give this object.
- SetQuota(self, value)
- Set the quota of this User object.
Args:
value: string The new quota to give this object.
- SetSuspended(self, value)
- Set the suspended flag of this User object.
Args:
value: string The new suspended flag to give this object.
- __init__(self, uri=None, email=None, first_name=None, last_name=None, password=None, hash_function=None, change_password=None, agreed_to_terms=None, suspended=None, is_admin=None, ip_whitelisted=None, quota=None, *args, **kwargs)
- Constructs a new UserEntry object with the given arguments.
Args:
uri: string (optional) The uri of of this object for HTTP requests.
email: string (optional) The email address of the user.
first_name: string (optional) The first name of the user.
last_name: string (optional) The last name of the user.
password: string (optional) The password of the user.
hash_function: string (optional) The name of the function used to hash the
password.
change_password: Boolean (optional) Whether or not the user must change
password at first login.
agreed_to_terms: Boolean (optional) Whether or not the user has agreed to
the Terms of Service.
suspended: Boolean (optional) Whether or not the user is suspended.
is_admin: Boolean (optional) Whether or not the user has administrator
privileges.
ip_whitelisted: Boolean (optional) Whether or not the user's ip is
whitelisted.
quota: string (optional) The value (in GB) of the user's quota.
args: The other parameters to pass to gdata.entry.GDEntry constructor.
kwargs: The other parameters to pass to gdata.entry.GDEntry constructor.
Data descriptors defined here:
- agreed_to_terms
- Get the agreed to terms flag of the User object.
Returns:
The agreed to terms flag of this User object as a string or None.
- change_password_at_next_login
- Get the change password at next login flag of the User object.
Returns:
The change password at next login flag of this User object as a string or
None.
- email
- Get the email address of the User object.
Returns:
The email address of this User object as a string or None.
- first_name
- Get the first name of the User object.
Returns:
The first name of this User object as a string or None.
- hash_function
- Get the hash function of the User object.
Returns:
The hash function of this User object as a string or None.
- ip_whitelisted
- Get the ipWhitelisted flag of the User object.
Returns:
The ipWhitelisted flag of this User object as a string or None.
- is_admin
- Get the isAdmin flag of the User object.
Returns:
The isAdmin flag of this User object as a string or None.
- last_name
- Get the last name of the User object.
Returns:
The last name of this User object as a string or None.
- password
- Get the password of the User object.
Returns:
The password of this User object as a string or None.
- quota
- Get the quota of the User object.
Returns:
The quota of this User object as a string or None.
- suspended
- Get the suspended flag of the User object.
Returns:
The suspended flag of this User object as a string or None.
Data and other attributes inherited from gdata.apps.apps_property_entry.AppsPropertyEntry:
- property = [<class 'gdata.apps_property.AppsProperty'>]
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.
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, pretty_print=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, pretty_print=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 (as a string) 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 (as a string) 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 UserFeed(gdata.data.GDFeed) |
| |
Represents a feed of UserEntry objects.
|
| |
- Method resolution order:
- UserFeed
- 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.apps.multidomain.data.UserEntry'>]
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, pretty_print=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, pretty_print=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 (as a string) 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 (as a string) 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 UserRenameRequest(gdata.apps.apps_property_entry.AppsPropertyEntry) |
| |
Represents an User rename request in object form.
|
| |
- Method resolution order:
- UserRenameRequest
- gdata.apps.apps_property_entry.AppsPropertyEntry
- gdata.data.GDEntry
- atom.data.Entry
- atom.data.FeedEntryParent
- atom.core.XmlElement
- gdata.data.LinkFinder
- atom.data.LinkFinder
- __builtin__.object
Methods defined here:
- GetNewEmail(self)
- Get the new email address for the User object.
Returns:
The new email address for the User object as a string or None.
- SetNewEmail(self, value)
- Set the new email address for the User object.
Args:
value: string The new email address to give this object.
- __init__(self, new_email=None, *args, **kwargs)
- Constructs a new UserRenameRequest object with the given arguments.
Args:
new_email: string (optional) The new email address for the target user.
args: The other parameters to pass to gdata.entry.GDEntry constructor.
kwargs: The other parameters to pass to gdata.entry.GDEntry constructor.
Data descriptors defined here:
- new_email
- Get the new email address for the User object.
Returns:
The new email address for the User object as a string or None.
Data and other attributes inherited from gdata.apps.apps_property_entry.AppsPropertyEntry:
- property = [<class 'gdata.apps_property.AppsProperty'>]
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.
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, pretty_print=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, pretty_print=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 (as a string) 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 (as a string) 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)
| |