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.AssertionCredentials</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 AssertionCredentials |
| 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.AssertionCredentials-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 AssertionCredentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials">source code</a></span></p> |
| 57 | <center> |
Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 58 | <center> <map id="class_hierarchy_for_assertionc" name="class_hierarchy_for_assertionc"> |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 59 | <area shape="rect" id="node1" href="oauth2client.client.AssertionCredentials-class.html" title="AssertionCredentials" alt="" coords="5,6,147,34"/> |
| 60 | <area shape="rect" id="node2" href="oauth2client.client.Credentials-class.html" title="Credentials" alt="" coords="171,6,259,34"/> |
| 61 | <area shape="rect" id="node3" href="oauth2client.client.OAuth2Credentials-class.html" title="OAuth2Credentials" alt="" coords="283,6,413,34"/> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 62 | </map> |
Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 63 | <img src="class_hierarchy_for_assertionc.gif" alt='' usemap="#class_hierarchy_for_assertionc" ismap="ismap" class="graph-without-title" /> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 64 | </center> |
| 65 | </center> |
| 66 | <hr /> |
| 67 | <pre class="literalblock"> |
| 68 | Abstract Credentials object used for OAuth 2.0 assertion grants. |
| 69 | |
| 70 | This credential does not require a flow to instantiate because it |
| 71 | represents a two legged flow, and therefore has all of the required |
Joe Gregorio | 52a5c53 | 2013-01-24 16:19:07 -0500 | [diff] [blame] | 72 | information to generate and refresh its own access tokens. It must |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 73 | be subclassed to generate the appropriate assertion string. |
| 74 | |
| 75 | AssertionCredentials objects may be safely pickled and unpickled. |
| 76 | |
| 77 | </pre> |
| 78 | |
| 79 | <!-- ==================== INSTANCE METHODS ==================== --> |
| 80 | <a name="section-InstanceMethods"></a> |
| 81 | <table class="summary" border="1" cellpadding="3" |
| 82 | cellspacing="0" width="100%" bgcolor="white"> |
| 83 | <tr bgcolor="#70b0f0" class="table-header"> |
| 84 | <td colspan="2" class="table-header"> |
| 85 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 86 | <tr valign="top"> |
| 87 | <td align="left"><span class="table-header">Instance Methods</span></td> |
| 88 | <td align="right" valign="top" |
| 89 | ><span class="options">[<a href="#section-InstanceMethods" |
| 90 | class="privatelink" onclick="toggle_private();" |
| 91 | >hide private</a>]</span></td> |
| 92 | </tr> |
| 93 | </table> |
| 94 | </td> |
| 95 | </tr> |
| 96 | <tr> |
| 97 | <td width="15%" align="right" valign="top" class="summary"> |
| 98 | <span class="summary-type"> </span> |
| 99 | </td><td class="summary"> |
| 100 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 101 | <tr> |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 102 | <td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
| 103 | <span class="summary-sig-arg">assertion_type</span>, |
| 104 | <span class="summary-sig-arg">user_agent</span>=<span class="summary-sig-default">None</span>, |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 105 | <span class="summary-sig-arg">token_uri</span>=<span class="summary-sig-default">GOOGLE_TOKEN_URI</span>, |
| 106 | <span class="summary-sig-arg">revoke_uri</span>=<span class="summary-sig-default">GOOGLE_REVOKE_URI</span>, |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 107 | <span class="summary-sig-arg">**unused_kwargs</span>)</span><br /> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 108 | Constructor for AssertionFlowCredentials.</td> |
| 109 | <td align="right" valign="top"> |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 110 | <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source code</a></span> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 111 | |
| 112 | </td> |
| 113 | </tr> |
| 114 | </table> |
| 115 | |
| 116 | </td> |
| 117 | </tr> |
| 118 | <tr class="private"> |
| 119 | <td width="15%" align="right" valign="top" class="summary"> |
| 120 | <span class="summary-type"> </span> |
| 121 | </td><td class="summary"> |
| 122 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 123 | <tr> |
| 124 | <td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body" class="summary-sig-name" onclick="show_private();">_generate_refresh_request_body</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 125 | Generate the body that will be used in the refresh request.</td> |
| 126 | <td align="right" valign="top"> |
| 127 | <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source code</a></span> |
| 128 | |
| 129 | </td> |
| 130 | </tr> |
| 131 | </table> |
| 132 | |
| 133 | </td> |
| 134 | </tr> |
| 135 | <tr class="private"> |
| 136 | <td width="15%" align="right" valign="top" class="summary"> |
| 137 | <span class="summary-type"> </span> |
| 138 | </td><td class="summary"> |
| 139 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 140 | <tr> |
| 141 | <td><span class="summary-sig"><a name="_generate_assertion"></a><span class="summary-sig-name">_generate_assertion</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
| 142 | Generate the assertion string that will be used in the access token |
| 143 | request.</td> |
| 144 | <td align="right" valign="top"> |
| 145 | <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_assertion">source code</a></span> |
| 146 | |
| 147 | </td> |
| 148 | </tr> |
| 149 | </table> |
| 150 | |
| 151 | </td> |
| 152 | </tr> |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 153 | <tr class="private"> |
| 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.AssertionCredentials-class.html#_revoke" class="summary-sig-name" onclick="show_private();">_revoke</a>(<span class="summary-sig-arg">self</span>, |
| 160 | <span class="summary-sig-arg">http_request</span>)</span><br /> |
| 161 | Revokes the access_token and deletes the store if available.</td> |
| 162 | <td align="right" valign="top"> |
| 163 | <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._revoke">source code</a></span> |
| 164 | |
| 165 | </td> |
| 166 | </tr> |
| 167 | </table> |
| 168 | |
| 169 | </td> |
| 170 | </tr> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 171 | <tr> |
| 172 | <td colspan="2" class="summary"> |
| 173 | <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>: |
| 174 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>, |
| 175 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>, |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 176 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>, |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 177 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>, |
| 178 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>, |
| 179 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>, |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 180 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#revoke">revoke</a></code>, |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 181 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>, |
| 182 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code> |
| 183 | </p> |
| 184 | <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private): |
| 185 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>, |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 186 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_revoke" onclick="show_private();">_do_revoke</a></code>, |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 187 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>, |
| 188 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">_refresh</a></code>, |
| 189 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code> |
| 190 | </p></div> |
| 191 | <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private): |
| 192 | <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code> |
| 193 | </p></div> |
| 194 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 195 | <code>__delattr__</code>, |
| 196 | <code>__format__</code>, |
| 197 | <code>__getattribute__</code>, |
| 198 | <code>__hash__</code>, |
| 199 | <code>__new__</code>, |
| 200 | <code>__reduce__</code>, |
| 201 | <code>__reduce_ex__</code>, |
| 202 | <code>__repr__</code>, |
| 203 | <code>__setattr__</code>, |
| 204 | <code>__sizeof__</code>, |
| 205 | <code>__str__</code>, |
| 206 | <code>__subclasshook__</code> |
| 207 | </p> |
| 208 | </td> |
| 209 | </tr> |
| 210 | </table> |
| 211 | <!-- ==================== CLASS METHODS ==================== --> |
| 212 | <a name="section-ClassMethods"></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">Class Methods</span></td> |
| 220 | <td align="right" valign="top" |
| 221 | ><span class="options">[<a href="#section-ClassMethods" |
| 222 | class="privatelink" onclick="toggle_private();" |
| 223 | >hide private</a>]</span></td> |
| 224 | </tr> |
| 225 | </table> |
| 226 | </td> |
| 227 | </tr> |
| 228 | <tr> |
| 229 | <td colspan="2" class="summary"> |
| 230 | <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>: |
| 231 | <code><a href="oauth2client.client.OAuth2Credentials-class.html#from_json">from_json</a></code> |
| 232 | </p> |
| 233 | <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>: |
| 234 | <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code> |
| 235 | </p> |
| 236 | </td> |
| 237 | </tr> |
| 238 | </table> |
| 239 | <!-- ==================== CLASS VARIABLES ==================== --> |
| 240 | <a name="section-ClassVariables"></a> |
| 241 | <table class="summary" border="1" cellpadding="3" |
| 242 | cellspacing="0" width="100%" bgcolor="white"> |
| 243 | <tr bgcolor="#70b0f0" class="table-header"> |
| 244 | <td colspan="2" class="table-header"> |
| 245 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 246 | <tr valign="top"> |
| 247 | <td align="left"><span class="table-header">Class Variables</span></td> |
| 248 | <td align="right" valign="top" |
| 249 | ><span class="options">[<a href="#section-ClassVariables" |
| 250 | class="privatelink" onclick="toggle_private();" |
| 251 | >hide private</a>]</span></td> |
| 252 | </tr> |
| 253 | </table> |
| 254 | </td> |
| 255 | </tr> |
| 256 | <tr> |
| 257 | <td colspan="2" class="summary"> |
| 258 | <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>: |
| 259 | <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code> |
| 260 | </p> |
| 261 | </td> |
| 262 | </tr> |
| 263 | </table> |
| 264 | <!-- ==================== PROPERTIES ==================== --> |
| 265 | <a name="section-Properties"></a> |
| 266 | <table class="summary" border="1" cellpadding="3" |
| 267 | cellspacing="0" width="100%" bgcolor="white"> |
| 268 | <tr bgcolor="#70b0f0" class="table-header"> |
| 269 | <td colspan="2" class="table-header"> |
| 270 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 271 | <tr valign="top"> |
| 272 | <td align="left"><span class="table-header">Properties</span></td> |
| 273 | <td align="right" valign="top" |
| 274 | ><span class="options">[<a href="#section-Properties" |
| 275 | class="privatelink" onclick="toggle_private();" |
| 276 | >hide private</a>]</span></td> |
| 277 | </tr> |
| 278 | </table> |
| 279 | </td> |
| 280 | </tr> |
| 281 | <tr> |
| 282 | <td colspan="2" class="summary"> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 283 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 284 | <code>__class__</code> |
| 285 | </p> |
| 286 | </td> |
| 287 | </tr> |
| 288 | </table> |
| 289 | <!-- ==================== METHOD DETAILS ==================== --> |
| 290 | <a name="section-MethodDetails"></a> |
| 291 | <table class="details" border="1" cellpadding="3" |
| 292 | cellspacing="0" width="100%" bgcolor="white"> |
| 293 | <tr bgcolor="#70b0f0" class="table-header"> |
| 294 | <td colspan="2" class="table-header"> |
| 295 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 296 | <tr valign="top"> |
| 297 | <td align="left"><span class="table-header">Method Details</span></td> |
| 298 | <td align="right" valign="top" |
| 299 | ><span class="options">[<a href="#section-MethodDetails" |
| 300 | class="privatelink" onclick="toggle_private();" |
| 301 | >hide private</a>]</span></td> |
| 302 | </tr> |
| 303 | </table> |
| 304 | </td> |
| 305 | </tr> |
| 306 | </table> |
| 307 | <a name="__init__"></a> |
| 308 | <div> |
| 309 | <table class="details" border="1" cellpadding="3" |
| 310 | cellspacing="0" width="100%" bgcolor="white"> |
| 311 | <tr><td> |
| 312 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 313 | <tr valign="top"><td> |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 314 | <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
| 315 | <span class="sig-arg">assertion_type</span>, |
| 316 | <span class="sig-arg">user_agent</span>=<span class="sig-default">None</span>, |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 317 | <span class="sig-arg">token_uri</span>=<span class="sig-default">GOOGLE_TOKEN_URI</span>, |
| 318 | <span class="sig-arg">revoke_uri</span>=<span class="sig-default">GOOGLE_REVOKE_URI</span>, |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 319 | <span class="sig-arg">**unused_kwargs</span>)</span> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 320 | <br /><em class="fname">(Constructor)</em> |
| 321 | </h3> |
| 322 | </td><td align="right" valign="top" |
Joe Gregorio | f4839b0 | 2012-09-06 13:47:24 -0400 | [diff] [blame] | 323 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source code</a></span> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 324 | </td> |
| 325 | </tr></table> |
| 326 | |
| 327 | <pre class="literalblock"> |
| 328 | Constructor for AssertionFlowCredentials. |
| 329 | |
| 330 | Args: |
| 331 | assertion_type: string, assertion type that will be declared to the auth |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 332 | server |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 333 | user_agent: string, The HTTP User-Agent to provide for this application. |
| 334 | token_uri: string, URI for token endpoint. For convenience |
| 335 | defaults to Google's endpoints but any OAuth 2.0 provider can be used. |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 336 | revoke_uri: string, URI for revoke endpoint. |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 337 | |
| 338 | </pre> |
| 339 | <dl class="fields"> |
Joe Gregorio | 1b425aa | 2012-08-24 12:04:34 -0400 | [diff] [blame] | 340 | <dt>Decorators:</dt> |
| 341 | <dd><ul class="nomargin-top"> |
| 342 | <li><code>@util.positional(2)</code></li> |
| 343 | </ul></dd> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 344 | <dt>Overrides: |
| 345 | object.__init__ |
| 346 | </dt> |
| 347 | </dl> |
| 348 | </td></tr></table> |
| 349 | </div> |
| 350 | <a name="_generate_refresh_request_body"></a> |
| 351 | <div class="private"> |
| 352 | <table class="details" border="1" cellpadding="3" |
| 353 | cellspacing="0" width="100%" bgcolor="white"> |
| 354 | <tr><td> |
| 355 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 356 | <tr valign="top"><td> |
| 357 | <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_refresh_request_body</span>(<span class="sig-arg">self</span>)</span> |
| 358 | </h3> |
| 359 | </td><td align="right" valign="top" |
| 360 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source code</a></span> |
| 361 | </td> |
| 362 | </tr></table> |
| 363 | |
| 364 | <pre class="literalblock"> |
| 365 | Generate the body that will be used in the refresh request. |
| 366 | |
| 367 | </pre> |
| 368 | <dl class="fields"> |
| 369 | <dt>Overrides: |
| 370 | <a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">OAuth2Credentials._generate_refresh_request_body</a> |
| 371 | <dd><em class="note">(inherited documentation)</em></dd> |
| 372 | </dt> |
| 373 | </dl> |
| 374 | </td></tr></table> |
| 375 | </div> |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 376 | <a name="_revoke"></a> |
| 377 | <div class="private"> |
| 378 | <table class="details" border="1" cellpadding="3" |
| 379 | cellspacing="0" width="100%" bgcolor="white"> |
| 380 | <tr><td> |
| 381 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 382 | <tr valign="top"><td> |
| 383 | <h3 class="epydoc"><span class="sig"><span class="sig-name">_revoke</span>(<span class="sig-arg">self</span>, |
| 384 | <span class="sig-arg">http_request</span>)</span> |
| 385 | </h3> |
| 386 | </td><td align="right" valign="top" |
| 387 | ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._revoke">source code</a></span> |
| 388 | </td> |
| 389 | </tr></table> |
| 390 | |
| 391 | <pre class="literalblock"> |
| 392 | Revokes the access_token and deletes the store if available. |
| 393 | |
| 394 | Args: |
| 395 | http_request: callable, a callable that matches the method signature of |
| 396 | httplib2.Http.request, used to make the revoke request. |
| 397 | |
| 398 | </pre> |
| 399 | <dl class="fields"> |
| 400 | <dt>Overrides: |
| 401 | <a href="oauth2client.client.OAuth2Credentials-class.html#_revoke" onclick="show_private();">OAuth2Credentials._revoke</a> |
| 402 | </dt> |
| 403 | </dl> |
| 404 | </td></tr></table> |
| 405 | </div> |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 406 | <br /> |
| 407 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 408 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 409 | bgcolor="#a0c0ff" cellspacing="0"> |
| 410 | <tr valign="middle"> |
| 411 | |
| 412 | <!-- Tree link --> |
| 413 | <th> <a |
| 414 | href="module-tree.html">Trees</a> </th> |
| 415 | |
| 416 | <!-- Index link --> |
| 417 | <th> <a |
| 418 | href="identifier-index.html">Indices</a> </th> |
| 419 | |
| 420 | <!-- Help link --> |
| 421 | <th> <a |
| 422 | href="help.html">Help</a> </th> |
| 423 | |
| 424 | <th class="navbar" width="100%"></th> |
| 425 | </tr> |
| 426 | </table> |
| 427 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 428 | <tr> |
| 429 | <td align="left" class="footer"> |
Joe Gregorio | 41be8e8 | 2013-03-07 10:31:47 -0500 | [diff] [blame] | 430 | Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013 |
Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 431 | </td> |
| 432 | <td align="right" class="footer"> |
| 433 | <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 434 | >http://epydoc.sourceforge.net</a> |
| 435 | </td> |
| 436 | </tr> |
| 437 | </table> |
| 438 | |
| 439 | <script type="text/javascript"> |
| 440 | <!-- |
| 441 | // Private objects are initially displayed (because if |
| 442 | // javascript is turned off then we want them to be |
| 443 | // visible); but by default, we want to hide them. So hide |
| 444 | // them unless we have a cookie that says to show them. |
| 445 | checkCookie(); |
| 446 | // --> |
| 447 | </script> |
| 448 | </body> |
| 449 | </html> |