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