Blame - docs/dyn/tasks_v1.tasks.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#insert">insert(tasklist, body=None, parent=None, previous=None)</a></code></p>

88

<p class="firstline">Creates a new task on the specified task list. Fails with HTTP code 403 or 429 after reaching the storage limit of 100,000 tasks per account.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

89

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

90

<code><a href="#list">list(tasklist, completedMax=None, completedMin=None, dueMax=None, dueMin=None, maxResults=None, pageToken=None, showCompleted=None, showDeleted=None, showHidden=None, updatedMin=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

91

<p class="firstline">Returns all tasks in the specified task list.</p>

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

96

<code><a href="#move">move(tasklist, task, parent=None, previous=None)</a></code></p>

97

<p class="firstline">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.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#patch">patch(tasklist, task, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

100

<p class="firstline">Updates the specified task. This method supports patch semantics.</p>

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#update">update(tasklist, task, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

103

<p class="firstline">Updates the specified task.</p>

104

<h3>Method Details</h3>

105

106

<code class="details" id="clear">clear(tasklist)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

107

<pre>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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

108

109

Args:

110

tasklist: string, Task list identifier. (required)

</pre>

</div>

<code class="details" id="delete">delete(tasklist, task)</code>

116

<pre>Deletes the specified task from the task list.

117

118

Args:

119

tasklist: string, Task list identifier. (required)

120

task: string, Task identifier. (required)

</pre>

</div>

<code class="details" id="get">get(tasklist, task)</code>

126

<pre>Returns the specified task.

127

128

Args:

129

tasklist: string, Task list identifier. (required)

130

task: string, Task identifier. (required)

131

132

Returns:

133

An object of the form:

134

135

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

136

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

137

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

138

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

139

"etag": "A String", # ETag of the resource.

140

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

141

"id": "A String", # Task identifier.

142

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

143

"links": [ # Collection of links. This collection is read-only.

144

{

145

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

146

"link": "A String", # The URL.

147

"type": "A String", # Type of the link, e.g. "email".

148

},

149

],

150

"notes": "A String", # Notes describing the task. Optional.

151

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

152

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

153

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

154

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

155

"title": "A String", # Title of the task.

156

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

157

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

161

<code class="details" id="insert">insert(tasklist, body=None, parent=None, previous=None)</code>

162

<pre>Creates a new task on the specified task list. Fails with HTTP code 403 or 429 after reaching the storage limit of 100,000 tasks per account.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

163

164

Args:

165

tasklist: string, Task list identifier. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

166

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

167

The object takes the form of:

168

169

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

170

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

171

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

172

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

173

"etag": "A String", # ETag of the resource.

174

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

175

"id": "A String", # Task identifier.

176

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

177

"links": [ # Collection of links. This collection is read-only.

178

{

179

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

180

"link": "A String", # The URL.

181

"type": "A String", # Type of the link, e.g. "email".

182

},

183

],

184

"notes": "A String", # Notes describing the task. Optional.

185

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

186

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

187

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

188

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

189

"title": "A String", # Title of the task.

190

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

191

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

192

193

parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.

194

previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.

195

196

Returns:

197

An object of the form:

198

199

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

201

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

202

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

203

"etag": "A String", # ETag of the resource.

204

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

205

"id": "A String", # Task identifier.

206

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

207

"links": [ # Collection of links. This collection is read-only.

208

{

209

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

210

"link": "A String", # The URL.

211

"type": "A String", # Type of the link, e.g. "email".

212

},

213

],

214

"notes": "A String", # Notes describing the task. Optional.

215

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

216

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

217

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

218

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

219

"title": "A String", # Title of the task.

220

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

221

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

<code class="details" id="list">list(tasklist, completedMax=None, completedMin=None, dueMax=None, dueMin=None, maxResults=None, pageToken=None, showCompleted=None, showDeleted=None, showHidden=None, updatedMin=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

226

<pre>Returns all tasks in the specified task list.

227

228

Args:

229

tasklist: string, Task list identifier. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

230

completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.

231

completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.

232

dueMax: string, Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.

233

dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

234

maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

235

pageToken: string, Token specifying the result page to return. Optional.

236

showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.

237

showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

238

showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

239

updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

240

241

Returns:

242

An object of the form:

243

244

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

"etag": "A String", # ETag of the resource.

246

"items": [ # Collection of tasks.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

247

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

248

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

249

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

250

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

251

"etag": "A String", # ETag of the resource.

252

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

253

"id": "A String", # Task identifier.

254

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

255

"links": [ # Collection of links. This collection is read-only.

256

{

257

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

258

"link": "A String", # The URL.

259

"type": "A String", # Type of the link, e.g. "email".

260

},

261

],

262

"notes": "A String", # Notes describing the task. Optional.

263

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

264

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

265

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

266

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

267

"title": "A String", # Title of the task.

268

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

269

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

270

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

271

"kind": "tasks#tasks", # Type of the resource. This is always "tasks#tasks".

272

"nextPageToken": "A String", # Token used to access the next page of this result.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

278

<pre>Retrieves the next page of results.

279

280

Args:

281

previous_request: The request for the previous page. (required)

282

previous_response: The response from the request for the previous page. (required)

283

284

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

285

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

286

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="move">move(tasklist, task, parent=None, previous=None)</code>

292

<pre>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.

293

294

Args:

295

tasklist: string, Task list identifier. (required)

296

task: string, Task identifier. (required)

297

parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.

298

previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.

299

300

Returns:

301

An object of the form:

302

303

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

304

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

305

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

306

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

307

"etag": "A String", # ETag of the resource.

308

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

309

"id": "A String", # Task identifier.

310

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

311

"links": [ # Collection of links. This collection is read-only.

312

{

313

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

314

"link": "A String", # The URL.

315

"type": "A String", # Type of the link, e.g. "email".

316

},

317

],

318

"notes": "A String", # Notes describing the task. Optional.

319

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

320

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

321

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

322

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

323

"title": "A String", # Title of the task.

324

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

325

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

329

<code class="details" id="patch">patch(tasklist, task, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

330

<pre>Updates the specified task. This method supports patch semantics.

331

332

Args:

333

tasklist: string, Task list identifier. (required)

334

task: string, Task identifier. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

335

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

336

The object takes the form of:

337

338

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

339

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

340

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

341

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

342

"etag": "A String", # ETag of the resource.

343

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

344

"id": "A String", # Task identifier.

345

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

346

"links": [ # Collection of links. This collection is read-only.

347

{

348

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

349

"link": "A String", # The URL.

350

"type": "A String", # Type of the link, e.g. "email".

351

},

352

],

353

"notes": "A String", # Notes describing the task. Optional.

354

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

355

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

356

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

357

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

358

"title": "A String", # Title of the task.

359

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

360

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

Returns:

An object of the form:

365

366

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

367

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

368

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

369

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

370

"etag": "A String", # ETag of the resource.

371

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

372

"id": "A String", # Task identifier.

373

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

374

"links": [ # Collection of links. This collection is read-only.

375

{

376

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

377

"link": "A String", # The URL.

378

"type": "A String", # Type of the link, e.g. "email".

379

},

380

],

381

"notes": "A String", # Notes describing the task. Optional.

382

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

383

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

384

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

385

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

386

"title": "A String", # Title of the task.

387

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

388

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

392

<code class="details" id="update">update(tasklist, task, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

393

<pre>Updates the specified task.

394

395

Args:

396

tasklist: string, Task list identifier. (required)

397

task: string, Task identifier. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

398

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

399

The object takes the form of:

400

401

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

402

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

403

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

404

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

405

"etag": "A String", # ETag of the resource.

406

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

407

"id": "A String", # Task identifier.

408

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

409

"links": [ # Collection of links. This collection is read-only.

410

{

411

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

412

"link": "A String", # The URL.

413

"type": "A String", # Type of the link, e.g. "email".

414

},

415

],

416

"notes": "A String", # Notes describing the task. Optional.

417

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

418

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

419

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

420

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

421

"title": "A String", # Title of the task.

422

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

423

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

Returns:

An object of the form:

428

429

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

430

"completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

431

"deleted": True or False, # Flag indicating whether the task has been deleted. The default if False.

432

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

433

"etag": "A String", # ETag of the resource.

434

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

435

"id": "A String", # Task identifier.

436

"kind": "tasks#task", # Type of the resource. This is always "tasks#task".

437

"links": [ # Collection of links. This collection is read-only.

438

{

439

"description": "A String", # The description. In HTML speak: Everything between <a> and </a>.

440

"link": "A String", # The URL.

441

"type": "A String", # Type of the link, e.g. "email".

442

},

443

],

444

"notes": "A String", # Notes describing the task. Optional.

445

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level.

446

"position": "A String", # String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only. Use the "move" method to move the task to another position.

447

"selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.

448

"status": "A String", # Status of the task. This is either "needsAction" or "completed".

449

"title": "A String", # Title of the task.

450

"updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).

451

}</pre>

John Asmuth