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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/tasks_v1/service.rb

Overview

Tasks API

The Google Tasks API lets you manage 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

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TasksService

Returns a new instance of TasksService.



45
46
47
48
49
50
 
# File 'lib/google/apis/tasks_v1/service.rb', line 45

def initialize
  super('https://tasks.googleapis.com/', '',
        client_name: 'google-apis-tasks_v1',
        client_version: Google::Apis::TasksV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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 'lib/google/apis/tasks_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



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

def quota_user
  @quota_user
end

Instance Method Details

#clear_task(tasklist, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



263
264
265
266
267
268
269
 
# File 'lib/google/apis/tasks_v1/service.rb', line 263

def clear_task(tasklist, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_task(tasklist, task, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



293
294
295
296
297
298
299
300
 
# File 'lib/google/apis/tasks_v1/service.rb', line 293

def delete_task(tasklist, task, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#delete_tasklist(tasklist, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



72
73
74
75
76
77
78
 
# File 'lib/google/apis/tasks_v1/service.rb', line 72

def delete_tasklist(tasklist, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#get_task(tasklist, task, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



324
325
326
327
328
329
330
331
332
333
 
# File 'lib/google/apis/tasks_v1/service.rb', line 324

def get_task(tasklist, task, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#get_tasklist(tasklist, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



100
101
102
103
104
105
106
107
108
 
# File 'lib/google/apis/tasks_v1/service.rb', line 100

def get_tasklist(tasklist, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

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

Creates a new task on the specified task list.

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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/google/apis/tasks_v1/service.rb', line 362

def insert_task(tasklist, task_object = nil, parent: nil, previous: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

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

Creates a new task list and adds it to the authenticated user's task 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/google/apis/tasks_v1/service.rb', line 129

def insert_tasklist(task_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#list_tasklists(max_results: nil, page_token: nil, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/google/apis/tasks_v1/service.rb', line 163

def list_tasklists(max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'tasks/v1/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?
  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, 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. Note that showHidden must also be True to show tasks completed in first party clients, such as the web UI and Google's mobile apps.

  • 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/google/apis/tasks_v1/service.rb', line 426

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, options: nil, &block)
  command = make_simple_command(:get, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#move_task(tasklist, task, parent: nil, previous: nil, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/google/apis/tasks_v1/service.rb', line 476

def move_task(tasklist, task, parent: nil, previous: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#patch_task(tasklist, task, task_object = nil, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/google/apis/tasks_v1/service.rb', line 512

def patch_task(tasklist, task, task_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#patch_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/apis/tasks_v1/service.rb', line 196

def patch_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#update_task(tasklist, task, task_object = nil, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/google/apis/tasks_v1/service.rb', line 548

def update_task(tasklist, task, task_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end

#update_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: 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) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/apis/tasks_v1/service.rb', line 229

def update_tasklist(tasklist, task_list_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'tasks/v1/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?
  execute_or_queue_command(command, &block)
end