docs/dyn/tasks.v1.tasks.html - platform/external/python/google-api-python-client - Gitiles


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: class Resource</title>
 </head><body bgcolor="#f0f0f8">
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <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>

 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</td>
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

 <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>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
 &nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)</tt></dd></dl>

 <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>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
 &nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)</tt></dd></dl>

 <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;the&nbsp;specified&nbsp;task.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
 &nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)</tt></dd></dl>

 <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>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
 &nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
 &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>
 &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>

 <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>
 &nbsp;<br>
 Args:<br>
 &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>
 &nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
 &nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;Token&nbsp;specifying&nbsp;the&nbsp;result&nbsp;page&nbsp;to&nbsp;return.&nbsp;Optional.<br>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>

 <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>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
 &nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
 &nbsp;<br>
 Returns:<br>
 &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>
 &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>

 <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>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
 &nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
 &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>
 &nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)<br>
 &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>

 <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>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
 &nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
 &nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)</tt></dd></dl>

 <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;specified&nbsp;task.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
 &nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
 &nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)</tt></dd></dl>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table>
 </body></html>

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html><head><title>Python: class Resource</title>
	</head><body bgcolor="#f0f0f8">
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ffc8d8">
	<td colspan=3 valign=bottom> <br>
	<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>

	<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>
	<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
	<tr><td> </td>
	<td width="100%">Methods defined here:<br>
	<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

	<dl><dt><a name="Resource-clear"><strong>clear</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.<br>
	<br>
	Args:<br>
	body: object, The request body. (required)<br>
	tasklist: string, Task list identifier. (required)</tt></dd></dl>

	<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes the specified task from the task list.<br>
	<br>
	Args:<br>
	tasklist: string, Task list identifier. (required)<br>
	task: string, Task identifier. (required)</tt></dd></dl>

	<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the specified task.<br>
	<br>
	Args:<br>
	tasklist: string, Task list identifier. (required)<br>
	task: string, Task identifier. (required)</tt></dd></dl>

	<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates a new task on the specified task list.<br>
	<br>
	Args:<br>
	body: object, The request body. (required)<br>
	tasklist: string, Task list identifier. (required)<br>
	parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.<br>
	previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.</tt></dd></dl>

	<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns all tasks in the specified task list.<br>
	<br>
	Args:<br>
	dueMax: string, Upper bound for a task's due date (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by due date.<br>
	tasklist: string, Task list identifier. (required)<br>
	pageToken: string, Token specifying the result page to return. Optional.<br>
	updatedMin: string, Lower bound for a task's last modification time (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by last modification time.<br>
	maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.<br>
	completedMin: string, Lower bound for a task's completion date (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by completion date.<br>
	showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.<br>
	completedMax: string, Upper bound for a task's completion date (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by completion date.<br>
	showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.<br>
	showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.<br>
	dueMin: string, Lower bound for a task's due date (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by due date.</tt></dd></dl>

	<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
	<br>
	Args:<br>
	previous_request: The request for the previous page.<br>
	previous_response: The response from the request for the previous page.<br>
	<br>
	Returns:<br>
	A request object that you can call 'execute()' on to request the next<br>
	page. Returns None if there are no more items in the collection.</tt></dd></dl>

	<dl><dt><a name="Resource-move"><strong>move</strong></a> = method(self, **kwargs)</dt><dd><tt>Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.<br>
	<br>
	Args:<br>
	body: object, The request body. (required)<br>
	tasklist: string, Task list identifier. (required)<br>
	parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.<br>
	task: string, Task identifier. (required)<br>
	previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.</tt></dd></dl>

	<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified task. This method supports patch semantics.<br>
	<br>
	Args:<br>
	body: object, The request body. (required)<br>
	tasklist: string, Task list identifier. (required)<br>
	task: string, Task identifier. (required)</tt></dd></dl>

	<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified task.<br>
	<br>
	Args:<br>
	body: object, The request body. (required)<br>
	tasklist: string, Task list identifier. (required)<br>
	task: string, Task identifier. (required)</tt></dd></dl>

	<hr>
	Data descriptors defined here:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	</td></tr></table>
	</body></html>