Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b4169b5fff9e64688e4e3f4254624fbdcd00b25d / . / docs / dyn / tasks.v1.tasks.html
blob: b8a46e4250a4bba5b5f0effe6074bff30d109fc6 [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>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]33&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)<br>
34&nbsp;<br>
35Returns:<br>
36&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
37&nbsp;<br>
38&nbsp;&nbsp;&nbsp;&nbsp;{<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
60&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]61
62<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>
63&nbsp;<br>
64Args:<br>
65&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]66&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
67&nbsp;<br>
68{<br>
69&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
70&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
71&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
72&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
73&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
74&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
79&nbsp;&nbsp;&nbsp;&nbsp;],<br>
80&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
81&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
82&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
83&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
87&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
90&nbsp;&nbsp;}<br>
91&nbsp;<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]92&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
93&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>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]94&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.<br>
95&nbsp;<br>
96Returns:<br>
97&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
98&nbsp;<br>
99&nbsp;&nbsp;&nbsp;&nbsp;{<br>
100&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
105&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
108&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
109&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
110&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
111&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
113&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
121&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]122
123<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>
124&nbsp;<br>
125Args:<br>
126&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>
127&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
128&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;Token&nbsp;specifying&nbsp;the&nbsp;result&nbsp;page&nbsp;to&nbsp;return.&nbsp;Optional.<br>
129&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]130&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]131&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>
132&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>
133&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>
134&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>
135&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>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]136&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.<br>
137&nbsp;<br>
138Returns:<br>
139&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
140&nbsp;<br>
141&nbsp;&nbsp;&nbsp;&nbsp;{<br>
142&nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Token&nbsp;used&nbsp;to&nbsp;access&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;this&nbsp;result.<br>
143&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;tasks.<br>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
167&nbsp;&nbsp;&nbsp;&nbsp;],<br>
168&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#tasks",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#tasks".<br>
169&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
170&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]171
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]172<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>
173&nbsp;<br>
174Args:<br>
175&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
176&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
177&nbsp;<br>
178Returns:<br>
179&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>
180&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>
181
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]182<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>
183&nbsp;<br>
184Args:<br>
185&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
186&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
187&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>
188&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]189&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.<br>
190&nbsp;<br>
191Returns:<br>
192&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
193&nbsp;<br>
194&nbsp;&nbsp;&nbsp;&nbsp;{<br>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
201&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
216&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]217
218<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>
219&nbsp;<br>
220Args:<br>
221&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]222&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
223&nbsp;<br>
224{<br>
225&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
226&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
227&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
228&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
229&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
234&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
235&nbsp;&nbsp;&nbsp;&nbsp;],<br>
236&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
237&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
238&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
239&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
240&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
241&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
242&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
243&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
244&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
245&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
246&nbsp;&nbsp;}<br>
247&nbsp;<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]248&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]249&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)<br>
250&nbsp;<br>
251Returns:<br>
252&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
253&nbsp;<br>
254&nbsp;&nbsp;&nbsp;&nbsp;{<br>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
259&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
264&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
267&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
270&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
272&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
276&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]277
278<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;specified&nbsp;task.<br>
279&nbsp;<br>
280Args:<br>
281&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]282&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
283&nbsp;<br>
284{<br>
285&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
286&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
287&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
288&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
289&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
292&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
294&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
295&nbsp;&nbsp;&nbsp;&nbsp;],<br>
296&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
297&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
298&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
299&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
300&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
301&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
302&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
303&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
304&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
305&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
306&nbsp;&nbsp;}<br>
307&nbsp;<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]308&nbsp;&nbsp;tasklist:&nbsp;string,&nbsp;Task&nbsp;list&nbsp;identifier.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]309&nbsp;&nbsp;task:&nbsp;string,&nbsp;Task&nbsp;identifier.&nbsp;(required)<br>
310&nbsp;<br>
311Returns:<br>
312&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
313&nbsp;<br>
314&nbsp;&nbsp;&nbsp;&nbsp;{<br>
315&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Status&nbsp;of&nbsp;the&nbsp;task.&nbsp;This&nbsp;is&nbsp;either&nbsp;"needsAction"&nbsp;or&nbsp;"completed".<br>
316&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"tasks#task",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource.&nbsp;This&nbsp;is&nbsp;always&nbsp;"tasks#task".<br>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Last&nbsp;modification&nbsp;time&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).<br>
318&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Parent&nbsp;task&nbsp;identifier.&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;it&nbsp;is&nbsp;a&nbsp;top-level&nbsp;task.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;under&nbsp;a&nbsp;different&nbsp;parent&nbsp;or&nbsp;to&nbsp;the&nbsp;top&nbsp;level.<br>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;Collection&nbsp;of&nbsp;links.&nbsp;This&nbsp;collection&nbsp;is&nbsp;read-only.<br>
320&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
321&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;link,&nbsp;e.g.&nbsp;"email".<br>
322&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL.<br>
323&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description.&nbsp;In&nbsp;HTML&nbsp;speak:&nbsp;Everything&nbsp;between&nbsp;&lt;a&gt;&nbsp;and&nbsp;&lt;/a&gt;.<br>
324&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
326&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;task.<br>
327&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"deleted":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;has&nbsp;been&nbsp;deleted.&nbsp;The&nbsp;default&nbsp;if&nbsp;False.<br>
328&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"completed":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Completion&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;This&nbsp;field&nbsp;is&nbsp;omitted&nbsp;if&nbsp;the&nbsp;task&nbsp;has&nbsp;not&nbsp;been&nbsp;completed.<br>
329&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"due":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Due&nbsp;date&nbsp;of&nbsp;the&nbsp;task&nbsp;(as&nbsp;a&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp).&nbsp;Optional.<br>
330&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
331&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"notes":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Notes&nbsp;describing&nbsp;the&nbsp;task.&nbsp;Optional.<br>
332&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"position":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;String&nbsp;indicating&nbsp;the&nbsp;position&nbsp;of&nbsp;the&nbsp;task&nbsp;among&nbsp;its&nbsp;sibling&nbsp;tasks&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;or&nbsp;at&nbsp;the&nbsp;top&nbsp;level.&nbsp;If&nbsp;this&nbsp;string&nbsp;is&nbsp;greater&nbsp;than&nbsp;another&nbsp;task's&nbsp;corresponding&nbsp;position&nbsp;string&nbsp;according&nbsp;to&nbsp;lexicographical&nbsp;ordering,&nbsp;the&nbsp;task&nbsp;is&nbsp;positioned&nbsp;after&nbsp;the&nbsp;other&nbsp;task&nbsp;under&nbsp;the&nbsp;same&nbsp;parent&nbsp;task&nbsp;(or&nbsp;at&nbsp;the&nbsp;top&nbsp;level).&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.&nbsp;Use&nbsp;the&nbsp;"move"&nbsp;method&nbsp;to&nbsp;move&nbsp;the&nbsp;task&nbsp;to&nbsp;another&nbsp;position.<br>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hidden":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Flag&nbsp;indicating&nbsp;whether&nbsp;the&nbsp;task&nbsp;is&nbsp;hidden.&nbsp;This&nbsp;is&nbsp;the&nbsp;case&nbsp;if&nbsp;the&nbsp;task&nbsp;had&nbsp;been&nbsp;marked&nbsp;completed&nbsp;when&nbsp;the&nbsp;task&nbsp;list&nbsp;was&nbsp;last&nbsp;cleared.&nbsp;The&nbsp;default&nbsp;is&nbsp;False.&nbsp;This&nbsp;field&nbsp;is&nbsp;read-only.<br>
334&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Task&nbsp;identifier.<br>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;pointing&nbsp;to&nbsp;this&nbsp;task.&nbsp;Used&nbsp;to&nbsp;retrieve,&nbsp;update,&nbsp;or&nbsp;delete&nbsp;this&nbsp;task.<br>
336&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]337
338<hr>
339Data descriptors defined here:<br>
340<dl><dt><strong>__dict__</strong></dt>
341<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
342</dl>
343<dl><dt><strong>__weakref__</strong></dt>
344<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
345</dl>
346</td></tr></table>
347</body></html>