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