Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e7a0c477e1269ee11daa322ee1ab9ef414cb1b77 / . / docs / epy / oauth2client.appengine-module.html
blob: 2f4ef1bdeb3784ad1f09cc1dc9ba898d5f60d1b3 [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</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 Module&nbsp;appengine
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="oauth2client.appengine-module.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<!-- ==================== MODULE DESCRIPTION ==================== -->
55<h1 class="epydoc">Module appengine</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html">source&nbsp;code</a></span></p>
56<pre class="literalblock">
57Utilities for Google App Engine
58
59Utilities for making it easier to use OAuth 2.0 on Google App Engine.
60
61</pre>
62
63<hr />
64<div class="fields"> <p><strong>Author:</strong>
65 jcgregorio@google.com (Joe Gregorio)
66 </p>
67</div><!-- ==================== CLASSES ==================== -->
68<a name="section-Classes"></a>
69<table class="summary" border="1" cellpadding="3"
70 cellspacing="0" width="100%" bgcolor="white">
71<tr bgcolor="#70b0f0" class="table-header">
72 <td colspan="2" class="table-header">
73 <table border="0" cellpadding="0" cellspacing="0" width="100%">
74 <tr valign="top">
75 <td align="left"><span class="table-header">Classes</span></td>
76 <td align="right" valign="top"
77 ><span class="options">[<a href="#section-Classes"
78 class="privatelink" onclick="toggle_private();"
79 >hide private</a>]</span></td>
80 </tr>
81 </table>
82 </td>
83</tr>
84<tr>
85 <td width="15%" align="right" valign="top" class="summary">
86 <span class="summary-type">&nbsp;</span>
87 </td><td class="summary">
88 <a href="oauth2client.appengine.InvalidClientSecretsError-class.html" class="summary-name">InvalidClientSecretsError</a><br />
89 The client_secrets.json file is malformed or missing required fields.
90 </td>
91 </tr>
92<tr>
93 <td width="15%" align="right" valign="top" class="summary">
94 <span class="summary-type">&nbsp;</span>
95 </td><td class="summary">
96 <a href="oauth2client.appengine.AppAssertionCredentials-class.html" class="summary-name">AppAssertionCredentials</a><br />
97 Credentials object for App Engine Assertion Grants
98 </td>
99 </tr>
100<tr>
101 <td width="15%" align="right" valign="top" class="summary">
102 <span class="summary-type">&nbsp;</span>
103 </td><td class="summary">
104 <a href="oauth2client.appengine.FlowProperty-class.html" class="summary-name">FlowProperty</a><br />
105 App Engine datastore Property for Flow.
106 </td>
107 </tr>
108<tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <a href="oauth2client.appengine.CredentialsProperty-class.html" class="summary-name">CredentialsProperty</a><br />
113 App Engine datastore Property for Credentials.
114 </td>
115 </tr>
116<tr>
117 <td width="15%" align="right" valign="top" class="summary">
118 <span class="summary-type">&nbsp;</span>
119 </td><td class="summary">
120 <a href="oauth2client.appengine.StorageByKeyName-class.html" class="summary-name">StorageByKeyName</a><br />
121 Store and retrieve a single credential to and from
122the App Engine datastore.
123 </td>
124 </tr>
125<tr>
126 <td width="15%" align="right" valign="top" class="summary">
127 <span class="summary-type">&nbsp;</span>
128 </td><td class="summary">
129 <a href="oauth2client.appengine.CredentialsModel-class.html" class="summary-name">CredentialsModel</a><br />
130 Storage for OAuth 2.0 Credentials
131 </td>
132 </tr>
133<tr>
134 <td width="15%" align="right" valign="top" class="summary">
135 <span class="summary-type">&nbsp;</span>
136 </td><td class="summary">
137 <a href="oauth2client.appengine.OAuth2Decorator-class.html" class="summary-name">OAuth2Decorator</a><br />
138 Utility for making OAuth 2.0 easier.
139 </td>
140 </tr>
141<tr>
142 <td width="15%" align="right" valign="top" class="summary">
143 <span class="summary-type">&nbsp;</span>
144 </td><td class="summary">
145 <a href="oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html" class="summary-name">OAuth2DecoratorFromClientSecrets</a><br />
146 An OAuth2Decorator that builds from a clientsecrets file.
147 </td>
148 </tr>
149<tr>
150 <td width="15%" align="right" valign="top" class="summary">
151 <span class="summary-type">&nbsp;</span>
152 </td><td class="summary">
153 <a href="oauth2client.appengine.OAuth2Handler-class.html" class="summary-name">OAuth2Handler</a><br />
154 Handler for the redirect_uri of the OAuth 2.0 dance.
155 </td>
156 </tr>
157</table>
158<!-- ==================== FUNCTIONS ==================== -->
159<a name="section-Functions"></a>
160<table class="summary" border="1" cellpadding="3"
161 cellspacing="0" width="100%" bgcolor="white">
162<tr bgcolor="#70b0f0" class="table-header">
163 <td colspan="2" class="table-header">
164 <table border="0" cellpadding="0" cellspacing="0" width="100%">
165 <tr valign="top">
166 <td align="left"><span class="table-header">Functions</span></td>
167 <td align="right" valign="top"
168 ><span class="options">[<a href="#section-Functions"
169 class="privatelink" onclick="toggle_private();"
170 >hide private</a>]</span></td>
171 </tr>
172 </table>
173 </td>
174</tr>
175<tr>
176 <td width="15%" align="right" valign="top" class="summary">
177 <span class="summary-type">&nbsp;</span>
178 </td><td class="summary">
179 <table width="100%" cellpadding="0" cellspacing="0" border="0">
180 <tr>
181 <td><span class="summary-sig"><a href="oauth2client.appengine-module.html#oauth2decorator_from_clientsecrets" class="summary-sig-name">oauth2decorator_from_clientsecrets</a>(<span class="summary-sig-arg">filename</span>,
182 <span class="summary-sig-arg">scope</span>,
183 <span class="summary-sig-arg">message</span>=<span class="summary-sig-default">None</span>)</span><br />
184 Creates an OAuth2Decorator populated from a clientsecrets file.</td>
185 <td align="right" valign="top">
186 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#oauth2decorator_from_clientsecrets">source&nbsp;code</a></span>
187
188 </td>
189 </tr>
190 </table>
191
192 </td>
193 </tr>
194<tr>
195 <td width="15%" align="right" valign="top" class="summary">
196 <span class="summary-type">&nbsp;</span>
197 </td><td class="summary">
198 <table width="100%" cellpadding="0" cellspacing="0" border="0">
199 <tr>
200 <td><span class="summary-sig"><a name="main"></a><span class="summary-sig-name">main</span>()</span></td>
201 <td align="right" valign="top">
202 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#main">source&nbsp;code</a></span>
203
204 </td>
205 </tr>
206 </table>
207
208 </td>
209 </tr>
210</table>
211<!-- ==================== VARIABLES ==================== -->
212<a name="section-Variables"></a>
213<table class="summary" border="1" cellpadding="3"
214 cellspacing="0" width="100%" bgcolor="white">
215<tr bgcolor="#70b0f0" class="table-header">
216 <td colspan="2" class="table-header">
217 <table border="0" cellpadding="0" cellspacing="0" width="100%">
218 <tr valign="top">
219 <td align="left"><span class="table-header">Variables</span></td>
220 <td align="right" valign="top"
221 ><span class="options">[<a href="#section-Variables"
222 class="privatelink" onclick="toggle_private();"
223 >hide private</a>]</span></td>
224 </tr>
225 </table>
226 </td>
227</tr>
228<tr>
229 <td width="15%" align="right" valign="top" class="summary">
230 <span class="summary-type">&nbsp;</span>
231 </td><td class="summary">
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame^]232 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
233 </td>
234 </tr>
235<tr>
236 <td width="15%" align="right" valign="top" class="summary">
237 <span class="summary-type">&nbsp;</span>
238 </td><td class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]239 <a name="OAUTH2CLIENT_NAMESPACE"></a><span class="summary-name">OAUTH2CLIENT_NAMESPACE</span> = <code title="'oauth2client#ns'"><code class="variable-quote">'</code><code class="variable-string">oauth2client#ns</code><code class="variable-quote">'</code></code>
240 </td>
241 </tr>
242<tr>
243 <td width="15%" align="right" valign="top" class="summary">
244 <span class="summary-type">&nbsp;</span>
245 </td><td class="summary">
246 <a href="oauth2client.appengine-module.html#application" class="summary-name">application</a> = <code title="webapp.WSGIApplication([('/oauth2callback', OAuth2Handler)])">webapp.WSGIApplication([('/oauth2callback', OAut<code class="variable-ellipsis">...</code></code>
247 </td>
248 </tr>
249<tr>
250 <td width="15%" align="right" valign="top" class="summary">
251 <span class="summary-type">&nbsp;</span>
252 </td><td class="summary">
253 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'oauth2client'"><code class="variable-quote">'</code><code class="variable-string">oauth2client</code><code class="variable-quote">'</code></code>
254 </td>
255 </tr>
256</table>
257<!-- ==================== FUNCTION DETAILS ==================== -->
258<a name="section-FunctionDetails"></a>
259<table class="details" border="1" cellpadding="3"
260 cellspacing="0" width="100%" bgcolor="white">
261<tr bgcolor="#70b0f0" class="table-header">
262 <td colspan="2" class="table-header">
263 <table border="0" cellpadding="0" cellspacing="0" width="100%">
264 <tr valign="top">
265 <td align="left"><span class="table-header">Function Details</span></td>
266 <td align="right" valign="top"
267 ><span class="options">[<a href="#section-FunctionDetails"
268 class="privatelink" onclick="toggle_private();"
269 >hide private</a>]</span></td>
270 </tr>
271 </table>
272 </td>
273</tr>
274</table>
275<a name="oauth2decorator_from_clientsecrets"></a>
276<div>
277<table class="details" border="1" cellpadding="3"
278 cellspacing="0" width="100%" bgcolor="white">
279<tr><td>
280 <table width="100%" cellpadding="0" cellspacing="0" border="0">
281 <tr valign="top"><td>
282 <h3 class="epydoc"><span class="sig"><span class="sig-name">oauth2decorator_from_clientsecrets</span>(<span class="sig-arg">filename</span>,
283 <span class="sig-arg">scope</span>,
284 <span class="sig-arg">message</span>=<span class="sig-default">None</span>)</span>
285 </h3>
286 </td><td align="right" valign="top"
287 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#oauth2decorator_from_clientsecrets">source&nbsp;code</a></span>&nbsp;
288 </td>
289 </tr></table>
290
291 <pre class="literalblock">
292Creates an OAuth2Decorator populated from a clientsecrets file.
293
294Args:
295 filename: string, File name of client secrets.
296 scope: string or list of strings, scope(s) of the credentials being
297 requested.
298 message: string, A friendly string to display to the user if the
299 clientsecrets file is missing or invalid. The message may contain HTML and
300 will be presented on the web interface for any method that uses the
301 decorator.
302
303Returns: An OAuth2Decorator
304
305</pre>
306 <dl class="fields">
307 </dl>
308</td></tr></table>
309</div>
310<br />
311<!-- ==================== VARIABLES DETAILS ==================== -->
312<a name="section-VariablesDetails"></a>
313<table class="details" border="1" cellpadding="3"
314 cellspacing="0" width="100%" bgcolor="white">
315<tr bgcolor="#70b0f0" class="table-header">
316 <td colspan="2" class="table-header">
317 <table border="0" cellpadding="0" cellspacing="0" width="100%">
318 <tr valign="top">
319 <td align="left"><span class="table-header">Variables Details</span></td>
320 <td align="right" valign="top"
321 ><span class="options">[<a href="#section-VariablesDetails"
322 class="privatelink" onclick="toggle_private();"
323 >hide private</a>]</span></td>
324 </tr>
325 </table>
326 </td>
327</tr>
328</table>
329<a name="application"></a>
330<div>
331<table class="details" border="1" cellpadding="3"
332 cellspacing="0" width="100%" bgcolor="white">
333<tr><td>
334 <h3 class="epydoc">application</h3>
335
336 <dl class="fields">
337 </dl>
338 <dl class="fields">
339 <dt>Value:</dt>
340 <dd><table><tr><td><pre class="variable">
341webapp.WSGIApplication([('/oauth2callback', OAuth2Handler)])
342</pre></td></tr></table>
343</dd>
344 </dl>
345</td></tr></table>
346</div>
347<br />
348<!-- ==================== NAVIGATION BAR ==================== -->
349<table class="navbar" border="0" width="100%" cellpadding="0"
350 bgcolor="#a0c0ff" cellspacing="0">
351 <tr valign="middle">
352
353 <!-- Tree link -->
354 <th>&nbsp;&nbsp;&nbsp;<a
355 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
356
357 <!-- Index link -->
358 <th>&nbsp;&nbsp;&nbsp;<a
359 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
360
361 <!-- Help link -->
362 <th>&nbsp;&nbsp;&nbsp;<a
363 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
364
365 <th class="navbar" width="100%"></th>
366 </tr>
367</table>
368<table border="0" cellpadding="0" cellspacing="0" width="100%%">
369 <tr>
370 <td align="left" class="footer">
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame^]371 Generated by Epydoc 3.0.1 on Thu Jul 12 10:44:08 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]372 </td>
373 <td align="right" class="footer">
374 <a target="mainFrame" href="http://epydoc.sourceforge.net"
375 >http://epydoc.sourceforge.net</a>
376 </td>
377 </tr>
378</table>
379
380<script type="text/javascript">
381 <!--
382 // Private objects are initially displayed (because if
383 // javascript is turned off then we want them to be
384 // visible); but by default, we want to hide them. So hide
385 // them unless we have a cookie that says to show them.
386 checkCookie();
387 // -->
388</script>
389</body>
390</html>