blob: 0827d746da8278259321cc500e310040fcd03f6d [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 Gregorio761c4562011-10-28 14:36:24 -040021&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 -050022&nbsp;&nbsp;userId:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050023&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>
24&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;"vote":&nbsp;"A&nbsp;String",<br>
30&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
33&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
36&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050037
Joe Gregorio93841702011-03-02 16:12:05 -080038<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 -050039&nbsp;<br>
40Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050041&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 -080042&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050043&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
44&nbsp;<br>
45{<br>
46&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
47&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
48&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
51&nbsp;&nbsp;&nbsp;&nbsp;},<br>
52&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
53&nbsp;&nbsp;}<br>
54&nbsp;<br>
Joe Gregorio761c4562011-10-28 14:36:24 -040055&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 -050056&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>
57&nbsp;<br>
58Returns:<br>
59&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
60&nbsp;<br>
61&nbsp;&nbsp;&nbsp;&nbsp;{<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
69&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050070
Joe Gregorio93841702011-03-02 16:12:05 -080071<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 -050072&nbsp;<br>
73Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050074&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
75&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050076&nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;Index&nbsp;of&nbsp;the&nbsp;first&nbsp;result&nbsp;to&nbsp;be&nbsp;retrieved.<br>
77&nbsp;<br>
78Returns:<br>
79&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
80&nbsp;<br>
81&nbsp;&nbsp;&nbsp;&nbsp;{<br>
82&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
89&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
90&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
91&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
92&nbsp;&nbsp;&nbsp;&nbsp;],<br>
93&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#voteList",<br>
94&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050095
Joe Gregoriob9e63ff2011-06-30 12:38:10 -040096<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>
97&nbsp;<br>
98Args:<br>
99&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
100&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500101&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
102&nbsp;<br>
103{<br>
104&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
105&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
106&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
108&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
109&nbsp;&nbsp;&nbsp;&nbsp;},<br>
110&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
111&nbsp;&nbsp;}<br>
112&nbsp;<br>
Joe Gregorio761c4562011-10-28 14:36:24 -0400113&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 -0400114&nbsp;&nbsp;userId:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500115&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>
116&nbsp;<br>
117Returns:<br>
118&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
119&nbsp;<br>
120&nbsp;&nbsp;&nbsp;&nbsp;{<br>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
128&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400129
Joe Gregorio93841702011-03-02 16:12:05 -0800130<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 -0500131&nbsp;<br>
132Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500133&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 -0800134&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500135&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
136&nbsp;<br>
137{<br>
138&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
139&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
140&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
143&nbsp;&nbsp;&nbsp;&nbsp;},<br>
144&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
145&nbsp;&nbsp;}<br>
146&nbsp;<br>
Joe Gregorio761c4562011-10-28 14:36:24 -0400147&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 -0500148&nbsp;&nbsp;userId:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500149&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>
150&nbsp;<br>
151Returns:<br>
152&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
153&nbsp;<br>
154&nbsp;&nbsp;&nbsp;&nbsp;{<br>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#vote",<br>
162&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500163
164<hr>
165Data descriptors defined here:<br>
166<dl><dt><strong>__dict__</strong></dt>
167<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
168</dl>
169<dl><dt><strong>__weakref__</strong></dt>
170<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
171</dl>
172</td></tr></table>
173</body></html>