Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / epy / oauth2client.client.AccessTokenCredentials-class.html
blob: 96579fbf49f981ee5f1e2fa6f48f409c17a7dfc1 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>oauth2client.client.AccessTokenCredentials</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 <a href="oauth2client.client-module.html">Module&nbsp;client</a> ::
39 Class&nbsp;AccessTokenCredentials
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.client.AccessTokenCredentials-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class AccessTokenCredentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_oauth2cl_15" name="uml_class_diagram_for_oauth2cl_15">
59<area shape="rect" id="node132" href="oauth2client.client.AccessTokenCredentials-class.html#__init__" title="Create an instance of OAuth2Credentials" alt="" coords="17,356,367,375"/>
60<area shape="rect" id="node132" href="oauth2client.client.AccessTokenCredentials-class.html#from_json" title="Instantiate a Credentials object from a JSON description of it." alt="" coords="17,375,367,393"/>
61<area shape="rect" id="node1" href="oauth2client.client.AccessTokenCredentials-class.html" title="Credentials object for OAuth 2.0." alt="" coords="5,323,379,399"/>
62<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#authorize" title="Authorize an httplib2.Http instance with these credentials." alt="" coords="108,129,275,148"/>
63<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#refresh" title="Forces a refresh of the access_token." alt="" coords="108,148,275,167"/>
64<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#revoke" title="Revokes a refresh_token and makes the credentials void." alt="" coords="108,167,275,185"/>
65<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#apply" title="Add the authorization to the headers." alt="" coords="108,185,275,204"/>
66<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#to_json" title="Creating a JSON representation of an instance of Credentials." alt="" coords="108,204,275,223"/>
67<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired" title="True if the credential is expired or invalid." alt="" coords="108,223,275,241"/>
68<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#set_store" title="Set the Storage for the credential." alt="" coords="108,241,275,260"/>
69<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#__getstate__" title="Trim the state down to something that can be pickled." alt="" coords="108,260,275,279"/>
70<area shape="rect" id="node133" href="oauth2client.client.OAuth2Credentials-class.html#__setstate__" title="Reconstitute the state of the object from being pickled." alt="" coords="108,279,275,297"/>
71<area shape="rect" id="node2" href="oauth2client.client.OAuth2Credentials-class.html" title="Credentials object for OAuth 2.0." alt="" coords="96,97,285,303"/>
72<area shape="rect" id="node134" href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS" title="oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS" alt="" coords="92,31,291,49"/>
73<area shape="rect" id="node134" 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="92,52,291,71"/>
74<area shape="rect" id="node3" href="oauth2client.client.Credentials-class.html" title="Base class for all Credentials objects." alt="" coords="80,6,301,77"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]75</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]76 <img src="uml_class_diagram_for_oauth2cl_15.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_15" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]77</center>
78</center>
79<hr />
80<pre class="literalblock">
81Credentials object for OAuth 2.0.
82
83Credentials can be applied to an httplib2.Http object using the
84authorize() method, which then signs each request from that object
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]85with the OAuth 2.0 access token. This set of credentials is for the
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]86use case where you have acquired an OAuth 2.0 access_token from
87another place such as a JavaScript client or another web
88application, and wish to use it from Python. Because only the
89access_token is present it can not be refreshed and will in time
90expire.
91
92AccessTokenCredentials objects may be safely pickled and unpickled.
93
94Usage:
95 credentials = AccessTokenCredentials('&lt;an access token&gt;',
96 'my-user-agent/1.0')
97 http = httplib2.Http()
98 http = credentials.authorize(http)
99
100Exceptions:
101 AccessTokenCredentialsExpired: raised when the access_token expires or is
102 revoked.
103
104</pre>
105
106<!-- ==================== INSTANCE METHODS ==================== -->
107<a name="section-InstanceMethods"></a>
108<table class="summary" border="1" cellpadding="3"
109 cellspacing="0" width="100%" bgcolor="white">
110<tr bgcolor="#70b0f0" class="table-header">
111 <td colspan="2" class="table-header">
112 <table border="0" cellpadding="0" cellspacing="0" width="100%">
113 <tr valign="top">
114 <td align="left"><span class="table-header">Instance Methods</span></td>
115 <td align="right" valign="top"
116 ><span class="options">[<a href="#section-InstanceMethods"
117 class="privatelink" onclick="toggle_private();"
118 >hide private</a>]</span></td>
119 </tr>
120 </table>
121 </td>
122</tr>
123<tr>
124 <td width="15%" align="right" valign="top" class="summary">
125 <span class="summary-type">&nbsp;</span>
126 </td><td class="summary">
127 <table width="100%" cellpadding="0" cellspacing="0" border="0">
128 <tr>
129 <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>,
130 <span class="summary-sig-arg">access_token</span>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]131 <span class="summary-sig-arg">user_agent</span>,
132 <span class="summary-sig-arg">revoke_uri</span>=<span class="summary-sig-default">None</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]133 Create an instance of OAuth2Credentials</td>
134 <td align="right" valign="top">
135 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.__init__">source&nbsp;code</a></span>
136
137 </td>
138 </tr>
139 </table>
140
141 </td>
142 </tr>
143<tr class="private">
144 <td width="15%" align="right" valign="top" class="summary">
145 <span class="summary-type">&nbsp;</span>
146 </td><td class="summary">
147 <table width="100%" cellpadding="0" cellspacing="0" border="0">
148 <tr>
149 <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>,
150 <span class="summary-sig-arg">http_request</span>)</span><br />
151 Refreshes the access_token.</td>
152 <td align="right" valign="top">
153 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._refresh">source&nbsp;code</a></span>
154
155 </td>
156 </tr>
157 </table>
158
159 </td>
160 </tr>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]161<tr class="private">
162 <td width="15%" align="right" valign="top" class="summary">
163 <span class="summary-type">&nbsp;</span>
164 </td><td class="summary">
165 <table width="100%" cellpadding="0" cellspacing="0" border="0">
166 <tr>
167 <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>,
168 <span class="summary-sig-arg">http_request</span>)</span><br />
169 Revokes the access_token and deletes the store if available.</td>
170 <td align="right" valign="top">
171 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._revoke">source&nbsp;code</a></span>
172
173 </td>
174 </tr>
175 </table>
176
177 </td>
178 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]179 <tr>
180 <td colspan="2" class="summary">
181 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
182 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,
183 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]184 <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]185 <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
186 <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
187 <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]188 <code><a href="oauth2client.client.OAuth2Credentials-class.html#revoke">revoke</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]189 <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
190 <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
191 </p>
192 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):
193 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]194 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_revoke" onclick="show_private();">_do_revoke</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]195 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">_generate_refresh_request_body</a></code>,
196 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
197 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
198 </p></div>
199 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
200 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
201 </p></div>
202 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
203 <code>__delattr__</code>,
204 <code>__format__</code>,
205 <code>__getattribute__</code>,
206 <code>__hash__</code>,
207 <code>__new__</code>,
208 <code>__reduce__</code>,
209 <code>__reduce_ex__</code>,
210 <code>__repr__</code>,
211 <code>__setattr__</code>,
212 <code>__sizeof__</code>,
213 <code>__str__</code>,
214 <code>__subclasshook__</code>
215 </p>
216 </td>
217 </tr>
218</table>
219<!-- ==================== CLASS METHODS ==================== -->
220<a name="section-ClassMethods"></a>
221<table class="summary" border="1" cellpadding="3"
222 cellspacing="0" width="100%" bgcolor="white">
223<tr bgcolor="#70b0f0" class="table-header">
224 <td colspan="2" class="table-header">
225 <table border="0" cellpadding="0" cellspacing="0" width="100%">
226 <tr valign="top">
227 <td align="left"><span class="table-header">Class Methods</span></td>
228 <td align="right" valign="top"
229 ><span class="options">[<a href="#section-ClassMethods"
230 class="privatelink" onclick="toggle_private();"
231 >hide private</a>]</span></td>
232 </tr>
233 </table>
234 </td>
235</tr>
236<tr>
237 <td width="15%" align="right" valign="top" class="summary">
238 <span class="summary-type">&nbsp;</span>
239 </td><td class="summary">
240 <table width="100%" cellpadding="0" cellspacing="0" border="0">
241 <tr>
242 <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>,
243 <span class="summary-sig-arg">s</span>)</span><br />
244 Instantiate a Credentials object from a JSON description of it.</td>
245 <td align="right" valign="top">
246 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.from_json">source&nbsp;code</a></span>
247
248 </td>
249 </tr>
250 </table>
251
252 </td>
253 </tr>
254 <tr>
255 <td colspan="2" class="summary">
256 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
257 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
258 </p>
259 </td>
260 </tr>
261</table>
262<!-- ==================== CLASS VARIABLES ==================== -->
263<a name="section-ClassVariables"></a>
264<table class="summary" border="1" cellpadding="3"
265 cellspacing="0" width="100%" bgcolor="white">
266<tr bgcolor="#70b0f0" class="table-header">
267 <td colspan="2" class="table-header">
268 <table border="0" cellpadding="0" cellspacing="0" width="100%">
269 <tr valign="top">
270 <td align="left"><span class="table-header">Class Variables</span></td>
271 <td align="right" valign="top"
272 ><span class="options">[<a href="#section-ClassVariables"
273 class="privatelink" onclick="toggle_private();"
274 >hide private</a>]</span></td>
275 </tr>
276 </table>
277 </td>
278</tr>
279 <tr>
280 <td colspan="2" class="summary">
281 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
282 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
283 </p>
284 </td>
285 </tr>
286</table>
287<!-- ==================== PROPERTIES ==================== -->
288<a name="section-Properties"></a>
289<table class="summary" border="1" cellpadding="3"
290 cellspacing="0" width="100%" bgcolor="white">
291<tr bgcolor="#70b0f0" class="table-header">
292 <td colspan="2" class="table-header">
293 <table border="0" cellpadding="0" cellspacing="0" width="100%">
294 <tr valign="top">
295 <td align="left"><span class="table-header">Properties</span></td>
296 <td align="right" valign="top"
297 ><span class="options">[<a href="#section-Properties"
298 class="privatelink" onclick="toggle_private();"
299 >hide private</a>]</span></td>
300 </tr>
301 </table>
302 </td>
303</tr>
304 <tr>
305 <td colspan="2" class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]306 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
307 <code>__class__</code>
308 </p>
309 </td>
310 </tr>
311</table>
312<!-- ==================== METHOD DETAILS ==================== -->
313<a name="section-MethodDetails"></a>
314<table class="details" border="1" cellpadding="3"
315 cellspacing="0" width="100%" bgcolor="white">
316<tr bgcolor="#70b0f0" class="table-header">
317 <td colspan="2" class="table-header">
318 <table border="0" cellpadding="0" cellspacing="0" width="100%">
319 <tr valign="top">
320 <td align="left"><span class="table-header">Method Details</span></td>
321 <td align="right" valign="top"
322 ><span class="options">[<a href="#section-MethodDetails"
323 class="privatelink" onclick="toggle_private();"
324 >hide private</a>]</span></td>
325 </tr>
326 </table>
327 </td>
328</tr>
329</table>
330<a name="__init__"></a>
331<div>
332<table class="details" border="1" cellpadding="3"
333 cellspacing="0" width="100%" bgcolor="white">
334<tr><td>
335 <table width="100%" cellpadding="0" cellspacing="0" border="0">
336 <tr valign="top"><td>
337 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
338 <span class="sig-arg">access_token</span>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]339 <span class="sig-arg">user_agent</span>,
340 <span class="sig-arg">revoke_uri</span>=<span class="sig-default">None</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]341 <br /><em class="fname">(Constructor)</em>
342 </h3>
343 </td><td align="right" valign="top"
344 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.__init__">source&nbsp;code</a></span>&nbsp;
345 </td>
346 </tr></table>
347
348 <pre class="literalblock">
349Create an instance of OAuth2Credentials
350
351This is one of the few types if Credentials that you should contrust,
352Credentials objects are usually instantiated by a Flow.
353
354Args:
355 access_token: string, access token.
356 user_agent: string, The HTTP User-Agent to provide for this application.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]357 revoke_uri: string, URI for revoke endpoint. Defaults to None; a token
358 can't be revoked if this is None.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]359
360</pre>
361 <dl class="fields">
362 <dt>Overrides:
363 object.__init__
364 </dt>
365 </dl>
366</td></tr></table>
367</div>
368<a name="from_json"></a>
369<div>
370<table class="details" border="1" cellpadding="3"
371 cellspacing="0" width="100%" bgcolor="white">
372<tr><td>
373 <table width="100%" cellpadding="0" cellspacing="0" border="0">
374 <tr valign="top"><td>
375 <h3 class="epydoc"><span class="sig"><span class="sig-name">from_json</span>(<span class="sig-arg">cls</span>,
376 <span class="sig-arg">s</span>)</span>
377 <br /><em class="fname">Class Method</em>
378 </h3>
379 </td><td align="right" valign="top"
380 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.from_json">source&nbsp;code</a></span>&nbsp;
381 </td>
382 </tr></table>
383
384 <pre class="literalblock">
385Instantiate a Credentials object from a JSON description of it. The JSON
386should have been produced by calling .to_json() on the object.
387
388Args:
389 data: dict, A deserialized JSON object.
390
391Returns:
392 An instance of a Credentials subclass.
393
394</pre>
395 <dl class="fields">
396 <dt>Overrides:
397 <a href="oauth2client.client.Credentials-class.html#from_json">Credentials.from_json</a>
398 <dd><em class="note">(inherited documentation)</em></dd>
399 </dt>
400 </dl>
401</td></tr></table>
402</div>
403<a name="_refresh"></a>
404<div class="private">
405<table class="details" border="1" cellpadding="3"
406 cellspacing="0" width="100%" bgcolor="white">
407<tr><td>
408 <table width="100%" cellpadding="0" cellspacing="0" border="0">
409 <tr valign="top"><td>
410 <h3 class="epydoc"><span class="sig"><span class="sig-name">_refresh</span>(<span class="sig-arg">self</span>,
411 <span class="sig-arg">http_request</span>)</span>
412 </h3>
413 </td><td align="right" valign="top"
414 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._refresh">source&nbsp;code</a></span>&nbsp;
415 </td>
416 </tr></table>
417
418 <pre class="literalblock">
419Refreshes the access_token.
420
421This method first checks by reading the Storage object if available.
422If a refresh is still needed, it holds the Storage lock until the
423refresh is completed.
424
425Args:
426 http_request: callable, a callable that matches the method signature of
427 httplib2.Http.request, used to make the refresh request.
428
429Raises:
430 AccessTokenRefreshError: When the refresh fails.
431
432</pre>
433 <dl class="fields">
434 <dt>Overrides:
435 <a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">OAuth2Credentials._refresh</a>
436 <dd><em class="note">(inherited documentation)</em></dd>
437 </dt>
438 </dl>
439</td></tr></table>
440</div>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]441<a name="_revoke"></a>
442<div class="private">
443<table class="details" border="1" cellpadding="3"
444 cellspacing="0" width="100%" bgcolor="white">
445<tr><td>
446 <table width="100%" cellpadding="0" cellspacing="0" border="0">
447 <tr valign="top"><td>
448 <h3 class="epydoc"><span class="sig"><span class="sig-name">_revoke</span>(<span class="sig-arg">self</span>,
449 <span class="sig-arg">http_request</span>)</span>
450 </h3>
451 </td><td align="right" valign="top"
452 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._revoke">source&nbsp;code</a></span>&nbsp;
453 </td>
454 </tr></table>
455
456 <pre class="literalblock">
457Revokes the access_token and deletes the store if available.
458
459Args:
460 http_request: callable, a callable that matches the method signature of
461 httplib2.Http.request, used to make the revoke request.
462
463</pre>
464 <dl class="fields">
465 <dt>Overrides:
466 <a href="oauth2client.client.OAuth2Credentials-class.html#_revoke" onclick="show_private();">OAuth2Credentials._revoke</a>
467 </dt>
468 </dl>
469</td></tr></table>
470</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]471<br />
472<!-- ==================== NAVIGATION BAR ==================== -->
473<table class="navbar" border="0" width="100%" cellpadding="0"
474 bgcolor="#a0c0ff" cellspacing="0">
475 <tr valign="middle">
476
477 <!-- Tree link -->
478 <th>&nbsp;&nbsp;&nbsp;<a
479 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
480
481 <!-- Index link -->
482 <th>&nbsp;&nbsp;&nbsp;<a
483 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
484
485 <!-- Help link -->
486 <th>&nbsp;&nbsp;&nbsp;<a
487 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
488
489 <th class="navbar" width="100%"></th>
490 </tr>
491</table>
492<table border="0" cellpadding="0" cellspacing="0" width="100%%">
493 <tr>
494 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]495 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:45 2013
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]496 </td>
497 <td align="right" class="footer">
498 <a target="mainFrame" href="http://epydoc.sourceforge.net"
499 >http://epydoc.sourceforge.net</a>
500 </td>
501 </tr>
502</table>
503
504<script type="text/javascript">
505 <!--
506 // Private objects are initially displayed (because if
507 // javascript is turned off then we want them to be
508 // visible); but by default, we want to hide them. So hide
509 // them unless we have a cookie that says to show them.
510 checkCookie();
511 // -->
512</script>
513</body>
514</html>