Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
joshourisman
joshourisman / gdata python
Repository URL to install this package:
|
Version:
2.1.0.jo1 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module gdata.sites.client</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="gdata.html"><font color="#ffffff">gdata</font></a>.<a href="gdata.sites.html"><font color="#ffffff">sites</font></a>.client</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/sites/client.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/sites/client.py</a></font></td></tr></table>
<p><tt><a href="#SitesClient">SitesClient</a> extends gdata.client.<a href="gdata.client.html#GDClient">GDClient</a> to streamline Sites API calls.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="atom.html">atom</a><br>
</td><td width="25%" valign=top><a href="gdata.html">gdata</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="gdata.client.html#GDClient">gdata.client.GDClient</a>(<a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.sites.client.html#SitesClient">SitesClient</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="SitesClient">class <strong>SitesClient</strong></a>(<a href="gdata.client.html#GDClient">gdata.client.GDClient</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Client extension for the Google Sites API service.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.sites.client.html#SitesClient">SitesClient</a></dd>
<dd><a href="gdata.client.html#GDClient">gdata.client.GDClient</a></dd>
<dd><a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="SitesClient-CreatePage"><strong>CreatePage</strong></a> = <a href="#SitesClient-create_page">create_page</a>(self, kind, title, html<font color="#909090">=''</font>, page_name<font color="#909090">=None</font>, parent<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, template<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-CreateSite"><strong>CreateSite</strong></a> = <a href="#SitesClient-create_site">create_site</a>(self, title, description<font color="#909090">=None</font>, source_site<font color="#909090">=None</font>, theme<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-CreateWebAttachment"><strong>CreateWebAttachment</strong></a> = <a href="#SitesClient-create_webattachment">create_webattachment</a>(self, src, content_type, title, parent, description<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-DownloadAttachment"><strong>DownloadAttachment</strong></a> = <a href="#SitesClient-download_attachment">download_attachment</a>(self, uri_or_entry, file_path)</dt></dl>
<dl><dt><a name="SitesClient-GetAclFeed"><strong>GetAclFeed</strong></a> = <a href="#SitesClient-get_acl_feed">get_acl_feed</a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-GetActivityFeed"><strong>GetActivityFeed</strong></a> = <a href="#SitesClient-get_activity_feed">get_activity_feed</a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-GetContentFeed"><strong>GetContentFeed</strong></a> = <a href="#SitesClient-get_content_feed">get_content_feed</a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-GetRevisionFeed"><strong>GetRevisionFeed</strong></a> = <a href="#SitesClient-get_revision_feed">get_revision_feed</a>(self, entry_or_uri_or_id, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-GetSiteFeed"><strong>GetSiteFeed</strong></a> = <a href="#SitesClient-get_site_feed">get_site_feed</a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-MakeAclFeedUri"><strong>MakeAclFeedUri</strong></a> = <a href="#SitesClient-make_acl_feed_uri">make_acl_feed_uri</a>(self)</dt></dl>
<dl><dt><a name="SitesClient-MakeActivityFeedUri"><strong>MakeActivityFeedUri</strong></a> = <a href="#SitesClient-make_activity_feed_uri">make_activity_feed_uri</a>(self)</dt></dl>
<dl><dt><a name="SitesClient-MakeContentFeedUri"><strong>MakeContentFeedUri</strong></a> = <a href="#SitesClient-make_content_feed_uri">make_content_feed_uri</a>(self)</dt></dl>
<dl><dt><a name="SitesClient-MakeRevisionFeedUri"><strong>MakeRevisionFeedUri</strong></a> = <a href="#SitesClient-make_revision_feed_uri">make_revision_feed_uri</a>(self)</dt></dl>
<dl><dt><a name="SitesClient-MakeSiteFeedUri"><strong>MakeSiteFeedUri</strong></a> = <a href="#SitesClient-make_site_feed_uri">make_site_feed_uri</a>(self, site_name<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="SitesClient-UploadAttachment"><strong>UploadAttachment</strong></a> = <a href="#SitesClient-upload_attachment">upload_attachment</a>(self, file_handle, parent, content_type<font color="#909090">=None</font>, title<font color="#909090">=None</font>, description<font color="#909090">=None</font>, folder_name<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-__init__"><strong>__init__</strong></a>(self, site<font color="#909090">=None</font>, domain<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Constructs a new client for the Sites API.<br>
<br>
Args:<br>
site: string (optional) Name (webspace) of the Google Site<br>
domain: string (optional) Domain of the (Google Apps hosted) Site.<br>
If no domain is given, the Site is assumed to be a consumer Google<br>
Site, in which case the value 'site' is used.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a><br>
constructor.</tt></dd></dl>
<dl><dt><a name="SitesClient-create_page"><strong>create_page</strong></a>(self, kind, title, html<font color="#909090">=''</font>, page_name<font color="#909090">=None</font>, parent<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, template<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a new page (specified by kind) on a Google Site.<br>
<br>
Args:<br>
kind: string The type of page/item to create. For example, webpage,<br>
listpage, comment, announcementspage, filecabinet, etc. The full list<br>
of supported kinds can be found in gdata.sites.gdata.SUPPORT_KINDS.<br>
title: string Title for the page.<br>
html: string (optional) XHTML for the page's content body.<br>
page_name: string (optional) The URL page name to set. If not set, the<br>
title will be normalized and used as the page's URL path.<br>
parent: string or gdata.sites.data.ContentEntry (optional) The parent<br>
entry or parent link url to create the page under.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
template: string or gdata.sites.data.ContentEntry (optional) Create page<br>
using the given template. Any content elements will be discarded as<br>
they are not valid when creating a page from a template.<br>
kwargs: Other parameters to pass to gdata.client.<a href="#SitesClient-post">post</a>().<br>
<br>
Returns:<br>
gdata.sites.data.ContentEntry of the created page.</tt></dd></dl>
<dl><dt><a name="SitesClient-create_site"><strong>create_site</strong></a>(self, title, description<font color="#909090">=None</font>, source_site<font color="#909090">=None</font>, theme<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a new Google Site.<br>
<br>
Note: This feature is only available to Google Apps domains.<br>
<br>
Args:<br>
title: string Title for the site.<br>
description: string (optional) A description/summary for the site.<br>
source_site: string (optional) The site feed URI of the site to copy.<br>
This parameter should only be specified when copying a site.<br>
theme: string (optional) The name of the theme to create the site with.<br>
uri: string (optional) A full site feed URI to override where the site<br>
is created/copied. By default, the site will be created under<br>
the currently set domain (e.g. self.<strong>domain</strong>).<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: Other parameters to pass to gdata.client.<a href="#SitesClient-post">post</a>().<br>
<br>
Returns:<br>
gdata.sites.data.SiteEntry of the created site.</tt></dd></dl>
<dl><dt><a name="SitesClient-create_webattachment"><strong>create_webattachment</strong></a>(self, src, content_type, title, parent, description<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a new webattachment within a filecabinet.<br>
<br>
Args:<br>
src: string The url of the web attachment.<br>
content_type: string The MIME type of the web attachment.<br>
title: string The title to name the web attachment.<br>
parent: string or gdata.sites.data.ContentEntry (optional) The<br>
parent entry or url of the filecabinet to create the attachment under.<br>
description: string (optional) A summary/description for the attachment.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: Other parameters to pass to gdata.client.<a href="#SitesClient-post">post</a>().<br>
<br>
Returns:<br>
gdata.sites.data.ContentEntry of the created page.</tt></dd></dl>
<dl><dt><a name="SitesClient-download_attachment"><strong>download_attachment</strong></a>(self, uri_or_entry, file_path)</dt><dd><tt>Downloads an attachment file to disk.<br>
<br>
Args:<br>
uri_or_entry: string The full URL to download the file from.<br>
file_path: string The full path to save the file to.<br>
<br>
Raises:<br>
gdata.client.RequestError: on error response from server.</tt></dd></dl>
<dl><dt><a name="SitesClient-get_acl_feed"><strong>get_acl_feed</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves the acl feed containing a site's sharing permissions.<br>
<br>
Args:<br>
uri: string (optional) A full URI to query the acl feed.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: Other parameters to pass to <a href="#SitesClient-get_feed">get_feed</a>().<br>
<br>
Returns:<br>
gdata.sites.data.AclFeed</tt></dd></dl>
<dl><dt><a name="SitesClient-get_activity_feed"><strong>get_activity_feed</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves the activity feed containing recent Site activity.<br>
<br>
Args:<br>
uri: string (optional) A full URI to query the Activity feed.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: Other parameters to pass to <a href="#SitesClient-get_feed">get_feed</a>().<br>
<br>
Returns:<br>
gdata.sites.data.ActivityFeed</tt></dd></dl>
<dl><dt><a name="SitesClient-get_content_feed"><strong>get_content_feed</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves the content feed containing the current state of site.<br>
<br>
Args:<br>
uri: string (optional) A full URI to query the Content feed with.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: Other parameters to pass to <a href="#SitesClient-get_feed">get_feed</a>().<br>
<br>
Returns:<br>
gdata.sites.data.ContentFeed</tt></dd></dl>
<dl><dt><a name="SitesClient-get_revision_feed"><strong>get_revision_feed</strong></a>(self, entry_or_uri_or_id, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves the revision feed containing the revision history for a node.<br>
<br>
Args:<br>
entry_or_uri_or_id: string or gdata.sites.data.ContentEntry A full URI,<br>
content entry node ID, or a content entry object of the entry to<br>
retrieve revision information for.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: Other parameters to pass to <a href="#SitesClient-get_feed">get_feed</a>().<br>
<br>
Returns:<br>
gdata.sites.data.RevisionFeed</tt></dd></dl>
<dl><dt><a name="SitesClient-get_site_feed"><strong>get_site_feed</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves the site feed containing a list of sites a user has access to.<br>
<br>
Args:<br>
uri: string (optional) A full URI to query the site feed.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: Other parameters to pass to <a href="#SitesClient-get_feed">get_feed</a>().<br>
<br>
Returns:<br>
gdata.sites.data.SiteFeed</tt></dd></dl>
<dl><dt><a name="SitesClient-make_acl_feed_uri"><strong>make_acl_feed_uri</strong></a>(self)</dt></dl>
<dl><dt><a name="SitesClient-make_activity_feed_uri"><strong>make_activity_feed_uri</strong></a>(self)</dt></dl>
<dl><dt><a name="SitesClient-make_content_feed_uri"><strong>make_content_feed_uri</strong></a>(self)</dt></dl>
<dl><dt><a name="SitesClient-make_revision_feed_uri"><strong>make_revision_feed_uri</strong></a>(self)</dt></dl>
<dl><dt><a name="SitesClient-make_site_feed_uri"><strong>make_site_feed_uri</strong></a>(self, site_name<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="SitesClient-upload_attachment"><strong>upload_attachment</strong></a>(self, file_handle, parent, content_type<font color="#909090">=None</font>, title<font color="#909090">=None</font>, description<font color="#909090">=None</font>, folder_name<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Uploads an attachment to a parent page.<br>
<br>
Args:<br>
file_handle: MediaSource or string A gdata.data.MediaSource object<br>
containing the file to be uploaded or the full path name to the<br>
file on disk.<br>
parent: gdata.sites.data.ContentEntry or string The parent page to<br>
upload the file to or the full URI of the entry's self link.<br>
content_type: string (optional) The MIME type of the file<br>
(e.g 'application/pdf'). This should be provided if file is not a<br>
MediaSource object.<br>
title: string (optional) The title to name the attachment. If not<br>
included, the filepath or media source's filename is used.<br>
description: string (optional) A summary/description for the attachment.<br>
folder_name: string (optional) The name of an existing folder to upload<br>
the attachment to. This only applies when the parent parameter points<br>
to a filecabinet entry.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the user's data.<br>
kwargs: Other parameters to pass to __upload().<br>
<br>
Returns:<br>
A gdata.sites.data.ContentEntry containing information about the created<br>
attachment.</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>api_version</strong> = '1.1'</dl>
<dl><dt><strong>auth_scopes</strong> = ('http://sites.google.com/feeds/', 'https://sites.google.com/feeds/')</dl>
<dl><dt><strong>auth_service</strong> = 'jotspot'</dl>
<dl><dt><strong>domain</strong> = 'site'</dl>
<dl><dt><strong>host</strong> = 'sites.google.com'</dl>
<dl><dt><strong>ssl</strong> = True</dl>
<hr>
Methods inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br>
<dl><dt><a name="SitesClient-Batch"><strong>Batch</strong></a> = batch(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br>
<br>
Args:<br>
feed: A batch feed containing batch entries, each is an operation.<br>
uri: (optional) The uri to which the batch request feed should be POSTed.<br>
If none is provided, then the feed's edit link will be used.<br>
force: (optional) boolean set to True if you want the batch update to<br>
clobber all data. If False, the version in the information in the<br>
feed object will cause the server to check to see that no changes<br>
intervened between when you fetched the data and when you sent the<br>
changes.<br>
auth_token: (optional) An object which sets the Authorization HTTP header<br>
in its modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.</tt></dd></dl>
<dl><dt><a name="SitesClient-ClientLogin"><strong>ClientLogin</strong></a> = client_login(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br>
<br>
In order to modify user specific data and read user private data, your<br>
application must be authorized by the user. One way to demonstrage<br>
authorization is by including a Client Login token in the Authorization<br>
HTTP header of all requests. This method requests the Client Login token<br>
by sending the user's email address, password, the name of the<br>
application, and the service code for the service which will be accessed<br>
by the application. If the username and password are correct, the server<br>
will respond with the client login code and a new ClientLoginToken<br>
object will be set in the client's auth_token member. With the auth_token<br>
set, future requests from this client will include the Client Login<br>
token.<br>
<br>
For a list of service names, see <br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
For more information on Client Login, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
email: str The user's email address or username.<br>
password: str The password for the user's account.<br>
source: str The name of your application. This can be anything you<br>
like but should should give some indication of which app is<br>
making the request.<br>
service: str The service code for the service you would like to access.<br>
For example, 'cp' for contacts, 'cl' for calendar. For a full<br>
list see<br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br>
service will usually be filled in for you so you do not need<br>
to specify it. For example see BloggerClient,<br>
SpreadsheetsClient, etc.<br>
account_type: str (optional) The type of account which is being<br>
authenticated. This can be either 'GOOGLE' for a Google<br>
Account, 'HOSTED' for a Google Apps Account, or the<br>
default 'HOSTED_OR_GOOGLE' which will select the Google<br>
Apps Account if the same email address is used for both<br>
a Google Account and a Google Apps Account.<br>
auth_url: str (optional) The URL to which the login request should be<br>
sent.<br>
captcha_token: str (optional) If a previous login attempt was reponded<br>
to with a CAPTCHA challenge, this is the token which<br>
identifies the challenge (from the CAPTCHA's URL).<br>
captcha_response: str (optional) If a previous login attempt was<br>
reponded to with a CAPTCHA challenge, this is the<br>
response text which was contained in the challenge.<br>
<br>
Returns:<br>
Generated token, which is also stored in this object.<br>
<br>
Raises:<br>
A RequestError or one of its suclasses: BadAuthentication,<br>
BadAuthenticationServiceURL, ClientLoginFailed,<br>
ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>
<dl><dt><a name="SitesClient-Delete"><strong>Delete</strong></a> = delete(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-GetAccessToken"><strong>GetAccessToken</strong></a> = get_access_token(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br>
<br>
Contacts the Google OAuth server to upgrade a previously authorized<br>
request token. Once the request token is upgraded to an access token,<br>
the access token may be used to access the user's data.<br>
<br>
For more details, see the Google Accounts OAuth documentation:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br>
<br>
Args:<br>
request_token: An OAuth token which has been authorized by the user.<br>
url: (optional) The URL to which the upgrade request should be sent.<br>
Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>
<dl><dt><a name="SitesClient-GetEntry"><strong>GetEntry</strong></a> = get_entry(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-GetFeed"><strong>GetFeed</strong></a> = get_feed(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-GetNext"><strong>GetNext</strong></a> = get_next(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br>
<br>
When requesting a feed, the number of entries returned is capped at a<br>
service specific default limit (often 25 entries). You can specify your<br>
own entry-count cap using the max-results URL query parameter. If there<br>
are more results than could fit under max-results, the feed will contain<br>
a next link. This method performs a GET against this next results URL.<br>
<br>
Returns:<br>
A new feed object containing the next set of entries in this feed.</tt></dd></dl>
<dl><dt><a name="SitesClient-GetOAuthToken"><strong>GetOAuthToken</strong></a> = get_oauth_token(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br>
<br>
Once this client has a request token, the user can authorize the request<br>
token by visiting the authorization URL in their browser. After being<br>
redirected back to this app at the 'next' URL, this app can then exchange<br>
the authorized request token for an access token.<br>
<br>
For more information see the documentation on Google Accounts with OAuth:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br>
<br>
Args:<br>
scopes: list of strings or atom.http_core.Uri objects which specify the<br>
URL prefixes which this app will be accessing. For example, to access<br>
the Google Calendar API, you would want to use scopes:<br>
['https://www.google.com/calendar/feeds/',<br>
'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br>
next: str or atom.http_core.Uri object, The URL which the user's browser<br>
should be sent to after they authorize access to their data. This<br>
should be a URL in your application which will read the token<br>
information from the URL and upgrade the request token to an access<br>
token.<br>
consumer_key: str This is the identifier for this application which you<br>
should have received when you registered your application with Google<br>
to use OAuth.<br>
consumer_secret: str (optional) The shared secret between your app and<br>
Google which provides evidence that this request is coming from you<br>
application and not another app. If present, this libraries assumes<br>
you want to use an HMAC signature to verify requests. Keep this data<br>
a secret.<br>
rsa_private_key: str (optional) The RSA private key which is used to<br>
generate a digital signature which is checked by Google's server. If<br>
present, this library assumes that you want to use an RSA signature<br>
to verify requests. Keep this data a secret.<br>
url: The URL to which a request for a token should be made. The default<br>
is Google's OAuth request token provider.</tt></dd></dl>
<dl><dt><a name="SitesClient-ModifyRequest"><strong>ModifyRequest</strong></a> = modify_request(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br>
<br>
This client will add the API version if it is specified.<br>
Subclasses may override this method to add their own request<br>
modifications before the request is made.</tt></dd></dl>
<dl><dt><a name="SitesClient-Post"><strong>Post</strong></a> = post(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-Request"><strong>Request</strong></a> = request(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br>
<br>
See also documentation for atom.client.AtomPubClient.request.<br>
<br>
If a 302 redirect is sent from the server to the client, this client<br>
assumes that the redirect is in the form used by the Google Calendar API.<br>
The same request URI and method will be used as in the original request,<br>
but a gsessionid URL parameter will be added to the request URI with<br>
the value provided in the server's 302 redirect response. If the 302<br>
redirect is not in the format specified by the Google Calendar API, a<br>
RedirectError will be raised containing the body of the server's<br>
response.<br>
<br>
The method calls the client's modify_request method to make any changes<br>
required by the client before the request is made. For example, a<br>
version 2 client could add a GData-Version: 2 header to the request in<br>
its modify_request method.<br>
<br>
Args:<br>
method: str The HTTP verb for this request, usually 'GET', 'POST',<br>
'PUT', or 'DELETE'<br>
uri: atom.http_core.Uri, str, or unicode The URL being requested.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.<br>
http_request: (optional) atom.http_core.HttpRequest<br>
converter: function which takes the body of the response as its only<br>
argument and returns the desired object.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned.<br>
redirects_remaining: (optional) int, if this number is 0 and the<br>
server sends a 302 redirect, the request method<br>
will raise an exception. This parameter is used in<br>
recursive request calls to avoid an infinite loop.<br>
<br>
Any additional arguments are passed through to<br>
atom.client.AtomPubClient.request.<br>
<br>
Returns:<br>
An HTTP response object (see atom.http_core.HttpResponse for a<br>
description of the object's interface) if no converter was<br>
specified and no desired_class was specified. If a converter function<br>
was provided, the results of calling the converter are returned. If no<br>
converter was specified but a desired_class was provided, the response<br>
body will be converted to the class using<br>
atom.core.parse.</tt></dd></dl>
<dl><dt><a name="SitesClient-RequestClientLoginToken"><strong>RequestClientLoginToken</strong></a> = request_client_login_token(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="SitesClient-RevokeToken"><strong>RevokeToken</strong></a> = revoke_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br>
<br>
This method can be used for both AuthSub and OAuth tokens (to invalidate<br>
a ClientLogin token, the user must change their password).<br>
<br>
Returns:<br>
True if the server responded with a 200.<br>
<br>
Raises:<br>
A RequestError if the server responds with a non-200 status.</tt></dd></dl>
<dl><dt><a name="SitesClient-Update"><strong>Update</strong></a> = update(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br>
<br>
Performs a PUT and converts the response to a new entry object with a<br>
matching class to the entry passed in.<br>
<br>
Args:<br>
entry:<br>
auth_token:<br>
force: boolean stating whether an update should be forced. Defaults to<br>
False. Normally, if a change has been made since the passed in<br>
entry was obtained, the server will not overwrite the entry since<br>
the changes were based on an obsolete version of the entry.<br>
Setting force to True will cause the update to silently<br>
overwrite whatever version is present.<br>
uri: The uri to put to. If provided, this uri is PUT to rather than the<br>
inferred uri from the entry's edit link.<br>
<br>
Returns:<br>
A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl>
<dl><dt><a name="SitesClient-UpgradeToken"><strong>UpgradeToken</strong></a> = upgrade_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br>
<br>
For details on AuthSub, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br>
(optional) If no token is passed in, the client's auth_token member<br>
is used to request the new token. The token object will be modified<br>
to contain the new session token string.<br>
url: str or atom.http_core.Uri (optional) The URL to which the token<br>
upgrade request should be sent. Defaults to:<br>
https://www.google.com/accounts/AuthSubSessionToken<br>
<br>
Returns:<br>
The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>
<dl><dt><a name="SitesClient-batch"><strong>batch</strong></a>(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br>
<br>
Args:<br>
feed: A batch feed containing batch entries, each is an operation.<br>
uri: (optional) The uri to which the batch request feed should be POSTed.<br>
If none is provided, then the feed's edit link will be used.<br>
force: (optional) boolean set to True if you want the batch update to<br>
clobber all data. If False, the version in the information in the<br>
feed object will cause the server to check to see that no changes<br>
intervened between when you fetched the data and when you sent the<br>
changes.<br>
auth_token: (optional) An object which sets the Authorization HTTP header<br>
in its modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.</tt></dd></dl>
<dl><dt><a name="SitesClient-client_login"><strong>client_login</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br>
<br>
In order to modify user specific data and read user private data, your<br>
application must be authorized by the user. One way to demonstrage<br>
authorization is by including a Client Login token in the Authorization<br>
HTTP header of all requests. This method requests the Client Login token<br>
by sending the user's email address, password, the name of the<br>
application, and the service code for the service which will be accessed<br>
by the application. If the username and password are correct, the server<br>
will respond with the client login code and a new ClientLoginToken<br>
object will be set in the client's auth_token member. With the auth_token<br>
set, future requests from this client will include the Client Login<br>
token.<br>
<br>
For a list of service names, see <br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
For more information on Client Login, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
email: str The user's email address or username.<br>
password: str The password for the user's account.<br>
source: str The name of your application. This can be anything you<br>
like but should should give some indication of which app is<br>
making the request.<br>
service: str The service code for the service you would like to access.<br>
For example, 'cp' for contacts, 'cl' for calendar. For a full<br>
list see<br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br>
service will usually be filled in for you so you do not need<br>
to specify it. For example see BloggerClient,<br>
SpreadsheetsClient, etc.<br>
account_type: str (optional) The type of account which is being<br>
authenticated. This can be either 'GOOGLE' for a Google<br>
Account, 'HOSTED' for a Google Apps Account, or the<br>
default 'HOSTED_OR_GOOGLE' which will select the Google<br>
Apps Account if the same email address is used for both<br>
a Google Account and a Google Apps Account.<br>
auth_url: str (optional) The URL to which the login request should be<br>
sent.<br>
captcha_token: str (optional) If a previous login attempt was reponded<br>
to with a CAPTCHA challenge, this is the token which<br>
identifies the challenge (from the CAPTCHA's URL).<br>
captcha_response: str (optional) If a previous login attempt was<br>
reponded to with a CAPTCHA challenge, this is the<br>
response text which was contained in the challenge.<br>
<br>
Returns:<br>
Generated token, which is also stored in this object.<br>
<br>
Raises:<br>
A RequestError or one of its suclasses: BadAuthentication,<br>
BadAuthenticationServiceURL, ClientLoginFailed,<br>
ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>
<dl><dt><a name="SitesClient-delete"><strong>delete</strong></a>(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-get_access_token"><strong>get_access_token</strong></a>(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br>
<br>
Contacts the Google OAuth server to upgrade a previously authorized<br>
request token. Once the request token is upgraded to an access token,<br>
the access token may be used to access the user's data.<br>
<br>
For more details, see the Google Accounts OAuth documentation:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br>
<br>
Args:<br>
request_token: An OAuth token which has been authorized by the user.<br>
url: (optional) The URL to which the upgrade request should be sent.<br>
Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>
<dl><dt><a name="SitesClient-get_entry"><strong>get_entry</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-get_feed"><strong>get_feed</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-get_next"><strong>get_next</strong></a>(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br>
<br>
When requesting a feed, the number of entries returned is capped at a<br>
service specific default limit (often 25 entries). You can specify your<br>
own entry-count cap using the max-results URL query parameter. If there<br>
are more results than could fit under max-results, the feed will contain<br>
a next link. This method performs a GET against this next results URL.<br>
<br>
Returns:<br>
A new feed object containing the next set of entries in this feed.</tt></dd></dl>
<dl><dt><a name="SitesClient-get_oauth_token"><strong>get_oauth_token</strong></a>(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br>
<br>
Once this client has a request token, the user can authorize the request<br>
token by visiting the authorization URL in their browser. After being<br>
redirected back to this app at the 'next' URL, this app can then exchange<br>
the authorized request token for an access token.<br>
<br>
For more information see the documentation on Google Accounts with OAuth:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br>
<br>
Args:<br>
scopes: list of strings or atom.http_core.Uri objects which specify the<br>
URL prefixes which this app will be accessing. For example, to access<br>
the Google Calendar API, you would want to use scopes:<br>
['https://www.google.com/calendar/feeds/',<br>
'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br>
next: str or atom.http_core.Uri object, The URL which the user's browser<br>
should be sent to after they authorize access to their data. This<br>
should be a URL in your application which will read the token<br>
information from the URL and upgrade the request token to an access<br>
token.<br>
consumer_key: str This is the identifier for this application which you<br>
should have received when you registered your application with Google<br>
to use OAuth.<br>
consumer_secret: str (optional) The shared secret between your app and<br>
Google which provides evidence that this request is coming from you<br>
application and not another app. If present, this libraries assumes<br>
you want to use an HMAC signature to verify requests. Keep this data<br>
a secret.<br>
rsa_private_key: str (optional) The RSA private key which is used to<br>
generate a digital signature which is checked by Google's server. If<br>
present, this library assumes that you want to use an RSA signature<br>
to verify requests. Keep this data a secret.<br>
url: The URL to which a request for a token should be made. The default<br>
is Google's OAuth request token provider.</tt></dd></dl>
<dl><dt><a name="SitesClient-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br>
<br>
This client will add the API version if it is specified.<br>
Subclasses may override this method to add their own request<br>
modifications before the request is made.</tt></dd></dl>
<dl><dt><a name="SitesClient-post"><strong>post</strong></a>(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SitesClient-request"><strong>request</strong></a>(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br>
<br>
See also documentation for atom.client.AtomPubClient.request.<br>
<br>
If a 302 redirect is sent from the server to the client, this client<br>
assumes that the redirect is in the form used by the Google Calendar API.<br>
The same request URI and method will be used as in the original request,<br>
but a gsessionid URL parameter will be added to the request URI with<br>
the value provided in the server's 302 redirect response. If the 302<br>
redirect is not in the format specified by the Google Calendar API, a<br>
RedirectError will be raised containing the body of the server's<br>
response.<br>
<br>
The method calls the client's modify_request method to make any changes<br>
required by the client before the request is made. For example, a<br>
version 2 client could add a GData-Version: 2 header to the request in<br>
its modify_request method.<br>
<br>
Args:<br>
method: str The HTTP verb for this request, usually 'GET', 'POST',<br>
'PUT', or 'DELETE'<br>
uri: atom.http_core.Uri, str, or unicode The URL being requested.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.<br>
http_request: (optional) atom.http_core.HttpRequest<br>
converter: function which takes the body of the response as its only<br>
argument and returns the desired object.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned.<br>
redirects_remaining: (optional) int, if this number is 0 and the<br>
server sends a 302 redirect, the request method<br>
will raise an exception. This parameter is used in<br>
recursive request calls to avoid an infinite loop.<br>
<br>
Any additional arguments are passed through to<br>
atom.client.AtomPubClient.request.<br>
<br>
Returns:<br>
An HTTP response object (see atom.http_core.HttpResponse for a<br>
description of the object's interface) if no converter was<br>
specified and no desired_class was specified. If a converter function<br>
was provided, the results of calling the converter are returned. If no<br>
converter was specified but a desired_class was provided, the response<br>
body will be converted to the class using<br>
atom.core.parse.</tt></dd></dl>
<dl><dt><a name="SitesClient-request_client_login_token"><strong>request_client_login_token</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="SitesClient-revoke_token"><strong>revoke_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br>
<br>
This method can be used for both AuthSub and OAuth tokens (to invalidate<br>
a ClientLogin token, the user must change their password).<br>
<br>
Returns:<br>
True if the server responded with a 200.<br>
<br>
Raises:<br>
A RequestError if the server responds with a non-200 status.</tt></dd></dl>
<dl><dt><a name="SitesClient-update"><strong>update</strong></a>(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br>
<br>
Performs a PUT and converts the response to a new entry object with a<br>
matching class to the entry passed in.<br>
<br>
Args:<br>
entry:<br>
auth_token:<br>
force: boolean stating whether an update should be forced. Defaults to<br>
False. Normally, if a change has been made since the passed in<br>
entry was obtained, the server will not overwrite the entry since<br>
the changes were based on an obsolete version of the entry.<br>
Setting force to True will cause the update to silently<br>
overwrite whatever version is present.<br>
uri: The uri to put to. If provided, this uri is PUT to rather than the<br>
inferred uri from the entry's edit link.<br>
<br>
Returns:<br>
A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl>
<dl><dt><a name="SitesClient-upgrade_token"><strong>upgrade_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br>
<br>
For details on AuthSub, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br>
(optional) If no token is passed in, the client's auth_token member<br>
is used to request the new token. The token object will be modified<br>
to contain the new session token string.<br>
url: str or atom.http_core.Uri (optional) The URL to which the token<br>
upgrade request should be sent. Defaults to:<br>
https://www.google.com/accounts/AuthSubSessionToken<br>
<br>
Returns:<br>
The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br>
<dl><dt><strong>alt_auth_service</strong> = None</dl>
<hr>
Methods inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><a name="SitesClient-Get"><strong>Get</strong></a> = get(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="SitesClient-Put"><strong>Put</strong></a> = put(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="SitesClient-get"><strong>get</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="SitesClient-put"><strong>put</strong></a>(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><strong>auth_token</strong> = None</dl>
<dl><dt><strong>xoauth_requestor_id</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>ACL_FEED_TEMPLATE</strong> = '/feeds/acl/site/%s/%s/'<br>
<strong>ACTIVITY_FEED_TEMPLATE</strong> = '/feeds/activity/%s/%s/'<br>
<strong>CONTENT_FEED_TEMPLATE</strong> = '/feeds/content/%s/%s/'<br>
<strong>REVISION_FEED_TEMPLATE</strong> = '/feeds/revision/%s/%s/'<br>
<strong>SITE_FEED_TEMPLATE</strong> = '/feeds/site/%s/'<br>
<strong>__author__</strong> = 'e.bidelman (Eric Bidelman)'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">e.bidelman (Eric Bidelman)</td></tr></table>
</body></html>