Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02503857cef62a9180632b798eacd30ae049f3c3 / . / docs / dyn / tasks.v1.tasks.html
blob: 4ff19128c11761ab79654719c03eda0a8c3599e4 [file] [log] [blame]
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]1
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-clear"><strong>clear</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears&nbsp;all&nbsp;completed&nbsp;tasks&nbsp;from&nbsp;the&nbsp;specified&nbsp;task&nbsp;list.&nbsp;The&nbsp;affected&nbsp;tasks&nbsp;will&nbsp;be&nbsp;marked&nbsp;as&nbsp;'hidden'&nbsp;and&nbsp;no&nbsp;longer&nbsp;be&nbsp;returned&nbsp;by&nbsp;default&nbsp;when&nbsp;retrieving&nbsp;all&nbsp;tasks&nbsp;for&nbsp;a&nbsp;task&nbsp;list.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
21&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)</tt></dd></dl>
22
23<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes&nbsp;the&nbsp;specified&nbsp;task&nbsp;from&nbsp;the&nbsp;task&nbsp;list.<br>
24&nbsp;<br>
25Args:<br>
26&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
27&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)</tt></dd></dl>
28
29<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;the&nbsp;specified&nbsp;task.<br>
30&nbsp;<br>
31Args:<br>
32&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
33&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)</tt></dd></dl>
34
35<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates&nbsp;a&nbsp;new&nbsp;task&nbsp;on&nbsp;the&nbsp;specified&nbsp;task&nbsp;list.<br>
36&nbsp;<br>
37Args:<br>
38&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
39&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
40&nbsp;&nbsp;parent:&nbsp;string,&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;task&nbsp;is&nbsp;created&nbsp;at&nbsp;the&nbsp;top&nbsp;level,&nbsp;this&nbsp;parameter&nbsp;is&nbsp;omitted.&nbsp;Optional.<br>
41&nbsp;&nbsp;previous:&nbsp;string,&nbsp;Previous&nbsp;sibling&nbsp;task&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;task&nbsp;is&nbsp;created&nbsp;at&nbsp;the&nbsp;first&nbsp;position&nbsp;among&nbsp;its&nbsp;siblings,&nbsp;this&nbsp;parameter&nbsp;is&nbsp;omitted.&nbsp;Optional.</tt></dd></dl>
42
43<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;all&nbsp;tasks&nbsp;in&nbsp;the&nbsp;specified&nbsp;task&nbsp;list.<br>
44&nbsp;<br>
45Args:<br>
46&nbsp;&nbsp;dueMax:&nbsp;string,&nbsp;Upper&nbsp;bound&nbsp;for&nbsp;a&nbsp;task's&nbsp;due&nbsp;date&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp)&nbsp;to&nbsp;filter&nbsp;by.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;not&nbsp;to&nbsp;filter&nbsp;by&nbsp;due&nbsp;date.<br>
47&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
48&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;Token&nbsp;specifying&nbsp;the&nbsp;result&nbsp;page&nbsp;to&nbsp;return.&nbsp;Optional.<br>
49&nbsp;&nbsp;updatedMin:&nbsp;string,&nbsp;Lower&nbsp;bound&nbsp;for&nbsp;a&nbsp;task's&nbsp;last&nbsp;modification&nbsp;time&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp)&nbsp;to&nbsp;filter&nbsp;by.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;not&nbsp;to&nbsp;filter&nbsp;by&nbsp;last&nbsp;modification&nbsp;time.<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame^]50&nbsp;&nbsp;maxResults:&nbsp;string,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;task&nbsp;lists&nbsp;returned&nbsp;on&nbsp;one&nbsp;page.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;100.<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]51&nbsp;&nbsp;completedMin:&nbsp;string,&nbsp;Lower&nbsp;bound&nbsp;for&nbsp;a&nbsp;task's&nbsp;completion&nbsp;date&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp)&nbsp;to&nbsp;filter&nbsp;by.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;not&nbsp;to&nbsp;filter&nbsp;by&nbsp;completion&nbsp;date.<br>
52&nbsp;&nbsp;showDeleted:&nbsp;boolean,&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;deleted&nbsp;tasks&nbsp;are&nbsp;returned&nbsp;in&nbsp;the&nbsp;result.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.<br>
53&nbsp;&nbsp;completedMax:&nbsp;string,&nbsp;Upper&nbsp;bound&nbsp;for&nbsp;a&nbsp;task's&nbsp;completion&nbsp;date&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp)&nbsp;to&nbsp;filter&nbsp;by.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;not&nbsp;to&nbsp;filter&nbsp;by&nbsp;completion&nbsp;date.<br>
54&nbsp;&nbsp;showHidden:&nbsp;boolean,&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;hidden&nbsp;tasks&nbsp;are&nbsp;returned&nbsp;in&nbsp;the&nbsp;result.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.<br>
55&nbsp;&nbsp;showCompleted:&nbsp;boolean,&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;completed&nbsp;tasks&nbsp;are&nbsp;returned&nbsp;in&nbsp;the&nbsp;result.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;True.<br>
56&nbsp;&nbsp;dueMin:&nbsp;string,&nbsp;Lower&nbsp;bound&nbsp;for&nbsp;a&nbsp;task's&nbsp;due&nbsp;date&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp)&nbsp;to&nbsp;filter&nbsp;by.&nbsp;Optional.&nbsp;The&nbsp;default&nbsp;is&nbsp;not&nbsp;to&nbsp;filter&nbsp;by&nbsp;due&nbsp;date.</tt></dd></dl>
57
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame^]58<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>
59&nbsp;<br>
60Args:<br>
61&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
62&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
63&nbsp;<br>
64Returns:<br>
65&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>
66&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>
67
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]68<dl><dt><a name="Resource-move"><strong>move</strong></a> = method(self, **kwargs)</dt><dd><tt>Moves&nbsp;the&nbsp;specified&nbsp;task&nbsp;to&nbsp;another&nbsp;position&nbsp;in&nbsp;the&nbsp;task&nbsp;list.&nbsp;This&nbsp;can&nbsp;include&nbsp;putting&nbsp;it&nbsp;as&nbsp;a&nbsp;child&nbsp;task&nbsp;under&nbsp;a&nbsp;new&nbsp;parent&nbsp;and/or&nbsp;move&nbsp;it&nbsp;to&nbsp;a&nbsp;different&nbsp;position&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks.<br>
69&nbsp;<br>
70Args:<br>
71&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
72&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
73&nbsp;&nbsp;parent:&nbsp;string,&nbsp;New&nbsp;parent&nbsp;task&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;task&nbsp;is&nbsp;moved&nbsp;to&nbsp;the&nbsp;top&nbsp;level,&nbsp;this&nbsp;parameter&nbsp;is&nbsp;omitted.&nbsp;Optional.<br>
74&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)<br>
75&nbsp;&nbsp;previous:&nbsp;string,&nbsp;New&nbsp;previous&nbsp;sibling&nbsp;task&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;task&nbsp;is&nbsp;moved&nbsp;to&nbsp;the&nbsp;first&nbsp;position&nbsp;among&nbsp;its&nbsp;siblings,&nbsp;this&nbsp;parameter&nbsp;is&nbsp;omitted.&nbsp;Optional.</tt></dd></dl>
76
77<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;specified&nbsp;task.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
78&nbsp;<br>
79Args:<br>
80&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
81&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
82&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)</tt></dd></dl>
83
84<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;specified&nbsp;task.<br>
85&nbsp;<br>
86Args:<br>
87&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
88&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
89&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)</tt></dd></dl>
90
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>