Joe Gregorio | 5dc0f5c | 2012-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.Storage</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> <a |
| 20 | href="module-tree.html">Trees</a> </th> |
| 21 | |
| 22 | <!-- Index link --> |
| 23 | <th> <a |
| 24 | href="identifier-index.html">Indices</a> </th> |
| 25 | |
| 26 | <!-- Help link --> |
| 27 | <th> <a |
| 28 | href="help.html">Help</a> </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 oauth2client</a> :: |
| 38 | <a href="oauth2client.client-module.html">Module client</a> :: |
| 39 | Class Storage |
| 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 private</a>]</span></td></tr> |
| 47 | <tr><td align="right"><span class="options" |
| 48 | >[<a href="frames.html" target="_top">frames</a |
| 49 | >] | <a href="oauth2client.client.Storage-class.html" |
| 50 | target="_top">no frames</a>]</span></td></tr> |
| 51 | </table> |
| 52 | </td> |
| 53 | </tr> |
| 54 | </table> |
| 55 | <!-- ==================== CLASS DESCRIPTION ==================== --> |
| 56 | <h1 class="epydoc">Class Storage</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage">source code</a></span></p> |
| 57 | <center> |
| 58 | <div class="private"><center> <map id="uml_class_diagram_for_oauth2cl_22" name="uml_class_diagram_for_oauth2cl_22"> |
| 59 | <area shape="rect" href="oauth2client.client.Storage-class.html#acquire_lock" title="Acquires any lock necessary to access this Storage." alt="" coords="337,36,505,55"/> |
| 60 | <area shape="rect" href="oauth2client.client.Storage-class.html#release_lock" title="Release the Storage lock." alt="" coords="337,55,505,73"/> |
| 61 | <area shape="rect" href="oauth2client.client.Storage-class.html#locked_get" title="Retrieve credential." alt="" coords="337,73,505,92"/> |
| 62 | <area shape="rect" href="oauth2client.client.Storage-class.html#locked_put" title="Write a credential." alt="" coords="337,92,505,111"/> |
| 63 | <area shape="rect" href="oauth2client.client.Storage-class.html#locked_delete" title="Delete a credential." alt="" coords="337,111,505,129"/> |
| 64 | <area shape="rect" href="oauth2client.client.Storage-class.html#get" title="Retrieve credential." alt="" coords="337,129,505,148"/> |
| 65 | <area shape="rect" href="oauth2client.client.Storage-class.html#put" title="Write a credential." alt="" coords="337,148,505,167"/> |
| 66 | <area shape="rect" href="oauth2client.client.Storage-class.html#delete" title="Delete credential." alt="" coords="337,167,505,185"/> |
| 67 | <area shape="rect" href="oauth2client.client.Storage-class.html" title="Base class for all Storage objects." alt="" coords="336,11,507,187"/> |
| 68 | <area shape="rect" href="oauth2client.multistore_file._MultiStore._Storage-class.html" title="A Storage object that knows how to read/write a single credential." alt="" coords="16,216,237,243"/> |
| 69 | <area shape="rect" href="oauth2client.file.Storage-class.html" title="Store and retrieve a single credential to and from a file." alt="" coords="288,216,368,243"/> |
| 70 | <area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html" title="Store and retrieve a single credential to and from the App Engine datastore." alt="" coords="419,216,613,243"/> |
| 71 | <area shape="rect" href="oauth2client.django_orm.Storage-class.html" title="Store and retrieve a single credential to and from the datastore." alt="" coords="664,216,795,243"/> |
| 72 | </map> |
| 73 | <img src="uml_class_diagram_for_oauth2cl_22.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_22" ismap="ismap" class="graph-without-title" /> |
| 74 | </center></div> |
| 75 | <div class="public" style="display:none"><center> <map id="uml_class_diagram_for_oauth2cl_23" name="uml_class_diagram_for_oauth2cl_23"> |
| 76 | <area shape="rect" href="oauth2client.client.Storage-class.html#acquire_lock" title="Acquires any lock necessary to access this Storage." alt="" coords="217,36,385,55"/> |
| 77 | <area shape="rect" href="oauth2client.client.Storage-class.html#release_lock" title="Release the Storage lock." alt="" coords="217,55,385,73"/> |
| 78 | <area shape="rect" href="oauth2client.client.Storage-class.html#locked_get" title="Retrieve credential." alt="" coords="217,73,385,92"/> |
| 79 | <area shape="rect" href="oauth2client.client.Storage-class.html#locked_put" title="Write a credential." alt="" coords="217,92,385,111"/> |
| 80 | <area shape="rect" href="oauth2client.client.Storage-class.html#locked_delete" title="Delete a credential." alt="" coords="217,111,385,129"/> |
| 81 | <area shape="rect" href="oauth2client.client.Storage-class.html#get" title="Retrieve credential." alt="" coords="217,129,385,148"/> |
| 82 | <area shape="rect" href="oauth2client.client.Storage-class.html#put" title="Write a credential." alt="" coords="217,148,385,167"/> |
| 83 | <area shape="rect" href="oauth2client.client.Storage-class.html#delete" title="Delete credential." alt="" coords="217,167,385,185"/> |
| 84 | <area shape="rect" href="oauth2client.client.Storage-class.html" title="Base class for all Storage objects." alt="" coords="216,11,387,187"/> |
| 85 | <area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html" title="Store and retrieve a single credential to and from the App Engine datastore." alt="" coords="16,216,211,243"/> |
| 86 | <area shape="rect" href="oauth2client.file.Storage-class.html" title="Store and retrieve a single credential to and from a file." alt="" coords="261,216,341,243"/> |
| 87 | <area shape="rect" href="oauth2client.django_orm.Storage-class.html" title="Store and retrieve a single credential to and from the datastore." alt="" coords="392,216,523,243"/> |
| 88 | </map> |
| 89 | <img src="uml_class_diagram_for_oauth2cl_23.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_23" ismap="ismap" class="graph-without-title" /> |
| 90 | </center></div> |
| 91 | </center> |
| 92 | <hr /> |
| 93 | <pre class="literalblock"> |
| 94 | Base class for all Storage objects. |
| 95 | |
| 96 | Store and retrieve a single credential. This class supports locking |
| 97 | such that multiple processes and threads can operate on a single |
| 98 | store. |
| 99 | |
| 100 | </pre> |
| 101 | |
| 102 | <!-- ==================== INSTANCE METHODS ==================== --> |
| 103 | <a name="section-InstanceMethods"></a> |
| 104 | <table class="summary" border="1" cellpadding="3" |
| 105 | cellspacing="0" width="100%" bgcolor="white"> |
| 106 | <tr bgcolor="#70b0f0" class="table-header"> |
| 107 | <td colspan="2" class="table-header"> |
| 108 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 109 | <tr valign="top"> |
| 110 | <td align="left"><span class="table-header">Instance Methods</span></td> |
| 111 | <td align="right" valign="top" |
| 112 | ><span class="options">[<a href="#section-InstanceMethods" |
| 113 | class="privatelink" onclick="toggle_private();" |
| 114 | >hide private</a>]</span></td> |
| 115 | </tr> |
| 116 | </table> |
| 117 | </td> |
| 118 | </tr> |
| 119 | <tr> |
| 120 | <td width="15%" align="right" valign="top" class="summary"> |
| 121 | <span class="summary-type"> </span> |
| 122 | </td><td class="summary"> |
| 123 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 124 | <tr> |
| 125 | <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#acquire_lock" class="summary-sig-name">acquire_lock</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 126 | Acquires any lock necessary to access this Storage.</td> |
| 127 | <td align="right" valign="top"> |
| 128 | <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.acquire_lock">source code</a></span> |
| 129 | |
| 130 | </td> |
| 131 | </tr> |
| 132 | </table> |
| 133 | |
| 134 | </td> |
| 135 | </tr> |
| 136 | <tr> |
| 137 | <td width="15%" align="right" valign="top" class="summary"> |
| 138 | <span class="summary-type"> </span> |
| 139 | </td><td class="summary"> |
| 140 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 141 | <tr> |
| 142 | <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#release_lock" class="summary-sig-name">release_lock</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 143 | Release the Storage lock.</td> |
| 144 | <td align="right" valign="top"> |
| 145 | <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.release_lock">source code</a></span> |
| 146 | |
| 147 | </td> |
| 148 | </tr> |
| 149 | </table> |
| 150 | |
| 151 | </td> |
| 152 | </tr> |
| 153 | <tr> |
| 154 | <td width="15%" align="right" valign="top" class="summary"> |
| 155 | <span class="summary-type"> </span> |
| 156 | </td><td class="summary"> |
| 157 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 158 | <tr> |
| 159 | <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#locked_get" class="summary-sig-name">locked_get</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 160 | Retrieve credential.</td> |
| 161 | <td align="right" valign="top"> |
| 162 | <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_get">source code</a></span> |
| 163 | |
| 164 | </td> |
| 165 | </tr> |
| 166 | </table> |
| 167 | |
| 168 | </td> |
| 169 | </tr> |
| 170 | <tr> |
| 171 | <td width="15%" align="right" valign="top" class="summary"> |
| 172 | <span class="summary-type"> </span> |
| 173 | </td><td class="summary"> |
| 174 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 175 | <tr> |
| 176 | <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#locked_put" class="summary-sig-name">locked_put</a>(<span class="summary-sig-arg">self</span>, |
| 177 | <span class="summary-sig-arg">credentials</span>)</span><br /> |
| 178 | Write a credential.</td> |
| 179 | <td align="right" valign="top"> |
| 180 | <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_put">source code</a></span> |
| 181 | |
| 182 | </td> |
| 183 | </tr> |
| 184 | </table> |
| 185 | |
| 186 | </td> |
| 187 | </tr> |
| 188 | <tr> |
| 189 | <td width="15%" align="right" valign="top" class="summary"> |
| 190 | <span class="summary-type"> </span> |
| 191 | </td><td class="summary"> |
| 192 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 193 | <tr> |
| 194 | <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#locked_delete" class="summary-sig-name">locked_delete</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 195 | Delete a credential.</td> |
| 196 | <td align="right" valign="top"> |
| 197 | <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_delete">source code</a></span> |
| 198 | |
| 199 | </td> |
| 200 | </tr> |
| 201 | </table> |
| 202 | |
| 203 | </td> |
| 204 | </tr> |
| 205 | <tr> |
| 206 | <td width="15%" align="right" valign="top" class="summary"> |
| 207 | <span class="summary-type"> </span> |
| 208 | </td><td class="summary"> |
| 209 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 210 | <tr> |
| 211 | <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 212 | Retrieve credential.</td> |
| 213 | <td align="right" valign="top"> |
| 214 | <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.get">source code</a></span> |
| 215 | |
| 216 | </td> |
| 217 | </tr> |
| 218 | </table> |
| 219 | |
| 220 | </td> |
| 221 | </tr> |
| 222 | <tr> |
| 223 | <td width="15%" align="right" valign="top" class="summary"> |
| 224 | <span class="summary-type"> </span> |
| 225 | </td><td class="summary"> |
| 226 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 227 | <tr> |
| 228 | <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#put" class="summary-sig-name">put</a>(<span class="summary-sig-arg">self</span>, |
| 229 | <span class="summary-sig-arg">credentials</span>)</span><br /> |
| 230 | Write a credential.</td> |
| 231 | <td align="right" valign="top"> |
| 232 | <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.put">source code</a></span> |
| 233 | |
| 234 | </td> |
| 235 | </tr> |
| 236 | </table> |
| 237 | |
| 238 | </td> |
| 239 | </tr> |
| 240 | <tr> |
| 241 | <td width="15%" align="right" valign="top" class="summary"> |
| 242 | <span class="summary-type"> </span> |
| 243 | </td><td class="summary"> |
| 244 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 245 | <tr> |
| 246 | <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 247 | Delete credential.</td> |
| 248 | <td align="right" valign="top"> |
| 249 | <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.delete">source code</a></span> |
| 250 | |
| 251 | </td> |
| 252 | </tr> |
| 253 | </table> |
| 254 | |
| 255 | </td> |
| 256 | </tr> |
| 257 | <tr> |
| 258 | <td colspan="2" class="summary"> |
| 259 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 260 | <code>__delattr__</code>, |
| 261 | <code>__format__</code>, |
| 262 | <code>__getattribute__</code>, |
| 263 | <code>__hash__</code>, |
| 264 | <code>__init__</code>, |
| 265 | <code>__new__</code>, |
| 266 | <code>__reduce__</code>, |
| 267 | <code>__reduce_ex__</code>, |
| 268 | <code>__repr__</code>, |
| 269 | <code>__setattr__</code>, |
| 270 | <code>__sizeof__</code>, |
| 271 | <code>__str__</code>, |
| 272 | <code>__subclasshook__</code> |
| 273 | </p> |
| 274 | </td> |
| 275 | </tr> |
| 276 | </table> |
| 277 | <!-- ==================== PROPERTIES ==================== --> |
| 278 | <a name="section-Properties"></a> |
| 279 | <table class="summary" border="1" cellpadding="3" |
| 280 | cellspacing="0" width="100%" bgcolor="white"> |
| 281 | <tr bgcolor="#70b0f0" class="table-header"> |
| 282 | <td colspan="2" class="table-header"> |
| 283 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 284 | <tr valign="top"> |
| 285 | <td align="left"><span class="table-header">Properties</span></td> |
| 286 | <td align="right" valign="top" |
| 287 | ><span class="options">[<a href="#section-Properties" |
| 288 | class="privatelink" onclick="toggle_private();" |
| 289 | >hide private</a>]</span></td> |
| 290 | </tr> |
| 291 | </table> |
| 292 | </td> |
| 293 | </tr> |
| 294 | <tr> |
| 295 | <td colspan="2" class="summary"> |
| 296 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 297 | <code>__class__</code> |
| 298 | </p> |
| 299 | </td> |
| 300 | </tr> |
| 301 | </table> |
| 302 | <!-- ==================== METHOD DETAILS ==================== --> |
| 303 | <a name="section-MethodDetails"></a> |
| 304 | <table class="details" border="1" cellpadding="3" |
| 305 | cellspacing="0" width="100%" bgcolor="white"> |
| 306 | <tr bgcolor="#70b0f0" class="table-header"> |
| 307 | <td colspan="2" class="table-header"> |
| 308 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 309 | <tr valign="top"> |
| 310 | <td align="left"><span class="table-header">Method Details</span></td> |
| 311 | <td align="right" valign="top" |
| 312 | ><span class="options">[<a href="#section-MethodDetails" |
| 313 | class="privatelink" onclick="toggle_private();" |
| 314 | >hide private</a>]</span></td> |
| 315 | </tr> |
| 316 | </table> |
| 317 | </td> |
| 318 | </tr> |
| 319 | </table> |
| 320 | <a name="acquire_lock"></a> |
| 321 | <div> |
| 322 | <table class="details" border="1" cellpadding="3" |
| 323 | cellspacing="0" width="100%" bgcolor="white"> |
| 324 | <tr><td> |
| 325 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 326 | <tr valign="top"><td> |
| 327 | <h3 class="epydoc"><span class="sig"><span class="sig-name">acquire_lock</span>(<span class="sig-arg">self</span>)</span> |
| 328 | </h3> |
| 329 | </td><td align="right" valign="top" |
| 330 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.acquire_lock">source code</a></span> |
| 331 | </td> |
| 332 | </tr></table> |
| 333 | |
| 334 | <pre class="literalblock"> |
| 335 | Acquires any lock necessary to access this Storage. |
| 336 | |
| 337 | This lock is not reentrant. |
| 338 | |
| 339 | </pre> |
| 340 | <dl class="fields"> |
| 341 | </dl> |
| 342 | </td></tr></table> |
| 343 | </div> |
| 344 | <a name="release_lock"></a> |
| 345 | <div> |
| 346 | <table class="details" border="1" cellpadding="3" |
| 347 | cellspacing="0" width="100%" bgcolor="white"> |
| 348 | <tr><td> |
| 349 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 350 | <tr valign="top"><td> |
| 351 | <h3 class="epydoc"><span class="sig"><span class="sig-name">release_lock</span>(<span class="sig-arg">self</span>)</span> |
| 352 | </h3> |
| 353 | </td><td align="right" valign="top" |
| 354 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.release_lock">source code</a></span> |
| 355 | </td> |
| 356 | </tr></table> |
| 357 | |
| 358 | <pre class="literalblock"> |
| 359 | Release the Storage lock. |
| 360 | |
| 361 | Trying to release a lock that isn't held will result in a |
| 362 | RuntimeError. |
| 363 | |
| 364 | </pre> |
| 365 | <dl class="fields"> |
| 366 | </dl> |
| 367 | </td></tr></table> |
| 368 | </div> |
| 369 | <a name="locked_get"></a> |
| 370 | <div> |
| 371 | <table class="details" border="1" cellpadding="3" |
| 372 | cellspacing="0" width="100%" bgcolor="white"> |
| 373 | <tr><td> |
| 374 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 375 | <tr valign="top"><td> |
| 376 | <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_get</span>(<span class="sig-arg">self</span>)</span> |
| 377 | </h3> |
| 378 | </td><td align="right" valign="top" |
| 379 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_get">source code</a></span> |
| 380 | </td> |
| 381 | </tr></table> |
| 382 | |
| 383 | <pre class="literalblock"> |
| 384 | Retrieve credential. |
| 385 | |
| 386 | The Storage lock must be held when this is called. |
| 387 | |
| 388 | Returns: |
| 389 | oauth2client.client.Credentials |
| 390 | |
| 391 | </pre> |
| 392 | <dl class="fields"> |
| 393 | </dl> |
| 394 | </td></tr></table> |
| 395 | </div> |
| 396 | <a name="locked_put"></a> |
| 397 | <div> |
| 398 | <table class="details" border="1" cellpadding="3" |
| 399 | cellspacing="0" width="100%" bgcolor="white"> |
| 400 | <tr><td> |
| 401 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 402 | <tr valign="top"><td> |
| 403 | <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_put</span>(<span class="sig-arg">self</span>, |
| 404 | <span class="sig-arg">credentials</span>)</span> |
| 405 | </h3> |
| 406 | </td><td align="right" valign="top" |
| 407 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_put">source code</a></span> |
| 408 | </td> |
| 409 | </tr></table> |
| 410 | |
| 411 | <pre class="literalblock"> |
| 412 | Write a credential. |
| 413 | |
| 414 | The Storage lock must be held when this is called. |
| 415 | |
| 416 | Args: |
| 417 | credentials: Credentials, the credentials to store. |
| 418 | |
| 419 | </pre> |
| 420 | <dl class="fields"> |
| 421 | </dl> |
| 422 | </td></tr></table> |
| 423 | </div> |
| 424 | <a name="locked_delete"></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">locked_delete</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#Storage.locked_delete">source code</a></span> |
| 435 | </td> |
| 436 | </tr></table> |
| 437 | |
| 438 | <pre class="literalblock"> |
| 439 | Delete a credential. |
| 440 | |
| 441 | The Storage lock must be held when this is called. |
| 442 | |
| 443 | </pre> |
| 444 | <dl class="fields"> |
| 445 | </dl> |
| 446 | </td></tr></table> |
| 447 | </div> |
| 448 | <a name="get"></a> |
| 449 | <div> |
| 450 | <table class="details" border="1" cellpadding="3" |
| 451 | cellspacing="0" width="100%" bgcolor="white"> |
| 452 | <tr><td> |
| 453 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 454 | <tr valign="top"><td> |
| 455 | <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>)</span> |
| 456 | </h3> |
| 457 | </td><td align="right" valign="top" |
| 458 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.get">source code</a></span> |
| 459 | </td> |
| 460 | </tr></table> |
| 461 | |
| 462 | <pre class="literalblock"> |
| 463 | Retrieve credential. |
| 464 | |
| 465 | The Storage lock must *not* be held when this is called. |
| 466 | |
| 467 | Returns: |
| 468 | oauth2client.client.Credentials |
| 469 | |
| 470 | </pre> |
| 471 | <dl class="fields"> |
| 472 | </dl> |
| 473 | </td></tr></table> |
| 474 | </div> |
| 475 | <a name="put"></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">put</span>(<span class="sig-arg">self</span>, |
| 483 | <span class="sig-arg">credentials</span>)</span> |
| 484 | </h3> |
| 485 | </td><td align="right" valign="top" |
| 486 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.put">source code</a></span> |
| 487 | </td> |
| 488 | </tr></table> |
| 489 | |
| 490 | <pre class="literalblock"> |
| 491 | Write a credential. |
| 492 | |
| 493 | The Storage lock must be held when this is called. |
| 494 | |
| 495 | Args: |
| 496 | credentials: Credentials, the credentials to store. |
| 497 | |
| 498 | </pre> |
| 499 | <dl class="fields"> |
| 500 | </dl> |
| 501 | </td></tr></table> |
| 502 | </div> |
| 503 | <a name="delete"></a> |
| 504 | <div> |
| 505 | <table class="details" border="1" cellpadding="3" |
| 506 | cellspacing="0" width="100%" bgcolor="white"> |
| 507 | <tr><td> |
| 508 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 509 | <tr valign="top"><td> |
| 510 | <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>)</span> |
| 511 | </h3> |
| 512 | </td><td align="right" valign="top" |
| 513 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.delete">source code</a></span> |
| 514 | </td> |
| 515 | </tr></table> |
| 516 | |
| 517 | <pre class="literalblock"> |
| 518 | Delete credential. |
| 519 | |
| 520 | Frees any resources associated with storing the credential. |
| 521 | The Storage lock must *not* be held when this is called. |
| 522 | |
| 523 | Returns: |
| 524 | None |
| 525 | |
| 526 | </pre> |
| 527 | <dl class="fields"> |
| 528 | </dl> |
| 529 | </td></tr></table> |
| 530 | </div> |
| 531 | <br /> |
| 532 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 533 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 534 | bgcolor="#a0c0ff" cellspacing="0"> |
| 535 | <tr valign="middle"> |
| 536 | |
| 537 | <!-- Tree link --> |
| 538 | <th> <a |
| 539 | href="module-tree.html">Trees</a> </th> |
| 540 | |
| 541 | <!-- Index link --> |
| 542 | <th> <a |
| 543 | href="identifier-index.html">Indices</a> </th> |
| 544 | |
| 545 | <!-- Help link --> |
| 546 | <th> <a |
| 547 | href="help.html">Help</a> </th> |
| 548 | |
| 549 | <th class="navbar" width="100%"></th> |
| 550 | </tr> |
| 551 | </table> |
| 552 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 553 | <tr> |
| 554 | <td align="left" class="footer"> |
| 555 | Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:10 2012 |
| 556 | </td> |
| 557 | <td align="right" class="footer"> |
| 558 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 559 | >http://epydoc.sourceforge.net</a> |
| 560 | </td> |
| 561 | </tr> |
| 562 | </table> |
| 563 | |
| 564 | <script type="text/javascript"> |
| 565 | <!-- |
| 566 | // Private objects are initially displayed (because if |
| 567 | // javascript is turned off then we want them to be |
| 568 | // visible); but by default, we want to hide them. So hide |
| 569 | // them unless we have a cookie that says to show them. |
| 570 | checkCookie(); |
| 571 | // --> |
| 572 | </script> |
| 573 | </body> |
| 574 | </html> |