blob: c4a6a645224b01224cb28b51c89a77e10b5d717e [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>
20&nbsp;<br>
21Returns:<br>
22&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
23&nbsp;<br>
24&nbsp;&nbsp;&nbsp;&nbsp;{<br>
25&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
26&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
27&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050028&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050029&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050030&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050031&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
33&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
39&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050040
Joe Gregoriob9e63ff2011-06-30 12:38:10 -040041<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>
42&nbsp;<br>
43Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050044&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
45&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
46&nbsp;<br>
47{<br>
48&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
49&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050051&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050052&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050053&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050054&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
58&nbsp;&nbsp;&nbsp;&nbsp;},<br>
59&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
61&nbsp;&nbsp;&nbsp;&nbsp;},<br>
62&nbsp;&nbsp;}<br>
63&nbsp;<br>
64&nbsp;<br>
65Returns:<br>
66&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
67&nbsp;<br>
68&nbsp;&nbsp;&nbsp;&nbsp;{<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050072&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050073&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050074&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050075&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
83&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -040084
Joe Gregorio93841702011-03-02 16:12:05 -080085<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 -050086&nbsp;<br>
87Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050088&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
89&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
90&nbsp;<br>
91{<br>
92&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
93&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
94&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050095&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050096&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050097&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050098&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
99&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
100&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
102&nbsp;&nbsp;&nbsp;&nbsp;},<br>
103&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
105&nbsp;&nbsp;&nbsp;&nbsp;},<br>
106&nbsp;&nbsp;}<br>
107&nbsp;<br>
108&nbsp;<br>
109Returns:<br>
110&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
111&nbsp;<br>
112&nbsp;&nbsp;&nbsp;&nbsp;{<br>
113&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#profile",<br>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user":&nbsp;"A&nbsp;String",<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
127&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500128
129<hr>
130Data descriptors defined here:<br>
131<dl><dt><strong>__dict__</strong></dt>
132<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
133</dl>
134<dl><dt><strong>__weakref__</strong></dt>
135<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
136</dl>
137</td></tr></table>
138</body></html>