blob: 696d0d3ccd1b6f8629f5f24223e778248544ed96 [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-get"><strong>get</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>
Joe Gregorio66212032012-06-14 09:10:14 -040020&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio945cca12012-02-21 11:59:48 -050024&nbsp;<br>
25Returns:<br>
26&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
27&nbsp;<br>
28&nbsp;&nbsp;&nbsp;&nbsp;{<br>
Joe Gregorio66212032012-06-14 09:10:14 -040029&nbsp;&nbsp;&nbsp;&nbsp;"family_name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;user's&nbsp;last&nbsp;name.<br>
30&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;user's&nbsp;full&nbsp;name.<br>
31&nbsp;&nbsp;&nbsp;&nbsp;"picture":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;user's&nbsp;picture&nbsp;image.<br>
32&nbsp;&nbsp;&nbsp;&nbsp;"locale":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;user's&nbsp;default&nbsp;locale.<br>
33&nbsp;&nbsp;&nbsp;&nbsp;"gender":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;user's&nbsp;gender.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;"email":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;user's&nbsp;email&nbsp;address.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;"birthday":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;user's&nbsp;birthday.&nbsp;The&nbsp;year&nbsp;is&nbsp;not&nbsp;present.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;profile&nbsp;page.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;"given_name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;user's&nbsp;first&nbsp;name.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;"timezone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;user's&nbsp;default&nbsp;timezone.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;focus&nbsp;obfuscated&nbsp;gaia&nbsp;id&nbsp;of&nbsp;the&nbsp;user.<br>
40&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.<br>
Joe Gregorio945cca12012-02-21 11:59:48 -050041&nbsp;&nbsp;}</tt></dd></dl>
42
43<dl><dt><a name="Resource-v2"><strong><a href="oauth2.v2.userinfo.v2.html">v2</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
44
45<hr>
46Data descriptors defined here:<br>
47<dl><dt><strong>__dict__</strong></dt>
48<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
49</dl>
50<dl><dt><strong>__weakref__</strong></dt>
51<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
52</dl>
53</td></tr></table>
54</body></html>