blob: 7c06e507340f97408f5a37240ca2ae72ad72942a [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-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Searches&nbsp;the&nbsp;submissions&nbsp;for&nbsp;the&nbsp;specified&nbsp;series&nbsp;and&nbsp;returns&nbsp;the&nbsp;search&nbsp;results.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050018&nbsp;<br>
19Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050020&nbsp;&nbsp;lang:&nbsp;string,&nbsp;The&nbsp;language&nbsp;code&nbsp;for&nbsp;the&nbsp;language&nbsp;the&nbsp;client&nbsp;prefers&nbsp;resuls&nbsp;in.<br>
21&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 -040022&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -040024&nbsp;&nbsp;includeVotes:&nbsp;boolean,&nbsp;Specifies&nbsp;whether&nbsp;to&nbsp;include&nbsp;the&nbsp;current&nbsp;user's&nbsp;vote<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050025&nbsp;&nbsp;author:&nbsp;string,&nbsp;Restricts&nbsp;the&nbsp;results&nbsp;to&nbsp;submissions&nbsp;by&nbsp;a&nbsp;specific&nbsp;author.<br>
26&nbsp;&nbsp;sort:&nbsp;string,&nbsp;Sort&nbsp;order.<br>
Joe Gregorio66212032012-06-14 09:10:14 -040027&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050028&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.<br>
29&nbsp;&nbsp;q:&nbsp;string,&nbsp;Search&nbsp;query.<br>
Joe Gregorio66212032012-06-14 09:10:14 -040030&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050031&nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;Index&nbsp;of&nbsp;the&nbsp;first&nbsp;result&nbsp;to&nbsp;be&nbsp;retrieved.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050032&nbsp;&nbsp;hasAttachedVideo:&nbsp;boolean,&nbsp;Specifies&nbsp;whether&nbsp;to&nbsp;restrict&nbsp;to&nbsp;submissions&nbsp;that&nbsp;have&nbsp;videos&nbsp;attached.<br>
33&nbsp;<br>
34Returns:<br>
35&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
36&nbsp;<br>
37&nbsp;&nbsp;&nbsp;&nbsp;{<br>
38&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#submission",<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribution":&nbsp;{<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatarUrl":&nbsp;"A&nbsp;String",<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"text":&nbsp;"A&nbsp;String",<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"topics":&nbsp;[<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"topicId":&nbsp;"A&nbsp;String",<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;"A&nbsp;String",<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"translations":&nbsp;[<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"lang":&nbsp;"A&nbsp;String",<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"text":&nbsp;"A&nbsp;String",<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parentSubmissionId":&nbsp;{<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;{<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vote":&nbsp;"A&nbsp;String",<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&nbsp;"A&nbsp;String",<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attachmentUrl":&nbsp;"A&nbsp;String",<br>
72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"geo":&nbsp;{<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050073&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050074&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050075&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&nbsp;3.14,<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050076&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"seriesId":&nbsp;"A&nbsp;String",<br>
79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"submissionId":&nbsp;"A&nbsp;String",<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"counters":&nbsp;{<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"noneVotes":&nbsp;42,<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"minusVotes":&nbsp;42,<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"plusVotes":&nbsp;42,<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
87&nbsp;&nbsp;&nbsp;&nbsp;],<br>
88&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"moderator#submissionList",<br>
89&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050090
91<hr>
92Data descriptors defined here:<br>
93<dl><dt><strong>__dict__</strong></dt>
94<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
95</dl>
96<dl><dt><strong>__weakref__</strong></dt>
97<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
98</dl>
99</td></tr></table>
100</body></html>