blob: dd6e7ad8c75f53771dc680f46a8334794557ea64 [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;votes&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user&nbsp;for&nbsp;the&nbsp;specified&nbsp;submission&nbsp;within&nbsp;the&nbsp;specified&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050018&nbsp;<br>
19Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050020&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -040021&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -040022&nbsp;&nbsp;unauthToken:&nbsp;string,&nbsp;User&nbsp;identifier&nbsp;for&nbsp;unauthenticated&nbsp;usage&nbsp;mode<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050023&nbsp;&nbsp;userId:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050024&nbsp;&nbsp;submissionId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Submission&nbsp;within&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -040025&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
26&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
27&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050028&nbsp;<br>
29Returns:<br>
30&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
31&nbsp;<br>
32&nbsp;&nbsp;&nbsp;&nbsp;{<br>
33&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
40&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050041
Joe Gregorio93841702011-03-02 16:12:05 -080042<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts&nbsp;a&nbsp;new&nbsp;vote&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user&nbsp;for&nbsp;the&nbsp;specified&nbsp;submission&nbsp;within&nbsp;the&nbsp;specified&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050043&nbsp;<br>
44Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050045&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio93841702011-03-02 16:12:05 -080046&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050047&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
48&nbsp;<br>
49{<br>
50&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
51&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
52&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
55&nbsp;&nbsp;&nbsp;&nbsp;},<br>
56&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
57&nbsp;&nbsp;}<br>
58&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -040059&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -040060&nbsp;&nbsp;unauthToken:&nbsp;string,&nbsp;User&nbsp;identifier&nbsp;for&nbsp;unauthenticated&nbsp;usage&nbsp;mode<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050061&nbsp;&nbsp;submissionId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Submission&nbsp;within&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -040062&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
63&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
64&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050065&nbsp;<br>
66Returns:<br>
67&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
68&nbsp;<br>
69&nbsp;&nbsp;&nbsp;&nbsp;{<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
74&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
77&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050078
Joe Gregorio93841702011-03-02 16:12:05 -080079<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists&nbsp;the&nbsp;votes&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user&nbsp;for&nbsp;the&nbsp;given&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050080&nbsp;<br>
81Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050082&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -040083&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
84&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
85&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050086&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.<br>
Joe Gregorio66212032012-06-14 09:10:14 -040087&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050088&nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;Index&nbsp;of&nbsp;the&nbsp;first&nbsp;result&nbsp;to&nbsp;be&nbsp;retrieved.<br>
89&nbsp;<br>
90Returns:<br>
91&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
92&nbsp;<br>
93&nbsp;&nbsp;&nbsp;&nbsp;{<br>
94&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[<br>
95&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
96&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
97&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
98&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
99&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
100&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
104&nbsp;&nbsp;&nbsp;&nbsp;],<br>
105&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#voteList",<br>
106&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500107
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400108<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;votes&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user&nbsp;for&nbsp;the&nbsp;specified&nbsp;submission&nbsp;within&nbsp;the&nbsp;specified&nbsp;series.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
109&nbsp;<br>
110Args:<br>
111&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
112&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500113&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
114&nbsp;<br>
115{<br>
116&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
117&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
118&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
121&nbsp;&nbsp;&nbsp;&nbsp;},<br>
122&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
123&nbsp;&nbsp;}<br>
124&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400125&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -0400126&nbsp;&nbsp;unauthToken:&nbsp;string,&nbsp;User&nbsp;identifier&nbsp;for&nbsp;unauthenticated&nbsp;usage&nbsp;mode<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400127&nbsp;&nbsp;userId:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500128&nbsp;&nbsp;submissionId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Submission&nbsp;within&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400129&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
130&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
131&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500132&nbsp;<br>
133Returns:<br>
134&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
135&nbsp;<br>
136&nbsp;&nbsp;&nbsp;&nbsp;{<br>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
144&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400145
Joe Gregorio93841702011-03-02 16:12:05 -0800146<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;votes&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user&nbsp;for&nbsp;the&nbsp;specified&nbsp;submission&nbsp;within&nbsp;the&nbsp;specified&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500147&nbsp;<br>
148Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500149&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio93841702011-03-02 16:12:05 -0800150&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500151&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
152&nbsp;<br>
153{<br>
154&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
155&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
156&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
159&nbsp;&nbsp;&nbsp;&nbsp;},<br>
160&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
161&nbsp;&nbsp;}<br>
162&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400163&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -0400164&nbsp;&nbsp;unauthToken:&nbsp;string,&nbsp;User&nbsp;identifier&nbsp;for&nbsp;unauthenticated&nbsp;usage&nbsp;mode<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500165&nbsp;&nbsp;userId:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500166&nbsp;&nbsp;submissionId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Submission&nbsp;within&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400167&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
168&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
169&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500170&nbsp;<br>
171Returns:<br>
172&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
173&nbsp;<br>
174&nbsp;&nbsp;&nbsp;&nbsp;{<br>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
182&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500183
184<hr>
185Data descriptors defined here:<br>
186<dl><dt><strong>__dict__</strong></dt>
187<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
188</dl>
189<dl><dt><strong>__weakref__</strong></dt>
190<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
191</dl>
192</td></tr></table>
193</body></html>