blob: 6a1317264ed1d19b01f81acec9d52e320bad159c [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -04001<?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 Gregorio746096f2012-06-15 10:53:36 -040058<center> <map id="class_hierarchy_for_accesstoke" name="class_hierarchy_for_accesstoke">
Joe Gregorio52a5c532013-01-24 16:19:07 -050059<area shape="rect" id="node1" href="oauth2client.client.AccessTokenCredentials-class.html" title="AccessTokenCredentials" alt="" coords="5,6,173,34"/>
60<area shape="rect" id="node2" href="oauth2client.client.Credentials-class.html" title="Credentials" alt="" coords="197,6,285,34"/>
61<area shape="rect" id="node3" href="oauth2client.client.OAuth2Credentials-class.html" title="OAuth2Credentials" alt="" coords="309,6,440,34"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040062</map>
Joe Gregorio746096f2012-06-15 10:53:36 -040063 <img src="class_hierarchy_for_accesstoke.gif" alt='' usemap="#class_hierarchy_for_accesstoke" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040064</center>
65</center>
66<hr />
67<pre class="literalblock">
68Credentials object for OAuth 2.0.
69
70Credentials can be applied to an httplib2.Http object using the
71authorize() method, which then signs each request from that object
Joe Gregorio52a5c532013-01-24 16:19:07 -050072with the OAuth 2.0 access token. This set of credentials is for the
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040073use case where you have acquired an OAuth 2.0 access_token from
74another place such as a JavaScript client or another web
75application, and wish to use it from Python. Because only the
76access_token is present it can not be refreshed and will in time
77expire.
78
79AccessTokenCredentials objects may be safely pickled and unpickled.
80
81Usage:
82 credentials = AccessTokenCredentials('&lt;an access token&gt;',
83 'my-user-agent/1.0')
84 http = httplib2.Http()
85 http = credentials.authorize(http)
86
87Exceptions:
88 AccessTokenCredentialsExpired: raised when the access_token expires or is
89 revoked.
90
91</pre>
92
93<!-- ==================== INSTANCE METHODS ==================== -->
94<a name="section-InstanceMethods"></a>
95<table class="summary" border="1" cellpadding="3"
96 cellspacing="0" width="100%" bgcolor="white">
97<tr bgcolor="#70b0f0" class="table-header">
98 <td colspan="2" class="table-header">
99 <table border="0" cellpadding="0" cellspacing="0" width="100%">
100 <tr valign="top">
101 <td align="left"><span class="table-header">Instance Methods</span></td>
102 <td align="right" valign="top"
103 ><span class="options">[<a href="#section-InstanceMethods"
104 class="privatelink" onclick="toggle_private();"
105 >hide private</a>]</span></td>
106 </tr>
107 </table>
108 </td>
109</tr>
110<tr>
111 <td width="15%" align="right" valign="top" class="summary">
112 <span class="summary-type">&nbsp;</span>
113 </td><td class="summary">
114 <table width="100%" cellpadding="0" cellspacing="0" border="0">
115 <tr>
116 <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>,
117 <span class="summary-sig-arg">access_token</span>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500118 <span class="summary-sig-arg">user_agent</span>,
119 <span class="summary-sig-arg">revoke_uri</span>=<span class="summary-sig-default">None</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400120 Create an instance of OAuth2Credentials</td>
121 <td align="right" valign="top">
122 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.__init__">source&nbsp;code</a></span>
123
124 </td>
125 </tr>
126 </table>
127
128 </td>
129 </tr>
130<tr class="private">
131 <td width="15%" align="right" valign="top" class="summary">
132 <span class="summary-type">&nbsp;</span>
133 </td><td class="summary">
134 <table width="100%" cellpadding="0" cellspacing="0" border="0">
135 <tr>
136 <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>,
137 <span class="summary-sig-arg">http_request</span>)</span><br />
138 Refreshes the access_token.</td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._refresh">source&nbsp;code</a></span>
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500148<tr class="private">
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <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>,
155 <span class="summary-sig-arg">http_request</span>)</span><br />
156 Revokes the access_token and deletes the store if available.</td>
157 <td align="right" valign="top">
158 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._revoke">source&nbsp;code</a></span>
159
160 </td>
161 </tr>
162 </table>
163
164 </td>
165 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400166 <tr>
167 <td colspan="2" class="summary">
168 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
169 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,
170 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,
Joe Gregoriof4839b02012-09-06 13:47:24 -0400171 <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400172 <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
173 <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
174 <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500175 <code><a href="oauth2client.client.OAuth2Credentials-class.html#revoke">revoke</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400176 <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
177 <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
178 </p>
179 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):
180 <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 -0500181 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_revoke" onclick="show_private();">_do_revoke</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400182 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">_generate_refresh_request_body</a></code>,
183 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
184 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
185 </p></div>
186 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
187 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
188 </p></div>
189 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
190 <code>__delattr__</code>,
191 <code>__format__</code>,
192 <code>__getattribute__</code>,
193 <code>__hash__</code>,
194 <code>__new__</code>,
195 <code>__reduce__</code>,
196 <code>__reduce_ex__</code>,
197 <code>__repr__</code>,
198 <code>__setattr__</code>,
199 <code>__sizeof__</code>,
200 <code>__str__</code>,
201 <code>__subclasshook__</code>
202 </p>
203 </td>
204 </tr>
205</table>
206<!-- ==================== CLASS METHODS ==================== -->
207<a name="section-ClassMethods"></a>
208<table class="summary" border="1" cellpadding="3"
209 cellspacing="0" width="100%" bgcolor="white">
210<tr bgcolor="#70b0f0" class="table-header">
211 <td colspan="2" class="table-header">
212 <table border="0" cellpadding="0" cellspacing="0" width="100%">
213 <tr valign="top">
214 <td align="left"><span class="table-header">Class Methods</span></td>
215 <td align="right" valign="top"
216 ><span class="options">[<a href="#section-ClassMethods"
217 class="privatelink" onclick="toggle_private();"
218 >hide private</a>]</span></td>
219 </tr>
220 </table>
221 </td>
222</tr>
223<tr>
224 <td width="15%" align="right" valign="top" class="summary">
225 <span class="summary-type">&nbsp;</span>
226 </td><td class="summary">
227 <table width="100%" cellpadding="0" cellspacing="0" border="0">
228 <tr>
229 <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>,
230 <span class="summary-sig-arg">s</span>)</span><br />
231 Instantiate a Credentials object from a JSON description of it.</td>
232 <td align="right" valign="top">
233 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.from_json">source&nbsp;code</a></span>
234
235 </td>
236 </tr>
237 </table>
238
239 </td>
240 </tr>
241 <tr>
242 <td colspan="2" class="summary">
243 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
244 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
245 </p>
246 </td>
247 </tr>
248</table>
249<!-- ==================== CLASS VARIABLES ==================== -->
250<a name="section-ClassVariables"></a>
251<table class="summary" border="1" cellpadding="3"
252 cellspacing="0" width="100%" bgcolor="white">
253<tr bgcolor="#70b0f0" class="table-header">
254 <td colspan="2" class="table-header">
255 <table border="0" cellpadding="0" cellspacing="0" width="100%">
256 <tr valign="top">
257 <td align="left"><span class="table-header">Class Variables</span></td>
258 <td align="right" valign="top"
259 ><span class="options">[<a href="#section-ClassVariables"
260 class="privatelink" onclick="toggle_private();"
261 >hide private</a>]</span></td>
262 </tr>
263 </table>
264 </td>
265</tr>
266 <tr>
267 <td colspan="2" class="summary">
268 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
269 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
270 </p>
271 </td>
272 </tr>
273</table>
274<!-- ==================== PROPERTIES ==================== -->
275<a name="section-Properties"></a>
276<table class="summary" border="1" cellpadding="3"
277 cellspacing="0" width="100%" bgcolor="white">
278<tr bgcolor="#70b0f0" class="table-header">
279 <td colspan="2" class="table-header">
280 <table border="0" cellpadding="0" cellspacing="0" width="100%">
281 <tr valign="top">
282 <td align="left"><span class="table-header">Properties</span></td>
283 <td align="right" valign="top"
284 ><span class="options">[<a href="#section-Properties"
285 class="privatelink" onclick="toggle_private();"
286 >hide private</a>]</span></td>
287 </tr>
288 </table>
289 </td>
290</tr>
291 <tr>
292 <td colspan="2" class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400293 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
294 <code>__class__</code>
295 </p>
296 </td>
297 </tr>
298</table>
299<!-- ==================== METHOD DETAILS ==================== -->
300<a name="section-MethodDetails"></a>
301<table class="details" border="1" cellpadding="3"
302 cellspacing="0" width="100%" bgcolor="white">
303<tr bgcolor="#70b0f0" class="table-header">
304 <td colspan="2" class="table-header">
305 <table border="0" cellpadding="0" cellspacing="0" width="100%">
306 <tr valign="top">
307 <td align="left"><span class="table-header">Method Details</span></td>
308 <td align="right" valign="top"
309 ><span class="options">[<a href="#section-MethodDetails"
310 class="privatelink" onclick="toggle_private();"
311 >hide private</a>]</span></td>
312 </tr>
313 </table>
314 </td>
315</tr>
316</table>
317<a name="__init__"></a>
318<div>
319<table class="details" border="1" cellpadding="3"
320 cellspacing="0" width="100%" bgcolor="white">
321<tr><td>
322 <table width="100%" cellpadding="0" cellspacing="0" border="0">
323 <tr valign="top"><td>
324 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
325 <span class="sig-arg">access_token</span>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500326 <span class="sig-arg">user_agent</span>,
327 <span class="sig-arg">revoke_uri</span>=<span class="sig-default">None</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400328 <br /><em class="fname">(Constructor)</em>
329 </h3>
330 </td><td align="right" valign="top"
331 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.__init__">source&nbsp;code</a></span>&nbsp;
332 </td>
333 </tr></table>
334
335 <pre class="literalblock">
336Create an instance of OAuth2Credentials
337
338This is one of the few types if Credentials that you should contrust,
339Credentials objects are usually instantiated by a Flow.
340
341Args:
342 access_token: string, access token.
343 user_agent: string, The HTTP User-Agent to provide for this application.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500344 revoke_uri: string, URI for revoke endpoint. Defaults to None; a token
345 can't be revoked if this is None.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400346
347</pre>
348 <dl class="fields">
349 <dt>Overrides:
350 object.__init__
351 </dt>
352 </dl>
353</td></tr></table>
354</div>
355<a name="from_json"></a>
356<div>
357<table class="details" border="1" cellpadding="3"
358 cellspacing="0" width="100%" bgcolor="white">
359<tr><td>
360 <table width="100%" cellpadding="0" cellspacing="0" border="0">
361 <tr valign="top"><td>
362 <h3 class="epydoc"><span class="sig"><span class="sig-name">from_json</span>(<span class="sig-arg">cls</span>,
363 <span class="sig-arg">s</span>)</span>
364 <br /><em class="fname">Class Method</em>
365 </h3>
366 </td><td align="right" valign="top"
367 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.from_json">source&nbsp;code</a></span>&nbsp;
368 </td>
369 </tr></table>
370
371 <pre class="literalblock">
372Instantiate a Credentials object from a JSON description of it. The JSON
373should have been produced by calling .to_json() on the object.
374
375Args:
376 data: dict, A deserialized JSON object.
377
378Returns:
379 An instance of a Credentials subclass.
380
381</pre>
382 <dl class="fields">
383 <dt>Overrides:
384 <a href="oauth2client.client.Credentials-class.html#from_json">Credentials.from_json</a>
385 <dd><em class="note">(inherited documentation)</em></dd>
386 </dt>
387 </dl>
388</td></tr></table>
389</div>
390<a name="_refresh"></a>
391<div class="private">
392<table class="details" border="1" cellpadding="3"
393 cellspacing="0" width="100%" bgcolor="white">
394<tr><td>
395 <table width="100%" cellpadding="0" cellspacing="0" border="0">
396 <tr valign="top"><td>
397 <h3 class="epydoc"><span class="sig"><span class="sig-name">_refresh</span>(<span class="sig-arg">self</span>,
398 <span class="sig-arg">http_request</span>)</span>
399 </h3>
400 </td><td align="right" valign="top"
401 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._refresh">source&nbsp;code</a></span>&nbsp;
402 </td>
403 </tr></table>
404
405 <pre class="literalblock">
406Refreshes the access_token.
407
408This method first checks by reading the Storage object if available.
409If a refresh is still needed, it holds the Storage lock until the
410refresh is completed.
411
412Args:
413 http_request: callable, a callable that matches the method signature of
414 httplib2.Http.request, used to make the refresh request.
415
416Raises:
417 AccessTokenRefreshError: When the refresh fails.
418
419</pre>
420 <dl class="fields">
421 <dt>Overrides:
422 <a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">OAuth2Credentials._refresh</a>
423 <dd><em class="note">(inherited documentation)</em></dd>
424 </dt>
425 </dl>
426</td></tr></table>
427</div>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500428<a name="_revoke"></a>
429<div class="private">
430<table class="details" border="1" cellpadding="3"
431 cellspacing="0" width="100%" bgcolor="white">
432<tr><td>
433 <table width="100%" cellpadding="0" cellspacing="0" border="0">
434 <tr valign="top"><td>
435 <h3 class="epydoc"><span class="sig"><span class="sig-name">_revoke</span>(<span class="sig-arg">self</span>,
436 <span class="sig-arg">http_request</span>)</span>
437 </h3>
438 </td><td align="right" valign="top"
439 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._revoke">source&nbsp;code</a></span>&nbsp;
440 </td>
441 </tr></table>
442
443 <pre class="literalblock">
444Revokes the access_token and deletes the store if available.
445
446Args:
447 http_request: callable, a callable that matches the method signature of
448 httplib2.Http.request, used to make the revoke request.
449
450</pre>
451 <dl class="fields">
452 <dt>Overrides:
453 <a href="oauth2client.client.OAuth2Credentials-class.html#_revoke" onclick="show_private();">OAuth2Credentials._revoke</a>
454 </dt>
455 </dl>
456</td></tr></table>
457</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400458<br />
459<!-- ==================== NAVIGATION BAR ==================== -->
460<table class="navbar" border="0" width="100%" cellpadding="0"
461 bgcolor="#a0c0ff" cellspacing="0">
462 <tr valign="middle">
463
464 <!-- Tree link -->
465 <th>&nbsp;&nbsp;&nbsp;<a
466 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
467
468 <!-- Index link -->
469 <th>&nbsp;&nbsp;&nbsp;<a
470 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
471
472 <!-- Help link -->
473 <th>&nbsp;&nbsp;&nbsp;<a
474 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
475
476 <th class="navbar" width="100%"></th>
477 </tr>
478</table>
479<table border="0" cellpadding="0" cellspacing="0" width="100%%">
480 <tr>
481 <td align="left" class="footer">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500482 Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400483 </td>
484 <td align="right" class="footer">
485 <a target="mainFrame" href="http://epydoc.sourceforge.net"
486 >http://epydoc.sourceforge.net</a>
487 </td>
488 </tr>
489</table>
490
491<script type="text/javascript">
492 <!--
493 // Private objects are initially displayed (because if
494 // javascript is turned off then we want them to be
495 // visible); but by default, we want to hide them. So hide
496 // them unless we have a cookie that says to show them.
497 checkCookie();
498 // -->
499</script>
500</body>
501</html>