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

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

96

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

97

<p class="firstline">Moves the specified task to another position in the task list. This can</p>

John Asmuth

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

[diff] [blame]

98

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

99

<code><a href="#patch">patch(tasklist, task, body=None, x__xgafv=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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

102

<code><a href="#update">update(tasklist, task, body=None, x__xgafv=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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

106

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

107

<pre>Clears all completed tasks from the specified task list. The affected tasks

108

will be marked as 'hidden' and no longer be returned by default when

109

retrieving all tasks for a task list.

John Asmuth

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

[diff] [blame]

110

111

Args:

112

tasklist: string, Task list identifier. (required)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

113

x__xgafv: string, V1 error format.

114

Allowed values

115

1 - v1 error format

116

2 - v2 error format

John Asmuth

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

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

121

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

John Asmuth

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

[diff] [blame]

122

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

123

124

Args:

125

tasklist: string, Task list identifier. (required)

126

task: string, Task identifier. (required)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

127

x__xgafv: string, V1 error format.

128

Allowed values

129

1 - v1 error format

130

2 - v2 error format

John Asmuth

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

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

135

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

John Asmuth

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

[diff] [blame]

136

<pre>Returns the specified task.

137

138

Args:

139

tasklist: string, Task list identifier. (required)

140

task: string, Task identifier. (required)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

141

x__xgafv: string, V1 error format.

142

Allowed values

143

1 - v1 error format

144

2 - v2 error format

John Asmuth

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

[diff] [blame]

145

146

Returns:

147

An object of the form:

148

149

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

150

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

151

# This field is read-only. Use the "move" method to move the task under a

152

# different parent or to the top level.

153

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

154

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

155

# had been marked completed when the task list was last cleared. The default

156

# is False. This field is read-only.

157

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

158

"position": "A String", # String indicating the position of the task among its sibling tasks under

159

# the same parent task or at the top level. If this string is greater than

160

# another task's corresponding position string according to lexicographical

161

# ordering, the task is positioned after the other task under the same parent

162

# task (or at the top level). This field is read-only. Use the "move" method

163

# to move the task to another position.

164

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

165

# omitted if the task has not been completed.

166

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

167

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

168

{

169

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

170

# &lt;/a&gt;.

171

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

172

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

173

},

174

],

175

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

176

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

177

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

178

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

179

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

180

# records date information; the time portion of the timestamp is discarded

181

# when setting the due date. It isn't possible to read or write the time that

182

# a task is due via the API.

183

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

184

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

185

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

189

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

190

<pre>Creates a new task on the specified task list.

John Asmuth

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

[diff] [blame]

191

192

Args:

193

tasklist: string, Task list identifier. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

194

body: object, The request body.

John Asmuth

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

[diff] [blame]

195

The object takes the form of:

196

197

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

198

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

199

# This field is read-only. Use the "move" method to move the task under a

200

# different parent or to the top level.

201

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

202

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

203

# had been marked completed when the task list was last cleared. The default

204

# is False. This field is read-only.

205

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

206

"position": "A String", # String indicating the position of the task among its sibling tasks under

207

# the same parent task or at the top level. If this string is greater than

208

# another task's corresponding position string according to lexicographical

209

# ordering, the task is positioned after the other task under the same parent

210

# task (or at the top level). This field is read-only. Use the "move" method

211

# to move the task to another position.

212

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

213

# omitted if the task has not been completed.

214

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

215

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

216

{

217

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

218

# &lt;/a&gt;.

219

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

220

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

221

},

222

],

223

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

224

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

225

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

226

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

227

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

228

# records date information; the time portion of the timestamp is discarded

229

# when setting the due date. It isn't possible to read or write the time that

230

# a task is due via the API.

231

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

232

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

233

}

234

235

previous: string, Previous sibling task identifier. If the task is created at the first

236

position among its siblings, this parameter is omitted. Optional.

237

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

238

parameter is omitted. Optional.

239

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

246

247

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

248

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

249

# This field is read-only. Use the "move" method to move the task under a

250

# different parent or to the top level.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

251

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

252

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

253

# had been marked completed when the task list was last cleared. The default

254

# is False. This field is read-only.

255

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

256

"position": "A String", # String indicating the position of the task among its sibling tasks under

257

# the same parent task or at the top level. If this string is greater than

258

# another task's corresponding position string according to lexicographical

259

# ordering, the task is positioned after the other task under the same parent

260

# task (or at the top level). This field is read-only. Use the "move" method

261

# to move the task to another position.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

262

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

263

# omitted if the task has not been completed.

264

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

265

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

266

{

267

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

268

# &lt;/a&gt;.

269

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

270

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

271

},

272

],

273

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

274

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

275

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

276

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

277

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

278

# records date information; the time portion of the timestamp is discarded

279

# when setting the due date. It isn't possible to read or write the time that

280

# a task is due via the API.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

281

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

282

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

283

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

287

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

John Asmuth

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

[diff] [blame]

288

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

289

290

Args:

291

tasklist: string, Task list identifier. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

292

showCompleted: boolean, Flag indicating whether completed tasks are returned in the result.

293

Optional. The default is True.

294

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

295

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

296

The default is False.

297

completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

298

filter by. Optional. The default is not to filter by completion date.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

299

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

300

Optional. The default is not to filter by due date.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

301

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

302

Optional. The default is not to filter by due date.

303

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

304

The default is False.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

305

completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to

306

filter by. Optional. The default is not to filter by completion date.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

307

maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is

308

20 (max allowed: 100).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

309

updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp)

310

to filter by. Optional. The default is not to filter by last modification

311

time.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

312

x__xgafv: string, V1 error format.

313

Allowed values

314

1 - v1 error format

315

2 - v2 error format

John Asmuth

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

[diff] [blame]

316

317

Returns:

318

An object of the form:

319

320

{

Bu Sun Kim

6502091

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

[diff] [blame]

321

"items": [ # Collection of tasks.

John Asmuth

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

[diff] [blame]

322

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

323

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

324

# This field is read-only. Use the "move" method to move the task under a

325

# different parent or to the top level.

326

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

327

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

328

# had been marked completed when the task list was last cleared. The default

329

# is False. This field is read-only.

330

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

331

"position": "A String", # String indicating the position of the task among its sibling tasks under

332

# the same parent task or at the top level. If this string is greater than

333

# another task's corresponding position string according to lexicographical

334

# ordering, the task is positioned after the other task under the same parent

335

# task (or at the top level). This field is read-only. Use the "move" method

336

# to move the task to another position.

337

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

338

# omitted if the task has not been completed.

339

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

340

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

341

{

342

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

343

# &lt;/a&gt;.

344

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

345

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

346

},

347

],

348

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

349

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

350

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

351

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

352

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

353

# records date information; the time portion of the timestamp is discarded

354

# when setting the due date. It isn't possible to read or write the time that

355

# a task is due via the API.

356

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

357

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

358

},

John Asmuth

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

[diff] [blame]

359

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

360

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

361

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

362

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

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>

368

<pre>Retrieves the next page of results.

369

370

Args:

371

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

372

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

373

374

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

375

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

John Asmuth

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

[diff] [blame]

376

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

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

381

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

382

<pre>Moves the specified task to another position in the task list. This can

383

include putting it as a child task under a new parent and/or move it to a

384

different position among its sibling tasks.

John Asmuth

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

[diff] [blame]

385

386

Args:

387

tasklist: string, Task list identifier. (required)

388

task: string, Task identifier. (required)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

389

previous: string, New previous sibling task identifier. If the task is moved to the first

390

position among its siblings, this parameter is omitted. Optional.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

391

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

392

parameter is omitted. Optional.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

393

x__xgafv: string, V1 error format.

394

Allowed values

395

1 - v1 error format

396

2 - v2 error format

John Asmuth

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

[diff] [blame]

397

398

Returns:

399

An object of the form:

400

401

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

402

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

403

# This field is read-only. Use the "move" method to move the task under a

404

# different parent or to the top level.

405

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

406

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

407

# had been marked completed when the task list was last cleared. The default

408

# is False. This field is read-only.

409

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

410

"position": "A String", # String indicating the position of the task among its sibling tasks under

411

# the same parent task or at the top level. If this string is greater than

412

# another task's corresponding position string according to lexicographical

413

# ordering, the task is positioned after the other task under the same parent

414

# task (or at the top level). This field is read-only. Use the "move" method

415

# to move the task to another position.

416

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

417

# omitted if the task has not been completed.

418

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

419

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

420

{

421

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

422

# &lt;/a&gt;.

423

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

424

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

425

},

426

],

427

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

428

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

429

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

430

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

431

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

432

# records date information; the time portion of the timestamp is discarded

433

# when setting the due date. It isn't possible to read or write the time that

434

# a task is due via the API.

435

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

436

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

437

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

441

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

John Asmuth

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

[diff] [blame]

442

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

443

444

Args:

445

tasklist: string, Task list identifier. (required)

446

task: string, Task identifier. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

447

body: object, The request body.

John Asmuth

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

[diff] [blame]

448

The object takes the form of:

449

450

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

451

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

452

# This field is read-only. Use the "move" method to move the task under a

453

# different parent or to the top level.

454

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

455

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

456

# had been marked completed when the task list was last cleared. The default

457

# is False. This field is read-only.

458

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

459

"position": "A String", # String indicating the position of the task among its sibling tasks under

460

# the same parent task or at the top level. If this string is greater than

461

# another task's corresponding position string according to lexicographical

462

# ordering, the task is positioned after the other task under the same parent

463

# task (or at the top level). This field is read-only. Use the "move" method

464

# to move the task to another position.

465

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

466

# omitted if the task has not been completed.

467

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

468

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

469

{

470

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

471

# &lt;/a&gt;.

472

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

473

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

474

},

475

],

476

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

477

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

478

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

479

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

480

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

481

# records date information; the time portion of the timestamp is discarded

482

# when setting the due date. It isn't possible to read or write the time that

483

# a task is due via the API.

484

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

485

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

486

}

John Asmuth

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

[diff] [blame]

487

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

488

x__xgafv: string, V1 error format.

489

Allowed values

490

1 - v1 error format

491

2 - v2 error format

John Asmuth

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

[diff] [blame]

492

493

Returns:

494

An object of the form:

495

496

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

497

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

498

# This field is read-only. Use the "move" method to move the task under a

499

# different parent or to the top level.

500

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

501

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

502

# had been marked completed when the task list was last cleared. The default

503

# is False. This field is read-only.

504

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

505

"position": "A String", # String indicating the position of the task among its sibling tasks under

506

# the same parent task or at the top level. If this string is greater than

507

# another task's corresponding position string according to lexicographical

508

# ordering, the task is positioned after the other task under the same parent

509

# task (or at the top level). This field is read-only. Use the "move" method

510

# to move the task to another position.

511

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

512

# omitted if the task has not been completed.

513

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

514

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

515

{

516

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

517

# &lt;/a&gt;.

518

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

519

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

520

},

521

],

522

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

523

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

524

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

525

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

526

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

527

# records date information; the time portion of the timestamp is discarded

528

# when setting the due date. It isn't possible to read or write the time that

529

# a task is due via the API.

530

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

531

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

532

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

536

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

John Asmuth

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

[diff] [blame]

537

<pre>Updates the specified task.

538

539

Args:

540

tasklist: string, Task list identifier. (required)

541

task: string, Task identifier. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

542

body: object, The request body.

John Asmuth

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

[diff] [blame]

543

The object takes the form of:

544

545

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

546

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

547

# This field is read-only. Use the "move" method to move the task under a

548

# different parent or to the top level.

549

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

550

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

551

# had been marked completed when the task list was last cleared. The default

552

# is False. This field is read-only.

553

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

554

"position": "A String", # String indicating the position of the task among its sibling tasks under

555

# the same parent task or at the top level. If this string is greater than

556

# another task's corresponding position string according to lexicographical

557

# ordering, the task is positioned after the other task under the same parent

558

# task (or at the top level). This field is read-only. Use the "move" method

559

# to move the task to another position.

560

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

561

# omitted if the task has not been completed.

562

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

563

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

564

{

565

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

566

# &lt;/a&gt;.

567

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

568

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

569

},

570

],

571

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

572

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

573

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

574

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

575

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

576

# records date information; the time portion of the timestamp is discarded

577

# when setting the due date. It isn't possible to read or write the time that

578

# a task is due via the API.

579

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

580

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

581

}

John Asmuth

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

[diff] [blame]

582

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

583

x__xgafv: string, V1 error format.

584

Allowed values

585

1 - v1 error format

586

2 - v2 error format

John Asmuth

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

[diff] [blame]

587

588

Returns:

589

An object of the form:

590

591

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

592

"parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.

593

# This field is read-only. Use the "move" method to move the task under a

594

# different parent or to the top level.

595

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

596

"hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task

597

# had been marked completed when the task list was last cleared. The default

598

# is False. This field is read-only.

599

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

600

"position": "A String", # String indicating the position of the task among its sibling tasks under

601

# the same parent task or at the top level. If this string is greater than

602

# another task's corresponding position string according to lexicographical

603

# ordering, the task is positioned after the other task under the same parent

604

# task (or at the top level). This field is read-only. Use the "move" method

605

# to move the task to another position.

606

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

607

# omitted if the task has not been completed.

608

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

609

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

610

{

611

"description": "A String", # The description. In HTML speak: Everything between &lt;a&gt; and

612

# &lt;/a&gt;.

613

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

614

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

615

},

616

],

617

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

618

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

619

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

620

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

621

"due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only

622

# records date information; the time portion of the timestamp is discarded

623

# when setting the due date. It isn't possible to read or write the time that

624

# a task is due via the API.

625

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

626

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

627

}</pre>

John Asmuth