blob: ad1b463aeea6b49f1c1c62efde4ea26bb930d3f7 [file] [log] [blame]
Joe Gregorioafc45f22011-02-20 16:11:28 -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
Joe Gregorio93841702011-03-02 16:12:05 -080017<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;the&nbsp;profile&nbsp;information&nbsp;for&nbsp;the&nbsp;authenticated&nbsp;user.<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050018&nbsp;<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050019Args:<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 Gregoriob417caf2011-12-08 12:04:24 -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>
29&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
30&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050032&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050033&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050034&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050035&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
43&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050044
Joe Gregoriob9e63ff2011-06-30 12:38:10 -040045<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;profile&nbsp;information&nbsp;for&nbsp;the&nbsp;authenticated&nbsp;user.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
46&nbsp;<br>
47Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050048&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
49&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
50&nbsp;<br>
51{<br>
52&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
53&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050055&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050056&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050057&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050058&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
62&nbsp;&nbsp;&nbsp;&nbsp;},<br>
63&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
65&nbsp;&nbsp;&nbsp;&nbsp;},<br>
66&nbsp;&nbsp;}<br>
67&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -040068&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
69&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
70&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
71&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050072&nbsp;<br>
73Returns:<br>
74&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
75&nbsp;<br>
76&nbsp;&nbsp;&nbsp;&nbsp;{<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050080&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050081&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050082&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050083&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
89&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
90&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
91&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -040092
Joe Gregorio93841702011-03-02 16:12:05 -080093<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;profile&nbsp;information&nbsp;for&nbsp;the&nbsp;authenticated&nbsp;user.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050094&nbsp;<br>
95Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050096&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
97&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
98&nbsp;<br>
99{<br>
100&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
101&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500105&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
108&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
109&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
110&nbsp;&nbsp;&nbsp;&nbsp;},<br>
111&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
113&nbsp;&nbsp;&nbsp;&nbsp;},<br>
114&nbsp;&nbsp;}<br>
115&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400116&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
117&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
118&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
119&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500120&nbsp;<br>
121Returns:<br>
122&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
123&nbsp;<br>
124&nbsp;&nbsp;&nbsp;&nbsp;{<br>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
139&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500140
141<hr>
142Data descriptors defined here:<br>
143<dl><dt><strong>__dict__</strong></dt>
144<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
145</dl>
146<dl><dt><strong>__weakref__</strong></dt>
147<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
148</dl>
149</td></tr></table>
150</body></html>