Class: Google::Apis::TasksV1::TasksService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::TasksV1::TasksService
- Defined in:
- generated/google/apis/tasks_v1/service.rb
Overview
Tasks API
Lets you manage your tasks and task lists.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
An opaque string that represents a user for quota purposes.
-
#user_ip ⇒ String
Deprecated.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#clear_task(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Clears all completed tasks from the specified task list.
-
#delete_task(tasklist, task, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes the specified task from the task list.
-
#delete_tasklist(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes the authenticated user's specified task list.
-
#get_task(tasklist, task, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Task
Returns the specified task.
-
#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.
-
#initialize ⇒ TasksService
constructor
A new instance of TasksService.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ TasksService
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
#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.
38 39 40 |
# File 'generated/google/apis/tasks_v1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns 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_ip ⇒ String
Returns 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.
285 286 287 288 289 290 291 292 |
# File 'generated/google/apis/tasks_v1/service.rb', line 285 def clear_task(tasklist, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'lists/{tasklist}/clear', ) 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.
318 319 320 321 322 323 324 325 326 |
# File 'generated/google/apis/tasks_v1/service.rb', line 318 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}', ) 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.
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}', ) 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.
352 353 354 355 356 357 358 359 360 361 362 |
# File 'generated/google/apis/tasks_v1/service.rb', line 352 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}', ) 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.
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}', ) 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.
393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
# File 'generated/google/apis/tasks_v1/service.rb', line 393 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', ) 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.
139 140 141 142 143 144 145 146 147 148 149 |
# File 'generated/google/apis/tasks_v1/service.rb', line 139 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', ) 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.
176 177 178 179 180 181 182 183 184 185 186 |
# File 'generated/google/apis/tasks_v1/service.rb', line 176 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', ) 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.
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 |
# File 'generated/google/apis/tasks_v1/service.rb', line 459 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', ) 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.
512 513 514 515 516 517 518 519 520 521 522 523 524 |
# File 'generated/google/apis/tasks_v1/service.rb', line 512 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', ) 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.
551 552 553 554 555 556 557 558 559 560 561 562 563 |
# File 'generated/google/apis/tasks_v1/service.rb', line 551 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}', ) 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.
212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'generated/google/apis/tasks_v1/service.rb', line 212 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}', ) 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.
590 591 592 593 594 595 596 597 598 599 600 601 602 |
# File 'generated/google/apis/tasks_v1/service.rb', line 590 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}', ) 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.
248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'generated/google/apis/tasks_v1/service.rb', line 248 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}', ) 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 |