| Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| Joe Gregorio | df70dfc | 2012-04-23 08:31:37 -0400 | [diff] [blame] | 17 | <dl><dt><a name="Resource-issueTokenGet"><strong>issueTokenGet</strong></a> = method(self, **kwargs)</dt><dd><tt>A description of how to use this function<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | origin: string, A parameter<br> |
| 21 | force: boolean, A parameter<br> |
| 22 | client_id: string, A parameter (required)<br> |
| 23 | alg: string, A parameter<br> |
| 24 | app_id: string, A parameter<br> |
| 25 | android_device_id: string, A parameter<br> |
| 26 | audience: string, A parameter<br> |
| 27 | hl: string, A parameter<br> |
| 28 | scope: string, A parameter (required)<br> |
| 29 | response_type: string, A parameter (required)<br> |
| 30 | <br> |
| 31 | Returns:<br> |
| 32 | An object of the form<br> |
| 33 | <br> |
| 34 | {<br> |
| 35 | "consent": {<br> |
| 36 | "scopes": [<br> |
| 37 | {<br> |
| 38 | "description": "A String",<br> |
| 39 | "detail": "A String",<br> |
| 40 | },<br> |
| 41 | ],<br> |
| 42 | "oauthClient": {<br> |
| 43 | "iconUri": "A String",<br> |
| 44 | "developerEmail": "A String",<br> |
| 45 | "name": "A String",<br> |
| 46 | },<br> |
| 47 | },<br> |
| 48 | "token": "A String",<br> |
| 49 | "code": "A String",<br> |
| 50 | "issueAdvice": "A String",<br> |
| 51 | "idToken": "A String",<br> |
| 52 | }</tt></dd></dl> |
| 53 | |
| Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 54 | <dl><dt><a name="Resource-tokeninfo"><strong>tokeninfo</strong></a> = method(self, **kwargs)</dt><dd><tt>A description of how to use this function<br> |
| 55 | <br> |
| 56 | Args:<br> |
| 57 | access_token: string, A parameter<br> |
| 58 | id_token: string, A parameter<br> |
| 59 | <br> |
| 60 | Returns:<br> |
| 61 | An object of the form<br> |
| 62 | <br> |
| 63 | {<br> |
| 64 | "issued_to": "A String", # To whom was the token issued to. In general the same as audience.<br> |
| 65 | "user_id": "A String", # The Gaia obfuscated user id.<br> |
| 66 | "expires_in": 42, # The expiry time of the token, as number of seconds left until expiry.<br> |
| 67 | "access_type": "A String", # The access type granted with this toke. It can be offline or online.<br> |
| 68 | "audience": "A String", # Who is the intended audience for this token. In general the same as issued_to.<br> |
| 69 | "scope": "A String", # The space separated list of scopes granted to this token.<br> |
| 70 | "email": "A String", # The email address of the user. Present only if the email scope is present in the request.<br> |
| 71 | "verified_email": True or False, # Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.<br> |
| 72 | }</tt></dd></dl> |
| 73 | |
| 74 | <dl><dt><a name="Resource-userinfo"><strong><a href="oauth2.v2.userinfo.html">userinfo</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| 75 | |
| 76 | <hr> |
| 77 | Data descriptors defined here:<br> |
| 78 | <dl><dt><strong>__dict__</strong></dt> |
| 79 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 80 | </dl> |
| 81 | <dl><dt><strong>__weakref__</strong></dt> |
| 82 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 83 | </dl> |
| 84 | </td></tr></table> |
| 85 | </body></html> |