Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02b5f3f369d9dceaf197eac540ce5797d1a07250 / . / docs / epy / oauth2client.appengine.StorageByKeyName-class.html
blob: 7f928f7ec90ddb874b18de73cccc8d88d10ff3db [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.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>&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.appengine-module.html">Module&nbsp;appengine</a> ::
39 Class&nbsp;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&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.appengine.StorageByKeyName-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 StorageByKeyName</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName">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_storagebyk" name="class_hierarchy_for_storagebyk">
59<area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html" title="StorageByKeyName" alt="" coords="5,61,144,88"/>
60<area shape="rect" href="oauth2client.client.Storage-class.html" title="client.Storage" alt="" coords="24,5,125,32"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]61</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]62 <img src="class_hierarchy_for_storagebyk.gif" alt='' usemap="#class_hierarchy_for_storagebyk" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]63</center>
64</center>
65<hr />
66<pre class="literalblock">
67Store and retrieve a single credential to and from
68the App Engine datastore.
69
70This Storage helper presumes the Credentials
71have been stored as a CredenialsProperty
72on a datastore model class, and that entities
73are stored by key_name.
74
75</pre>
76
77<!-- ==================== INSTANCE METHODS ==================== -->
78<a name="section-InstanceMethods"></a>
79<table class="summary" border="1" cellpadding="3"
80 cellspacing="0" width="100%" bgcolor="white">
81<tr bgcolor="#70b0f0" class="table-header">
82 <td colspan="2" class="table-header">
83 <table border="0" cellpadding="0" cellspacing="0" width="100%">
84 <tr valign="top">
85 <td align="left"><span class="table-header">Instance Methods</span></td>
86 <td align="right" valign="top"
87 ><span class="options">[<a href="#section-InstanceMethods"
88 class="privatelink" onclick="toggle_private();"
89 >hide private</a>]</span></td>
90 </tr>
91 </table>
92 </td>
93</tr>
94<tr>
95 <td width="15%" align="right" valign="top" class="summary">
96 <span class="summary-type">&nbsp;</span>
97 </td><td class="summary">
98 <table width="100%" cellpadding="0" cellspacing="0" border="0">
99 <tr>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]100 <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
101 <span class="summary-sig-arg">**kwargs</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]102 Constructor for Storage.</td>
103 <td align="right" valign="top">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]104 <span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]105
106 </td>
107 </tr>
108 </table>
109
110 </td>
111 </tr>
112<tr>
113 <td width="15%" align="right" valign="top" class="summary">
114 <span class="summary-type">&nbsp;</span>
115 </td><td class="summary">
116 <table width="100%" cellpadding="0" cellspacing="0" border="0">
117 <tr>
118 <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 />
119 Retrieve Credential from datastore.</td>
120 <td align="right" valign="top">
121 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_get">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>
135 <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>,
136 <span class="summary-sig-arg">credentials</span>)</span><br />
137 Write a Credentials to the datastore.</td>
138 <td align="right" valign="top">
139 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_put">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>
153 <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 />
154 Delete Credential from datastore.</td>
155 <td align="right" valign="top">
156 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_delete">source&nbsp;code</a></span>
157
158 </td>
159 </tr>
160 </table>
161
162 </td>
163 </tr>
164 <tr>
165 <td colspan="2" class="summary">
166 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Storage-class.html">client.Storage</a></code></b>:
167 <code><a href="oauth2client.client.Storage-class.html#acquire_lock">acquire_lock</a></code>,
168 <code><a href="oauth2client.client.Storage-class.html#delete">delete</a></code>,
169 <code><a href="oauth2client.client.Storage-class.html#get">get</a></code>,
170 <code><a href="oauth2client.client.Storage-class.html#put">put</a></code>,
171 <code><a href="oauth2client.client.Storage-class.html#release_lock">release_lock</a></code>
172 </p>
173 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
174 <code>__delattr__</code>,
175 <code>__format__</code>,
176 <code>__getattribute__</code>,
177 <code>__hash__</code>,
178 <code>__new__</code>,
179 <code>__reduce__</code>,
180 <code>__reduce_ex__</code>,
181 <code>__repr__</code>,
182 <code>__setattr__</code>,
183 <code>__sizeof__</code>,
184 <code>__str__</code>,
185 <code>__subclasshook__</code>
186 </p>
187 </td>
188 </tr>
189</table>
190<!-- ==================== PROPERTIES ==================== -->
191<a name="section-Properties"></a>
192<table class="summary" border="1" cellpadding="3"
193 cellspacing="0" width="100%" bgcolor="white">
194<tr bgcolor="#70b0f0" class="table-header">
195 <td colspan="2" class="table-header">
196 <table border="0" cellpadding="0" cellspacing="0" width="100%">
197 <tr valign="top">
198 <td align="left"><span class="table-header">Properties</span></td>
199 <td align="right" valign="top"
200 ><span class="options">[<a href="#section-Properties"
201 class="privatelink" onclick="toggle_private();"
202 >hide private</a>]</span></td>
203 </tr>
204 </table>
205 </td>
206</tr>
207 <tr>
208 <td colspan="2" class="summary">
209 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
210 <code>__class__</code>
211 </p>
212 </td>
213 </tr>
214</table>
215<!-- ==================== METHOD DETAILS ==================== -->
216<a name="section-MethodDetails"></a>
217<table class="details" border="1" cellpadding="3"
218 cellspacing="0" width="100%" bgcolor="white">
219<tr bgcolor="#70b0f0" class="table-header">
220 <td colspan="2" class="table-header">
221 <table border="0" cellpadding="0" cellspacing="0" width="100%">
222 <tr valign="top">
223 <td align="left"><span class="table-header">Method Details</span></td>
224 <td align="right" valign="top"
225 ><span class="options">[<a href="#section-MethodDetails"
226 class="privatelink" onclick="toggle_private();"
227 >hide private</a>]</span></td>
228 </tr>
229 </table>
230 </td>
231</tr>
232</table>
233<a name="__init__"></a>
234<div>
235<table class="details" border="1" cellpadding="3"
236 cellspacing="0" width="100%" bgcolor="white">
237<tr><td>
238 <table width="100%" cellpadding="0" cellspacing="0" border="0">
239 <tr valign="top"><td>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]240 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
241 <span class="sig-arg">**kwargs</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]242 <br /><em class="fname">(Constructor)</em>
243 </h3>
244 </td><td align="right" valign="top"
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]245 ><span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]246 </td>
247 </tr></table>
248
249 <pre class="literalblock">
250Constructor for Storage.
251
252Args:
253 model: db.Model, model class
254 key_name: string, key name for the entity that has the credentials
255 property_name: string, name of the property that is a CredentialsProperty
256 cache: memcache, a write-through cache to put in front of the datastore
257
258</pre>
259 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]260 <dt>Decorators:</dt>
261 <dd><ul class="nomargin-top">
262 <li><code>@util.positional(4)</code></li>
263 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]264 <dt>Overrides:
265 object.__init__
266 </dt>
267 </dl>
268</td></tr></table>
269</div>
270<a name="locked_get"></a>
271<div>
272<table class="details" border="1" cellpadding="3"
273 cellspacing="0" width="100%" bgcolor="white">
274<tr><td>
275 <table width="100%" cellpadding="0" cellspacing="0" border="0">
276 <tr valign="top"><td>
277 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_get</span>(<span class="sig-arg">self</span>)</span>
278 </h3>
279 </td><td align="right" valign="top"
280 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_get">source&nbsp;code</a></span>&nbsp;
281 </td>
282 </tr></table>
283
284 <pre class="literalblock">
285Retrieve Credential from datastore.
286
287Returns:
288 oauth2client.Credentials
289
290</pre>
291 <dl class="fields">
292 <dt>Overrides:
293 <a href="oauth2client.client.Storage-class.html#locked_get">client.Storage.locked_get</a>
294 </dt>
295 </dl>
296</td></tr></table>
297</div>
298<a name="locked_put"></a>
299<div>
300<table class="details" border="1" cellpadding="3"
301 cellspacing="0" width="100%" bgcolor="white">
302<tr><td>
303 <table width="100%" cellpadding="0" cellspacing="0" border="0">
304 <tr valign="top"><td>
305 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_put</span>(<span class="sig-arg">self</span>,
306 <span class="sig-arg">credentials</span>)</span>
307 </h3>
308 </td><td align="right" valign="top"
309 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_put">source&nbsp;code</a></span>&nbsp;
310 </td>
311 </tr></table>
312
313 <pre class="literalblock">
314Write a Credentials to the datastore.
315
316Args:
317 credentials: Credentials, the credentials to store.
318
319</pre>
320 <dl class="fields">
321 <dt>Overrides:
322 <a href="oauth2client.client.Storage-class.html#locked_put">client.Storage.locked_put</a>
323 </dt>
324 </dl>
325</td></tr></table>
326</div>
327<a name="locked_delete"></a>
328<div>
329<table class="details" border="1" cellpadding="3"
330 cellspacing="0" width="100%" bgcolor="white">
331<tr><td>
332 <table width="100%" cellpadding="0" cellspacing="0" border="0">
333 <tr valign="top"><td>
334 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_delete</span>(<span class="sig-arg">self</span>)</span>
335 </h3>
336 </td><td align="right" valign="top"
337 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_delete">source&nbsp;code</a></span>&nbsp;
338 </td>
339 </tr></table>
340
341 <pre class="literalblock">
342Delete Credential from datastore.
343
344</pre>
345 <dl class="fields">
346 <dt>Overrides:
347 <a href="oauth2client.client.Storage-class.html#locked_delete">client.Storage.locked_delete</a>
348 </dt>
349 </dl>
350</td></tr></table>
351</div>
352<br />
353<!-- ==================== NAVIGATION BAR ==================== -->
354<table class="navbar" border="0" width="100%" cellpadding="0"
355 bgcolor="#a0c0ff" cellspacing="0">
356 <tr valign="middle">
357
358 <!-- Tree link -->
359 <th>&nbsp;&nbsp;&nbsp;<a
360 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
361
362 <!-- Index link -->
363 <th>&nbsp;&nbsp;&nbsp;<a
364 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
365
366 <!-- Help link -->
367 <th>&nbsp;&nbsp;&nbsp;<a
368 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
369
370 <th class="navbar" width="100%"></th>
371 </tr>
372</table>
373<table border="0" cellpadding="0" cellspacing="0" width="100%%">
374 <tr>
375 <td align="left" class="footer">
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]376 Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:45 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]377 </td>
378 <td align="right" class="footer">
379 <a target="mainFrame" href="http://epydoc.sourceforge.net"
380 >http://epydoc.sourceforge.net</a>
381 </td>
382 </tr>
383</table>
384
385<script type="text/javascript">
386 <!--
387 // Private objects are initially displayed (because if
388 // javascript is turned off then we want them to be
389 // visible); but by default, we want to hide them. So hide
390 // them unless we have a cookie that says to show them.
391 checkCookie();
392 // -->
393</script>
394</body>
395</html>