524 lines
24 KiB
HTML
524 lines
24 KiB
HTML
<?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.AccessTokenCredentials</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">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="oauth2client-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<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 AccessTokenCredentials
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
<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.AccessTokenCredentials-class.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class AccessTokenCredentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials">source code</a></span></p>
|
|
<center>
|
|
<center> <map id="uml_class_diagram_for_oauth2cl_15" name="uml_class_diagram_for_oauth2cl_15">
|
|
<area shape="rect" id="node1_14" href="oauth2client.client.AccessTokenCredentials-class.html#__init__" title="Create an instance of OAuth2Credentials" alt="" coords="18,367,371,385"/>
|
|
<area shape="rect" id="node1_15" href="oauth2client.client.AccessTokenCredentials-class.html#from_json" title="Instantiate a Credentials object from a JSON description of it." alt="" coords="18,385,371,404"/>
|
|
<area shape="rect" id="node1" href="oauth2client.client.AccessTokenCredentials-class.html" title="Credentials object for OAuth 2.0." alt="" coords="5,336,383,411"/>
|
|
<area shape="rect" id="node2_16" href="oauth2client.client.OAuth2Credentials-class.html#authorize" title="Authorize an httplib2.Http instance with these credentials." alt="" coords="90,124,301,143"/>
|
|
<area shape="rect" id="node2_17" href="oauth2client.client.OAuth2Credentials-class.html#refresh" title="Forces a refresh of the access_token." alt="" coords="90,143,301,161"/>
|
|
<area shape="rect" id="node2_18" href="oauth2client.client.OAuth2Credentials-class.html#revoke" title="Revokes a refresh_token and makes the credentials void." alt="" coords="90,161,301,180"/>
|
|
<area shape="rect" id="node2_19" href="oauth2client.client.OAuth2Credentials-class.html#apply" title="Add the authorization to the headers." alt="" coords="90,180,301,199"/>
|
|
<area shape="rect" id="node2_20" href="oauth2client.client.OAuth2Credentials-class.html#to_json" title="Creating a JSON representation of an instance of Credentials." alt="" coords="90,199,301,217"/>
|
|
<area shape="rect" id="node2_21" href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired" title="True if the credential is expired or invalid." alt="" coords="90,217,301,236"/>
|
|
<area shape="rect" id="node2_22" href="oauth2client.client.OAuth2Credentials-class.html#get_access_token" title="Return the access token and its expiration information." alt="" coords="90,236,301,255"/>
|
|
<area shape="rect" id="node2_23" href="oauth2client.client.OAuth2Credentials-class.html#set_store" title="Set the Storage for the credential." alt="" coords="90,255,301,273"/>
|
|
<area shape="rect" id="node2_24" href="oauth2client.client.OAuth2Credentials-class.html#__getstate__" title="Trim the state down to something that can be pickled." alt="" coords="90,273,301,292"/>
|
|
<area shape="rect" id="node2_25" href="oauth2client.client.OAuth2Credentials-class.html#__setstate__" title="Reconstitute the state of the object from being pickled." alt="" coords="90,292,301,311"/>
|
|
<area shape="rect" id="node2" href="oauth2client.client.OAuth2Credentials-class.html" title="Credentials object for OAuth 2.0." alt="" coords="78,93,313,317"/>
|
|
<area shape="rect" id="node3_26" href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS" title="oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS" alt="" coords="98,28,293,47"/>
|
|
<area shape="rect" id="node3_27" 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="98,49,293,68"/>
|
|
<area shape="rect" id="node3" href="oauth2client.client.Credentials-class.html" title="Base class for all Credentials objects." alt="" coords="86,5,305,75"/>
|
|
</map>
|
|
<img src="uml_class_diagram_for_oauth2cl_15.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_15" ismap="ismap" class="graph-without-title" />
|
|
</center>
|
|
</center>
|
|
<hr />
|
|
<pre class="literalblock">
|
|
Credentials object for OAuth 2.0.
|
|
|
|
Credentials can be applied to an httplib2.Http object using the
|
|
authorize() method, which then signs each request from that object
|
|
with the OAuth 2.0 access token. This set of credentials is for the
|
|
use case where you have acquired an OAuth 2.0 access_token from
|
|
another place such as a JavaScript client or another web
|
|
application, and wish to use it from Python. Because only the
|
|
access_token is present it can not be refreshed and will in time
|
|
expire.
|
|
|
|
AccessTokenCredentials objects may be safely pickled and unpickled.
|
|
|
|
Usage:
|
|
credentials = AccessTokenCredentials('<an access token>',
|
|
'my-user-agent/1.0')
|
|
http = httplib2.Http()
|
|
http = credentials.authorize(http)
|
|
|
|
Exceptions:
|
|
AccessTokenCredentialsExpired: raised when the access_token expires or is
|
|
revoked.
|
|
|
|
</pre>
|
|
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<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.AccessTokenCredentials-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">access_token</span>,
|
|
<span class="summary-sig-arg">user_agent</span>,
|
|
<span class="summary-sig-arg">revoke_uri</span>=<span class="summary-sig-default">None</span>)</span><br />
|
|
Create an instance of OAuth2Credentials</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.__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.AccessTokenCredentials-class.html#_refresh" class="summary-sig-name" onclick="show_private();">_refresh</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">http_request</span>)</span><br />
|
|
Refreshes the access_token.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._refresh">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.AccessTokenCredentials-class.html#_revoke" class="summary-sig-name" onclick="show_private();">_revoke</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">http_request</span>)</span><br />
|
|
Revokes the access_token and deletes the store if available.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._revoke">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#access_token_expired">access_token_expired</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#get_access_token">get_access_token</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#revoke">revoke</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#_do_revoke" onclick="show_private();">_do_revoke</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#_expires_in" onclick="show_private();">_expires_in</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">_generate_refresh_request_body</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#_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>
|
|
<!-- ==================== CLASS METHODS ==================== -->
|
|
<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 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.AccessTokenCredentials-class.html#from_json" class="summary-sig-name">from_json</a>(<span class="summary-sig-arg">cls</span>,
|
|
<span class="summary-sig-arg">s</span>)</span><br />
|
|
Instantiate a Credentials object from a JSON description of it.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.from_json">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.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>
|
|
<!-- ==================== CLASS VARIABLES ==================== -->
|
|
<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>
|
|
<!-- ==================== PROPERTIES ==================== -->
|
|
<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>object</code></b>:
|
|
<code>__class__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<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">access_token</span>,
|
|
<span class="sig-arg">user_agent</span>,
|
|
<span class="sig-arg">revoke_uri</span>=<span class="sig-default">None</span>)</span>
|
|
<br /><em class="fname">(Constructor)</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.__init__">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
Create an instance of OAuth2Credentials
|
|
|
|
This is one of the few types if Credentials that you should contrust,
|
|
Credentials objects are usually instantiated by a Flow.
|
|
|
|
Args:
|
|
access_token: string, access token.
|
|
user_agent: string, The HTTP User-Agent to provide for this application.
|
|
revoke_uri: string, URI for revoke endpoint. Defaults to None; a token
|
|
can't be revoked if this is None.
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
object.__init__
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="from_json"></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">from_json</span>(<span class="sig-arg">cls</span>,
|
|
<span class="sig-arg">s</span>)</span>
|
|
<br /><em class="fname">Class Method</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.from_json">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
Instantiate a Credentials object from a JSON description of it. The JSON
|
|
should have been produced by calling .to_json() on the object.
|
|
|
|
Args:
|
|
data: dict, A deserialized JSON object.
|
|
|
|
Returns:
|
|
An instance of a Credentials subclass.
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
<a href="oauth2client.client.Credentials-class.html#from_json">Credentials.from_json</a>
|
|
<dd><em class="note">(inherited documentation)</em></dd>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="_refresh"></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">_refresh</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">http_request</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._refresh">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
Refreshes the access_token.
|
|
|
|
This method first checks by reading the Storage object if available.
|
|
If a refresh is still needed, it holds the Storage lock until the
|
|
refresh is completed.
|
|
|
|
Args:
|
|
http_request: callable, a callable that matches the method signature of
|
|
httplib2.Http.request, used to make the refresh request.
|
|
|
|
Raises:
|
|
AccessTokenRefreshError: When the refresh fails.
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
<a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">OAuth2Credentials._refresh</a>
|
|
<dd><em class="note">(inherited documentation)</em></dd>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="_revoke"></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">_revoke</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">http_request</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._revoke">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
Revokes the access_token and deletes the store if available.
|
|
|
|
Args:
|
|
http_request: callable, a callable that matches the method signature of
|
|
httplib2.Http.request, used to make the revoke request.
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
<a href="oauth2client.client.OAuth2Credentials-class.html#_revoke" onclick="show_private();">OAuth2Credentials._revoke</a>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="oauth2client-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<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 Mon Sep 29 15:21:52 2014
|
|
</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>
|