blob: 717293a9fae51afc606af7f1176522d5566f236c [file] [log] [blame]
Joe Gregorio761c4562011-10-28 14:36:24 -04001
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
17<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes&nbsp;an&nbsp;existing&nbsp;comment.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;commentId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment&nbsp;to&nbsp;remove.&nbsp;(required)</tt></dd></dl>
21
22<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;an&nbsp;existing&nbsp;comment.<br>
23&nbsp;<br>
24Args:<br>
25&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Specifies&nbsp;the&nbsp;interface&nbsp;language&nbsp;(host&nbsp;language)&nbsp;of&nbsp;your&nbsp;user&nbsp;interface.<br>
26&nbsp;&nbsp;commentId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment&nbsp;to&nbsp;get.&nbsp;(required)</tt></dd></dl>
27
28<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts&nbsp;a&nbsp;new&nbsp;comment&nbsp;to&nbsp;an&nbsp;activity.<br>
29&nbsp;<br>
30Args:<br>
31&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
32&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;contain&nbsp;the&nbsp;new&nbsp;comment.&nbsp;(required)</tt></dd></dl>
33
34<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;comments,&nbsp;possibly&nbsp;filtered.<br>
35&nbsp;<br>
36Args:<br>
37&nbsp;&nbsp;orderBy:&nbsp;string,&nbsp;Sort&nbsp;search&nbsp;results.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ascending&nbsp;-&nbsp;Use&nbsp;ascending&nbsp;sort&nbsp;order.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;descending&nbsp;-&nbsp;Use&nbsp;descending&nbsp;sort&nbsp;order.<br>
41&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
42&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;activities&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response.<br>
43&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;containing&nbsp;the&nbsp;comments.&nbsp;(required)<br>
44&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Specifies&nbsp;the&nbsp;interface&nbsp;language&nbsp;(host&nbsp;language)&nbsp;of&nbsp;your&nbsp;user&nbsp;interface.</tt></dd></dl>
45
46<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
47&nbsp;<br>
48Args:<br>
49&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
50&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
51&nbsp;<br>
52Returns:<br>
53&nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
54&nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>
55
56<hr>
57Data descriptors defined here:<br>
58<dl><dt><strong>__dict__</strong></dt>
59<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
60</dl>
61<dl><dt><strong>__weakref__</strong></dt>
62<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
63</dl>
64</td></tr></table>
65</body></html>