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

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

Overview

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

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://tasks.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TasksService

Returns a new instance of TasksService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        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.



40
41
42
 
# File 'lib/google/apis/tasks_v1/service.rb', line 40

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.



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

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



269
270
271
272
273
274
275
 
# File 'lib/google/apis/tasks_v1/service.rb', line 269

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. If the task is assigned, both the assigned task and the original task (in Docs, Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there.

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



302
303
304
305
306
307
308
309
 
# File 'lib/google/apis/tasks_v1/service.rb', line 302

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. If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.

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



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

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



333
334
335
336
337
338
339
340
341
342
 
# File 'lib/google/apis/tasks_v1/service.rb', line 333

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



104
105
106
107
108
109
110
111
112
 
# File 'lib/google/apis/tasks_v1/service.rb', line 104

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. Tasks assigned from Docs or Chat Spaces cannot be inserted from Tasks Public API; they can only be created by assigning them from Docs or Chat Spaces. A user can have up to 20,000 non- hidden tasks per list and up to 100,000 tasks in total at a time.

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. An assigned task cannot be a parent task, nor can it have a parent. Setting the parent to an assigned task results in failure of the request. 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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/google/apis/tasks_v1/service.rb', line 376

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. A user can have up to 2000 lists at a time.

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



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/google/apis/tasks_v1/service.rb', line 134

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. A user can have up to 2000 lists at a time.

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



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/google/apis/tasks_v1/service.rb', line 169

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_assigned: 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. Does not return assigned tasks be default (from Docs, Chat Spaces). A user can have up to 20,000 non-hidden tasks per list and up to 100,000 tasks in total at a time.

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 tasks 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_assigned (Boolean) (defaults to: nil) —

    Optional. Flag indicating whether tasks assigned to the current user are returned in the result. Optional. The default is False.

  • show_completed (Boolean) (defaults to: nil) —

    Flag indicating whether completed tasks are returned in the result. 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. 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) —

    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



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/google/apis/tasks_v1/service.rb', line 445

def list_tasks(tasklist, completed_max: nil, completed_min: nil, due_max: nil, due_min: nil, max_results: nil, page_token: nil, show_assigned: 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['showAssigned'] = show_assigned unless show_assigned.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, destination_tasklist: nil, 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 destination task list. If the destination list is not specified, the task is moved within its current 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. A user can have up to 2,000 subtasks per task.

Parameters:

  • tasklist (String) —

    Task list identifier.

  • task (String) —

    Task identifier.

  • destination_tasklist (String) (defaults to: nil) —

    Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists. Optional.

  • parent (String) (defaults to: nil) —

    New parent task identifier. If the task is moved to the top level, this parameter is omitted. Assigned tasks can not be set as parent task (have subtasks) or be moved under a parent task (become subtasks). 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



504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/google/apis/tasks_v1/service.rb', line 504

def move_task(tasklist, task, destination_tasklist: nil, 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['destinationTasklist'] = destination_tasklist unless destination_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

#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



541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/google/apis/tasks_v1/service.rb', line 541

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



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/google/apis/tasks_v1/service.rb', line 202

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



577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/google/apis/tasks_v1/service.rb', line 577

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



235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/google/apis/tasks_v1/service.rb', line 235

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