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
The Google Tasks API lets you manage your tasks and task lists.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#clear_task(tasklist, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Clears all completed tasks from the specified task list.
-
#delete_task(tasklist, task, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes the specified task from the task list.
-
#delete_tasklist(tasklist, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes the authenticated user's specified task list.
-
#get_task(tasklist, task, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Task
Returns the specified task.
-
#get_tasklist(tasklist, fields: nil, quota_user: 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, 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, 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, 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, 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, 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, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::Task
Updates the specified task.
-
#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.
-
#update_task(tasklist, task, task_object = nil, fields: nil, quota_user: 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, options: nil) {|result, err| ... } ⇒ Google::Apis::TasksV1::TaskList
Updates the authenticated user's specified task list.
Constructor Details
#initialize ⇒ TasksService
Returns a new instance of TasksService.
45 46 47 48 |
# File 'generated/google/apis/tasks_v1/service.rb', line 45 def initialize super('https://tasks.googleapis.com/', '') @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.
38 39 40 |
# File 'generated/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.
43 44 45 |
# File 'generated/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.
261 262 263 264 265 266 267 |
# File 'generated/google/apis/tasks_v1/service.rb', line 261 def clear_task(tasklist, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'tasks/v1/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? 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.
291 292 293 294 295 296 297 298 |
# File 'generated/google/apis/tasks_v1/service.rb', line 291 def delete_task(tasklist, task, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'tasks/v1/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? 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.
70 71 72 73 74 75 76 |
# File 'generated/google/apis/tasks_v1/service.rb', line 70 def delete_tasklist(tasklist, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'tasks/v1/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? 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.
322 323 324 325 326 327 328 329 330 331 |
# File 'generated/google/apis/tasks_v1/service.rb', line 322 def get_task(tasklist, task, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'tasks/v1/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? 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.
98 99 100 101 102 103 104 105 106 |
# File 'generated/google/apis/tasks_v1/service.rb', line 98 def get_tasklist(tasklist, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'tasks/v1/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? 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.
360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'generated/google/apis/tasks_v1/service.rb', line 360 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', ) 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.
127 128 129 130 131 132 133 134 135 136 |
# File 'generated/google/apis/tasks_v1/service.rb', line 127 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', ) 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.
161 162 163 164 165 166 167 168 169 170 |
# File 'generated/google/apis/tasks_v1/service.rb', line 161 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', ) 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.
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
# File 'generated/google/apis/tasks_v1/service.rb', line 424 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', ) 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.
474 475 476 477 478 479 480 481 482 483 484 485 |
# File 'generated/google/apis/tasks_v1/service.rb', line 474 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', ) 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.
510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'generated/google/apis/tasks_v1/service.rb', line 510 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}', ) 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.
194 195 196 197 198 199 200 201 202 203 204 |
# File 'generated/google/apis/tasks_v1/service.rb', line 194 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}', ) 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.
546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'generated/google/apis/tasks_v1/service.rb', line 546 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}', ) 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.
227 228 229 230 231 232 233 234 235 236 237 |
# File 'generated/google/apis/tasks_v1/service.rb', line 227 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}', ) 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 |