docs/epy/oauth2client.client.AssertionCredentials-class.html - Issue 6305043: Switch to epydoc for documenting library.

Unified Diff: docs/epy/oauth2client.client.AssertionCredentials-class.html

Issue 6305043: Switch to epydoc for documenting library. (Closed)

Patch Set: Revert old pydocs, they didn't really change. Created 12 years, 10 months ago

Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.

Jump to:

View side-by-side diff with in-line comments

« no previous file with comments | « docs/epy/oauth2client.client.AccessTokenRefreshError-class.html ('k') | docs/epy/oauth2client.client.Credentials-class.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: docs/epy/oauth2client.client.AssertionCredentials-class.html

===================================================================

new file mode 100644

--- /dev/null

+++ b/docs/epy/oauth2client.client.AssertionCredentials-class.html

@@ -0,0 +1,408 @@

+<?xml version="1.0" encoding="ascii"?>

+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

+ "DTD/xhtml1-transitional.dtd">

+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

+<head>

+ <title>oauth2client.client.AssertionCredentials</title>

+ <link rel="stylesheet" href="epydoc.css" type="text/css" />

+ <script type="text/javascript" src="epydoc.js"></script>

+</head>

+<body bgcolor="white" text="black" link="blue" vlink="#204080"

+ alink="#204080">

+

+<table class="navbar" border="0" width="100%" cellpadding="0"

+ bgcolor="#a0c0ff" cellspacing="0">

+ <tr valign="middle">

+

+ <th>   <a

+ href="module-tree.html">Trees</a>   </th>

+

+ <th>   <a

+ href="identifier-index.html">Indices</a>   </th>

+

+ <th>   <a

+ href="help.html">Help</a>   </th>

+ <th class="navbar" width="100%"></th>

+ </tr>

+</table>

+<table width="100%" cellpadding="0" cellspacing="0">

+ <tr valign="top">

+ <td width="100%">

+ <span class="breadcrumbs">

+ <a href="oauth2client-module.html">Package oauth2client</a> ::

+ <a href="oauth2client.client-module.html">Module client</a> ::

+ Class AssertionCredentials

+ </span>

+ </td>

+ <td>

+ <table cellpadding="0" cellspacing="0">

+

+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"

+ onclick="toggle_private();">hide private</a>]</span></td></tr>

+ <tr><td align="right"><span class="options"

+ >[<a href="frames.html" target="_top">frames</a

+ >] | <a href="oauth2client.client.AssertionCredentials-class.html"

+ target="_top">no frames</a>]</span></td></tr>

+ </table>

+ </td>

+ </tr>

+</table>

+

+<h1 class="epydoc">Class AssertionCredentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials">source code</a></span></p>

+<center>

+<center> <map id="uml_class_diagram_for_oauth2cl_13" name="uml_class_diagram_for_oauth2cl_13">

+<area shape="rect" href="oauth2client.client.AssertionCredentials-class.html#__init__" title="Constructor for AssertionFlowCredentials." alt="" coords="17,343,697,361"/>

+<area shape="rect" href="oauth2client.client.AssertionCredentials-class.html" title="Abstract Credentials object used for OAuth 2.0 assertion grants." alt="" coords="16,317,699,363"/>

+<area shape="rect" href="oauth2client.appengine.AppAssertionCredentials-class.html" title="Credentials object for App Engine Assertion Grants" alt="" coords="119,392,340,419"/>

+<area shape="rect" href="oauth2client.client.SignedJwtAssertionCredentials-class.html" title="Credentials object used for OAuth 2.0 Signed JWT assertion grants." alt="" coords="391,392,583,419"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired" title="True if the credential is expired or invalid." alt="" coords="284,116,431,135"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#authorize" title="Authorize an httplib2.Http instance with these credentials." alt="" coords="284,137,431,156"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#refresh" title="Forces a refresh of the access_token." alt="" coords="284,156,431,175"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#apply" title="Add the authorization to the headers." alt="" coords="284,175,431,193"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#to_json" title="Creating a JSON representation of an instance of Credentials." alt="" coords="284,193,431,212"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#from_json" title="Instantiate a Credentials object from a JSON description of it." alt="" coords="284,212,431,231"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#set_store" title="Set the Storage for the credential." alt="" coords="284,231,431,249"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#__getstate__" title="Trim the state down to something that can be pickled." alt="" coords="284,249,431,268"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html#__setstate__" title="Reconstitute the state of the object from being pickled." alt="" coords="284,268,431,287"/>

+<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html" title="Credentials object for OAuth 2.0." alt="" coords="283,99,432,288"/>

+<area shape="rect" href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS" title="oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS" alt="" coords="263,28,452,47"/>

+<area shape="rect" href="oauth2client.client.Credentials-class.html#new_from_json" title="Utility class method to instantiate a Credentials subclass from a JSON representation produced by to_json()." alt="" coords="263,49,452,68"/>

+<area shape="rect" href="oauth2client.client.Credentials-class.html" title="Base class for all Credentials objects." alt="" coords="261,11,453,69"/>

+</map>

+ <img src="uml_class_diagram_for_oauth2cl_13.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_13" ismap="ismap" class="graph-without-title" />

+</center>

+<hr />

+<pre class="literalblock">

+Abstract Credentials object used for OAuth 2.0 assertion grants.

+This credential does not require a flow to instantiate because it

+represents a two legged flow, and therefore has all of the required

+information to generate and refresh its own access tokens. It must

+be subclassed to generate the appropriate assertion string.

+AssertionCredentials objects may be safely pickled and unpickled.

+</pre>

+

+<a name="section-InstanceMethods"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Instance Methods</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-InstanceMethods"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+<tr>

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <table width="100%" cellpadding="0" cellspacing="0" border="0">

+ <tr>

+ <td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,

+ <span class="summary-sig-arg">assertion_type</span>,

+ <span class="summary-sig-arg">user_agent</span>,

+ <span class="summary-sig-arg">token_uri</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">https://accounts.google.com/o/oauth2/token</code><code class="variable-quote">'</code></span>,

+ <span class="summary-sig-arg">**unused_kwargs</span>)</span><br />

+ Constructor for AssertionFlowCredentials.</td>

+ <td align="right" valign="top">

+ <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source code</a></span>

+ </td>

+ </tr>

+ </table>

+ </td>

+ </tr>

+<tr class="private">

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <table width="100%" cellpadding="0" cellspacing="0" border="0">

+ <tr>

+ <td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body" class="summary-sig-name" onclick="show_private();">_generate_refresh_request_body</a>(<span class="summary-sig-arg">self</span>)</span><br />

+ Generate the body that will be used in the refresh request.</td>

+ <td align="right" valign="top">

+ <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source code</a></span>

+ </td>

+ </tr>

+ </table>

+ </td>

+ </tr>

+<tr class="private">

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <table width="100%" cellpadding="0" cellspacing="0" border="0">

+ <tr>

+ <td><span class="summary-sig"><a name="_generate_assertion"></a><span class="summary-sig-name">_generate_assertion</span>(<span class="summary-sig-arg">self</span>)</span><br />

+ Generate the assertion string that will be used in the access token

+request.</td>

+ <td align="right" valign="top">

+ <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_assertion">source code</a></span>

+ </td>

+ </tr>

+ </table>

+ </td>

+ </tr>

+ <tr>

+ <td colspan="2" class="summary">

+ <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>

+ </p>

+ <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">_refresh</a></code>,

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>

+ </p></div>

+ <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):

+ <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>

+ </p></div>

+ <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:

+ <code>__delattr__</code>,

+ <code>__format__</code>,

+ <code>__getattribute__</code>,

+ <code>__hash__</code>,

+ <code>__new__</code>,

+ <code>__reduce__</code>,

+ <code>__reduce_ex__</code>,

+ <code>__repr__</code>,

+ <code>__setattr__</code>,

+ <code>__sizeof__</code>,

+ <code>__str__</code>,

+ <code>__subclasshook__</code>

+ </p>

+ </td>

+ </tr>

+</table>

+

+<a name="section-ClassMethods"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Class Methods</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-ClassMethods"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+ <tr>

+ <td colspan="2" class="summary">

+ <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#from_json">from_json</a></code>

+ </p>

+ <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:

+ <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>

+ </p>

+ </td>

+ </tr>

+</table>

+

+<a name="section-ClassVariables"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Class Variables</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-ClassVariables"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+ <tr>

+ <td colspan="2" class="summary">

+ <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:

+ <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>

+ </p>

+ </td>

+ </tr>

+</table>

+

+<a name="section-Properties"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Properties</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-Properties"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+ <tr>

+ <td colspan="2" class="summary">

+ <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:

+ <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>

+ </p>

+ <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:

+ <code>__class__</code>

+ </p>

+ </td>

+ </tr>

+</table>

+

+<a name="section-MethodDetails"></a>

+<table class="details" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Method Details</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-MethodDetails"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+</table>

+<a name="__init__"></a>

+<div>

+<table class="details" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr><td>

+ <table width="100%" cellpadding="0" cellspacing="0" border="0">

+ <tr valign="top"><td>

+ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,

+ <span class="sig-arg">assertion_type</span>,

+ <span class="sig-arg">user_agent</span>,

+ <span class="sig-arg">token_uri</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">https://accounts.google.com/o/oauth2/token</code><code class="variable-quote">'</code></span>,

+ <span class="sig-arg">**unused_kwargs</span>)</span>

+ <br /><em class="fname">(Constructor)</em>

+ </h3>

+ </td><td align="right" valign="top"

+ ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source code</a></span> 

+ </td>

+ </tr></table>

+ <pre class="literalblock">

+Constructor for AssertionFlowCredentials.

+Args:

+ assertion_type: string, assertion type that will be declared to the auth

+ server

+ user_agent: string, The HTTP User-Agent to provide for this application.

+ token_uri: string, URI for token endpoint. For convenience

+ defaults to Google's endpoints but any OAuth 2.0 provider can be used.

+</pre>

+ <dl class="fields">

+ <dt>Overrides:

+ object.__init__

+ </dt>

+ </dl>

+</td></tr></table>

+</div>

+<a name="_generate_refresh_request_body"></a>

+<div class="private">

+<table class="details" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr><td>

+ <table width="100%" cellpadding="0" cellspacing="0" border="0">

+ <tr valign="top"><td>

+ <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_refresh_request_body</span>(<span class="sig-arg">self</span>)</span>

+ </h3>

+ </td><td align="right" valign="top"

+ ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source code</a></span> 

+ </td>

+ </tr></table>

+ <pre class="literalblock">

+Generate the body that will be used in the refresh request.

+</pre>

+ <dl class="fields">

+ <dt>Overrides:

+ <a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">OAuth2Credentials._generate_refresh_request_body</a>

+ <dd><em class="note">(inherited documentation)</em></dd>

+ </dt>

+ </dl>

+</td></tr></table>

+</div>

+<br />

+

+<table class="navbar" border="0" width="100%" cellpadding="0"

+ bgcolor="#a0c0ff" cellspacing="0">

+ <tr valign="middle">

+

+ <th>   <a

+ href="module-tree.html">Trees</a>   </th>

+

+ <th>   <a

+ href="identifier-index.html">Indices</a>   </th>

+

+ <th>   <a

+ href="help.html">Help</a>   </th>

+ <th class="navbar" width="100%"></th>

+ </tr>

+</table>

+<table border="0" cellpadding="0" cellspacing="0" width="100%%">

+ <tr>

+ <td align="left" class="footer">

+ Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:09 2012

+ </td>

+ <td align="right" class="footer">

+ <a target="mainFrame" href="http://epydoc.sourceforge.net"

+ >http://epydoc.sourceforge.net</a>

+ </td>

+ </tr>

+</table>

+<script type="text/javascript">

+ <!--

+ // Private objects are initially displayed (because if

+ // javascript is turned off then we want them to be

+ // visible); but by default, we want to hide them. So hide

+ // them unless we have a cookie that says to show them.

+ checkCookie();

+ // -->

+</script>

+</body>

+</html>