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