blob: 8a9ce0557ee01e218a6ad73f667c87a61f601d06 [file] [log] [blame]
Joe Gregorio945cca12012-02-21 11:59:48 -05001
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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-tokeninfo"><strong>tokeninfo</strong></a> = method(self, **kwargs)</dt><dd><tt>A&nbsp;description&nbsp;of&nbsp;how&nbsp;to&nbsp;use&nbsp;this&nbsp;function<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;access_token:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;id_token:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;<br>
23Returns:<br>
24&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
25&nbsp;<br>
26&nbsp;&nbsp;&nbsp;&nbsp;{<br>
27&nbsp;&nbsp;&nbsp;&nbsp;"issued_to":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;To&nbsp;whom&nbsp;was&nbsp;the&nbsp;token&nbsp;issued&nbsp;to.&nbsp;In&nbsp;general&nbsp;the&nbsp;same&nbsp;as&nbsp;audience.<br>
28&nbsp;&nbsp;&nbsp;&nbsp;"user_id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;Gaia&nbsp;obfuscated&nbsp;user&nbsp;id.<br>
29&nbsp;&nbsp;&nbsp;&nbsp;"expires_in":&nbsp;42,&nbsp;#&nbsp;The&nbsp;expiry&nbsp;time&nbsp;of&nbsp;the&nbsp;token,&nbsp;as&nbsp;number&nbsp;of&nbsp;seconds&nbsp;left&nbsp;until&nbsp;expiry.<br>
30&nbsp;&nbsp;&nbsp;&nbsp;"access_type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;access&nbsp;type&nbsp;granted&nbsp;with&nbsp;this&nbsp;toke.&nbsp;It&nbsp;can&nbsp;be&nbsp;offline&nbsp;or&nbsp;online.<br>
31&nbsp;&nbsp;&nbsp;&nbsp;"audience":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Who&nbsp;is&nbsp;the&nbsp;intended&nbsp;audience&nbsp;for&nbsp;this&nbsp;token.&nbsp;In&nbsp;general&nbsp;the&nbsp;same&nbsp;as&nbsp;issued_to.<br>
32&nbsp;&nbsp;&nbsp;&nbsp;"scope":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;space&nbsp;separated&nbsp;list&nbsp;of&nbsp;scopes&nbsp;granted&nbsp;to&nbsp;this&nbsp;token.<br>
33&nbsp;&nbsp;&nbsp;&nbsp;"email":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;email&nbsp;address&nbsp;of&nbsp;the&nbsp;user.&nbsp;Present&nbsp;only&nbsp;if&nbsp;the&nbsp;email&nbsp;scope&nbsp;is&nbsp;present&nbsp;in&nbsp;the&nbsp;request.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;"verified_email":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Boolean&nbsp;flag&nbsp;which&nbsp;is&nbsp;true&nbsp;if&nbsp;the&nbsp;email&nbsp;address&nbsp;is&nbsp;verified.&nbsp;Present&nbsp;only&nbsp;if&nbsp;the&nbsp;email&nbsp;scope&nbsp;is&nbsp;present&nbsp;in&nbsp;the&nbsp;request.<br>
35&nbsp;&nbsp;}</tt></dd></dl>
36
37<dl><dt><a name="Resource-userinfo"><strong><a href="oauth2.v2.userinfo.html">userinfo</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
38
39<hr>
40Data descriptors defined here:<br>
41<dl><dt><strong>__dict__</strong></dt>
42<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
43</dl>
44<dl><dt><strong>__weakref__</strong></dt>
45<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
46</dl>
47</td></tr></table>
48</body></html>