Class: Google::Apis::TasksV1::TasksService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/tasks_v1/service.rb

Overview

Tasks API

Manages your tasks and task lists.

Examples:

require 'google/apis/tasks_v1'

Tasks = Google::Apis::TasksV1 # Alias the module
service = Tasks::TasksService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeTasksService

Returns a new instance of TasksService.


49
50
51
52
# File 'generated/google/apis/tasks_v1/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'tasks/v1/')
  @batch_path = 'batch/tasks/v1'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


38
39
40
# File 'generated/google/apis/tasks_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.


43
44
45
# File 'generated/google/apis/tasks_v1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


47
48
49
# File 'generated/google/apis/tasks_v1/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#clear_task(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

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.

Parameters:

  • tasklist (String)

    Task list identifier.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


287
288
289
290
291
292
293
294
# File 'generated/google/apis/tasks_v1/service.rb', line 287

def clear_task(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'lists/{tasklist}/clear', options)
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_task(tasklist, task, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes the specified task from the task list.

Parameters:

  • tasklist (String)

    Task list identifier.

  • task (String)

    Task identifier.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


320
321
322
323
324
325
326
327
328
# File 'generated/google/apis/tasks_v1/service.rb', line 320

def delete_task(tasklist, task, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'lists/{tasklist}/tasks/{task}', options)
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.params['task'] = task unless task.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_tasklist(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes the authenticated user's specified task list.

Parameters:

  • tasklist (String)

    Task list identifier.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


76
77
78
79
80
81
82
83
# File 'generated/google/apis/tasks_v1/service.rb', line 76

def delete_tasklist(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'users/@me/lists/{tasklist}', options)
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_task(tasklist, task, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Task

Returns the specified task.

Parameters:

  • tasklist (String)

    Task list identifier.

  • task (String)

    Task identifier.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


354
355
356
357
358
359
360
361
362
363
364
# File 'generated/google/apis/tasks_v1/service.rb', line 354

def get_task(tasklist, task, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'lists/{tasklist}/tasks/{task}', options)
  command.response_representation = Google::Apis::TasksV1::Task::Representation
  command.response_class = Google::Apis::TasksV1::Task
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.params['task'] = task unless task.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_tasklist(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::TaskList

Returns the authenticated user's specified task list.

Parameters:

  • tasklist (String)

    Task list identifier.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


107
108
109
110
111
112
113
114
115
116
# File 'generated/google/apis/tasks_v1/service.rb', line 107

def get_tasklist(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'users/@me/lists/{tasklist}', options)
  command.response_representation = Google::Apis::TasksV1::TaskList::Representation
  command.response_class = Google::Apis::TasksV1::TaskList
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_task(tasklist, task_object = nil, parent: nil, previous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Task

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.

Parameters:

  • tasklist (String)

    Task list identifier.

  • task_object (Google::Apis::TasksV1::Task) (defaults to: nil)
  • parent (String) (defaults to: nil)

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

  • previous (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


396
397
398
399
400
401
402
403
404
405
406
407
408
409
# File 'generated/google/apis/tasks_v1/service.rb', line 396

def insert_task(tasklist, task_object = nil, parent: nil, previous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'lists/{tasklist}/tasks', options)
  command.request_representation = Google::Apis::TasksV1::Task::Representation
  command.request_object = task_object
  command.response_representation = Google::Apis::TasksV1::Task::Representation
  command.response_class = Google::Apis::TasksV1::Task
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['previous'] = previous unless previous.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_tasklist(task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::TaskList

Creates a new task list and adds it to the authenticated user's task lists. Fails with HTTP code 403 or 429 after reaching the storage limit of 2,000 lists.

Parameters:

  • task_list_object (Google::Apis::TasksV1::TaskList) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


141
142
143
144
145
146
147
148
149
150
151
# File 'generated/google/apis/tasks_v1/service.rb', line 141

def insert_tasklist(task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'users/@me/lists', options)
  command.request_representation = Google::Apis::TasksV1::TaskList::Representation
  command.request_object = task_list_object
  command.response_representation = Google::Apis::TasksV1::TaskList::Representation
  command.response_class = Google::Apis::TasksV1::TaskList
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_tasklists(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::TaskLists

Returns all the authenticated user's task lists.

Parameters:

  • max_results (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    Token specifying the result page to return. Optional.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


178
179
180
181
182
183
184
185
186
187
188
# File 'generated/google/apis/tasks_v1/service.rb', line 178

def list_tasklists(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'users/@me/lists', options)
  command.response_representation = Google::Apis::TasksV1::TaskLists::Representation
  command.response_class = Google::Apis::TasksV1::TaskLists
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_tasks(tasklist, completed_max: nil, completed_min: nil, due_max: nil, due_min: nil, max_results: nil, page_token: nil, show_completed: nil, show_deleted: nil, show_hidden: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Tasks

Returns all tasks in the specified task list.

Parameters:

  • tasklist (String)

    Task list identifier.

  • completed_max (String) (defaults to: nil)

    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.

  • completed_min (String) (defaults to: nil)

    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.

  • due_max (String) (defaults to: nil)

    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.

  • due_min (String) (defaults to: nil)

    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.

  • max_results (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    Token specifying the result page to return. Optional.

  • show_completed (Boolean) (defaults to: nil)

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

  • show_deleted (Boolean) (defaults to: nil)

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

  • show_hidden (Boolean) (defaults to: nil)

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

  • updated_min (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
# File 'generated/google/apis/tasks_v1/service.rb', line 462

def list_tasks(tasklist, completed_max: nil, completed_min: nil, due_max: nil, due_min: nil, max_results: nil, page_token: nil, show_completed: nil, show_deleted: nil, show_hidden: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'lists/{tasklist}/tasks', options)
  command.response_representation = Google::Apis::TasksV1::Tasks::Representation
  command.response_class = Google::Apis::TasksV1::Tasks
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.query['completedMax'] = completed_max unless completed_max.nil?
  command.query['completedMin'] = completed_min unless completed_min.nil?
  command.query['dueMax'] = due_max unless due_max.nil?
  command.query['dueMin'] = due_min unless due_min.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showCompleted'] = show_completed unless show_completed.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['showHidden'] = show_hidden unless show_hidden.nil?
  command.query['updatedMin'] = updated_min unless updated_min.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#move_task(tasklist, task, parent: nil, previous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Task

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.

Parameters:

  • tasklist (String)

    Task list identifier.

  • task (String)

    Task identifier.

  • parent (String) (defaults to: nil)

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

  • previous (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


515
516
517
518
519
520
521
522
523
524
525
526
527
# File 'generated/google/apis/tasks_v1/service.rb', line 515

def move_task(tasklist, task, parent: nil, previous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'lists/{tasklist}/tasks/{task}/move', options)
  command.response_representation = Google::Apis::TasksV1::Task::Representation
  command.response_class = Google::Apis::TasksV1::Task
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.params['task'] = task unless task.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['previous'] = previous unless previous.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_task(tasklist, task, task_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Task

Updates the specified task. This method supports patch semantics.

Parameters:

  • tasklist (String)

    Task list identifier.

  • task (String)

    Task identifier.

  • task_object (Google::Apis::TasksV1::Task) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


554
555
556
557
558
559
560
561
562
563
564
565
566
# File 'generated/google/apis/tasks_v1/service.rb', line 554

def patch_task(tasklist, task, task_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'lists/{tasklist}/tasks/{task}', options)
  command.request_representation = Google::Apis::TasksV1::Task::Representation
  command.request_object = task_object
  command.response_representation = Google::Apis::TasksV1::Task::Representation
  command.response_class = Google::Apis::TasksV1::Task
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.params['task'] = task unless task.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::TaskList

Updates the authenticated user's specified task list. This method supports patch semantics.

Parameters:

  • tasklist (String)

    Task list identifier.

  • task_list_object (Google::Apis::TasksV1::TaskList) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


214
215
216
217
218
219
220
221
222
223
224
225
# File 'generated/google/apis/tasks_v1/service.rb', line 214

def patch_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'users/@me/lists/{tasklist}', options)
  command.request_representation = Google::Apis::TasksV1::TaskList::Representation
  command.request_object = task_list_object
  command.response_representation = Google::Apis::TasksV1::TaskList::Representation
  command.response_class = Google::Apis::TasksV1::TaskList
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_task(tasklist, task, task_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Task

Updates the specified task.

Parameters:

  • tasklist (String)

    Task list identifier.

  • task (String)

    Task identifier.

  • task_object (Google::Apis::TasksV1::Task) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


593
594
595
596
597
598
599
600
601
602
603
604
605
# File 'generated/google/apis/tasks_v1/service.rb', line 593

def update_task(tasklist, task, task_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'lists/{tasklist}/tasks/{task}', options)
  command.request_representation = Google::Apis::TasksV1::Task::Representation
  command.request_object = task_object
  command.response_representation = Google::Apis::TasksV1::Task::Representation
  command.response_class = Google::Apis::TasksV1::Task
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.params['task'] = task unless task.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::TaskList

Updates the authenticated user's specified task list.

Parameters:

  • tasklist (String)

    Task list identifier.

  • task_list_object (Google::Apis::TasksV1::TaskList) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


250
251
252
253
254
255
256
257
258
259
260
261
# File 'generated/google/apis/tasks_v1/service.rb', line 250

def update_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'users/@me/lists/{tasklist}', options)
  command.request_representation = Google::Apis::TasksV1::TaskList::Representation
  command.request_object = task_list_object
  command.response_representation = Google::Apis::TasksV1::TaskList::Representation
  command.response_class = Google::Apis::TasksV1::TaskList
  command.params['tasklist'] = tasklist unless tasklist.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end