blob: 2d01c509e66dbbd9e1c44721bb9f5f191db46f84 [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;specified&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050018&nbsp;<br>
19Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -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>
22&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
24&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050025&nbsp;<br>
26Returns:<br>
27&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
28&nbsp;<br>
29&nbsp;&nbsp;&nbsp;&nbsp;{<br>
30&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#series",<br>
31&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",<br>
32&nbsp;&nbsp;&nbsp;&nbsp;"rules":&nbsp;{<br>
33&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"votes":&nbsp;{<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;{<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
41&nbsp;&nbsp;&nbsp;&nbsp;},<br>
42&nbsp;&nbsp;&nbsp;&nbsp;"unauthVotingAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
43&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
44&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",<br>
45&nbsp;&nbsp;&nbsp;&nbsp;"numTopics":&nbsp;42,<br>
46&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
47&nbsp;&nbsp;&nbsp;&nbsp;"unauthSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<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;},<br>
51&nbsp;&nbsp;&nbsp;&nbsp;"counters":&nbsp;{<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"users":&nbsp;42,<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissions":&nbsp;42,<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissions":&nbsp;42,<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;42,<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
59&nbsp;&nbsp;&nbsp;&nbsp;},<br>
60&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050061
Joe Gregorio93841702011-03-02 16:12:05 -080062<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts&nbsp;a&nbsp;new&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050063&nbsp;<br>
64Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050065&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
66&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
67&nbsp;<br>
68{<br>
69&nbsp;&nbsp;"kind":&nbsp;"moderator#series",<br>
70&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",<br>
71&nbsp;&nbsp;"rules":&nbsp;{<br>
72&nbsp;&nbsp;&nbsp;&nbsp;"votes":&nbsp;{<br>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
74&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
75&nbsp;&nbsp;&nbsp;&nbsp;},<br>
76&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;{<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
79&nbsp;&nbsp;&nbsp;&nbsp;},<br>
80&nbsp;&nbsp;},<br>
81&nbsp;&nbsp;"unauthVotingAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
82&nbsp;&nbsp;"videoSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
83&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",<br>
84&nbsp;&nbsp;"numTopics":&nbsp;42,<br>
85&nbsp;&nbsp;"anonymousSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
86&nbsp;&nbsp;"unauthSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
87&nbsp;&nbsp;"id":&nbsp;{<br>
88&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
89&nbsp;&nbsp;},<br>
90&nbsp;&nbsp;"counters":&nbsp;{<br>
91&nbsp;&nbsp;&nbsp;&nbsp;"users":&nbsp;42,<br>
92&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
93&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissions":&nbsp;42,<br>
94&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
95&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissions":&nbsp;42,<br>
96&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;42,<br>
97&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
98&nbsp;&nbsp;},<br>
99}<br>
100&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400101&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
102&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
103&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
104&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500105&nbsp;<br>
106Returns:<br>
107&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
108&nbsp;<br>
109&nbsp;&nbsp;&nbsp;&nbsp;{<br>
110&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#series",<br>
111&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",<br>
112&nbsp;&nbsp;&nbsp;&nbsp;"rules":&nbsp;{<br>
113&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"votes":&nbsp;{<br>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;{<br>
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
121&nbsp;&nbsp;&nbsp;&nbsp;},<br>
122&nbsp;&nbsp;&nbsp;&nbsp;"unauthVotingAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
123&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
124&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",<br>
125&nbsp;&nbsp;&nbsp;&nbsp;"numTopics":&nbsp;42,<br>
126&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
127&nbsp;&nbsp;&nbsp;&nbsp;"unauthSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
128&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
130&nbsp;&nbsp;&nbsp;&nbsp;},<br>
131&nbsp;&nbsp;&nbsp;&nbsp;"counters":&nbsp;{<br>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"users":&nbsp;42,<br>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissions":&nbsp;42,<br>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissions":&nbsp;42,<br>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;42,<br>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
139&nbsp;&nbsp;&nbsp;&nbsp;},<br>
140&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500141
Joe Gregorio93841702011-03-02 16:12:05 -0800142<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Searches&nbsp;the&nbsp;series&nbsp;and&nbsp;returns&nbsp;the&nbsp;search&nbsp;results.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500143&nbsp;<br>
144Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500145&nbsp;&nbsp;q:&nbsp;string,&nbsp;Search&nbsp;query.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400146&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
147&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
148&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500149&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 -0400150&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500151&nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;Index&nbsp;of&nbsp;the&nbsp;first&nbsp;result&nbsp;to&nbsp;be&nbsp;retrieved.<br>
152&nbsp;<br>
153Returns:<br>
154&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
155&nbsp;<br>
156&nbsp;&nbsp;&nbsp;&nbsp;{<br>
157&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[<br>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#series",<br>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",<br>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rules":&nbsp;{<br>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"votes":&nbsp;{<br>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;{<br>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"unauthVotingAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",<br>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numTopics":&nbsp;42,<br>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"unauthSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"counters":&nbsp;{<br>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"users":&nbsp;42,<br>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissions":&nbsp;42,<br>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissions":&nbsp;42,<br>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;42,<br>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
190&nbsp;&nbsp;&nbsp;&nbsp;],<br>
191&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#seriesList",<br>
192&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500193
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400194<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;specified&nbsp;series.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
195&nbsp;<br>
196Args:<br>
197&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500198&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
199&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
200&nbsp;<br>
201{<br>
202&nbsp;&nbsp;"kind":&nbsp;"moderator#series",<br>
203&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",<br>
204&nbsp;&nbsp;"rules":&nbsp;{<br>
205&nbsp;&nbsp;&nbsp;&nbsp;"votes":&nbsp;{<br>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
208&nbsp;&nbsp;&nbsp;&nbsp;},<br>
209&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;{<br>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
212&nbsp;&nbsp;&nbsp;&nbsp;},<br>
213&nbsp;&nbsp;},<br>
214&nbsp;&nbsp;"unauthVotingAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
215&nbsp;&nbsp;"videoSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
216&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",<br>
217&nbsp;&nbsp;"numTopics":&nbsp;42,<br>
218&nbsp;&nbsp;"anonymousSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
219&nbsp;&nbsp;"unauthSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
220&nbsp;&nbsp;"id":&nbsp;{<br>
221&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
222&nbsp;&nbsp;},<br>
223&nbsp;&nbsp;"counters":&nbsp;{<br>
224&nbsp;&nbsp;&nbsp;&nbsp;"users":&nbsp;42,<br>
225&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
226&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissions":&nbsp;42,<br>
227&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
228&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissions":&nbsp;42,<br>
229&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;42,<br>
230&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
231&nbsp;&nbsp;},<br>
232}<br>
233&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400234&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
235&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
236&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
237&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500238&nbsp;<br>
239Returns:<br>
240&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
241&nbsp;<br>
242&nbsp;&nbsp;&nbsp;&nbsp;{<br>
243&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#series",<br>
244&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",<br>
245&nbsp;&nbsp;&nbsp;&nbsp;"rules":&nbsp;{<br>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"votes":&nbsp;{<br>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;{<br>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
254&nbsp;&nbsp;&nbsp;&nbsp;},<br>
255&nbsp;&nbsp;&nbsp;&nbsp;"unauthVotingAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
256&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
257&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",<br>
258&nbsp;&nbsp;&nbsp;&nbsp;"numTopics":&nbsp;42,<br>
259&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
260&nbsp;&nbsp;&nbsp;&nbsp;"unauthSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
261&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
263&nbsp;&nbsp;&nbsp;&nbsp;},<br>
264&nbsp;&nbsp;&nbsp;&nbsp;"counters":&nbsp;{<br>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"users":&nbsp;42,<br>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
267&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissions":&nbsp;42,<br>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissions":&nbsp;42,<br>
270&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;42,<br>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
272&nbsp;&nbsp;&nbsp;&nbsp;},<br>
273&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400274
Joe Gregorioafc45f22011-02-20 16:11:28 -0500275<dl><dt><a name="Resource-responses"><strong><a href="moderator.v1.series.responses.html">responses</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
276
277<dl><dt><a name="Resource-submissions"><strong><a href="moderator.v1.series.submissions.html">submissions</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
278
Joe Gregorio93841702011-03-02 16:12:05 -0800279<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;specified&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500280&nbsp;<br>
281Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500282&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500283&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
284&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
285&nbsp;<br>
286{<br>
287&nbsp;&nbsp;"kind":&nbsp;"moderator#series",<br>
288&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",<br>
289&nbsp;&nbsp;"rules":&nbsp;{<br>
290&nbsp;&nbsp;&nbsp;&nbsp;"votes":&nbsp;{<br>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
292&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
293&nbsp;&nbsp;&nbsp;&nbsp;},<br>
294&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;{<br>
295&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
296&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
297&nbsp;&nbsp;&nbsp;&nbsp;},<br>
298&nbsp;&nbsp;},<br>
299&nbsp;&nbsp;"unauthVotingAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
300&nbsp;&nbsp;"videoSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
301&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",<br>
302&nbsp;&nbsp;"numTopics":&nbsp;42,<br>
303&nbsp;&nbsp;"anonymousSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
304&nbsp;&nbsp;"unauthSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
305&nbsp;&nbsp;"id":&nbsp;{<br>
306&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
307&nbsp;&nbsp;},<br>
308&nbsp;&nbsp;"counters":&nbsp;{<br>
309&nbsp;&nbsp;&nbsp;&nbsp;"users":&nbsp;42,<br>
310&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
311&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissions":&nbsp;42,<br>
312&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
313&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissions":&nbsp;42,<br>
314&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;42,<br>
315&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
316&nbsp;&nbsp;},<br>
317}<br>
318&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400319&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
320&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
321&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
322&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500323&nbsp;<br>
324Returns:<br>
325&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
326&nbsp;<br>
327&nbsp;&nbsp;&nbsp;&nbsp;{<br>
328&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#series",<br>
329&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",<br>
330&nbsp;&nbsp;&nbsp;&nbsp;"rules":&nbsp;{<br>
331&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"votes":&nbsp;{<br>
332&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
334&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;{<br>
336&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"close":&nbsp;"A&nbsp;String",<br>
337&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"open":&nbsp;"A&nbsp;String",<br>
338&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
339&nbsp;&nbsp;&nbsp;&nbsp;},<br>
340&nbsp;&nbsp;&nbsp;&nbsp;"unauthVotingAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
341&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
342&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",<br>
343&nbsp;&nbsp;&nbsp;&nbsp;"numTopics":&nbsp;42,<br>
344&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
345&nbsp;&nbsp;&nbsp;&nbsp;"unauthSubmissionAllowed":&nbsp;True&nbsp;or&nbsp;False,<br>
346&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
347&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
348&nbsp;&nbsp;&nbsp;&nbsp;},<br>
349&nbsp;&nbsp;&nbsp;&nbsp;"counters":&nbsp;{<br>
350&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"users":&nbsp;42,<br>
351&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
352&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoSubmissions":&nbsp;42,<br>
353&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
354&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"anonymousSubmissions":&nbsp;42,<br>
355&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissions":&nbsp;42,<br>
356&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
357&nbsp;&nbsp;&nbsp;&nbsp;},<br>
358&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500359
360<hr>
361Data descriptors defined here:<br>
362<dl><dt><strong>__dict__</strong></dt>
363<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
364</dl>
365<dl><dt><strong>__weakref__</strong></dt>
366<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
367</dl>
368</td></tr></table>
369</body></html>