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