blob: 57e4963e3fcbd61bd8d18cdbdb0cf1f9bc609b52 [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>
23&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)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050024
Joe Gregorio93841702011-03-02 16:12:05 -080025<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 -050026&nbsp;<br>
27Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050028&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 -080029&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregorio761c4562011-10-28 14:36:24 -040030&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 -050031&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)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050032
Joe Gregorio93841702011-03-02 16:12:05 -080033<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 -050034&nbsp;<br>
35Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050036&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
37&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.<br>
38&nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;Index&nbsp;of&nbsp;the&nbsp;first&nbsp;result&nbsp;to&nbsp;be&nbsp;retrieved.</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050039
Joe Gregoriob9e63ff2011-06-30 12:38:10 -040040<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>
41&nbsp;<br>
42Args:<br>
43&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
44&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregorio761c4562011-10-28 14:36:24 -040045&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 -040046&nbsp;&nbsp;userId:&nbsp;string,&nbsp;A&nbsp;parameter<br>
47&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)</tt></dd></dl>
48
Joe Gregorio93841702011-03-02 16:12:05 -080049<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 -050050&nbsp;<br>
51Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050052&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 -080053&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregorio761c4562011-10-28 14:36:24 -040054&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 -050055&nbsp;&nbsp;userId:&nbsp;string,&nbsp;A&nbsp;parameter<br>
56&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)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050057
58<hr>
59Data descriptors defined here:<br>
60<dl><dt><strong>__dict__</strong></dt>
61<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
62</dl>
63<dl><dt><strong>__weakref__</strong></dt>
64<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
65</dl>
66</td></tr></table>
67</body></html>