Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d37e76fad280dda7565e08efe6a0426e081fd542 / . / docs / epy / oauth2client.client.AccessTokenCredentials-class.html
blob: 50160f398c80aa9ccd7a2ee8d0e335b202eb50a9 [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 Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]58<center> <map id="class_hierarchy_for_accesstoke" name="class_hierarchy_for_accesstoke">
59<area shape="rect" href="oauth2client.client.AccessTokenCredentials-class.html" title="AccessTokenCredentials" alt="" coords="5,117,168,144"/>
60<area shape="rect" href="oauth2client.client.Credentials-class.html" title="Credentials" alt="" coords="44,5,129,32"/>
61<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html" title="OAuth2Credentials" alt="" coords="21,61,152,88"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]62</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]63 <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 -0400[diff] [blame]64</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
72with the OAuth 2.0 access token. This set of credentials is for the
73use 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>,
118 <span class="summary-sig-arg">user_agent</span>)</span><br />
119 Create an instance of OAuth2Credentials</td>
120 <td align="right" valign="top">
121 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.__init__">source&nbsp;code</a></span>
122
123 </td>
124 </tr>
125 </table>
126
127 </td>
128 </tr>
129<tr class="private">
130 <td width="15%" align="right" valign="top" class="summary">
131 <span class="summary-type">&nbsp;</span>
132 </td><td class="summary">
133 <table width="100%" cellpadding="0" cellspacing="0" border="0">
134 <tr>
135 <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>,
136 <span class="summary-sig-arg">http_request</span>)</span><br />
137 Refreshes the access_token.</td>
138 <td align="right" valign="top">
139 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._refresh">source&nbsp;code</a></span>
140
141 </td>
142 </tr>
143 </table>
144
145 </td>
146 </tr>
147 <tr>
148 <td colspan="2" class="summary">
149 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
150 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,
151 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,
152 <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
153 <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
154 <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
155 <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
156 <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
157 </p>
158 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):
159 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,
160 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">_generate_refresh_request_body</a></code>,
161 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
162 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
163 </p></div>
164 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
165 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
166 </p></div>
167 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
168 <code>__delattr__</code>,
169 <code>__format__</code>,
170 <code>__getattribute__</code>,
171 <code>__hash__</code>,
172 <code>__new__</code>,
173 <code>__reduce__</code>,
174 <code>__reduce_ex__</code>,
175 <code>__repr__</code>,
176 <code>__setattr__</code>,
177 <code>__sizeof__</code>,
178 <code>__str__</code>,
179 <code>__subclasshook__</code>
180 </p>
181 </td>
182 </tr>
183</table>
184<!-- ==================== CLASS METHODS ==================== -->
185<a name="section-ClassMethods"></a>
186<table class="summary" border="1" cellpadding="3"
187 cellspacing="0" width="100%" bgcolor="white">
188<tr bgcolor="#70b0f0" class="table-header">
189 <td colspan="2" class="table-header">
190 <table border="0" cellpadding="0" cellspacing="0" width="100%">
191 <tr valign="top">
192 <td align="left"><span class="table-header">Class Methods</span></td>
193 <td align="right" valign="top"
194 ><span class="options">[<a href="#section-ClassMethods"
195 class="privatelink" onclick="toggle_private();"
196 >hide private</a>]</span></td>
197 </tr>
198 </table>
199 </td>
200</tr>
201<tr>
202 <td width="15%" align="right" valign="top" class="summary">
203 <span class="summary-type">&nbsp;</span>
204 </td><td class="summary">
205 <table width="100%" cellpadding="0" cellspacing="0" border="0">
206 <tr>
207 <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>,
208 <span class="summary-sig-arg">s</span>)</span><br />
209 Instantiate a Credentials object from a JSON description of it.</td>
210 <td align="right" valign="top">
211 <span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.from_json">source&nbsp;code</a></span>
212
213 </td>
214 </tr>
215 </table>
216
217 </td>
218 </tr>
219 <tr>
220 <td colspan="2" class="summary">
221 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
222 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
223 </p>
224 </td>
225 </tr>
226</table>
227<!-- ==================== CLASS VARIABLES ==================== -->
228<a name="section-ClassVariables"></a>
229<table class="summary" border="1" cellpadding="3"
230 cellspacing="0" width="100%" bgcolor="white">
231<tr bgcolor="#70b0f0" class="table-header">
232 <td colspan="2" class="table-header">
233 <table border="0" cellpadding="0" cellspacing="0" width="100%">
234 <tr valign="top">
235 <td align="left"><span class="table-header">Class Variables</span></td>
236 <td align="right" valign="top"
237 ><span class="options">[<a href="#section-ClassVariables"
238 class="privatelink" onclick="toggle_private();"
239 >hide private</a>]</span></td>
240 </tr>
241 </table>
242 </td>
243</tr>
244 <tr>
245 <td colspan="2" class="summary">
246 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
247 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
248 </p>
249 </td>
250 </tr>
251</table>
252<!-- ==================== PROPERTIES ==================== -->
253<a name="section-Properties"></a>
254<table class="summary" border="1" cellpadding="3"
255 cellspacing="0" width="100%" bgcolor="white">
256<tr bgcolor="#70b0f0" class="table-header">
257 <td colspan="2" class="table-header">
258 <table border="0" cellpadding="0" cellspacing="0" width="100%">
259 <tr valign="top">
260 <td align="left"><span class="table-header">Properties</span></td>
261 <td align="right" valign="top"
262 ><span class="options">[<a href="#section-Properties"
263 class="privatelink" onclick="toggle_private();"
264 >hide private</a>]</span></td>
265 </tr>
266 </table>
267 </td>
268</tr>
269 <tr>
270 <td colspan="2" class="summary">
271 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
272 <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>
273 </p>
274 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
275 <code>__class__</code>
276 </p>
277 </td>
278 </tr>
279</table>
280<!-- ==================== METHOD DETAILS ==================== -->
281<a name="section-MethodDetails"></a>
282<table class="details" border="1" cellpadding="3"
283 cellspacing="0" width="100%" bgcolor="white">
284<tr bgcolor="#70b0f0" class="table-header">
285 <td colspan="2" class="table-header">
286 <table border="0" cellpadding="0" cellspacing="0" width="100%">
287 <tr valign="top">
288 <td align="left"><span class="table-header">Method Details</span></td>
289 <td align="right" valign="top"
290 ><span class="options">[<a href="#section-MethodDetails"
291 class="privatelink" onclick="toggle_private();"
292 >hide private</a>]</span></td>
293 </tr>
294 </table>
295 </td>
296</tr>
297</table>
298<a name="__init__"></a>
299<div>
300<table class="details" border="1" cellpadding="3"
301 cellspacing="0" width="100%" bgcolor="white">
302<tr><td>
303 <table width="100%" cellpadding="0" cellspacing="0" border="0">
304 <tr valign="top"><td>
305 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
306 <span class="sig-arg">access_token</span>,
307 <span class="sig-arg">user_agent</span>)</span>
308 <br /><em class="fname">(Constructor)</em>
309 </h3>
310 </td><td align="right" valign="top"
311 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.__init__">source&nbsp;code</a></span>&nbsp;
312 </td>
313 </tr></table>
314
315 <pre class="literalblock">
316Create an instance of OAuth2Credentials
317
318This is one of the few types if Credentials that you should contrust,
319Credentials objects are usually instantiated by a Flow.
320
321Args:
322 access_token: string, access token.
323 user_agent: string, The HTTP User-Agent to provide for this application.
324
325Notes:
326 store: callable, a callable that when passed a Credential
327 will store the credential back to where it came from.
328
329</pre>
330 <dl class="fields">
331 <dt>Overrides:
332 object.__init__
333 </dt>
334 </dl>
335</td></tr></table>
336</div>
337<a name="from_json"></a>
338<div>
339<table class="details" border="1" cellpadding="3"
340 cellspacing="0" width="100%" bgcolor="white">
341<tr><td>
342 <table width="100%" cellpadding="0" cellspacing="0" border="0">
343 <tr valign="top"><td>
344 <h3 class="epydoc"><span class="sig"><span class="sig-name">from_json</span>(<span class="sig-arg">cls</span>,
345 <span class="sig-arg">s</span>)</span>
346 <br /><em class="fname">Class Method</em>
347 </h3>
348 </td><td align="right" valign="top"
349 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials.from_json">source&nbsp;code</a></span>&nbsp;
350 </td>
351 </tr></table>
352
353 <pre class="literalblock">
354Instantiate a Credentials object from a JSON description of it. The JSON
355should have been produced by calling .to_json() on the object.
356
357Args:
358 data: dict, A deserialized JSON object.
359
360Returns:
361 An instance of a Credentials subclass.
362
363</pre>
364 <dl class="fields">
365 <dt>Overrides:
366 <a href="oauth2client.client.Credentials-class.html#from_json">Credentials.from_json</a>
367 <dd><em class="note">(inherited documentation)</em></dd>
368 </dt>
369 </dl>
370</td></tr></table>
371</div>
372<a name="_refresh"></a>
373<div class="private">
374<table class="details" border="1" cellpadding="3"
375 cellspacing="0" width="100%" bgcolor="white">
376<tr><td>
377 <table width="100%" cellpadding="0" cellspacing="0" border="0">
378 <tr valign="top"><td>
379 <h3 class="epydoc"><span class="sig"><span class="sig-name">_refresh</span>(<span class="sig-arg">self</span>,
380 <span class="sig-arg">http_request</span>)</span>
381 </h3>
382 </td><td align="right" valign="top"
383 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AccessTokenCredentials._refresh">source&nbsp;code</a></span>&nbsp;
384 </td>
385 </tr></table>
386
387 <pre class="literalblock">
388Refreshes the access_token.
389
390This method first checks by reading the Storage object if available.
391If a refresh is still needed, it holds the Storage lock until the
392refresh is completed.
393
394Args:
395 http_request: callable, a callable that matches the method signature of
396 httplib2.Http.request, used to make the refresh request.
397
398Raises:
399 AccessTokenRefreshError: When the refresh fails.
400
401</pre>
402 <dl class="fields">
403 <dt>Overrides:
404 <a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">OAuth2Credentials._refresh</a>
405 <dd><em class="note">(inherited documentation)</em></dd>
406 </dt>
407 </dl>
408</td></tr></table>
409</div>
410<br />
411<!-- ==================== NAVIGATION BAR ==================== -->
412<table class="navbar" border="0" width="100%" cellpadding="0"
413 bgcolor="#a0c0ff" cellspacing="0">
414 <tr valign="middle">
415
416 <!-- Tree link -->
417 <th>&nbsp;&nbsp;&nbsp;<a
418 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
419
420 <!-- Index link -->
421 <th>&nbsp;&nbsp;&nbsp;<a
422 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
423
424 <!-- Help link -->
425 <th>&nbsp;&nbsp;&nbsp;<a
426 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
427
428 <th class="navbar" width="100%"></th>
429 </tr>
430</table>
431<table border="0" cellpadding="0" cellspacing="0" width="100%%">
432 <tr>
433 <td align="left" class="footer">
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]434 Generated by Epydoc 3.0.1 on Fri Jun 15 13:13:24 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]435 </td>
436 <td align="right" class="footer">
437 <a target="mainFrame" href="http://epydoc.sourceforge.net"
438 >http://epydoc.sourceforge.net</a>
439 </td>
440 </tr>
441</table>
442
443<script type="text/javascript">
444 <!--
445 // Private objects are initially displayed (because if
446 // javascript is turned off then we want them to be
447 // visible); but by default, we want to hide them. So hide
448 // them unless we have a cookie that says to show them.
449 checkCookie();
450 // -->
451</script>
452</body>
453</html>