Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 41be8e897ece164d89f457c7ebbbafefd4cc357e / . / docs / epy / oauth2client.client.OAuth2Credentials-class.html
blob: 47e54cd786ad256c76cdd2e0a9497f0abcf0c46c [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.OAuth2Credentials</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;OAuth2Credentials
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.OAuth2Credentials-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 OAuth2Credentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials">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_oauth2cred" name="class_hierarchy_for_oauth2cred">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]59<area shape="rect" id="node1" href="oauth2client.client.Credentials-class.html" title="Credentials" alt="" coords="5,6,93,34"/>
60<area shape="rect" id="node2" href="oauth2client.client.OAuth2Credentials-class.html" title="OAuth2Credentials" alt="" coords="117,6,248,34"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]61</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]62 <img src="class_hierarchy_for_oauth2cred.gif" alt='' usemap="#class_hierarchy_for_oauth2cred" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]63</center>
64</center>
65<hr />
66<pre class="literalblock">
67Credentials object for OAuth 2.0.
68
69Credentials can be applied to an httplib2.Http object using the authorize()
70method, which then adds the OAuth 2.0 access token to each request.
71
72OAuth2Credentials objects may be safely pickled and unpickled.
73
74</pre>
75
76<!-- ==================== INSTANCE METHODS ==================== -->
77<a name="section-InstanceMethods"></a>
78<table class="summary" border="1" cellpadding="3"
79 cellspacing="0" width="100%" bgcolor="white">
80<tr bgcolor="#70b0f0" class="table-header">
81 <td colspan="2" class="table-header">
82 <table border="0" cellpadding="0" cellspacing="0" width="100%">
83 <tr valign="top">
84 <td align="left"><span class="table-header">Instance Methods</span></td>
85 <td align="right" valign="top"
86 ><span class="options">[<a href="#section-InstanceMethods"
87 class="privatelink" onclick="toggle_private();"
88 >hide private</a>]</span></td>
89 </tr>
90 </table>
91 </td>
92</tr>
93<tr>
94 <td width="15%" align="right" valign="top" class="summary">
95 <span class="summary-type">&nbsp;</span>
96 </td><td class="summary">
97 <table width="100%" cellpadding="0" cellspacing="0" border="0">
98 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]99 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
100 <span class="summary-sig-arg">access_token</span>,
101 <span class="summary-sig-arg">client_id</span>,
102 <span class="summary-sig-arg">client_secret</span>,
103 <span class="summary-sig-arg">refresh_token</span>,
104 <span class="summary-sig-arg">token_expiry</span>,
105 <span class="summary-sig-arg">token_uri</span>,
106 <span class="summary-sig-arg">user_agent</span>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]107 <span class="summary-sig-arg">revoke_uri</span>=<span class="summary-sig-default">None</span>,
108 <span class="summary-sig-arg">id_token</span>=<span class="summary-sig-default">None</span>,
109 <span class="summary-sig-arg">token_response</span>=<span class="summary-sig-default">None</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]110 Create an instance of OAuth2Credentials.</td>
111 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]112 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.__init__">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]113
114 </td>
115 </tr>
116 </table>
117
118 </td>
119 </tr>
120<tr>
121 <td width="15%" align="right" valign="top" class="summary">
122 <span class="summary-type">&nbsp;</span>
123 </td><td class="summary">
124 <table width="100%" cellpadding="0" cellspacing="0" border="0">
125 <tr>
126 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#authorize" class="summary-sig-name">authorize</a>(<span class="summary-sig-arg">self</span>,
127 <span class="summary-sig-arg">http</span>)</span><br />
128 Authorize an httplib2.Http instance with these credentials.</td>
129 <td align="right" valign="top">
130 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.authorize">source&nbsp;code</a></span>
131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
138<tr>
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type">&nbsp;</span>
141 </td><td class="summary">
142 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <tr>
144 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#refresh" class="summary-sig-name">refresh</a>(<span class="summary-sig-arg">self</span>,
145 <span class="summary-sig-arg">http</span>)</span><br />
146 Forces a refresh of the access_token.</td>
147 <td align="right" valign="top">
148 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.refresh">source&nbsp;code</a></span>
149
150 </td>
151 </tr>
152 </table>
153
154 </td>
155 </tr>
156<tr>
157 <td width="15%" align="right" valign="top" class="summary">
158 <span class="summary-type">&nbsp;</span>
159 </td><td class="summary">
160 <table width="100%" cellpadding="0" cellspacing="0" border="0">
161 <tr>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]162 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#revoke" class="summary-sig-name">revoke</a>(<span class="summary-sig-arg">self</span>,
163 <span class="summary-sig-arg">http</span>)</span><br />
164 Revokes a refresh_token and makes the credentials void.</td>
165 <td align="right" valign="top">
166 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.revoke">source&nbsp;code</a></span>
167
168 </td>
169 </tr>
170 </table>
171
172 </td>
173 </tr>
174<tr>
175 <td width="15%" align="right" valign="top" class="summary">
176 <span class="summary-type">&nbsp;</span>
177 </td><td class="summary">
178 <table width="100%" cellpadding="0" cellspacing="0" border="0">
179 <tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]180 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#apply" class="summary-sig-name">apply</a>(<span class="summary-sig-arg">self</span>,
181 <span class="summary-sig-arg">headers</span>)</span><br />
182 Add the authorization to the headers.</td>
183 <td align="right" valign="top">
184 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.apply">source&nbsp;code</a></span>
185
186 </td>
187 </tr>
188 </table>
189
190 </td>
191 </tr>
192<tr>
193 <td width="15%" align="right" valign="top" class="summary">
194 <span class="summary-type">&nbsp;</span>
195 </td><td class="summary">
196 <table width="100%" cellpadding="0" cellspacing="0" border="0">
197 <tr>
198 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#to_json" class="summary-sig-name">to_json</a>(<span class="summary-sig-arg">self</span>)</span><br />
199 Creating a JSON representation of an instance of Credentials.</td>
200 <td align="right" valign="top">
201 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.to_json">source&nbsp;code</a></span>
202
203 </td>
204 </tr>
205 </table>
206
207 </td>
208 </tr>
209<tr>
210 <td width="15%" align="right" valign="top" class="summary">
211 <span class="summary-type">&nbsp;</span>
212 </td><td class="summary">
213 <table width="100%" cellpadding="0" cellspacing="0" border="0">
214 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]215 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired" class="summary-sig-name">access_token_expired</a>(<span class="summary-sig-arg">self</span>)</span><br />
216 True if the credential is expired or invalid.</td>
217 <td align="right" valign="top">
218 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.access_token_expired">source&nbsp;code</a></span>
219
220 </td>
221 </tr>
222 </table>
223
224 </td>
225 </tr>
226<tr>
227 <td width="15%" align="right" valign="top" class="summary">
228 <span class="summary-type">&nbsp;</span>
229 </td><td class="summary">
230 <table width="100%" cellpadding="0" cellspacing="0" border="0">
231 <tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]232 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#set_store" class="summary-sig-name">set_store</a>(<span class="summary-sig-arg">self</span>,
233 <span class="summary-sig-arg">store</span>)</span><br />
234 Set the Storage for the credential.</td>
235 <td align="right" valign="top">
236 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.set_store">source&nbsp;code</a></span>
237
238 </td>
239 </tr>
240 </table>
241
242 </td>
243 </tr>
244<tr class="private">
245 <td width="15%" align="right" valign="top" class="summary">
246 <span class="summary-type">&nbsp;</span>
247 </td><td class="summary">
248 <table width="100%" cellpadding="0" cellspacing="0" border="0">
249 <tr>
250 <td><span class="summary-sig"><a name="_updateFromCredential"></a><span class="summary-sig-name">_updateFromCredential</span>(<span class="summary-sig-arg">self</span>,
251 <span class="summary-sig-arg">other</span>)</span><br />
252 Update this Credential from another instance.</td>
253 <td align="right" valign="top">
254 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._updateFromCredential">source&nbsp;code</a></span>
255
256 </td>
257 </tr>
258 </table>
259
260 </td>
261 </tr>
262<tr>
263 <td width="15%" align="right" valign="top" class="summary">
264 <span class="summary-type">&nbsp;</span>
265 </td><td class="summary">
266 <table width="100%" cellpadding="0" cellspacing="0" border="0">
267 <tr>
268 <td><span class="summary-sig"><a name="__getstate__"></a><span class="summary-sig-name">__getstate__</span>(<span class="summary-sig-arg">self</span>)</span><br />
269 Trim the state down to something that can be pickled.</td>
270 <td align="right" valign="top">
271 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.__getstate__">source&nbsp;code</a></span>
272
273 </td>
274 </tr>
275 </table>
276
277 </td>
278 </tr>
279<tr>
280 <td width="15%" align="right" valign="top" class="summary">
281 <span class="summary-type">&nbsp;</span>
282 </td><td class="summary">
283 <table width="100%" cellpadding="0" cellspacing="0" border="0">
284 <tr>
285 <td><span class="summary-sig"><a name="__setstate__"></a><span class="summary-sig-name">__setstate__</span>(<span class="summary-sig-arg">self</span>,
286 <span class="summary-sig-arg">state</span>)</span><br />
287 Reconstitute the state of the object from being pickled.</td>
288 <td align="right" valign="top">
289 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.__setstate__">source&nbsp;code</a></span>
290
291 </td>
292 </tr>
293 </table>
294
295 </td>
296 </tr>
297<tr class="private">
298 <td width="15%" align="right" valign="top" class="summary">
299 <span class="summary-type">&nbsp;</span>
300 </td><td class="summary">
301 <table width="100%" cellpadding="0" cellspacing="0" border="0">
302 <tr>
303 <td><span class="summary-sig"><a name="_generate_refresh_request_body"></a><span class="summary-sig-name">_generate_refresh_request_body</span>(<span class="summary-sig-arg">self</span>)</span><br />
304 Generate the body that will be used in the refresh request.</td>
305 <td align="right" valign="top">
306 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._generate_refresh_request_body">source&nbsp;code</a></span>
307
308 </td>
309 </tr>
310 </table>
311
312 </td>
313 </tr>
314<tr class="private">
315 <td width="15%" align="right" valign="top" class="summary">
316 <span class="summary-type">&nbsp;</span>
317 </td><td class="summary">
318 <table width="100%" cellpadding="0" cellspacing="0" border="0">
319 <tr>
320 <td><span class="summary-sig"><a name="_generate_refresh_request_headers"></a><span class="summary-sig-name">_generate_refresh_request_headers</span>(<span class="summary-sig-arg">self</span>)</span><br />
321 Generate the headers that will be used in the refresh request.</td>
322 <td align="right" valign="top">
323 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._generate_refresh_request_headers">source&nbsp;code</a></span>
324
325 </td>
326 </tr>
327 </table>
328
329 </td>
330 </tr>
331<tr class="private">
332 <td width="15%" align="right" valign="top" class="summary">
333 <span class="summary-type">&nbsp;</span>
334 </td><td class="summary">
335 <table width="100%" cellpadding="0" cellspacing="0" border="0">
336 <tr>
337 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" class="summary-sig-name" onclick="show_private();">_refresh</a>(<span class="summary-sig-arg">self</span>,
338 <span class="summary-sig-arg">http_request</span>)</span><br />
339 Refreshes the access_token.</td>
340 <td align="right" valign="top">
341 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._refresh">source&nbsp;code</a></span>
342
343 </td>
344 </tr>
345 </table>
346
347 </td>
348 </tr>
349<tr class="private">
350 <td width="15%" align="right" valign="top" class="summary">
351 <span class="summary-type">&nbsp;</span>
352 </td><td class="summary">
353 <table width="100%" cellpadding="0" cellspacing="0" border="0">
354 <tr>
355 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" class="summary-sig-name" onclick="show_private();">_do_refresh_request</a>(<span class="summary-sig-arg">self</span>,
356 <span class="summary-sig-arg">http_request</span>)</span><br />
357 Refresh the access_token using the refresh_token.</td>
358 <td align="right" valign="top">
359 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._do_refresh_request">source&nbsp;code</a></span>
360
361 </td>
362 </tr>
363 </table>
364
365 </td>
366 </tr>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]367<tr class="private">
368 <td width="15%" align="right" valign="top" class="summary">
369 <span class="summary-type">&nbsp;</span>
370 </td><td class="summary">
371 <table width="100%" cellpadding="0" cellspacing="0" border="0">
372 <tr>
373 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#_revoke" class="summary-sig-name" onclick="show_private();">_revoke</a>(<span class="summary-sig-arg">self</span>,
374 <span class="summary-sig-arg">http_request</span>)</span><br />
375 Revokes the refresh_token and deletes the store if available.</td>
376 <td align="right" valign="top">
377 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._revoke">source&nbsp;code</a></span>
378
379 </td>
380 </tr>
381 </table>
382
383 </td>
384 </tr>
385<tr class="private">
386 <td width="15%" align="right" valign="top" class="summary">
387 <span class="summary-type">&nbsp;</span>
388 </td><td class="summary">
389 <table width="100%" cellpadding="0" cellspacing="0" border="0">
390 <tr>
391 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#_do_revoke" class="summary-sig-name" onclick="show_private();">_do_revoke</a>(<span class="summary-sig-arg">self</span>,
392 <span class="summary-sig-arg">http_request</span>,
393 <span class="summary-sig-arg">token</span>)</span><br />
394 Revokes the credentials and deletes the store if available.</td>
395 <td align="right" valign="top">
396 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._do_revoke">source&nbsp;code</a></span>
397
398 </td>
399 </tr>
400 </table>
401
402 </td>
403 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]404 <tr>
405 <td colspan="2" class="summary">
406 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
407 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
408 </p></div>
409 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
410 <code>__delattr__</code>,
411 <code>__format__</code>,
412 <code>__getattribute__</code>,
413 <code>__hash__</code>,
414 <code>__new__</code>,
415 <code>__reduce__</code>,
416 <code>__reduce_ex__</code>,
417 <code>__repr__</code>,
418 <code>__setattr__</code>,
419 <code>__sizeof__</code>,
420 <code>__str__</code>,
421 <code>__subclasshook__</code>
422 </p>
423 </td>
424 </tr>
425</table>
426<!-- ==================== CLASS METHODS ==================== -->
427<a name="section-ClassMethods"></a>
428<table class="summary" border="1" cellpadding="3"
429 cellspacing="0" width="100%" bgcolor="white">
430<tr bgcolor="#70b0f0" class="table-header">
431 <td colspan="2" class="table-header">
432 <table border="0" cellpadding="0" cellspacing="0" width="100%">
433 <tr valign="top">
434 <td align="left"><span class="table-header">Class Methods</span></td>
435 <td align="right" valign="top"
436 ><span class="options">[<a href="#section-ClassMethods"
437 class="privatelink" onclick="toggle_private();"
438 >hide private</a>]</span></td>
439 </tr>
440 </table>
441 </td>
442</tr>
443<tr>
444 <td width="15%" align="right" valign="top" class="summary">
445 <span class="summary-type">&nbsp;</span>
446 </td><td class="summary">
447 <table width="100%" cellpadding="0" cellspacing="0" border="0">
448 <tr>
449 <td><span class="summary-sig"><a href="oauth2client.client.OAuth2Credentials-class.html#from_json" class="summary-sig-name">from_json</a>(<span class="summary-sig-arg">cls</span>,
450 <span class="summary-sig-arg">s</span>)</span><br />
451 Instantiate a Credentials object from a JSON description of it.</td>
452 <td align="right" valign="top">
453 <span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.from_json">source&nbsp;code</a></span>
454
455 </td>
456 </tr>
457 </table>
458
459 </td>
460 </tr>
461 <tr>
462 <td colspan="2" class="summary">
463 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
464 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
465 </p>
466 </td>
467 </tr>
468</table>
469<!-- ==================== CLASS VARIABLES ==================== -->
470<a name="section-ClassVariables"></a>
471<table class="summary" border="1" cellpadding="3"
472 cellspacing="0" width="100%" bgcolor="white">
473<tr bgcolor="#70b0f0" class="table-header">
474 <td colspan="2" class="table-header">
475 <table border="0" cellpadding="0" cellspacing="0" width="100%">
476 <tr valign="top">
477 <td align="left"><span class="table-header">Class Variables</span></td>
478 <td align="right" valign="top"
479 ><span class="options">[<a href="#section-ClassVariables"
480 class="privatelink" onclick="toggle_private();"
481 >hide private</a>]</span></td>
482 </tr>
483 </table>
484 </td>
485</tr>
486 <tr>
487 <td colspan="2" class="summary">
488 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
489 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
490 </p>
491 </td>
492 </tr>
493</table>
494<!-- ==================== PROPERTIES ==================== -->
495<a name="section-Properties"></a>
496<table class="summary" border="1" cellpadding="3"
497 cellspacing="0" width="100%" bgcolor="white">
498<tr bgcolor="#70b0f0" class="table-header">
499 <td colspan="2" class="table-header">
500 <table border="0" cellpadding="0" cellspacing="0" width="100%">
501 <tr valign="top">
502 <td align="left"><span class="table-header">Properties</span></td>
503 <td align="right" valign="top"
504 ><span class="options">[<a href="#section-Properties"
505 class="privatelink" onclick="toggle_private();"
506 >hide private</a>]</span></td>
507 </tr>
508 </table>
509 </td>
510</tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]511 <tr>
512 <td colspan="2" class="summary">
513 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
514 <code>__class__</code>
515 </p>
516 </td>
517 </tr>
518</table>
519<!-- ==================== METHOD DETAILS ==================== -->
520<a name="section-MethodDetails"></a>
521<table class="details" border="1" cellpadding="3"
522 cellspacing="0" width="100%" bgcolor="white">
523<tr bgcolor="#70b0f0" class="table-header">
524 <td colspan="2" class="table-header">
525 <table border="0" cellpadding="0" cellspacing="0" width="100%">
526 <tr valign="top">
527 <td align="left"><span class="table-header">Method Details</span></td>
528 <td align="right" valign="top"
529 ><span class="options">[<a href="#section-MethodDetails"
530 class="privatelink" onclick="toggle_private();"
531 >hide private</a>]</span></td>
532 </tr>
533 </table>
534 </td>
535</tr>
536</table>
537<a name="__init__"></a>
538<div>
539<table class="details" border="1" cellpadding="3"
540 cellspacing="0" width="100%" bgcolor="white">
541<tr><td>
542 <table width="100%" cellpadding="0" cellspacing="0" border="0">
543 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]544 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
545 <span class="sig-arg">access_token</span>,
546 <span class="sig-arg">client_id</span>,
547 <span class="sig-arg">client_secret</span>,
548 <span class="sig-arg">refresh_token</span>,
549 <span class="sig-arg">token_expiry</span>,
550 <span class="sig-arg">token_uri</span>,
551 <span class="sig-arg">user_agent</span>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]552 <span class="sig-arg">revoke_uri</span>=<span class="sig-default">None</span>,
553 <span class="sig-arg">id_token</span>=<span class="sig-default">None</span>,
554 <span class="sig-arg">token_response</span>=<span class="sig-default">None</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]555 <br /><em class="fname">(Constructor)</em>
556 </h3>
557 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]558 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.__init__">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]559 </td>
560 </tr></table>
561
562 <pre class="literalblock">
563Create an instance of OAuth2Credentials.
564
565This constructor is not usually called by the user, instead
566OAuth2Credentials objects are instantiated by the OAuth2WebServerFlow.
567
568Args:
569 access_token: string, access token.
570 client_id: string, client identifier.
571 client_secret: string, client secret.
572 refresh_token: string, refresh token.
573 token_expiry: datetime, when the access_token expires.
574 token_uri: string, URI of token endpoint.
575 user_agent: string, The HTTP User-Agent to provide for this application.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]576 revoke_uri: string, URI for revoke endpoint. Defaults to None; a token
577 can't be revoked if this is None.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]578 id_token: object, The identity of the resource owner.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]579 token_response: dict, the decoded response to the token request. None
580 if a token hasn't been requested yet. Stored because some providers
581 (e.g. wordpress.com) include extra fields that clients may want.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]582
583Notes:
584 store: callable, A callable that when passed a Credential
585 will store the credential back to where it came from.
586 This is needed to store the latest access_token if it
587 has expired and been refreshed.
588
589</pre>
590 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]591 <dt>Decorators:</dt>
592 <dd><ul class="nomargin-top">
593 <li><code>@util.positional(8)</code></li>
594 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]595 <dt>Overrides:
596 object.__init__
597 </dt>
598 </dl>
599</td></tr></table>
600</div>
601<a name="authorize"></a>
602<div>
603<table class="details" border="1" cellpadding="3"
604 cellspacing="0" width="100%" bgcolor="white">
605<tr><td>
606 <table width="100%" cellpadding="0" cellspacing="0" border="0">
607 <tr valign="top"><td>
608 <h3 class="epydoc"><span class="sig"><span class="sig-name">authorize</span>(<span class="sig-arg">self</span>,
609 <span class="sig-arg">http</span>)</span>
610 </h3>
611 </td><td align="right" valign="top"
612 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.authorize">source&nbsp;code</a></span>&nbsp;
613 </td>
614 </tr></table>
615
616 <pre class="literalblock">
617Authorize an httplib2.Http instance with these credentials.
618
619The modified http.request method will add authentication headers to each
620request and will refresh access_tokens when a 401 is received on a
621request. In addition the http.request method has a credentials property,
622http.request.credentials, which is the Credentials object that authorized
623it.
624
625Args:
626 http: An instance of httplib2.Http
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]627 or something that acts like it.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]628
629Returns:
630 A modified instance of http that was passed in.
631
632Example:
633
634 h = httplib2.Http()
635 h = credentials.authorize(h)
636
637You can't create a new OAuth subclass of httplib2.Authenication
638because it never gets passed the absolute URI, which is needed for
639signing. So instead we have to overload 'request' with a closure
640that adds in the Authorization header and then calls the original
641version of 'request()'.
642
643</pre>
644 <dl class="fields">
645 <dt>Overrides:
646 <a href="oauth2client.client.Credentials-class.html#authorize">Credentials.authorize</a>
647 </dt>
648 </dl>
649</td></tr></table>
650</div>
651<a name="refresh"></a>
652<div>
653<table class="details" border="1" cellpadding="3"
654 cellspacing="0" width="100%" bgcolor="white">
655<tr><td>
656 <table width="100%" cellpadding="0" cellspacing="0" border="0">
657 <tr valign="top"><td>
658 <h3 class="epydoc"><span class="sig"><span class="sig-name">refresh</span>(<span class="sig-arg">self</span>,
659 <span class="sig-arg">http</span>)</span>
660 </h3>
661 </td><td align="right" valign="top"
662 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.refresh">source&nbsp;code</a></span>&nbsp;
663 </td>
664 </tr></table>
665
666 <pre class="literalblock">
667Forces a refresh of the access_token.
668
669Args:
670 http: httplib2.Http, an http object to be used to make the refresh
671 request.
672
673</pre>
674 <dl class="fields">
675 <dt>Overrides:
676 <a href="oauth2client.client.Credentials-class.html#refresh">Credentials.refresh</a>
677 </dt>
678 </dl>
679</td></tr></table>
680</div>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]681<a name="revoke"></a>
682<div>
683<table class="details" border="1" cellpadding="3"
684 cellspacing="0" width="100%" bgcolor="white">
685<tr><td>
686 <table width="100%" cellpadding="0" cellspacing="0" border="0">
687 <tr valign="top"><td>
688 <h3 class="epydoc"><span class="sig"><span class="sig-name">revoke</span>(<span class="sig-arg">self</span>,
689 <span class="sig-arg">http</span>)</span>
690 </h3>
691 </td><td align="right" valign="top"
692 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.revoke">source&nbsp;code</a></span>&nbsp;
693 </td>
694 </tr></table>
695
696 <pre class="literalblock">
697Revokes a refresh_token and makes the credentials void.
698
699Args:
700 http: httplib2.Http, an http object to be used to make the revoke
701 request.
702
703</pre>
704 <dl class="fields">
705 <dt>Overrides:
706 <a href="oauth2client.client.Credentials-class.html#revoke">Credentials.revoke</a>
707 </dt>
708 </dl>
709</td></tr></table>
710</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]711<a name="apply"></a>
712<div>
713<table class="details" border="1" cellpadding="3"
714 cellspacing="0" width="100%" bgcolor="white">
715<tr><td>
716 <table width="100%" cellpadding="0" cellspacing="0" border="0">
717 <tr valign="top"><td>
718 <h3 class="epydoc"><span class="sig"><span class="sig-name">apply</span>(<span class="sig-arg">self</span>,
719 <span class="sig-arg">headers</span>)</span>
720 </h3>
721 </td><td align="right" valign="top"
722 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.apply">source&nbsp;code</a></span>&nbsp;
723 </td>
724 </tr></table>
725
726 <pre class="literalblock">
727Add the authorization to the headers.
728
729Args:
730 headers: dict, the headers to add the Authorization header to.
731
732</pre>
733 <dl class="fields">
734 <dt>Overrides:
735 <a href="oauth2client.client.Credentials-class.html#apply">Credentials.apply</a>
736 </dt>
737 </dl>
738</td></tr></table>
739</div>
740<a name="to_json"></a>
741<div>
742<table class="details" border="1" cellpadding="3"
743 cellspacing="0" width="100%" bgcolor="white">
744<tr><td>
745 <table width="100%" cellpadding="0" cellspacing="0" border="0">
746 <tr valign="top"><td>
747 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
748 </h3>
749 </td><td align="right" valign="top"
750 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.to_json">source&nbsp;code</a></span>&nbsp;
751 </td>
752 </tr></table>
753
754 <pre class="literalblock">
755Creating a JSON representation of an instance of Credentials.
756
757Returns:
758 string, a JSON representation of this instance, suitable to pass to
759 from_json().
760
761</pre>
762 <dl class="fields">
763 <dt>Overrides:
764 <a href="oauth2client.client.Credentials-class.html#to_json">Credentials.to_json</a>
765 <dd><em class="note">(inherited documentation)</em></dd>
766 </dt>
767 </dl>
768</td></tr></table>
769</div>
770<a name="from_json"></a>
771<div>
772<table class="details" border="1" cellpadding="3"
773 cellspacing="0" width="100%" bgcolor="white">
774<tr><td>
775 <table width="100%" cellpadding="0" cellspacing="0" border="0">
776 <tr valign="top"><td>
777 <h3 class="epydoc"><span class="sig"><span class="sig-name">from_json</span>(<span class="sig-arg">cls</span>,
778 <span class="sig-arg">s</span>)</span>
779 <br /><em class="fname">Class Method</em>
780 </h3>
781 </td><td align="right" valign="top"
782 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.from_json">source&nbsp;code</a></span>&nbsp;
783 </td>
784 </tr></table>
785
786 <pre class="literalblock">
787Instantiate a Credentials object from a JSON description of it. The JSON
788should have been produced by calling .to_json() on the object.
789
790Args:
791 data: dict, A deserialized JSON object.
792
793Returns:
794 An instance of a Credentials subclass.
795
796</pre>
797 <dl class="fields">
798 <dt>Overrides:
799 <a href="oauth2client.client.Credentials-class.html#from_json">Credentials.from_json</a>
800 </dt>
801 </dl>
802</td></tr></table>
803</div>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]804<a name="access_token_expired"></a>
805<div>
806<table class="details" border="1" cellpadding="3"
807 cellspacing="0" width="100%" bgcolor="white">
808<tr><td>
809 <table width="100%" cellpadding="0" cellspacing="0" border="0">
810 <tr valign="top"><td>
811 <h3 class="epydoc"><span class="sig"><span class="sig-name">access_token_expired</span>(<span class="sig-arg">self</span>)</span>
812 </h3>
813 </td><td align="right" valign="top"
814 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.access_token_expired">source&nbsp;code</a></span>&nbsp;
815 </td>
816 </tr></table>
817
818 <pre class="literalblock">
819True if the credential is expired or invalid.
820
821If the token_expiry isn't set, we assume the token doesn't expire.
822
823</pre>
824 <dl class="fields">
825 <dt>Decorators:</dt>
826 <dd><ul class="nomargin-top">
827 <li><code>@property</code></li>
828 </ul></dd>
829 </dl>
830</td></tr></table>
831</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]832<a name="set_store"></a>
833<div>
834<table class="details" border="1" cellpadding="3"
835 cellspacing="0" width="100%" bgcolor="white">
836<tr><td>
837 <table width="100%" cellpadding="0" cellspacing="0" border="0">
838 <tr valign="top"><td>
839 <h3 class="epydoc"><span class="sig"><span class="sig-name">set_store</span>(<span class="sig-arg">self</span>,
840 <span class="sig-arg">store</span>)</span>
841 </h3>
842 </td><td align="right" valign="top"
843 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials.set_store">source&nbsp;code</a></span>&nbsp;
844 </td>
845 </tr></table>
846
847 <pre class="literalblock">
848Set the Storage for the credential.
849
850Args:
851 store: Storage, an implementation of Stroage object.
852 This is needed to store the latest access_token if it
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]853 has expired and been refreshed. This implementation uses
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]854 locking to check for updates before updating the
855 access_token.
856
857</pre>
858 <dl class="fields">
859 </dl>
860</td></tr></table>
861</div>
862<a name="_refresh"></a>
863<div class="private">
864<table class="details" border="1" cellpadding="3"
865 cellspacing="0" width="100%" bgcolor="white">
866<tr><td>
867 <table width="100%" cellpadding="0" cellspacing="0" border="0">
868 <tr valign="top"><td>
869 <h3 class="epydoc"><span class="sig"><span class="sig-name">_refresh</span>(<span class="sig-arg">self</span>,
870 <span class="sig-arg">http_request</span>)</span>
871 </h3>
872 </td><td align="right" valign="top"
873 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._refresh">source&nbsp;code</a></span>&nbsp;
874 </td>
875 </tr></table>
876
877 <pre class="literalblock">
878Refreshes the access_token.
879
880This method first checks by reading the Storage object if available.
881If a refresh is still needed, it holds the Storage lock until the
882refresh is completed.
883
884Args:
885 http_request: callable, a callable that matches the method signature of
886 httplib2.Http.request, used to make the refresh request.
887
888Raises:
889 AccessTokenRefreshError: When the refresh fails.
890
891</pre>
892 <dl class="fields">
893 </dl>
894</td></tr></table>
895</div>
896<a name="_do_refresh_request"></a>
897<div class="private">
898<table class="details" border="1" cellpadding="3"
899 cellspacing="0" width="100%" bgcolor="white">
900<tr><td>
901 <table width="100%" cellpadding="0" cellspacing="0" border="0">
902 <tr valign="top"><td>
903 <h3 class="epydoc"><span class="sig"><span class="sig-name">_do_refresh_request</span>(<span class="sig-arg">self</span>,
904 <span class="sig-arg">http_request</span>)</span>
905 </h3>
906 </td><td align="right" valign="top"
907 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._do_refresh_request">source&nbsp;code</a></span>&nbsp;
908 </td>
909 </tr></table>
910
911 <pre class="literalblock">
912Refresh the access_token using the refresh_token.
913
914Args:
915 http_request: callable, a callable that matches the method signature of
916 httplib2.Http.request, used to make the refresh request.
917
918Raises:
919 AccessTokenRefreshError: When the refresh fails.
920
921</pre>
922 <dl class="fields">
923 </dl>
924</td></tr></table>
925</div>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]926<a name="_revoke"></a>
927<div class="private">
928<table class="details" border="1" cellpadding="3"
929 cellspacing="0" width="100%" bgcolor="white">
930<tr><td>
931 <table width="100%" cellpadding="0" cellspacing="0" border="0">
932 <tr valign="top"><td>
933 <h3 class="epydoc"><span class="sig"><span class="sig-name">_revoke</span>(<span class="sig-arg">self</span>,
934 <span class="sig-arg">http_request</span>)</span>
935 </h3>
936 </td><td align="right" valign="top"
937 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._revoke">source&nbsp;code</a></span>&nbsp;
938 </td>
939 </tr></table>
940
941 <pre class="literalblock">
942Revokes the refresh_token and deletes the store if available.
943
944Args:
945 http_request: callable, a callable that matches the method signature of
946 httplib2.Http.request, used to make the revoke request.
947
948</pre>
949 <dl class="fields">
950 </dl>
951</td></tr></table>
952</div>
953<a name="_do_revoke"></a>
954<div class="private">
955<table class="details" border="1" cellpadding="3"
956 cellspacing="0" width="100%" bgcolor="white">
957<tr><td>
958 <table width="100%" cellpadding="0" cellspacing="0" border="0">
959 <tr valign="top"><td>
960 <h3 class="epydoc"><span class="sig"><span class="sig-name">_do_revoke</span>(<span class="sig-arg">self</span>,
961 <span class="sig-arg">http_request</span>,
962 <span class="sig-arg">token</span>)</span>
963 </h3>
964 </td><td align="right" valign="top"
965 ><span class="codelink"><a href="oauth2client.client-pysrc.html#OAuth2Credentials._do_revoke">source&nbsp;code</a></span>&nbsp;
966 </td>
967 </tr></table>
968
969 <pre class="literalblock">
970Revokes the credentials and deletes the store if available.
971
972Args:
973 http_request: callable, a callable that matches the method signature of
974 httplib2.Http.request, used to make the refresh request.
975 token: A string used as the token to be revoked. Can be either an
976 access_token or refresh_token.
977
978Raises:
979 TokenRevokeError: If the revoke request does not return with a 200 OK.
980
981</pre>
982 <dl class="fields">
983 </dl>
984</td></tr></table>
985</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]986<br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]987<!-- ==================== NAVIGATION BAR ==================== -->
988<table class="navbar" border="0" width="100%" cellpadding="0"
989 bgcolor="#a0c0ff" cellspacing="0">
990 <tr valign="middle">
991
992 <!-- Tree link -->
993 <th>&nbsp;&nbsp;&nbsp;<a
994 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
995
996 <!-- Index link -->
997 <th>&nbsp;&nbsp;&nbsp;<a
998 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
999
1000 <!-- Help link -->
1001 <th>&nbsp;&nbsp;&nbsp;<a
1002 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1003
1004 <th class="navbar" width="100%"></th>
1005 </tr>
1006</table>
1007<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1008 <tr>
1009 <td align="left" class="footer">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame^]1010 Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:25 2013
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1011 </td>
1012 <td align="right" class="footer">
1013 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1014 >http://epydoc.sourceforge.net</a>
1015 </td>
1016 </tr>
1017</table>
1018
1019<script type="text/javascript">
1020 <!--
1021 // Private objects are initially displayed (because if
1022 // javascript is turned off then we want them to be
1023 // visible); but by default, we want to hide them. So hide
1024 // them unless we have a cookie that says to show them.
1025 checkCookie();
1026 // -->
1027</script>
1028</body>
1029</html>