Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ee90896d7183072d29fc60d0b8540360609ffa2c / . / docs / epy / oauth2client.client.Credentials-class.html
blob: a0d862f795098d7a04294b685c54e16b23e2812f [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.Credentials</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;Credentials
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.Credentials-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 Credentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials">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_credential_3" name="class_hierarchy_for_credential_3">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]59<area shape="rect" href="oauth2client.appengine.AppAssertionCredentials-class.html" title="appengine.AppAssertionCredentials" alt="" coords="5,173,232,200"/>
60<area shape="rect" href="oauth2client.client.AccessTokenCredentials-class.html" title="AccessTokenCredentials" alt="" coords="99,117,261,144"/>
61<area shape="rect" href="oauth2client.client.AssertionCredentials-class.html" title="AssertionCredentials" alt="" coords="285,117,427,144"/>
62<area shape="rect" href="oauth2client.client.SignedJwtAssertionCredentials-class.html" title="SignedJwtAssertionCredentials" alt="" coords="256,173,456,200"/>
63<area shape="rect" href="oauth2client.gce.AppAssertionCredentials-class.html" title="gce.AppAssertionCredentials" alt="" coords="480,173,669,200"/>
64<area shape="rect" href="oauth2client.client.Credentials-class.html" title="Credentials" alt="" coords="225,5,311,32"/>
65<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html" title="OAuth2Credentials" alt="" coords="203,61,333,88"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]66</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]67 <img src="class_hierarchy_for_credential_3.gif" alt='' usemap="#class_hierarchy_for_credential_3" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]68</center>
69</center>
70<hr />
71<pre class="literalblock">
72Base class for all Credentials objects.
73
74Subclasses must define an authorize() method that applies the credentials to
75an HTTP transport.
76
77Subclasses must also specify a classmethod named 'from_json' that takes a JSON
78string as input and returns an instaniated Credentials object.
79
80</pre>
81
82<!-- ==================== INSTANCE METHODS ==================== -->
83<a name="section-InstanceMethods"></a>
84<table class="summary" border="1" cellpadding="3"
85 cellspacing="0" width="100%" bgcolor="white">
86<tr bgcolor="#70b0f0" class="table-header">
87 <td colspan="2" class="table-header">
88 <table border="0" cellpadding="0" cellspacing="0" width="100%">
89 <tr valign="top">
90 <td align="left"><span class="table-header">Instance Methods</span></td>
91 <td align="right" valign="top"
92 ><span class="options">[<a href="#section-InstanceMethods"
93 class="privatelink" onclick="toggle_private();"
94 >hide private</a>]</span></td>
95 </tr>
96 </table>
97 </td>
98</tr>
99<tr>
100 <td width="15%" align="right" valign="top" class="summary">
101 <span class="summary-type">&nbsp;</span>
102 </td><td class="summary">
103 <table width="100%" cellpadding="0" cellspacing="0" border="0">
104 <tr>
105 <td><span class="summary-sig"><a name="authorize"></a><span class="summary-sig-name">authorize</span>(<span class="summary-sig-arg">self</span>,
106 <span class="summary-sig-arg">http</span>)</span><br />
107 Take an httplib2.Http instance (or equivalent) and
108authorizes it for the set of credentials, usually by
109replacing http.request() with a method that adds in
110the appropriate headers and then delegates to the original
111Http.request() method.</td>
112 <td align="right" valign="top">
113 <span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.authorize">source&nbsp;code</a></span>
114
115 </td>
116 </tr>
117 </table>
118
119 </td>
120 </tr>
121<tr>
122 <td width="15%" align="right" valign="top" class="summary">
123 <span class="summary-type">&nbsp;</span>
124 </td><td class="summary">
125 <table width="100%" cellpadding="0" cellspacing="0" border="0">
126 <tr>
127 <td><span class="summary-sig"><a href="oauth2client.client.Credentials-class.html#refresh" class="summary-sig-name">refresh</a>(<span class="summary-sig-arg">self</span>,
128 <span class="summary-sig-arg">http</span>)</span><br />
129 Forces a refresh of the access_token.</td>
130 <td align="right" valign="top">
131 <span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.refresh">source&nbsp;code</a></span>
132
133 </td>
134 </tr>
135 </table>
136
137 </td>
138 </tr>
139<tr>
140 <td width="15%" align="right" valign="top" class="summary">
141 <span class="summary-type">&nbsp;</span>
142 </td><td class="summary">
143 <table width="100%" cellpadding="0" cellspacing="0" border="0">
144 <tr>
145 <td><span class="summary-sig"><a href="oauth2client.client.Credentials-class.html#apply" class="summary-sig-name">apply</a>(<span class="summary-sig-arg">self</span>,
146 <span class="summary-sig-arg">headers</span>)</span><br />
147 Add the authorization to the headers.</td>
148 <td align="right" valign="top">
149 <span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.apply">source&nbsp;code</a></span>
150
151 </td>
152 </tr>
153 </table>
154
155 </td>
156 </tr>
157<tr class="private">
158 <td width="15%" align="right" valign="top" class="summary">
159 <span class="summary-type">&nbsp;</span>
160 </td><td class="summary">
161 <table width="100%" cellpadding="0" cellspacing="0" border="0">
162 <tr>
163 <td><span class="summary-sig"><a href="oauth2client.client.Credentials-class.html#_to_json" class="summary-sig-name" onclick="show_private();">_to_json</a>(<span class="summary-sig-arg">self</span>,
164 <span class="summary-sig-arg">strip</span>)</span><br />
165 Utility function for creating a JSON representation of an instance of Credentials.</td>
166 <td align="right" valign="top">
167 <span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials._to_json">source&nbsp;code</a></span>
168
169 </td>
170 </tr>
171 </table>
172
173 </td>
174 </tr>
175<tr>
176 <td width="15%" align="right" valign="top" class="summary">
177 <span class="summary-type">&nbsp;</span>
178 </td><td class="summary">
179 <table width="100%" cellpadding="0" cellspacing="0" border="0">
180 <tr>
181 <td><span class="summary-sig"><a href="oauth2client.client.Credentials-class.html#to_json" class="summary-sig-name">to_json</a>(<span class="summary-sig-arg">self</span>)</span><br />
182 Creating a JSON representation of an instance of Credentials.</td>
183 <td align="right" valign="top">
184 <span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.to_json">source&nbsp;code</a></span>
185
186 </td>
187 </tr>
188 </table>
189
190 </td>
191 </tr>
192 <tr>
193 <td colspan="2" class="summary">
194 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
195 <code>__delattr__</code>,
196 <code>__format__</code>,
197 <code>__getattribute__</code>,
198 <code>__hash__</code>,
199 <code>__init__</code>,
200 <code>__new__</code>,
201 <code>__reduce__</code>,
202 <code>__reduce_ex__</code>,
203 <code>__repr__</code>,
204 <code>__setattr__</code>,
205 <code>__sizeof__</code>,
206 <code>__str__</code>,
207 <code>__subclasshook__</code>
208 </p>
209 </td>
210 </tr>
211</table>
212<!-- ==================== CLASS METHODS ==================== -->
213<a name="section-ClassMethods"></a>
214<table class="summary" border="1" cellpadding="3"
215 cellspacing="0" width="100%" bgcolor="white">
216<tr bgcolor="#70b0f0" class="table-header">
217 <td colspan="2" class="table-header">
218 <table border="0" cellpadding="0" cellspacing="0" width="100%">
219 <tr valign="top">
220 <td align="left"><span class="table-header">Class Methods</span></td>
221 <td align="right" valign="top"
222 ><span class="options">[<a href="#section-ClassMethods"
223 class="privatelink" onclick="toggle_private();"
224 >hide private</a>]</span></td>
225 </tr>
226 </table>
227 </td>
228</tr>
229<tr>
230 <td width="15%" align="right" valign="top" class="summary">
231 <span class="summary-type">&nbsp;</span>
232 </td><td class="summary">
233 <table width="100%" cellpadding="0" cellspacing="0" border="0">
234 <tr>
235 <td><span class="summary-sig"><a href="oauth2client.client.Credentials-class.html#new_from_json" class="summary-sig-name">new_from_json</a>(<span class="summary-sig-arg">cls</span>,
236 <span class="summary-sig-arg">s</span>)</span><br />
237 Utility class method to instantiate a Credentials subclass from a JSON
238representation produced by to_json().</td>
239 <td align="right" valign="top">
240 <span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.new_from_json">source&nbsp;code</a></span>
241
242 </td>
243 </tr>
244 </table>
245
246 </td>
247 </tr>
248<tr>
249 <td width="15%" align="right" valign="top" class="summary">
250 <span class="summary-type">&nbsp;</span>
251 </td><td class="summary">
252 <table width="100%" cellpadding="0" cellspacing="0" border="0">
253 <tr>
254 <td><span class="summary-sig"><a href="oauth2client.client.Credentials-class.html#from_json" class="summary-sig-name">from_json</a>(<span class="summary-sig-arg">cls</span>,
255 <span class="summary-sig-arg">s</span>)</span><br />
256 Instantiate a Credentials object from a JSON description of it.</td>
257 <td align="right" valign="top">
258 <span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.from_json">source&nbsp;code</a></span>
259
260 </td>
261 </tr>
262 </table>
263
264 </td>
265 </tr>
266</table>
267<!-- ==================== CLASS VARIABLES ==================== -->
268<a name="section-ClassVariables"></a>
269<table class="summary" border="1" cellpadding="3"
270 cellspacing="0" width="100%" bgcolor="white">
271<tr bgcolor="#70b0f0" class="table-header">
272 <td colspan="2" class="table-header">
273 <table border="0" cellpadding="0" cellspacing="0" width="100%">
274 <tr valign="top">
275 <td align="left"><span class="table-header">Class Variables</span></td>
276 <td align="right" valign="top"
277 ><span class="options">[<a href="#section-ClassVariables"
278 class="privatelink" onclick="toggle_private();"
279 >hide private</a>]</span></td>
280 </tr>
281 </table>
282 </td>
283</tr>
284<tr>
285 <td width="15%" align="right" valign="top" class="summary">
286 <span class="summary-type">&nbsp;</span>
287 </td><td class="summary">
288 <a name="NON_SERIALIZED_MEMBERS"></a><span class="summary-name">NON_SERIALIZED_MEMBERS</span> = <code title="['store']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">store</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
289 </td>
290 </tr>
291</table>
292<!-- ==================== PROPERTIES ==================== -->
293<a name="section-Properties"></a>
294<table class="summary" border="1" cellpadding="3"
295 cellspacing="0" width="100%" bgcolor="white">
296<tr bgcolor="#70b0f0" class="table-header">
297 <td colspan="2" class="table-header">
298 <table border="0" cellpadding="0" cellspacing="0" width="100%">
299 <tr valign="top">
300 <td align="left"><span class="table-header">Properties</span></td>
301 <td align="right" valign="top"
302 ><span class="options">[<a href="#section-Properties"
303 class="privatelink" onclick="toggle_private();"
304 >hide private</a>]</span></td>
305 </tr>
306 </table>
307 </td>
308</tr>
309 <tr>
310 <td colspan="2" class="summary">
311 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
312 <code>__class__</code>
313 </p>
314 </td>
315 </tr>
316</table>
317<!-- ==================== METHOD DETAILS ==================== -->
318<a name="section-MethodDetails"></a>
319<table class="details" border="1" cellpadding="3"
320 cellspacing="0" width="100%" bgcolor="white">
321<tr bgcolor="#70b0f0" class="table-header">
322 <td colspan="2" class="table-header">
323 <table border="0" cellpadding="0" cellspacing="0" width="100%">
324 <tr valign="top">
325 <td align="left"><span class="table-header">Method Details</span></td>
326 <td align="right" valign="top"
327 ><span class="options">[<a href="#section-MethodDetails"
328 class="privatelink" onclick="toggle_private();"
329 >hide private</a>]</span></td>
330 </tr>
331 </table>
332 </td>
333</tr>
334</table>
335<a name="refresh"></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">refresh</span>(<span class="sig-arg">self</span>,
343 <span class="sig-arg">http</span>)</span>
344 </h3>
345 </td><td align="right" valign="top"
346 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.refresh">source&nbsp;code</a></span>&nbsp;
347 </td>
348 </tr></table>
349
350 <pre class="literalblock">
351Forces a refresh of the access_token.
352
353Args:
354 http: httplib2.Http, an http object to be used to make the refresh
355 request.
356
357</pre>
358 <dl class="fields">
359 </dl>
360</td></tr></table>
361</div>
362<a name="apply"></a>
363<div>
364<table class="details" border="1" cellpadding="3"
365 cellspacing="0" width="100%" bgcolor="white">
366<tr><td>
367 <table width="100%" cellpadding="0" cellspacing="0" border="0">
368 <tr valign="top"><td>
369 <h3 class="epydoc"><span class="sig"><span class="sig-name">apply</span>(<span class="sig-arg">self</span>,
370 <span class="sig-arg">headers</span>)</span>
371 </h3>
372 </td><td align="right" valign="top"
373 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.apply">source&nbsp;code</a></span>&nbsp;
374 </td>
375 </tr></table>
376
377 <pre class="literalblock">
378Add the authorization to the headers.
379
380Args:
381 headers: dict, the headers to add the Authorization header to.
382
383</pre>
384 <dl class="fields">
385 </dl>
386</td></tr></table>
387</div>
388<a name="_to_json"></a>
389<div class="private">
390<table class="details" border="1" cellpadding="3"
391 cellspacing="0" width="100%" bgcolor="white">
392<tr><td>
393 <table width="100%" cellpadding="0" cellspacing="0" border="0">
394 <tr valign="top"><td>
395 <h3 class="epydoc"><span class="sig"><span class="sig-name">_to_json</span>(<span class="sig-arg">self</span>,
396 <span class="sig-arg">strip</span>)</span>
397 </h3>
398 </td><td align="right" valign="top"
399 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials._to_json">source&nbsp;code</a></span>&nbsp;
400 </td>
401 </tr></table>
402
403 <pre class="literalblock">
404Utility function for creating a JSON representation of an instance of Credentials.
405
406Args:
407 strip: array, An array of names of members to not include in the JSON.
408
409Returns:
410 string, a JSON representation of this instance, suitable to pass to
411 from_json().
412
413</pre>
414 <dl class="fields">
415 </dl>
416</td></tr></table>
417</div>
418<a name="to_json"></a>
419<div>
420<table class="details" border="1" cellpadding="3"
421 cellspacing="0" width="100%" bgcolor="white">
422<tr><td>
423 <table width="100%" cellpadding="0" cellspacing="0" border="0">
424 <tr valign="top"><td>
425 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
426 </h3>
427 </td><td align="right" valign="top"
428 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.to_json">source&nbsp;code</a></span>&nbsp;
429 </td>
430 </tr></table>
431
432 <pre class="literalblock">
433Creating a JSON representation of an instance of Credentials.
434
435Returns:
436 string, a JSON representation of this instance, suitable to pass to
437 from_json().
438
439</pre>
440 <dl class="fields">
441 </dl>
442</td></tr></table>
443</div>
444<a name="new_from_json"></a>
445<div>
446<table class="details" border="1" cellpadding="3"
447 cellspacing="0" width="100%" bgcolor="white">
448<tr><td>
449 <table width="100%" cellpadding="0" cellspacing="0" border="0">
450 <tr valign="top"><td>
451 <h3 class="epydoc"><span class="sig"><span class="sig-name">new_from_json</span>(<span class="sig-arg">cls</span>,
452 <span class="sig-arg">s</span>)</span>
453 <br /><em class="fname">Class Method</em>
454 </h3>
455 </td><td align="right" valign="top"
456 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.new_from_json">source&nbsp;code</a></span>&nbsp;
457 </td>
458 </tr></table>
459
460 <pre class="literalblock">
461Utility class method to instantiate a Credentials subclass from a JSON
462representation produced by to_json().
463
464Args:
465 s: string, JSON from to_json().
466
467Returns:
468 An instance of the subclass of Credentials that was serialized with
469 to_json().
470
471</pre>
472 <dl class="fields">
473 </dl>
474</td></tr></table>
475</div>
476<a name="from_json"></a>
477<div>
478<table class="details" border="1" cellpadding="3"
479 cellspacing="0" width="100%" bgcolor="white">
480<tr><td>
481 <table width="100%" cellpadding="0" cellspacing="0" border="0">
482 <tr valign="top"><td>
483 <h3 class="epydoc"><span class="sig"><span class="sig-name">from_json</span>(<span class="sig-arg">cls</span>,
484 <span class="sig-arg">s</span>)</span>
485 <br /><em class="fname">Class Method</em>
486 </h3>
487 </td><td align="right" valign="top"
488 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Credentials.from_json">source&nbsp;code</a></span>&nbsp;
489 </td>
490 </tr></table>
491
492 <pre class="literalblock">
493Instantiate a Credentials object from a JSON description of it.
494
495The JSON should have been produced by calling .to_json() on the object.
496
497Args:
498 data: dict, A deserialized JSON object.
499
500Returns:
501 An instance of a Credentials subclass.
502
503</pre>
504 <dl class="fields">
505 </dl>
506</td></tr></table>
507</div>
508<br />
509<!-- ==================== NAVIGATION BAR ==================== -->
510<table class="navbar" border="0" width="100%" cellpadding="0"
511 bgcolor="#a0c0ff" cellspacing="0">
512 <tr valign="middle">
513
514 <!-- Tree link -->
515 <th>&nbsp;&nbsp;&nbsp;<a
516 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
517
518 <!-- Index link -->
519 <th>&nbsp;&nbsp;&nbsp;<a
520 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
521
522 <!-- Help link -->
523 <th>&nbsp;&nbsp;&nbsp;<a
524 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
525
526 <th class="navbar" width="100%"></th>
527 </tr>
528</table>
529<table border="0" cellpadding="0" cellspacing="0" width="100%%">
530 <tr>
531 <td align="left" class="footer">
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]532 Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:45 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]533 </td>
534 <td align="right" class="footer">
535 <a target="mainFrame" href="http://epydoc.sourceforge.net"
536 >http://epydoc.sourceforge.net</a>
537 </td>
538 </tr>
539</table>
540
541<script type="text/javascript">
542 <!--
543 // Private objects are initially displayed (because if
544 // javascript is turned off then we want them to be
545 // visible); but by default, we want to hide them. So hide
546 // them unless we have a cookie that says to show them.
547 checkCookie();
548 // -->
549</script>
550</body>
551</html>