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.OAuth2Handler</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 OAuth2Handler |
| 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.OAuth2Handler-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 OAuth2Handler</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#OAuth2Handler">source code</a></span></p> |
| 57 | <center> |
| 58 | <center> <map id="uml_class_diagram_for_oauth2cl_8" name="uml_class_diagram_for_oauth2cl_8"> |
| 59 | <area shape="rect" href="oauth2client.appengine.OAuth2Handler-class.html#get" title="Handler method for GET requests." alt="" coords="140,316,231,335"/> |
| 60 | <area shape="rect" href="oauth2client.appengine.OAuth2Handler-class.html" title="Handler for the redirect_uri of the OAuth 2.0 dance." alt="" coords="139,291,232,336"/> |
| 61 | <area shape="rect" href="javascript:void(0);" title="Handler method for DELETE requests." alt="" coords="17,36,353,55"/> |
| 62 | <area shape="rect" href="javascript:void(0);" title="Clears the response output stream and sets the given HTTP error code." alt="" coords="17,55,353,73"/> |
| 63 | <area shape="rect" href="javascript:void(0);" title="Returns the url for the given handler." alt="" coords="17,73,353,92"/> |
| 64 | <area shape="rect" href="javascript:void(0);" title="Called if this handler throws an exception during execution." alt="" coords="17,92,353,111"/> |
| 65 | <area shape="rect" href="javascript:void(0);" title="Handler method for HEAD requests." alt="" coords="17,111,353,129"/> |
| 66 | <area shape="rect" href="javascript:void(0);" title="Initializes this request handler with the given Request and Response." alt="" coords="17,129,353,148"/> |
| 67 | <area shape="rect" href="javascript:void(0);" title="Create new request handler factory." alt="" coords="17,148,353,167"/> |
| 68 | <area shape="rect" href="javascript:void(0);" title="Handler method for OPTIONS requests." alt="" coords="17,167,353,185"/> |
| 69 | <area shape="rect" href="javascript:void(0);" title="Handler method for POST requests." alt="" coords="17,185,353,204"/> |
| 70 | <area shape="rect" href="javascript:void(0);" title="Handler method for PUT requests." alt="" coords="17,204,353,223"/> |
| 71 | <area shape="rect" href="javascript:void(0);" title="Issues an HTTP redirect to the given relative URL." alt="" coords="17,223,353,241"/> |
| 72 | <area shape="rect" href="javascript:void(0);" title="Handler method for TRACE requests." alt="" coords="17,241,353,260"/> |
| 73 | <area shape="rect" href="javascript:void(0);" title="Our base HTTP request handler." alt="" coords="16,11,355,261"/> |
| 74 | </map> |
| 75 | <img src="uml_class_diagram_for_oauth2cl_8.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_8" ismap="ismap" class="graph-without-title" /> |
| 76 | </center> |
| 77 | </center> |
| 78 | <hr /> |
| 79 | <pre class="literalblock"> |
| 80 | Handler for the redirect_uri of the OAuth 2.0 dance. |
| 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> |
| 107 | <td><span class="summary-sig"><a href="oauth2client.appengine.OAuth2Handler-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>, |
| 108 | <span class="summary-sig-arg">*args</span>)</span><br /> |
| 109 | Handler method for GET requests.</td> |
| 110 | <td align="right" valign="top"> |
| 111 | |
| 112 | |
| 113 | </td> |
| 114 | </tr> |
| 115 | </table> |
| 116 | |
| 117 | </td> |
| 118 | </tr> |
| 119 | <tr> |
| 120 | <td colspan="2" class="summary"> |
| 121 | <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.webapp._webapp25.RequestHandler</code></b>: |
| 122 | <code>delete</code>, |
| 123 | <code>error</code>, |
| 124 | <code>handle_exception</code>, |
| 125 | <code>head</code>, |
| 126 | <code>initialize</code>, |
| 127 | <code>options</code>, |
| 128 | <code>post</code>, |
| 129 | <code>put</code>, |
| 130 | <code>redirect</code>, |
| 131 | <code>trace</code> |
| 132 | </p> |
| 133 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 134 | <code>__delattr__</code>, |
| 135 | <code>__format__</code>, |
| 136 | <code>__getattribute__</code>, |
| 137 | <code>__hash__</code>, |
| 138 | <code>__init__</code>, |
| 139 | <code>__new__</code>, |
| 140 | <code>__reduce__</code>, |
| 141 | <code>__reduce_ex__</code>, |
| 142 | <code>__repr__</code>, |
| 143 | <code>__setattr__</code>, |
| 144 | <code>__sizeof__</code>, |
| 145 | <code>__str__</code>, |
| 146 | <code>__subclasshook__</code> |
| 147 | </p> |
| 148 | </td> |
| 149 | </tr> |
| 150 | </table> |
| 151 | <!-- ==================== CLASS METHODS ==================== --> |
| 152 | <a name="section-ClassMethods"></a> |
| 153 | <table class="summary" border="1" cellpadding="3" |
| 154 | cellspacing="0" width="100%" bgcolor="white"> |
| 155 | <tr bgcolor="#70b0f0" class="table-header"> |
| 156 | <td colspan="2" class="table-header"> |
| 157 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 158 | <tr valign="top"> |
| 159 | <td align="left"><span class="table-header">Class Methods</span></td> |
| 160 | <td align="right" valign="top" |
| 161 | ><span class="options">[<a href="#section-ClassMethods" |
| 162 | class="privatelink" onclick="toggle_private();" |
| 163 | >hide private</a>]</span></td> |
| 164 | </tr> |
| 165 | </table> |
| 166 | </td> |
| 167 | </tr> |
| 168 | <tr> |
| 169 | <td colspan="2" class="summary"> |
| 170 | <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.webapp._webapp25.RequestHandler</code></b>: |
| 171 | <code>get_url</code>, |
| 172 | <code>new_factory</code> |
| 173 | </p> |
| 174 | </td> |
| 175 | </tr> |
| 176 | </table> |
| 177 | <!-- ==================== PROPERTIES ==================== --> |
| 178 | <a name="section-Properties"></a> |
| 179 | <table class="summary" border="1" cellpadding="3" |
| 180 | cellspacing="0" width="100%" bgcolor="white"> |
| 181 | <tr bgcolor="#70b0f0" class="table-header"> |
| 182 | <td colspan="2" class="table-header"> |
| 183 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 184 | <tr valign="top"> |
| 185 | <td align="left"><span class="table-header">Properties</span></td> |
| 186 | <td align="right" valign="top" |
| 187 | ><span class="options">[<a href="#section-Properties" |
| 188 | class="privatelink" onclick="toggle_private();" |
| 189 | >hide private</a>]</span></td> |
| 190 | </tr> |
| 191 | </table> |
| 192 | </td> |
| 193 | </tr> |
| 194 | <tr> |
| 195 | <td colspan="2" class="summary"> |
| 196 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 197 | <code>__class__</code> |
| 198 | </p> |
| 199 | </td> |
| 200 | </tr> |
| 201 | </table> |
| 202 | <!-- ==================== METHOD DETAILS ==================== --> |
| 203 | <a name="section-MethodDetails"></a> |
| 204 | <table class="details" border="1" cellpadding="3" |
| 205 | cellspacing="0" width="100%" bgcolor="white"> |
| 206 | <tr bgcolor="#70b0f0" class="table-header"> |
| 207 | <td colspan="2" class="table-header"> |
| 208 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 209 | <tr valign="top"> |
| 210 | <td align="left"><span class="table-header">Method Details</span></td> |
| 211 | <td align="right" valign="top" |
| 212 | ><span class="options">[<a href="#section-MethodDetails" |
| 213 | class="privatelink" onclick="toggle_private();" |
| 214 | >hide private</a>]</span></td> |
| 215 | </tr> |
| 216 | </table> |
| 217 | </td> |
| 218 | </tr> |
| 219 | </table> |
| 220 | <a name="get"></a> |
| 221 | <div> |
| 222 | <table class="details" border="1" cellpadding="3" |
| 223 | cellspacing="0" width="100%" bgcolor="white"> |
| 224 | <tr><td> |
| 225 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 226 | <tr valign="top"><td> |
| 227 | <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>, |
| 228 | <span class="sig-arg">*args</span>)</span> |
| 229 | </h3> |
| 230 | </td><td align="right" valign="top" |
| 231 | > |
| 232 | </td> |
| 233 | </tr></table> |
| 234 | |
| 235 | <pre class="literalblock"> |
| 236 | Handler method for GET requests. |
| 237 | |
| 238 | </pre> |
| 239 | <dl class="fields"> |
| 240 | <dt>Decorators:</dt> |
| 241 | <dd><ul class="nomargin-top"> |
| 242 | <li><code>@login_required</code></li> |
| 243 | </ul></dd> |
| 244 | <dt>Overrides: |
| 245 | google.appengine.ext.webapp._webapp25.RequestHandler.get |
| 246 | <dd><em class="note">(inherited documentation)</em></dd> |
| 247 | </dt> |
| 248 | </dl> |
| 249 | </td></tr></table> |
| 250 | </div> |
| 251 | <br /> |
| 252 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 253 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 254 | bgcolor="#a0c0ff" cellspacing="0"> |
| 255 | <tr valign="middle"> |
| 256 | |
| 257 | <!-- Tree link --> |
| 258 | <th> <a |
| 259 | href="module-tree.html">Trees</a> </th> |
| 260 | |
| 261 | <!-- Index link --> |
| 262 | <th> <a |
| 263 | href="identifier-index.html">Indices</a> </th> |
| 264 | |
| 265 | <!-- Help link --> |
| 266 | <th> <a |
| 267 | href="help.html">Help</a> </th> |
| 268 | |
| 269 | <th class="navbar" width="100%"></th> |
| 270 | </tr> |
| 271 | </table> |
| 272 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 273 | <tr> |
| 274 | <td align="left" class="footer"> |
| 275 | Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:08 2012 |
| 276 | </td> |
| 277 | <td align="right" class="footer"> |
| 278 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 279 | >http://epydoc.sourceforge.net</a> |
| 280 | </td> |
| 281 | </tr> |
| 282 | </table> |
| 283 | |
| 284 | <script type="text/javascript"> |
| 285 | <!-- |
| 286 | // Private objects are initially displayed (because if |
| 287 | // javascript is turned off then we want them to be |
| 288 | // visible); but by default, we want to hide them. So hide |
| 289 | // them unless we have a cookie that says to show them. |
| 290 | checkCookie(); |
| 291 | // --> |
| 292 | </script> |
| 293 | </body> |
| 294 | </html> |