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