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.appengine.StorageByKeyName</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.appengine-module.html">Module appengine</a> :: |
| 39 | Class StorageByKeyName |
| 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.appengine.StorageByKeyName-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 StorageByKeyName</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName">source code</a></span></p> |
| 57 | <center> |
Joe Gregorio | 37802c3 | 2013-08-06 12:24:05 -0400 | [diff] [blame] | 58 | <center> <map id="uml_class_diagram_for_oauth2cl_14" name="uml_class_diagram_for_oauth2cl_14"> |
| 59 | <area shape="rect" id="node130" href="oauth2client.appengine.StorageByKeyName-class.html#__init__" title="Constructor for Storage." alt="" coords="17,191,457,209"/> |
| 60 | <area shape="rect" id="node130" href="oauth2client.appengine.StorageByKeyName-class.html#locked_get" title="Retrieve Credential from datastore." alt="" coords="17,209,457,228"/> |
| 61 | <area shape="rect" id="node130" href="oauth2client.appengine.StorageByKeyName-class.html#locked_put" title="Write a Credentials to the datastore." alt="" coords="17,228,457,247"/> |
| 62 | <area shape="rect" id="node130" href="oauth2client.appengine.StorageByKeyName-class.html#locked_delete" title="Delete Credential from datastore." alt="" coords="17,247,457,265"/> |
| 63 | <area shape="rect" id="node1" href="oauth2client.appengine.StorageByKeyName-class.html" title="Store and retrieve a credential to and from the App Engine datastore." alt="" coords="5,158,469,271"/> |
| 64 | <area shape="rect" id="node131" href="oauth2client.client.Storage-class.html#acquire_lock" title="Acquires any lock necessary to access this Storage." alt="" coords="175,39,300,57"/> |
| 65 | <area shape="rect" id="node131" href="oauth2client.client.Storage-class.html#release_lock" title="Release the Storage lock." alt="" coords="175,57,300,76"/> |
| 66 | <area shape="rect" id="node131" href="oauth2client.client.Storage-class.html#get" title="Retrieve credential." alt="" coords="175,76,300,95"/> |
| 67 | <area shape="rect" id="node131" href="oauth2client.client.Storage-class.html#put" title="Write a credential." alt="" coords="175,95,300,113"/> |
| 68 | <area shape="rect" id="node131" href="oauth2client.client.Storage-class.html#delete" title="Delete credential." alt="" coords="175,113,300,132"/> |
| 69 | <area shape="rect" id="node2" href="oauth2client.client.Storage-class.html" title="Base class for all Storage objects." alt="" coords="163,6,312,138"/> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 70 | </map> |
Joe Gregorio | 37802c3 | 2013-08-06 12:24:05 -0400 | [diff] [blame] | 71 | <img src="uml_class_diagram_for_oauth2cl_14.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_14" ismap="ismap" class="graph-without-title" /> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 72 | </center> |
| 73 | </center> |
| 74 | <hr /> |
| 75 | <pre class="literalblock"> |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 76 | Store and retrieve a credential to and from the App Engine datastore. |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 77 | |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 78 | This Storage helper presumes the Credentials have been stored as a |
| 79 | CredentialsProperty or CredentialsNDBProperty on a datastore model class, and |
| 80 | that entities are stored by key_name. |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 81 | |
| 82 | </pre> |
| 83 | |
| 84 | <!-- ==================== INSTANCE METHODS ==================== --> |
| 85 | <a name="section-InstanceMethods"></a> |
| 86 | <table class="summary" border="1" cellpadding="3" |
| 87 | cellspacing="0" width="100%" bgcolor="white"> |
| 88 | <tr bgcolor="#70b0f0" class="table-header"> |
| 89 | <td colspan="2" class="table-header"> |
| 90 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 91 | <tr valign="top"> |
| 92 | <td align="left"><span class="table-header">Instance Methods</span></td> |
| 93 | <td align="right" valign="top" |
| 94 | ><span class="options">[<a href="#section-InstanceMethods" |
| 95 | class="privatelink" onclick="toggle_private();" |
| 96 | >hide private</a>]</span></td> |
| 97 | </tr> |
| 98 | </table> |
| 99 | </td> |
| 100 | </tr> |
| 101 | <tr> |
| 102 | <td width="15%" align="right" valign="top" class="summary"> |
| 103 | <span class="summary-type"> </span> |
| 104 | </td><td class="summary"> |
| 105 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 106 | <tr> |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 107 | <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
| 108 | <span class="summary-sig-arg">model</span>, |
| 109 | <span class="summary-sig-arg">key_name</span>, |
| 110 | <span class="summary-sig-arg">property_name</span>, |
Joe Gregorio | 37802c3 | 2013-08-06 12:24:05 -0400 | [diff] [blame] | 111 | <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>, |
| 112 | <span class="summary-sig-arg">user</span>=<span class="summary-sig-default">None</span>)</span><br /> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 113 | Constructor for Storage.</td> |
| 114 | <td align="right" valign="top"> |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 115 | <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.__init__">source code</a></span> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 116 | |
| 117 | </td> |
| 118 | </tr> |
| 119 | </table> |
| 120 | |
| 121 | </td> |
| 122 | </tr> |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 123 | <tr class="private"> |
| 124 | <td width="15%" align="right" valign="top" class="summary"> |
| 125 | <span class="summary-type"> </span> |
| 126 | </td><td class="summary"> |
| 127 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 128 | <tr> |
| 129 | <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#_is_ndb" class="summary-sig-name" onclick="show_private();">_is_ndb</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 130 | Determine whether the model of the instance is an NDB model.</td> |
| 131 | <td align="right" valign="top"> |
| 132 | <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName._is_ndb">source code</a></span> |
| 133 | |
| 134 | </td> |
| 135 | </tr> |
| 136 | </table> |
| 137 | |
| 138 | </td> |
| 139 | </tr> |
| 140 | <tr class="private"> |
| 141 | <td width="15%" align="right" valign="top" class="summary"> |
| 142 | <span class="summary-type"> </span> |
| 143 | </td><td class="summary"> |
| 144 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 145 | <tr> |
| 146 | <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#_get_entity" class="summary-sig-name" onclick="show_private();">_get_entity</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 147 | Retrieve entity from datastore.</td> |
| 148 | <td align="right" valign="top"> |
| 149 | <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName._get_entity">source code</a></span> |
| 150 | |
| 151 | </td> |
| 152 | </tr> |
| 153 | </table> |
| 154 | |
| 155 | </td> |
| 156 | </tr> |
| 157 | <tr class="private"> |
| 158 | <td width="15%" align="right" valign="top" class="summary"> |
| 159 | <span class="summary-type"> </span> |
| 160 | </td><td class="summary"> |
| 161 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 162 | <tr> |
| 163 | <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#_delete_entity" class="summary-sig-name" onclick="show_private();">_delete_entity</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 164 | Delete entity from datastore.</td> |
| 165 | <td align="right" valign="top"> |
| 166 | <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName._delete_entity">source code</a></span> |
| 167 | |
| 168 | </td> |
| 169 | </tr> |
| 170 | </table> |
| 171 | |
| 172 | </td> |
| 173 | </tr> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 174 | <tr> |
| 175 | <td width="15%" align="right" valign="top" class="summary"> |
| 176 | <span class="summary-type"> </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.appengine.StorageByKeyName-class.html#locked_get" class="summary-sig-name">locked_get</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 181 | Retrieve Credential from datastore.</td> |
| 182 | <td align="right" valign="top"> |
| 183 | <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_get">source code</a></span> |
| 184 | |
| 185 | </td> |
| 186 | </tr> |
| 187 | </table> |
| 188 | |
| 189 | </td> |
| 190 | </tr> |
| 191 | <tr> |
| 192 | <td width="15%" align="right" valign="top" class="summary"> |
| 193 | <span class="summary-type"> </span> |
| 194 | </td><td class="summary"> |
| 195 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 196 | <tr> |
| 197 | <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#locked_put" class="summary-sig-name">locked_put</a>(<span class="summary-sig-arg">self</span>, |
| 198 | <span class="summary-sig-arg">credentials</span>)</span><br /> |
| 199 | Write a Credentials to the datastore.</td> |
| 200 | <td align="right" valign="top"> |
| 201 | <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_put">source code</a></span> |
| 202 | |
| 203 | </td> |
| 204 | </tr> |
| 205 | </table> |
| 206 | |
| 207 | </td> |
| 208 | </tr> |
| 209 | <tr> |
| 210 | <td width="15%" align="right" valign="top" class="summary"> |
| 211 | <span class="summary-type"> </span> |
| 212 | </td><td class="summary"> |
| 213 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 214 | <tr> |
| 215 | <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#locked_delete" class="summary-sig-name">locked_delete</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 216 | Delete Credential from datastore.</td> |
| 217 | <td align="right" valign="top"> |
| 218 | <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_delete">source code</a></span> |
| 219 | |
| 220 | </td> |
| 221 | </tr> |
| 222 | </table> |
| 223 | |
| 224 | </td> |
| 225 | </tr> |
| 226 | <tr> |
| 227 | <td colspan="2" class="summary"> |
| 228 | <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Storage-class.html">client.Storage</a></code></b>: |
| 229 | <code><a href="oauth2client.client.Storage-class.html#acquire_lock">acquire_lock</a></code>, |
| 230 | <code><a href="oauth2client.client.Storage-class.html#delete">delete</a></code>, |
| 231 | <code><a href="oauth2client.client.Storage-class.html#get">get</a></code>, |
| 232 | <code><a href="oauth2client.client.Storage-class.html#put">put</a></code>, |
| 233 | <code><a href="oauth2client.client.Storage-class.html#release_lock">release_lock</a></code> |
| 234 | </p> |
| 235 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 236 | <code>__delattr__</code>, |
| 237 | <code>__format__</code>, |
| 238 | <code>__getattribute__</code>, |
| 239 | <code>__hash__</code>, |
| 240 | <code>__new__</code>, |
| 241 | <code>__reduce__</code>, |
| 242 | <code>__reduce_ex__</code>, |
| 243 | <code>__repr__</code>, |
| 244 | <code>__setattr__</code>, |
| 245 | <code>__sizeof__</code>, |
| 246 | <code>__str__</code>, |
| 247 | <code>__subclasshook__</code> |
| 248 | </p> |
| 249 | </td> |
| 250 | </tr> |
| 251 | </table> |
| 252 | <!-- ==================== PROPERTIES ==================== --> |
| 253 | <a name="section-Properties"></a> |
| 254 | <table class="summary" border="1" cellpadding="3" |
| 255 | cellspacing="0" width="100%" bgcolor="white"> |
| 256 | <tr bgcolor="#70b0f0" class="table-header"> |
| 257 | <td colspan="2" class="table-header"> |
| 258 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 259 | <tr valign="top"> |
| 260 | <td align="left"><span class="table-header">Properties</span></td> |
| 261 | <td align="right" valign="top" |
| 262 | ><span class="options">[<a href="#section-Properties" |
| 263 | class="privatelink" onclick="toggle_private();" |
| 264 | >hide private</a>]</span></td> |
| 265 | </tr> |
| 266 | </table> |
| 267 | </td> |
| 268 | </tr> |
| 269 | <tr> |
| 270 | <td colspan="2" class="summary"> |
| 271 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 272 | <code>__class__</code> |
| 273 | </p> |
| 274 | </td> |
| 275 | </tr> |
| 276 | </table> |
| 277 | <!-- ==================== METHOD DETAILS ==================== --> |
| 278 | <a name="section-MethodDetails"></a> |
| 279 | <table class="details" 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">Method Details</span></td> |
| 286 | <td align="right" valign="top" |
| 287 | ><span class="options">[<a href="#section-MethodDetails" |
| 288 | class="privatelink" onclick="toggle_private();" |
| 289 | >hide private</a>]</span></td> |
| 290 | </tr> |
| 291 | </table> |
| 292 | </td> |
| 293 | </tr> |
| 294 | </table> |
| 295 | <a name="__init__"></a> |
| 296 | <div> |
| 297 | <table class="details" border="1" cellpadding="3" |
| 298 | cellspacing="0" width="100%" bgcolor="white"> |
| 299 | <tr><td> |
| 300 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 301 | <tr valign="top"><td> |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 302 | <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
| 303 | <span class="sig-arg">model</span>, |
| 304 | <span class="sig-arg">key_name</span>, |
| 305 | <span class="sig-arg">property_name</span>, |
Joe Gregorio | 37802c3 | 2013-08-06 12:24:05 -0400 | [diff] [blame] | 306 | <span class="sig-arg">cache</span>=<span class="sig-default">None</span>, |
| 307 | <span class="sig-arg">user</span>=<span class="sig-default">None</span>)</span> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 308 | <br /><em class="fname">(Constructor)</em> |
| 309 | </h3> |
| 310 | </td><td align="right" valign="top" |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 311 | ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.__init__">source code</a></span> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 312 | </td> |
| 313 | </tr></table> |
| 314 | |
| 315 | <pre class="literalblock"> |
| 316 | Constructor for Storage. |
| 317 | |
| 318 | Args: |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 319 | model: db.Model or ndb.Model, model class |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 320 | key_name: string, key name for the entity that has the credentials |
| 321 | property_name: string, name of the property that is a CredentialsProperty |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 322 | or CredentialsNDBProperty. |
| 323 | cache: memcache, a write-through cache to put in front of the datastore. |
| 324 | If the model you are using is an NDB model, using a cache will be |
| 325 | redundant since the model uses an instance cache and memcache for you. |
Joe Gregorio | 37802c3 | 2013-08-06 12:24:05 -0400 | [diff] [blame] | 326 | user: users.User object, optional. Can be used to grab user ID as a |
| 327 | key_name if no key name is specified. |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 328 | |
| 329 | </pre> |
| 330 | <dl class="fields"> |
Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 331 | <dt>Decorators:</dt> |
| 332 | <dd><ul class="nomargin-top"> |
| 333 | <li><code>@util.positional(4)</code></li> |
| 334 | </ul></dd> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 335 | <dt>Overrides: |
| 336 | object.__init__ |
| 337 | </dt> |
| 338 | </dl> |
| 339 | </td></tr></table> |
| 340 | </div> |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 341 | <a name="_is_ndb"></a> |
| 342 | <div class="private"> |
| 343 | <table class="details" border="1" cellpadding="3" |
| 344 | cellspacing="0" width="100%" bgcolor="white"> |
| 345 | <tr><td> |
| 346 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 347 | <tr valign="top"><td> |
| 348 | <h3 class="epydoc"><span class="sig"><span class="sig-name">_is_ndb</span>(<span class="sig-arg">self</span>)</span> |
| 349 | </h3> |
| 350 | </td><td align="right" valign="top" |
| 351 | ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName._is_ndb">source code</a></span> |
| 352 | </td> |
| 353 | </tr></table> |
| 354 | |
| 355 | <pre class="literalblock"> |
| 356 | Determine whether the model of the instance is an NDB model. |
| 357 | |
| 358 | Returns: |
| 359 | Boolean indicating whether or not the model is an NDB or DB model. |
| 360 | |
| 361 | </pre> |
| 362 | <dl class="fields"> |
| 363 | </dl> |
| 364 | </td></tr></table> |
| 365 | </div> |
| 366 | <a name="_get_entity"></a> |
| 367 | <div class="private"> |
| 368 | <table class="details" border="1" cellpadding="3" |
| 369 | cellspacing="0" width="100%" bgcolor="white"> |
| 370 | <tr><td> |
| 371 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 372 | <tr valign="top"><td> |
| 373 | <h3 class="epydoc"><span class="sig"><span class="sig-name">_get_entity</span>(<span class="sig-arg">self</span>)</span> |
| 374 | </h3> |
| 375 | </td><td align="right" valign="top" |
| 376 | ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName._get_entity">source code</a></span> |
| 377 | </td> |
| 378 | </tr></table> |
| 379 | |
| 380 | <pre class="literalblock"> |
| 381 | Retrieve entity from datastore. |
| 382 | |
| 383 | Uses a different model method for db or ndb models. |
| 384 | |
| 385 | Returns: |
| 386 | Instance of the model corresponding to the current storage object |
| 387 | and stored using the key name of the storage object. |
| 388 | |
| 389 | </pre> |
| 390 | <dl class="fields"> |
| 391 | </dl> |
| 392 | </td></tr></table> |
| 393 | </div> |
| 394 | <a name="_delete_entity"></a> |
| 395 | <div class="private"> |
| 396 | <table class="details" border="1" cellpadding="3" |
| 397 | cellspacing="0" width="100%" bgcolor="white"> |
| 398 | <tr><td> |
| 399 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 400 | <tr valign="top"><td> |
| 401 | <h3 class="epydoc"><span class="sig"><span class="sig-name">_delete_entity</span>(<span class="sig-arg">self</span>)</span> |
| 402 | </h3> |
| 403 | </td><td align="right" valign="top" |
| 404 | ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName._delete_entity">source code</a></span> |
| 405 | </td> |
| 406 | </tr></table> |
| 407 | |
| 408 | <pre class="literalblock"> |
| 409 | Delete entity from datastore. |
| 410 | |
| 411 | Attempts to delete using the key_name stored on the object, whether or not |
| 412 | the given key is in the datastore. |
| 413 | |
| 414 | </pre> |
| 415 | <dl class="fields"> |
| 416 | </dl> |
| 417 | </td></tr></table> |
| 418 | </div> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 419 | <a name="locked_get"></a> |
| 420 | <div> |
| 421 | <table class="details" border="1" cellpadding="3" |
| 422 | cellspacing="0" width="100%" bgcolor="white"> |
| 423 | <tr><td> |
| 424 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 425 | <tr valign="top"><td> |
| 426 | <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_get</span>(<span class="sig-arg">self</span>)</span> |
| 427 | </h3> |
| 428 | </td><td align="right" valign="top" |
| 429 | ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_get">source code</a></span> |
| 430 | </td> |
| 431 | </tr></table> |
| 432 | |
| 433 | <pre class="literalblock"> |
| 434 | Retrieve Credential from datastore. |
| 435 | |
| 436 | Returns: |
| 437 | oauth2client.Credentials |
| 438 | |
| 439 | </pre> |
| 440 | <dl class="fields"> |
| 441 | <dt>Overrides: |
| 442 | <a href="oauth2client.client.Storage-class.html#locked_get">client.Storage.locked_get</a> |
| 443 | </dt> |
| 444 | </dl> |
| 445 | </td></tr></table> |
| 446 | </div> |
| 447 | <a name="locked_put"></a> |
| 448 | <div> |
| 449 | <table class="details" border="1" cellpadding="3" |
| 450 | cellspacing="0" width="100%" bgcolor="white"> |
| 451 | <tr><td> |
| 452 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 453 | <tr valign="top"><td> |
| 454 | <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_put</span>(<span class="sig-arg">self</span>, |
| 455 | <span class="sig-arg">credentials</span>)</span> |
| 456 | </h3> |
| 457 | </td><td align="right" valign="top" |
| 458 | ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_put">source code</a></span> |
| 459 | </td> |
| 460 | </tr></table> |
| 461 | |
| 462 | <pre class="literalblock"> |
| 463 | Write a Credentials to the datastore. |
| 464 | |
| 465 | Args: |
| 466 | credentials: Credentials, the credentials to store. |
| 467 | |
| 468 | </pre> |
| 469 | <dl class="fields"> |
| 470 | <dt>Overrides: |
| 471 | <a href="oauth2client.client.Storage-class.html#locked_put">client.Storage.locked_put</a> |
| 472 | </dt> |
| 473 | </dl> |
| 474 | </td></tr></table> |
| 475 | </div> |
| 476 | <a name="locked_delete"></a> |
| 477 | <div> |
| 478 | <table class="details" border="1" cellpadding="3" |
| 479 | cellspacing="0" width="100%" bgcolor="white"> |
| 480 | <tr><td> |
| 481 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 482 | <tr valign="top"><td> |
| 483 | <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_delete</span>(<span class="sig-arg">self</span>)</span> |
| 484 | </h3> |
| 485 | </td><td align="right" valign="top" |
| 486 | ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_delete">source code</a></span> |
| 487 | </td> |
| 488 | </tr></table> |
| 489 | |
| 490 | <pre class="literalblock"> |
| 491 | Delete Credential from datastore. |
| 492 | |
| 493 | </pre> |
| 494 | <dl class="fields"> |
| 495 | <dt>Overrides: |
| 496 | <a href="oauth2client.client.Storage-class.html#locked_delete">client.Storage.locked_delete</a> |
| 497 | </dt> |
| 498 | </dl> |
| 499 | </td></tr></table> |
| 500 | </div> |
| 501 | <br /> |
| 502 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 503 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 504 | bgcolor="#a0c0ff" cellspacing="0"> |
| 505 | <tr valign="middle"> |
| 506 | |
| 507 | <!-- Tree link --> |
| 508 | <th> <a |
| 509 | href="module-tree.html">Trees</a> </th> |
| 510 | |
| 511 | <!-- Index link --> |
| 512 | <th> <a |
| 513 | href="identifier-index.html">Indices</a> </th> |
| 514 | |
| 515 | <!-- Help link --> |
| 516 | <th> <a |
| 517 | href="help.html">Help</a> </th> |
| 518 | |
| 519 | <th class="navbar" width="100%"></th> |
| 520 | </tr> |
| 521 | </table> |
| 522 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 523 | <tr> |
| 524 | <td align="left" class="footer"> |
Joe Gregorio | 37802c3 | 2013-08-06 12:24:05 -0400 | [diff] [blame] | 525 | Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:45 2013 |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 526 | </td> |
| 527 | <td align="right" class="footer"> |
| 528 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 529 | >http://epydoc.sourceforge.net</a> |
| 530 | </td> |
| 531 | </tr> |
| 532 | </table> |
| 533 | |
| 534 | <script type="text/javascript"> |
| 535 | <!-- |
| 536 | // Private objects are initially displayed (because if |
| 537 | // javascript is turned off then we want them to be |
| 538 | // visible); but by default, we want to hide them. So hide |
| 539 | // them unless we have a cookie that says to show them. |
| 540 | checkCookie(); |
| 541 | // --> |
| 542 | </script> |
| 543 | </body> |
| 544 | </html> |