blob: f78626be52a6f784926d490141e7da685837b5c1 [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;topic&nbsp;from&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>
21&nbsp;&nbsp;topicId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Topic&nbsp;within&nbsp;the&nbsp;Series.&nbsp;(required)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050022
Joe Gregorio93841702011-03-02 16:12:05 -080023<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts&nbsp;a&nbsp;new&nbsp;topic&nbsp;into&nbsp;the&nbsp;specified&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050024&nbsp;<br>
25Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050026&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 -080027&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050028
Joe Gregorio93841702011-03-02 16:12:05 -080029<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Searches&nbsp;the&nbsp;topics&nbsp;within&nbsp;the&nbsp;specified&nbsp;series&nbsp;and&nbsp;returns&nbsp;the&nbsp;search&nbsp;results.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050030&nbsp;<br>
31Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050032&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
33&nbsp;&nbsp;q:&nbsp;string,&nbsp;Search&nbsp;query.<br>
34&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.<br>
35&nbsp;&nbsp;mode:&nbsp;string,&nbsp;A&nbsp;parameter<br>
36&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 -050037
38<dl><dt><a name="Resource-submissions"><strong><a href="moderator.v1.topics.submissions.html">submissions</a></strong></a> = methodResource(self)</dt><dd><tt>A&nbsp;collection&nbsp;resource.</tt></dd></dl>
39
Joe Gregorio93841702011-03-02 16:12:05 -080040<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;specified&nbsp;topic&nbsp;within&nbsp;the&nbsp;specified&nbsp;series.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -050041&nbsp;<br>
42Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050043&nbsp;&nbsp;seriesId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Series.&nbsp;(required)<br>
44&nbsp;&nbsp;topicId:&nbsp;integer,&nbsp;The&nbsp;decimal&nbsp;ID&nbsp;of&nbsp;the&nbsp;Topic&nbsp;within&nbsp;the&nbsp;Series.&nbsp;(required)<br>
Joe Gregorio93841702011-03-02 16:12:05 -080045&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050046
47<hr>
48Data descriptors defined here:<br>
49<dl><dt><strong>__dict__</strong></dt>
50<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
51</dl>
52<dl><dt><strong>__weakref__</strong></dt>
53<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
54</dl>
55</td></tr></table>
56</body></html>