| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module gdata.docs.service</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.docs.html"><font color="#ffffff">docs</font></a>.service</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/docs/service.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/docs/service.py</a></font></td></tr></table> |
| <p><tt><a href="#DocsService">DocsService</a> extends the <a href="gdata.service.html#GDataService">GDataService</a> to streamline Google Documents<br> |
| operations.<br> |
| <br> |
| <a href="#DocsService">DocsService</a>: Provides methods to query feeds and manipulate items.<br> |
| Extends <a href="gdata.service.html#GDataService">GDataService</a>.<br> |
| <br> |
| <a href="#DocumentQuery">DocumentQuery</a>: Queries a Google Document list feed.<br> |
| <br> |
| <a href="#DocumentAclQuery">DocumentAclQuery</a>: Queries a Google Document Acl feed.</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><a href="re.html">re</a><br> |
| </td><td width="25%" valign=top><a href="urllib.html">urllib</a><br> |
| </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.service.html#GDataService">gdata.service.GDataService</a>(<a href="atom.service.html#AtomService">atom.service.AtomService</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.docs.service.html#DocsService">DocsService</a> |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="gdata.service.html#Query">gdata.service.Query</a>(<a href="__builtin__.html#dict">__builtin__.dict</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.docs.service.html#DocumentAclQuery">DocumentAclQuery</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.docs.service.html#DocumentQuery">DocumentQuery</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="DocsService">class <strong>DocsService</strong></a>(<a href="gdata.service.html#GDataService">gdata.service.GDataService</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Client extension for the Google Documents service Document List feed.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.docs.service.html#DocsService">DocsService</a></dd> |
| <dd><a href="gdata.service.html#GDataService">gdata.service.GDataService</a></dd> |
| <dd><a href="atom.service.html#AtomService">atom.service.AtomService</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="DocsService-CreateFolder"><strong>CreateFolder</strong></a>(self, title, folder_or_uri<font color="#909090">=None</font>)</dt><dd><tt>Creates a folder in the Document List feed.<br> |
| <br> |
| Args:<br> |
| title: string The title of the folder on the server after being created.<br> |
| folder_or_uri: DocumentListEntry or string (optional) An object with a<br> |
| link to a folder or a uri to a folder to upload to.<br> |
| Note: A valid uri for a folder is of the form:<br> |
| /feeds/folders/private/full/folder%3Afolder_id<br> |
| <br> |
| Returns:<br> |
| A DocumentListEntry containing information about the folder created on<br> |
| the Google Documents service.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-Download"><strong>Download</strong></a>(self, entry_or_id_or_url, file_path, export_format<font color="#909090">=None</font>, gid<font color="#909090">=None</font>, extra_params<font color="#909090">=None</font>)</dt><dd><tt>Downloads a document from the Document List.<br> |
| <br> |
| Args:<br> |
| entry_or_id_or_url: a DocumentListEntry, or the resource id of an entry,<br> |
| or a url to download from (such as the content src).<br> |
| file_path: string The full path to save the file to.<br> |
| export_format: the format to convert to, if conversion is required.<br> |
| gid: grid id, for downloading a single grid of a spreadsheet<br> |
| extra_params: a map of any further parameters to control how the document<br> |
| is downloaded<br> |
| <br> |
| Raises:<br> |
| RequestError if the service does not respond with success</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-DownloadDocument"><strong>DownloadDocument</strong></a> = Export(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-DownloadPresentation"><strong>DownloadPresentation</strong></a> = Export(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-DownloadSpreadsheet"><strong>DownloadSpreadsheet</strong></a> = Export(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-Export"><strong>Export</strong></a>(self, entry_or_id_or_url, file_path, gid<font color="#909090">=None</font>, extra_params<font color="#909090">=None</font>)</dt><dd><tt>Downloads a document from the Document List in a different format.<br> |
| <br> |
| Args:<br> |
| entry_or_id_or_url: a DocumentListEntry, or the resource id of an entry,<br> |
| or a url to download from (such as the content src).<br> |
| file_path: string The full path to save the file to. The export<br> |
| format is inferred from the the file extension.<br> |
| gid: grid id, for downloading a single grid of a spreadsheet<br> |
| extra_params: a map of any further parameters to control how the document<br> |
| is downloaded<br> |
| <br> |
| Raises:<br> |
| RequestError if the service does not respond with success</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetDocumentListAclEntry"><strong>GetDocumentListAclEntry</strong></a>(self, uri)</dt><dd><tt>Retrieves a particular DocumentListAclEntry by its unique URI.<br> |
| <br> |
| Args:<br> |
| uri: string The unique URI of an entry in a Document List feed.<br> |
| <br> |
| Returns:<br> |
| A DocumentListAclEntry object representing the retrieved entry.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetDocumentListAclFeed"><strong>GetDocumentListAclFeed</strong></a>(self, uri)</dt><dd><tt>Retrieves a feed containing all of a user's documents.<br> |
| <br> |
| Args:<br> |
| uri: string The URI of a document's Acl feed to retrieve.<br> |
| <br> |
| Returns:<br> |
| A DocumentListAclFeed object representing the ACL feed<br> |
| returned by the server.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetDocumentListEntry"><strong>GetDocumentListEntry</strong></a>(self, uri)</dt><dd><tt>Retrieves a particular DocumentListEntry by its unique URI.<br> |
| <br> |
| Args:<br> |
| uri: string The unique URI of an entry in a Document List feed.<br> |
| <br> |
| Returns:<br> |
| A DocumentListEntry object representing the retrieved entry.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetDocumentListFeed"><strong>GetDocumentListFeed</strong></a>(self, uri<font color="#909090">=None</font>)</dt><dd><tt>Retrieves a feed containing all of a user's documents.<br> |
| <br> |
| Args:<br> |
| uri: string A full URI to query the Document List feed.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-MoveDocumentIntoFolder"><strong>MoveDocumentIntoFolder</strong></a> = MoveIntoFolder(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-MoveFolderIntoFolder"><strong>MoveFolderIntoFolder</strong></a> = MoveIntoFolder(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-MoveIntoFolder"><strong>MoveIntoFolder</strong></a>(self, source_entry, folder_entry)</dt><dd><tt>Moves a document into a folder in the Document List Feed.<br> |
| <br> |
| Args:<br> |
| source_entry: DocumentListEntry An object representing the source<br> |
| document/folder.<br> |
| folder_entry: DocumentListEntry An object with a link to the destination<br> |
| folder.<br> |
| <br> |
| Returns:<br> |
| A DocumentListEntry containing information about the document created on<br> |
| the Google Documents service.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-MoveOutOfFolder"><strong>MoveOutOfFolder</strong></a>(self, source_entry)</dt><dd><tt>Moves a document into a folder in the Document List Feed.<br> |
| <br> |
| Args:<br> |
| source_entry: DocumentListEntry An object representing the source<br> |
| document/folder.<br> |
| <br> |
| Returns:<br> |
| True if the entry was moved out.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-MovePresentationIntoFolder"><strong>MovePresentationIntoFolder</strong></a> = MoveIntoFolder(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-MoveSpreadsheetIntoFolder"><strong>MoveSpreadsheetIntoFolder</strong></a> = MoveIntoFolder(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-Query"><strong>Query</strong></a>(self, uri, converter<font color="#909090">=<function DocumentListFeedFromString></font>)</dt><dd><tt>Queries the Document List feed and returns the resulting feed of<br> |
| entries.<br> |
| <br> |
| Args:<br> |
| uri: string The full URI to be queried. This can contain query<br> |
| parameters, a hostname, or simply the relative path to a Document<br> |
| List feed. The <a href="#DocumentQuery">DocumentQuery</a> object is useful when constructing<br> |
| query parameters.<br> |
| converter: func (optional) A function which will be executed on the<br> |
| retrieved item, generally to render it into a Python object.<br> |
| By default the DocumentListFeedFromString function is used to<br> |
| return a DocumentListFeed object. This is because most feed<br> |
| queries will result in a feed and not a single entry.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-QueryDocumentListFeed"><strong>QueryDocumentListFeed</strong></a>(self, uri)</dt><dd><tt>Retrieves a DocumentListFeed by retrieving a URI based off the Document<br> |
| List feed, including any query parameters. A <a href="#DocumentQuery">DocumentQuery</a> object can<br> |
| be used to construct these parameters.<br> |
| <br> |
| Args:<br> |
| uri: string The URI of the feed being retrieved possibly with query<br> |
| parameters.<br> |
| <br> |
| Returns:<br> |
| A DocumentListFeed object representing the feed returned by the server.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-Upload"><strong>Upload</strong></a>(self, media_source, title, folder_or_uri<font color="#909090">=None</font>, label<font color="#909090">=None</font>)</dt><dd><tt>Uploads a document inside of a MediaSource object to the Document List<br> |
| feed with the given title.<br> |
| <br> |
| Args:<br> |
| media_source: MediaSource The gdata.MediaSource object containing a<br> |
| document file to be uploaded.<br> |
| title: string The title of the document on the server after being<br> |
| uploaded.<br> |
| folder_or_uri: DocumentListEntry or string (optional) An object with a<br> |
| link to a folder or a uri to a folder to upload to.<br> |
| Note: A valid uri for a folder is of the form:<br> |
| /feeds/folders/private/full/folder%3Afolder_id<br> |
| label: optional label describing the type of the document to be created.<br> |
| <br> |
| Returns:<br> |
| A DocumentListEntry containing information about the document created<br> |
| on the Google Documents service.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-UploadDocument"><strong>UploadDocument</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-UploadPresentation"><strong>UploadPresentation</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-UploadSpreadsheet"><strong>UploadSpreadsheet</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-__init__"><strong>__init__</strong></a>(self, email<font color="#909090">=None</font>, password<font color="#909090">=None</font>, source<font color="#909090">=None</font>, server<font color="#909090">='docs.google.com'</font>, additional_headers<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a client for the Google Documents service.<br> |
| <br> |
| Args:<br> |
| email: string (optional) The user's email address, used for<br> |
| authentication.<br> |
| password: string (optional) The user's password.<br> |
| source: string (optional) The name of the user's application.<br> |
| server: string (optional) The name of the server to which a connection<br> |
| will be opened. Default value: 'docs.google.com'.<br> |
| **kwargs: The other parameters to pass to gdata.service.<a href="gdata.service.html#GDataService">GDataService</a><br> |
| constructor.</tt></dd></dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.service.html#GDataService">gdata.service.GDataService</a>:<br> |
| <dl><dt><a name="DocsService-AuthSubTokenInfo"><strong>AuthSubTokenInfo</strong></a>(self)</dt><dd><tt>Fetches the AuthSub token's metadata from the server.<br> |
| <br> |
| Raises:<br> |
| NonAuthSubToken if the user's auth token is not an AuthSub token</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-ClientLogin"><strong>ClientLogin</strong></a>(self, username, password, account_type<font color="#909090">=None</font>, service<font color="#909090">=None</font>, auth_service_url<font color="#909090">=None</font>, source<font color="#909090">=None</font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Convenience method for authenticating using ProgrammaticLogin. <br> |
| <br> |
| Sets values for email, password, and other optional members.<br> |
| <br> |
| Args:<br> |
| username:<br> |
| password:<br> |
| account_type: string (optional)<br> |
| service: string (optional)<br> |
| auth_service_url: string (optional)<br> |
| captcha_token: string (optional)<br> |
| captcha_response: string (optional)</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-Delete"><strong>Delete</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, redirects_remaining<font color="#909090">=4</font>)</dt><dd><tt>Deletes the entry at the given URI.<br> |
| <br> |
| Args:<br> |
| uri: string The URI of the entry to be deleted. Example: <br> |
| '/base/feeds/items/ITEM-ID'<br> |
| extra_headers: dict (optional) HTTP headers which are to be included.<br> |
| The client automatically sets the Content-Type and<br> |
| Authorization headers.<br> |
| url_params: dict (optional) Additional URL parameters to be included<br> |
| in the URI. These are translated into query arguments<br> |
| in the form '&dict_key=value&...'.<br> |
| Example: {'max-results': '250'} becomes &max-results=250<br> |
| escape_params: boolean (optional) If false, the calling code has already<br> |
| ensured that the query will form a valid URL (all<br> |
| reserved characters have been escaped). If true, this<br> |
| method will escape the query and any URL parameters<br> |
| provided.<br> |
| <br> |
| Returns:<br> |
| True if the entry was deleted.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-FetchOAuthRequestToken"><strong>FetchOAuthRequestToken</strong></a>(self, scopes<font color="#909090">=None</font>, extra_parameters<font color="#909090">=None</font>, request_url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>, oauth_callback<font color="#909090">=None</font>)</dt><dd><tt>Fetches and sets the OAuth request token and returns it.<br> |
| <br> |
| Args:<br> |
| scopes: string or list of string base URL(s) of the service(s) to be<br> |
| accessed. If None, then this method tries to determine the<br> |
| scope(s) from the current service.<br> |
| extra_parameters: dict (optional) key-value pairs as any additional<br> |
| parameters to be included in the URL and signature while making a<br> |
| request for fetching an OAuth request token. All the OAuth parameters<br> |
| are added by default. But if provided through this argument, any<br> |
| default parameters will be overwritten. For e.g. a default parameter<br> |
| oauth_version 1.0 can be overwritten if<br> |
| extra_parameters = {'oauth_version': '2.0'}<br> |
| request_url: Request token URL. The default is<br> |
| 'https://www.google.com/accounts/OAuthGetRequestToken'.<br> |
| oauth_callback: str (optional) If set, it is assume the client is using<br> |
| the OAuth v1.0a protocol where the callback url is sent in the<br> |
| request token step. If the oauth_callback is also set in<br> |
| extra_params, this value will override that one.<br> |
| <br> |
| Returns:<br> |
| The fetched request token as a gdata.auth.OAuthToken object.<br> |
| <br> |
| Raises:<br> |
| FetchingOAuthRequestTokenFailed if the server responded to the request<br> |
| with an error.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GenerateAuthSubURL"><strong>GenerateAuthSubURL</strong></a>(self, next, scope, secure<font color="#909090">=False</font>, session<font color="#909090">=True</font>, domain<font color="#909090">='default'</font>)</dt><dd><tt>Generate a URL at which the user will login and be redirected back.<br> |
| <br> |
| Users enter their credentials on a Google login page and a token is sent<br> |
| to the URL specified in next. See documentation for AuthSub login at:<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> |
| next: string The URL user will be sent to after logging in.<br> |
| scope: string or list of strings. The URLs of the services to be <br> |
| accessed.<br> |
| secure: boolean (optional) Determines whether or not the issued token<br> |
| is a secure token.<br> |
| session: boolean (optional) Determines whether or not the issued token<br> |
| can be upgraded to a session token.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GenerateOAuthAuthorizationURL"><strong>GenerateOAuthAuthorizationURL</strong></a>(self, request_token<font color="#909090">=None</font>, callback_url<font color="#909090">=None</font>, extra_params<font color="#909090">=None</font>, include_scopes_in_callback<font color="#909090">=False</font>, scopes_param_prefix<font color="#909090">='oauth_token_scope'</font>, request_url<font color="#909090">='https://www.google.com/accounts/OAuthAuthorizeToken'</font>)</dt><dd><tt>Generates URL at which user will login to authorize the request token.<br> |
| <br> |
| Args:<br> |
| request_token: gdata.auth.OAuthToken (optional) OAuth request token.<br> |
| If not specified, then the current token will be used if it is of<br> |
| type <gdata.auth.OAuthToken>, else it is found by looking in the<br> |
| token_store by looking for a token for the current scope. <br> |
| callback_url: string (optional) The URL user will be sent to after<br> |
| logging in and granting access.<br> |
| extra_params: dict (optional) Additional parameters to be sent.<br> |
| include_scopes_in_callback: Boolean (default=False) if set to True, and<br> |
| if 'callback_url' is present, the 'callback_url' will be modified to<br> |
| include the scope(s) from the request token as a URL parameter. The<br> |
| key for the 'callback' URL's scope parameter will be<br> |
| OAUTH_SCOPE_URL_PARAM_NAME. The benefit of including the scope URL as<br> |
| a parameter to the 'callback' URL, is that the page which receives<br> |
| the OAuth token will be able to tell which URLs the token grants<br> |
| access to.<br> |
| scopes_param_prefix: string (default='oauth_token_scope') The URL<br> |
| parameter key which maps to the list of valid scopes for the token.<br> |
| This URL parameter will be included in the callback URL along with<br> |
| the scopes of the token as value if include_scopes_in_callback=True.<br> |
| request_url: Authorization URL. The default is<br> |
| 'https://www.google.com/accounts/OAuthAuthorizeToken'.<br> |
| Returns:<br> |
| A string URL at which the user is required to login.<br> |
| <br> |
| Raises:<br> |
| NonOAuthToken if the user's request token is not an OAuth token or if a<br> |
| request token was not available.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-Get"><strong>Get</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, encoding<font color="#909090">='UTF-8'</font>, converter<font color="#909090">=None</font>)</dt><dd><tt><a href="gdata.service.html#Query">Query</a> the GData API with the given URI<br> |
| <br> |
| The uri is the portion of the URI after the server value <br> |
| (ex: www.google.com).<br> |
| <br> |
| To perform a query against Google Base, set the server to <br> |
| 'base.google.com' and set the uri to '/base/feeds/...', where ... is <br> |
| your query. For example, to find snippets for all digital cameras uri <br> |
| should be set to: '/base/feeds/snippets?bq=digital+camera'<br> |
| <br> |
| Args:<br> |
| uri: string The query in the form of a URI. Example:<br> |
| '/base/feeds/snippets?bq=digital+camera'.<br> |
| extra_headers: dictionary (optional) Extra HTTP headers to be included<br> |
| in the GET request. These headers are in addition to <br> |
| those stored in the client's additional_headers property.<br> |
| The client automatically sets the Content-Type and <br> |
| Authorization headers.<br> |
| redirects_remaining: int (optional) Tracks the number of additional<br> |
| redirects this method will allow. If the service object receives<br> |
| a redirect and remaining is 0, it will not follow the redirect. <br> |
| This was added to avoid infinite redirect loops.<br> |
| encoding: string (optional) The character encoding for the server's<br> |
| response. Default is UTF-8<br> |
| converter: func (optional) A function which will transform<br> |
| the server's results before it is returned. Example: use <br> |
| GDataFeedFromString to parse the server response as if it<br> |
| were a GDataFeed.<br> |
| <br> |
| Returns:<br> |
| If there is no ResultsTransformer specified in the call, a GDataFeed <br> |
| or GDataEntry depending on which is sent from the server. If the <br> |
| response is niether a feed or entry and there is no ResultsTransformer,<br> |
| return a string. If there is a ResultsTransformer, the returned value <br> |
| will be that of the ResultsTransformer function.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetAuthSubToken"><strong>GetAuthSubToken</strong></a>(self)</dt><dd><tt>Returns the AuthSub token as a string.<br> |
| <br> |
| If the token is an gdta.auth.AuthSubToken, the Authorization Label<br> |
| ("AuthSub token") is removed.<br> |
| <br> |
| This method examines the current_token to see if it is an AuthSubToken<br> |
| or SecureAuthSubToken. If not, it searches the token_store for a token<br> |
| which matches the current scope.<br> |
| <br> |
| The current scope is determined by the service name string member.<br> |
| <br> |
| Returns:<br> |
| If the current_token is set to an AuthSubToken/SecureAuthSubToken,<br> |
| return the token string. If there is no current_token, a token string<br> |
| for a token which matches the service object's default scope is returned.<br> |
| If there are no tokens valid for the scope, returns None.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetClientLoginToken"><strong>GetClientLoginToken</strong></a>(self)</dt><dd><tt>Returns the token string for the current token or a token matching the <br> |
| service scope.<br> |
| <br> |
| If the current_token is a ClientLoginToken, the token string for <br> |
| the current token is returned. If the current_token is not set, this method<br> |
| searches for a token in the token_store which is valid for the service <br> |
| object's current scope.<br> |
| <br> |
| The current scope is determined by the service name string member.<br> |
| The token string is the end of the Authorization header, it doesn not<br> |
| include the ClientLogin label.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetEntry"><strong>GetEntry</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>)</dt><dd><tt><a href="gdata.service.html#Query">Query</a> the GData API with the given URI and receive an Entry.<br> |
| <br> |
| See also documentation for gdata.service.Get<br> |
| <br> |
| Args:<br> |
| uri: string The query in the form of a URI. Example:<br> |
| '/base/feeds/snippets?bq=digital+camera'.<br> |
| extra_headers: dictionary (optional) Extra HTTP headers to be included<br> |
| in the GET request. These headers are in addition to<br> |
| those stored in the client's additional_headers property.<br> |
| The client automatically sets the Content-Type and<br> |
| Authorization headers.<br> |
| <br> |
| Returns:<br> |
| A GDataEntry built from the XML in the server's response.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetFeed"><strong>GetFeed</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>, converter<font color="#909090">=<function GDataFeedFromString></font>)</dt><dd><tt><a href="gdata.service.html#Query">Query</a> the GData API with the given URI and receive a Feed.<br> |
| <br> |
| See also documentation for gdata.service.Get<br> |
| <br> |
| Args:<br> |
| uri: string The query in the form of a URI. Example:<br> |
| '/base/feeds/snippets?bq=digital+camera'.<br> |
| extra_headers: dictionary (optional) Extra HTTP headers to be included<br> |
| in the GET request. These headers are in addition to<br> |
| those stored in the client's additional_headers property.<br> |
| The client automatically sets the Content-Type and<br> |
| Authorization headers.<br> |
| <br> |
| Returns:<br> |
| A GDataFeed built from the XML in the server's response.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetGeneratorFromLinkFinder"><strong>GetGeneratorFromLinkFinder</strong></a>(self, link_finder, func, num_retries<font color="#909090">=3</font>, delay<font color="#909090">=1</font>, backoff<font color="#909090">=2</font>)</dt><dd><tt>returns a generator for pagination</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetMedia"><strong>GetMedia</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>)</dt><dd><tt>Returns a MediaSource containing media and its metadata from the given<br> |
| URI string.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetNext"><strong>GetNext</strong></a>(self, feed)</dt><dd><tt>Requests the next 'page' of results in the feed.<br> |
| <br> |
| This method uses the feed's next link to request an additional feed<br> |
| and uses the class of the feed to convert the results of the GET request.<br> |
| <br> |
| Args:<br> |
| feed: atom.Feed or a subclass. The feed should contain a next link and<br> |
| the type of the feed will be applied to the results from the <br> |
| server. The new feed which is returned will be of the same class<br> |
| as this feed which was passed in.<br> |
| <br> |
| Returns:<br> |
| A new feed representing the next set of results in the server's feed.<br> |
| The type of this feed will match that of the feed argument.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-GetOAuthInputParameters"><strong>GetOAuthInputParameters</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="DocsService-GetWithRetries"><strong>GetWithRetries</strong></a>(self, uri, extra_headers<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, encoding<font color="#909090">='UTF-8'</font>, converter<font color="#909090">=None</font>, num_retries<font color="#909090">=3</font>, delay<font color="#909090">=1</font>, backoff<font color="#909090">=2</font>, logger<font color="#909090">=None</font>)</dt><dd><tt>This is a wrapper method for Get with retrying capability.<br> |
| <br> |
| To avoid various errors while retrieving bulk entities by retrying<br> |
| specified times.<br> |
| <br> |
| Note this method relies on the time module and so may not be usable<br> |
| by default in Python2.2.<br> |
| <br> |
| Args:<br> |
| num_retries: Integer; the retry count.<br> |
| delay: Integer; the initial delay for retrying.<br> |
| backoff: Integer; how much the delay should lengthen after each failure.<br> |
| logger: An object which has a <a href="#DocsService-debug">debug</a>(str) method to receive logging<br> |
| messages. Recommended that you pass in the logging module.<br> |
| Raises:<br> |
| ValueError if any of the parameters has an invalid value.<br> |
| RanOutOfTries on failure after number of retries.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-Post"><strong>Post</strong></a>(self, data, uri, extra_headers<font color="#909090">=None</font>, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, redirects_remaining<font color="#909090">=4</font>, media_source<font color="#909090">=None</font>, converter<font color="#909090">=None</font>)</dt><dd><tt>Insert or update data into a GData service at the given URI.<br> |
| <br> |
| Args:<br> |
| data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The<br> |
| XML to be sent to the uri.<br> |
| uri: string The location (feed) to which the data should be inserted.<br> |
| Example: '/base/feeds/items'.<br> |
| extra_headers: dict (optional) HTTP headers which are to be included.<br> |
| The client automatically sets the Content-Type,<br> |
| Authorization, and Content-Length headers.<br> |
| url_params: dict (optional) Additional URL parameters to be included<br> |
| in the URI. These are translated into query arguments<br> |
| in the form '&dict_key=value&...'.<br> |
| Example: {'max-results': '250'} becomes &max-results=250<br> |
| escape_params: boolean (optional) If false, the calling code has already<br> |
| ensured that the query will form a valid URL (all<br> |
| reserved characters have been escaped). If true, this<br> |
| method will escape the query and any URL parameters<br> |
| provided.<br> |
| media_source: MediaSource (optional) Container for the media to be sent<br> |
| along with the entry, if provided.<br> |
| converter: func (optional) A function which will be executed on the<br> |
| server's response. Often this is a function like<br> |
| GDataEntryFromString which will parse the body of the server's<br> |
| response and return a GDataEntry.<br> |
| <br> |
| Returns:<br> |
| If the post succeeded, this method will return a GDataFeed, GDataEntry,<br> |
| or the results of running converter on the server's result body (if<br> |
| converter was specified).</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-PostOrPut"><strong>PostOrPut</strong></a>(self, verb, data, uri, extra_headers<font color="#909090">=None</font>, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, redirects_remaining<font color="#909090">=4</font>, media_source<font color="#909090">=None</font>, converter<font color="#909090">=None</font>)</dt><dd><tt>Insert data into a GData service at the given URI.<br> |
| <br> |
| Args:<br> |
| verb: string, either 'POST' or 'PUT'<br> |
| data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The<br> |
| XML to be sent to the uri. <br> |
| uri: string The location (feed) to which the data should be inserted. <br> |
| Example: '/base/feeds/items'. <br> |
| extra_headers: dict (optional) HTTP headers which are to be included. <br> |
| The client automatically sets the Content-Type,<br> |
| Authorization, and Content-Length headers.<br> |
| url_params: dict (optional) Additional URL parameters to be included<br> |
| in the URI. These are translated into query arguments<br> |
| in the form '&dict_key=value&...'.<br> |
| Example: {'max-results': '250'} becomes &max-results=250<br> |
| escape_params: boolean (optional) If false, the calling code has already<br> |
| ensured that the query will form a valid URL (all<br> |
| reserved characters have been escaped). If true, this<br> |
| method will escape the query and any URL parameters<br> |
| provided.<br> |
| media_source: MediaSource (optional) Container for the media to be sent<br> |
| along with the entry, if provided.<br> |
| converter: func (optional) A function which will be executed on the <br> |
| server's response. Often this is a function like <br> |
| GDataEntryFromString which will parse the body of the server's <br> |
| response and return a GDataEntry.<br> |
| <br> |
| Returns:<br> |
| If the post succeeded, this method will return a GDataFeed, GDataEntry,<br> |
| or the results of running converter on the server's result body (if<br> |
| converter was specified).</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-ProgrammaticLogin"><strong>ProgrammaticLogin</strong></a>(self, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Authenticates the user and sets the GData Auth token.<br> |
| <br> |
| Login retreives a temporary auth token which must be used with all<br> |
| requests to GData services. The auth token is stored in the GData client<br> |
| object.<br> |
| <br> |
| Login is also used to respond to a captcha challenge. If the user's login<br> |
| attempt failed with a CaptchaRequired error, the user can respond by<br> |
| calling Login with the captcha token and the answer to the challenge.<br> |
| <br> |
| Args:<br> |
| captcha_token: string (optional) The identifier for the captcha challenge<br> |
| which was presented to the user.<br> |
| captcha_response: string (optional) The user's answer to the captch <br> |
| challenge.<br> |
| <br> |
| Raises:<br> |
| CaptchaRequired if the login service will require a captcha response<br> |
| BadAuthentication if the login service rejected the username or password<br> |
| Error if the login service responded with a 403 different from the above</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-Put"><strong>Put</strong></a>(self, data, uri, extra_headers<font color="#909090">=None</font>, url_params<font color="#909090">=None</font>, escape_params<font color="#909090">=True</font>, redirects_remaining<font color="#909090">=3</font>, media_source<font color="#909090">=None</font>, converter<font color="#909090">=None</font>)</dt><dd><tt>Updates an entry at the given URI.<br> |
| <br> |
| Args:<br> |
| data: string, ElementTree._Element, or xml_wrapper.ElementWrapper The <br> |
| XML containing the updated data.<br> |
| uri: string A URI indicating entry to which the update will be applied.<br> |
| Example: '/base/feeds/items/ITEM-ID'<br> |
| extra_headers: dict (optional) HTTP headers which are to be included.<br> |
| The client automatically sets the Content-Type,<br> |
| Authorization, and Content-Length headers.<br> |
| url_params: dict (optional) Additional URL parameters to be included<br> |
| in the URI. These are translated into query arguments<br> |
| in the form '&dict_key=value&...'.<br> |
| Example: {'max-results': '250'} becomes &max-results=250<br> |
| escape_params: boolean (optional) If false, the calling code has already<br> |
| ensured that the query will form a valid URL (all<br> |
| reserved characters have been escaped). If true, this<br> |
| method will escape the query and any URL parameters<br> |
| provided.<br> |
| converter: func (optional) A function which will be executed on the <br> |
| server's response. Often this is a function like <br> |
| GDataEntryFromString which will parse the body of the server's <br> |
| response and return a GDataEntry.<br> |
| <br> |
| Returns:<br> |
| If the put succeeded, this method will return a GDataFeed, GDataEntry,<br> |
| or the results of running converter on the server's result body (if<br> |
| converter was specified).</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-RevokeAuthSubToken"><strong>RevokeAuthSubToken</strong></a>(self)</dt><dd><tt>Revokes an existing AuthSub token.<br> |
| <br> |
| Raises:<br> |
| NonAuthSubToken if the user's auth token is not an AuthSub token</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-RevokeOAuthToken"><strong>RevokeOAuthToken</strong></a>(self, request_url<font color="#909090">='https://www.google.com/accounts/AuthSubRevokeToken'</font>)</dt><dd><tt>Revokes an existing OAuth token.<br> |
| <br> |
| request_url: Token revoke URL. The default is<br> |
| 'https://www.google.com/accounts/AuthSubRevokeToken'.<br> |
| Raises:<br> |
| NonOAuthToken if the user's auth token is not an OAuth token.<br> |
| RevokingOAuthTokenFailed if request for revoking an OAuth token failed.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-SetAuthSubToken"><strong>SetAuthSubToken</strong></a>(self, token, scopes<font color="#909090">=None</font>, rsa_key<font color="#909090">=None</font>)</dt><dd><tt>Sets the token sent in requests to an AuthSub token.<br> |
| <br> |
| Sets the current_token and attempts to add the token to the token_store.<br> |
| <br> |
| Only use this method if you have received a token from the AuthSub<br> |
| service. The auth token is set automatically when <a href="#DocsService-UpgradeToSessionToken">UpgradeToSessionToken</a>()<br> |
| is used. See documentation for Google AuthSub here:<br> |
| <a href="http://code.google.com/apis/accounts/AuthForWebApps.html">http://code.google.com/apis/accounts/AuthForWebApps.html</a> <br> |
| <br> |
| Args:<br> |
| token: gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken or string<br> |
| The token returned by the AuthSub service. If the token is an<br> |
| AuthSubToken or SecureAuthSubToken, the scope information stored in<br> |
| the token is used. If the token is a string, the scopes parameter is<br> |
| used to determine the valid scopes.<br> |
| scopes: list of URLs for which the token is valid. This is only used<br> |
| if the token parameter is a string.<br> |
| rsa_key: string (optional) Private key required for RSA_SHA1 signature<br> |
| method. This parameter is necessary if the token is a string<br> |
| representing a secure token.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-SetClientLoginToken"><strong>SetClientLoginToken</strong></a>(self, token, scopes<font color="#909090">=None</font>)</dt><dd><tt>Sets the token sent in requests to a ClientLogin token.<br> |
| <br> |
| This method sets the current_token to a new ClientLoginToken and it <br> |
| also attempts to add the ClientLoginToken to the token_store.<br> |
| <br> |
| Only use this method if you have received a token from the ClientLogin<br> |
| service. The auth_token is set automatically when <a href="#DocsService-ProgrammaticLogin">ProgrammaticLogin</a>()<br> |
| is used. See documentation for Google ClientLogin here:<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> |
| token: string or instance of a ClientLoginToken.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-SetOAuthInputParameters"><strong>SetOAuthInputParameters</strong></a>(self, signature_method, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_key<font color="#909090">=None</font>, two_legged_oauth<font color="#909090">=False</font>, requestor_id<font color="#909090">=None</font>)</dt><dd><tt>Sets parameters required for using OAuth authentication mechanism.<br> |
| <br> |
| NOTE: Though consumer_secret and rsa_key are optional, either of the two<br> |
| is required depending on the value of the signature_method.<br> |
| <br> |
| Args:<br> |
| signature_method: class which provides implementation for strategy class<br> |
| oauth.oauth.OAuthSignatureMethod. Signature method to be used for<br> |
| signing each request. Valid implementations are provided as the<br> |
| constants defined by gdata.auth.OAuthSignatureMethod. Currently<br> |
| they are gdata.auth.OAuthSignatureMethod.RSA_SHA1 and<br> |
| gdata.auth.OAuthSignatureMethod.HMAC_SHA1<br> |
| consumer_key: string Domain identifying third_party web application.<br> |
| consumer_secret: string (optional) Secret generated during registration.<br> |
| Required only for HMAC_SHA1 signature method.<br> |
| rsa_key: string (optional) Private key required for RSA_SHA1 signature<br> |
| method.<br> |
| two_legged_oauth: boolean (optional) Enables two-legged OAuth process.<br> |
| requestor_id: string (optional) User email adress to make requests on<br> |
| their behalf. This parameter should only be set when two_legged_oauth<br> |
| is True.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-SetOAuthToken"><strong>SetOAuthToken</strong></a>(self, oauth_token)</dt><dd><tt>Attempts to set the current token and add it to the token store.<br> |
| <br> |
| The oauth_token can be any OAuth token i.e. unauthorized request token,<br> |
| authorized request token or access token.<br> |
| This method also attempts to add the token to the token store.<br> |
| Use this method any time you want the current token to point to the<br> |
| oauth_token passed. For e.g. call this method with the request token<br> |
| you receive from FetchOAuthRequestToken.<br> |
| <br> |
| Args:<br> |
| request_token: gdata.auth.OAuthToken OAuth request token.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-UpgradeToOAuthAccessToken"><strong>UpgradeToOAuthAccessToken</strong></a>(self, authorized_request_token<font color="#909090">=None</font>, request_url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>, oauth_version<font color="#909090">='1.0'</font>, oauth_verifier<font color="#909090">=None</font>)</dt><dd><tt>Upgrades the authorized request token to an access token and returns it<br> |
| <br> |
| Args:<br> |
| authorized_request_token: gdata.auth.OAuthToken (optional) OAuth request<br> |
| token. If not specified, then the current token will be used if it is<br> |
| of type <gdata.auth.OAuthToken>, else it is found by looking in the<br> |
| token_store by looking for a token for the current scope.<br> |
| request_url: Access token URL. The default is<br> |
| 'https://www.google.com/accounts/OAuthGetAccessToken'.<br> |
| oauth_version: str (default='1.0') oauth_version parameter. All other<br> |
| 'oauth_' parameters are added by default. This parameter too, is<br> |
| added by default but here you can override it's value.<br> |
| oauth_verifier: str (optional) If present, it is assumed that the client<br> |
| will use the OAuth v1.0a protocol which includes passing the<br> |
| oauth_verifier (as returned by the SP) in the access token step.<br> |
| <br> |
| Returns:<br> |
| Access token<br> |
| <br> |
| Raises:<br> |
| NonOAuthToken if the user's authorized request token is not an OAuth<br> |
| token or if an authorized request token was not available.<br> |
| TokenUpgradeFailed if the server responded to the request with an <br> |
| error.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-UpgradeToSessionToken"><strong>UpgradeToSessionToken</strong></a>(self, token<font color="#909090">=None</font>)</dt><dd><tt>Upgrades a single use AuthSub token to a session token.<br> |
| <br> |
| Args:<br> |
| token: A gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken<br> |
| (optional) which is good for a single use but can be upgraded<br> |
| to a session token. If no token is passed in, the token<br> |
| is found by looking in the token_store by looking for a token<br> |
| for the current scope.<br> |
| <br> |
| Raises:<br> |
| NonAuthSubToken if the user's auth token is not an AuthSub token<br> |
| TokenUpgradeFailed if the server responded to the request with an <br> |
| error.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-upgrade_to_session_token"><strong>upgrade_to_session_token</strong></a>(self, token)</dt><dd><tt>Upgrades a single use AuthSub token to a session token.<br> |
| <br> |
| Args:<br> |
| token: A gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken<br> |
| which is good for a single use but can be upgraded to a<br> |
| session token.<br> |
| <br> |
| Returns:<br> |
| The upgraded token as a gdata.auth.AuthSubToken object.<br> |
| <br> |
| Raises:<br> |
| TokenUpgradeFailed if the server responded to the request with an <br> |
| error.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.service.html#GDataService">gdata.service.GDataService</a>:<br> |
| <dl><dt><strong>captcha_token</strong></dt> |
| <dd><tt>Get the captcha token for a login request.</tt></dd> |
| </dl> |
| <dl><dt><strong>captcha_url</strong></dt> |
| <dd><tt>Get the captcha URL for a login request.</tt></dd> |
| </dl> |
| <dl><dt><strong>source</strong></dt> |
| <dd><tt>The source is the name of the application making the request. <br> |
| It should be in the form company_id-app_name-app_version</tt></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="gdata.service.html#GDataService">gdata.service.GDataService</a>:<br> |
| <dl><dt><strong>auth_token</strong> = None</dl> |
| |
| <dl><dt><strong>handler</strong> = None</dl> |
| |
| <dl><dt><strong>tokens</strong> = None</dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.service.html#AtomService">atom.service.AtomService</a>:<br> |
| <dl><dt><a name="DocsService-UseBasicAuth"><strong>UseBasicAuth</strong></a>(self, username, password, for_proxy<font color="#909090">=False</font>)</dt><dd><tt>Sets an Authenticaiton: Basic HTTP header containing plaintext.<br> |
| <br> |
| Deprecated, use use_basic_auth instead.<br> |
| <br> |
| The username and password are base64 encoded and added to an HTTP header<br> |
| which will be included in each request. Note that your username and <br> |
| password are sent in plaintext.<br> |
| <br> |
| Args:<br> |
| username: str<br> |
| password: str</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-request"><strong>request</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl> |
| |
| <dl><dt><a name="DocsService-use_basic_auth"><strong>use_basic_auth</strong></a>(self, username, password, scopes<font color="#909090">=None</font>)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.service.html#AtomService">atom.service.AtomService</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> |
| <dl><dt><strong>debug</strong></dt> |
| <dd><tt>If True, HTTP debug information is printed.</tt></dd> |
| </dl> |
| <dl><dt><strong>override_token</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.service.html#AtomService">atom.service.AtomService</a>:<br> |
| <dl><dt><strong>auto_set_current_token</strong> = True</dl> |
| |
| <dl><dt><strong>auto_store_tokens</strong> = True</dl> |
| |
| <dl><dt><strong>current_token</strong> = None</dl> |
| |
| <dl><dt><strong>port</strong> = 80</dl> |
| |
| <dl><dt><strong>ssl</strong> = False</dl> |
| |
| </td></tr></table> <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="DocumentAclQuery">class <strong>DocumentAclQuery</strong></a>(<a href="gdata.service.html#Query">gdata.service.Query</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Object used to construct a URI to query a Document's ACL feed<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.docs.service.html#DocumentAclQuery">DocumentAclQuery</a></dd> |
| <dd><a href="gdata.service.html#Query">gdata.service.Query</a></dd> |
| <dd><a href="__builtin__.html#dict">__builtin__.dict</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="DocumentAclQuery-ToUri"><strong>ToUri</strong></a>(self)</dt><dd><tt>Generates a URI from the query parameters set in the object.<br> |
| <br> |
| Returns:<br> |
| A string containing the URI used to retrieve entries from the Document<br> |
| ACL feed.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__init__"><strong>__init__</strong></a>(self, resource_id, feed<font color="#909090">='/feeds/acl/private/full'</font>)</dt><dd><tt>Constructor for Document ACL <a href="gdata.service.html#Query">Query</a><br> |
| <br> |
| Args:<br> |
| resource_id: string The resource id. (e.g. 'document%3Adocument_id',<br> |
| 'spreadsheet%3Aspreadsheet_id', etc.)<br> |
| feed: string (optional) The path for the feed.<br> |
| (e.g. '/feeds/acl/private/full')<br> |
| <br> |
| Yields:<br> |
| A <a href="#DocumentAclQuery">DocumentAclQuery</a> object used to construct a URI based on the Document<br> |
| ACL feed.</tt></dd></dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.service.html#Query">gdata.service.Query</a>:<br> |
| <dl><dt><a name="DocumentAclQuery-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.service.html#Query">gdata.service.Query</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> |
| <dl><dt><strong>alt</strong></dt> |
| <dd><tt>The feed query's alt parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>author</strong></dt> |
| <dd><tt>The feed query's author parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>max_results</strong></dt> |
| <dd><tt>The feed query's max-results parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>orderby</strong></dt> |
| <dd><tt>The feed query's orderby parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>published_max</strong></dt> |
| <dd><tt>The feed query's published-max parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>published_min</strong></dt> |
| <dd><tt>The feed query's published-min parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>start_index</strong></dt> |
| <dd><tt>The feed query's start-index parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>text_query</strong></dt> |
| <dd><tt>The feed query's q parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>updated_max</strong></dt> |
| <dd><tt>The feed query's updated-max parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>updated_min</strong></dt> |
| <dd><tt>The feed query's updated-min parameter</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="__builtin__.html#dict">__builtin__.dict</a>:<br> |
| <dl><dt><a name="DocumentAclQuery-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-__contains__">__contains__</a>(k) -> True if D has a key k, else False</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__delitem__"><strong>__delitem__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__delitem__">__delitem__</a>(y) <==> del x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__eq__">__eq__</a>(y) <==> x==y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__ge__">__ge__</a>(y) <==> x>=y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__gt__">__gt__</a>(y) <==> x>y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__iter__"><strong>__iter__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__iter__">__iter__</a>() <==> iter(x)</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__le__">__le__</a>(y) <==> x<=y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__len__">__len__</a>() <==> len(x)</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__lt__">__lt__</a>(y) <==> x<y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__ne__">__ne__</a>(y) <==> x!=y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__setitem__"><strong>__setitem__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentAclQuery-__setitem__">__setitem__</a>(i, y) <==> x[i]=y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-__sizeof__"><strong>__sizeof__</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-__sizeof__">__sizeof__</a>() -> size of D in memory, in bytes</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-clear"><strong>clear</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-clear">clear</a>() -> None. Remove all items from D.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-copy"><strong>copy</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-copy">copy</a>() -> a shallow copy of D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-fromkeys"><strong>fromkeys</strong></a>(...)</dt><dd><tt>dict.<a href="#DocumentAclQuery-fromkeys">fromkeys</a>(S[,v]) -> New dict with keys from S and values equal to v.<br> |
| v defaults to None.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-get"><strong>get</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-get">get</a>(k[,d]) -> D[k] if k in D, else d. d defaults to None.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-has_key"><strong>has_key</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-has_key">has_key</a>(k) -> True if D has a key k, else False</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-items"><strong>items</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-items">items</a>() -> list of D's (key, value) pairs, as 2-tuples</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-iteritems"><strong>iteritems</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-iteritems">iteritems</a>() -> an iterator over the (key, value) items of D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-iterkeys"><strong>iterkeys</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-iterkeys">iterkeys</a>() -> an iterator over the keys of D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-itervalues"><strong>itervalues</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-itervalues">itervalues</a>() -> an iterator over the values of D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-keys"><strong>keys</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-keys">keys</a>() -> list of D's keys</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-pop"><strong>pop</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-pop">pop</a>(k[,d]) -> v, remove specified key and return the corresponding value.<br> |
| If key is not found, d is returned if given, otherwise KeyError is raised</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-popitem"><strong>popitem</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-popitem">popitem</a>() -> (k, v), remove and return some (key, value) pair as a<br> |
| 2-tuple; but raise KeyError if D is empty.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-setdefault"><strong>setdefault</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-setdefault">setdefault</a>(k[,d]) -> D.<a href="#DocumentAclQuery-get">get</a>(k,d), also set D[k]=d if k not in D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-update"><strong>update</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-update">update</a>([E, ]**F) -> None. Update D from dict/iterable E and F.<br> |
| If E present and has a .<a href="#DocumentAclQuery-keys">keys</a>() method, does: for k in E: D[k] = E[k]<br> |
| If E present and lacks .<a href="#DocumentAclQuery-keys">keys</a>() method, does: for (k, v) in E: D[k] = v<br> |
| In either case, this is followed by: for k in F: D[k] = F[k]</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-values"><strong>values</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-values">values</a>() -> list of D's values</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-viewitems"><strong>viewitems</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-viewitems">viewitems</a>() -> a set-like object providing a view on D's items</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-viewkeys"><strong>viewkeys</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-viewkeys">viewkeys</a>() -> a set-like object providing a view on D's keys</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentAclQuery-viewvalues"><strong>viewvalues</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentAclQuery-viewvalues">viewvalues</a>() -> an object providing a view on D's values</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="__builtin__.html#dict">__builtin__.dict</a>:<br> |
| <dl><dt><strong>__hash__</strong> = None</dl> |
| |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#DocumentAclQuery-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> |
| |
| </td></tr></table> <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="DocumentQuery">class <strong>DocumentQuery</strong></a>(<a href="gdata.service.html#Query">gdata.service.Query</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Object used to construct a URI to query the Google Document List feed<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.docs.service.html#DocumentQuery">DocumentQuery</a></dd> |
| <dd><a href="gdata.service.html#Query">gdata.service.Query</a></dd> |
| <dd><a href="__builtin__.html#dict">__builtin__.dict</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="DocumentQuery-AddNamedFolder"><strong>AddNamedFolder</strong></a>(self, email, folder_name)</dt><dd><tt>Adds a named folder category, qualified by a schema.<br> |
| <br> |
| This function lets you query for documents that are contained inside a<br> |
| named folder without fear of collision with other categories.<br> |
| <br> |
| Args:<br> |
| email: string The email of the user who owns the folder.<br> |
| folder_name: string The name of the folder.<br> |
| <br> |
| Returns:<br> |
| The string of the category that was added to the object.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-RemoveNamedFolder"><strong>RemoveNamedFolder</strong></a>(self, email, folder_name)</dt><dd><tt>Removes a named folder category, qualified by a schema.<br> |
| <br> |
| Args:<br> |
| email: string The email of the user who owns the folder.<br> |
| folder_name: string The name of the folder.<br> |
| <br> |
| Returns:<br> |
| The string of the category that was removed to the object.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-ToUri"><strong>ToUri</strong></a>(self)</dt><dd><tt>Generates a URI from the query parameters set in the object.<br> |
| <br> |
| Returns:<br> |
| A string containing the URI used to retrieve entries from the Document<br> |
| List feed.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__init__"><strong>__init__</strong></a>(self, feed<font color="#909090">='/feeds/documents'</font>, visibility<font color="#909090">='private'</font>, projection<font color="#909090">='full'</font>, text_query<font color="#909090">=None</font>, params<font color="#909090">=None</font>, categories<font color="#909090">=None</font>)</dt><dd><tt>Constructor for Document List <a href="gdata.service.html#Query">Query</a><br> |
| <br> |
| Args:<br> |
| feed: string (optional) The path for the feed. (e.g. '/feeds/documents')<br> |
| visibility: string (optional) The visibility chosen for the current feed.<br> |
| projection: string (optional) The projection chosen for the current feed.<br> |
| text_query: string (optional) The contents of the q query parameter. This<br> |
| string is URL escaped upon conversion to a URI.<br> |
| params: dict (optional) Parameter value string pairs which become URL<br> |
| params when translated to a URI. These parameters are added to<br> |
| the query's items.<br> |
| categories: list (optional) List of category strings which should be<br> |
| included as query categories. See gdata.service.<a href="gdata.service.html#Query">Query</a> for<br> |
| additional documentation.<br> |
| <br> |
| Yields:<br> |
| A <a href="#DocumentQuery">DocumentQuery</a> object used to construct a URI based on the Document<br> |
| List feed.</tt></dd></dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.service.html#Query">gdata.service.Query</a>:<br> |
| <dl><dt><a name="DocumentQuery-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="gdata.service.html#Query">gdata.service.Query</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> |
| <dl><dt><strong>alt</strong></dt> |
| <dd><tt>The feed query's alt parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>author</strong></dt> |
| <dd><tt>The feed query's author parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>max_results</strong></dt> |
| <dd><tt>The feed query's max-results parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>orderby</strong></dt> |
| <dd><tt>The feed query's orderby parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>published_max</strong></dt> |
| <dd><tt>The feed query's published-max parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>published_min</strong></dt> |
| <dd><tt>The feed query's published-min parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>start_index</strong></dt> |
| <dd><tt>The feed query's start-index parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>text_query</strong></dt> |
| <dd><tt>The feed query's q parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>updated_max</strong></dt> |
| <dd><tt>The feed query's updated-max parameter</tt></dd> |
| </dl> |
| <dl><dt><strong>updated_min</strong></dt> |
| <dd><tt>The feed query's updated-min parameter</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="__builtin__.html#dict">__builtin__.dict</a>:<br> |
| <dl><dt><a name="DocumentQuery-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__cmp__">__cmp__</a>(y) <==> cmp(x,y)</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__contains__"><strong>__contains__</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-__contains__">__contains__</a>(k) -> True if D has a key k, else False</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__delitem__"><strong>__delitem__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__delitem__">__delitem__</a>(y) <==> del x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__eq__"><strong>__eq__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__eq__">__eq__</a>(y) <==> x==y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__ge__"><strong>__ge__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__ge__">__ge__</a>(y) <==> x>=y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__gt__"><strong>__gt__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__gt__">__gt__</a>(y) <==> x>y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__iter__"><strong>__iter__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__iter__">__iter__</a>() <==> iter(x)</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__le__"><strong>__le__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__le__">__le__</a>(y) <==> x<=y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__len__"><strong>__len__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__len__">__len__</a>() <==> len(x)</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__lt__"><strong>__lt__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__lt__">__lt__</a>(y) <==> x<y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__ne__"><strong>__ne__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__ne__">__ne__</a>(y) <==> x!=y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__setitem__"><strong>__setitem__</strong></a>(...)</dt><dd><tt>x.<a href="#DocumentQuery-__setitem__">__setitem__</a>(i, y) <==> x[i]=y</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-__sizeof__"><strong>__sizeof__</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-__sizeof__">__sizeof__</a>() -> size of D in memory, in bytes</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-clear"><strong>clear</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-clear">clear</a>() -> None. Remove all items from D.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-copy"><strong>copy</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-copy">copy</a>() -> a shallow copy of D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-fromkeys"><strong>fromkeys</strong></a>(...)</dt><dd><tt>dict.<a href="#DocumentQuery-fromkeys">fromkeys</a>(S[,v]) -> New dict with keys from S and values equal to v.<br> |
| v defaults to None.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-get"><strong>get</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-get">get</a>(k[,d]) -> D[k] if k in D, else d. d defaults to None.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-has_key"><strong>has_key</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-has_key">has_key</a>(k) -> True if D has a key k, else False</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-items"><strong>items</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-items">items</a>() -> list of D's (key, value) pairs, as 2-tuples</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-iteritems"><strong>iteritems</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-iteritems">iteritems</a>() -> an iterator over the (key, value) items of D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-iterkeys"><strong>iterkeys</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-iterkeys">iterkeys</a>() -> an iterator over the keys of D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-itervalues"><strong>itervalues</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-itervalues">itervalues</a>() -> an iterator over the values of D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-keys"><strong>keys</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-keys">keys</a>() -> list of D's keys</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-pop"><strong>pop</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-pop">pop</a>(k[,d]) -> v, remove specified key and return the corresponding value.<br> |
| If key is not found, d is returned if given, otherwise KeyError is raised</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-popitem"><strong>popitem</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-popitem">popitem</a>() -> (k, v), remove and return some (key, value) pair as a<br> |
| 2-tuple; but raise KeyError if D is empty.</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-setdefault"><strong>setdefault</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-setdefault">setdefault</a>(k[,d]) -> D.<a href="#DocumentQuery-get">get</a>(k,d), also set D[k]=d if k not in D</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-update"><strong>update</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-update">update</a>([E, ]**F) -> None. Update D from dict/iterable E and F.<br> |
| If E present and has a .<a href="#DocumentQuery-keys">keys</a>() method, does: for k in E: D[k] = E[k]<br> |
| If E present and lacks .<a href="#DocumentQuery-keys">keys</a>() method, does: for (k, v) in E: D[k] = v<br> |
| In either case, this is followed by: for k in F: D[k] = F[k]</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-values"><strong>values</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-values">values</a>() -> list of D's values</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-viewitems"><strong>viewitems</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-viewitems">viewitems</a>() -> a set-like object providing a view on D's items</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-viewkeys"><strong>viewkeys</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-viewkeys">viewkeys</a>() -> a set-like object providing a view on D's keys</tt></dd></dl> |
| |
| <dl><dt><a name="DocumentQuery-viewvalues"><strong>viewvalues</strong></a>(...)</dt><dd><tt>D.<a href="#DocumentQuery-viewvalues">viewvalues</a>() -> an object providing a view on D's values</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="__builtin__.html#dict">__builtin__.dict</a>:<br> |
| <dl><dt><strong>__hash__</strong> = None</dl> |
| |
| <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#DocumentQuery-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></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>DATA_KIND_SCHEME</strong> = 'http://schemas.google.com/g/2005#kind'<br> |
| <strong>DOCUMENT_LABEL</strong> = 'document'<br> |
| <strong>FOLDERS_SCHEME_PREFIX</strong> = 'http://schemas.google.com/docs/2007/folders/'<br> |
| <strong>FOLDER_LABEL</strong> = 'folder'<br> |
| <strong>HIDDEN_LABEL_TERM</strong> = 'http://schemas.google.com/g/2005/labels#hidden'<br> |
| <strong>LABEL_SCHEME</strong> = 'http://schemas.google.com/g/2005/labels'<br> |
| <strong>MINE_LABEL_TERM</strong> = 'http://schemas.google.com/g/2005/labels#mine'<br> |
| <strong>PDF_LABEL</strong> = 'pdf'<br> |
| <strong>PRESENTATION_LABEL</strong> = 'presentation'<br> |
| <strong>PRIVATE_LABEL_TERM</strong> = 'http://schemas.google.com/g/2005/labels#private'<br> |
| <strong>SHARED_WITH_DOMAIN_LABEL_TERM</strong> = 'http://schemas.google.com/g/2005/labels#shared-with-domain'<br> |
| <strong>SPREADSHEET_LABEL</strong> = 'spreadsheet'<br> |
| <strong>STARRED_LABEL_TERM</strong> = 'http://schemas.google.com/g/2005/labels#starred'<br> |
| <strong>SUPPORTED_FILETYPES</strong> = {'CSV': 'text/csv', 'DOC': 'application/msword', 'DOCX': 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'HTM': 'text/html', 'HTML': 'text/html', 'ODS': 'application/x-vnd.oasis.opendocument.spreadsheet', 'ODT': 'application/vnd.oasis.opendocument.text', 'PDF': 'application/pdf', 'PNG': 'image/png', 'PPS': 'application/vnd.ms-powerpoint', ...}<br> |
| <strong>TRASHED_LABEL_TERM</strong> = 'http://schemas.google.com/g/2005/labels#trashed'<br> |
| <strong>VIEWED_LABEL_TERM</strong> = 'http://schemas.google.com/g/2005/labels#viewed'<br> |
| <strong>__author__</strong> = 'api.jfisher (Jeff Fisher), 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%">api.jfisher (Jeff Fisher), e.bidelman (Eric Bidelman)</td></tr></table> |
| </body></html> |
