The "tasks" collection of methods. More...

Inheritance diagram for Google_Service_Tasks_Tasks_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.

	clear ($tasklist, $optParams=array())
	Clears all completed tasks from the specified task list.

	delete ($tasklist, $task, $optParams=array())
	Deletes the specified task from the task list.

	get ($tasklist, $task, $optParams=array())
	Returns the specified task.

	insert ($tasklist, Google_Service_Tasks_Task $postBody, $optParams=array())
	Creates a new task on the specified task list.

	listTasks ($tasklist, $optParams=array())
	Returns all tasks in the specified task list.

	move ($tasklist, $task, $optParams=array())
	Moves the specified task to another position in the task list.

	patch ($tasklist, $task, Google_Service_Tasks_Task $postBody, $optParams=array())
	Updates the specified task.

	update ($tasklist, $task, Google_Service_Tasks_Task $postBody, $optParams=array())
	Updates the specified task.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "tasks" collection of methods.

Typical usage is: $tasksService = new Google_Service_Tasks(...); $tasks = $tasksService->tasks;

Member Function Documentation

◆ call()

Google_Service_Resource::call	(	$name,
		$arguments,
		$expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

◆ clear()

Google_Service_Tasks_Tasks_Resource::clear	(		$tasklist,
			$optParams = array() )

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. (tasks.clear)

Parameters

string	$tasklist	Task list identifier.
array	$optParams	Optional parameters.

◆ delete()

Google_Service_Tasks_Tasks_Resource::delete	(	$tasklist,
		$task,
		$optParams = array() )

Deletes the specified task from the task list.

(tasks.delete)

Parameters

string	$tasklist	Task list identifier.
string	$task	Task identifier.
array	$optParams	Optional parameters.

◆ get()

Google_Service_Tasks_Tasks_Resource::get	(	$tasklist,
		$task,
		$optParams = array() )

Returns the specified task.

(tasks.get)

Parameters

string	$tasklist	Task list identifier.
string	$task	Task identifier.
array	$optParams	Optional parameters.

Return values

Google_Service_Tasks_Task

◆ insert()

Google_Service_Tasks_Tasks_Resource::insert	(		$tasklist,
		Google_Service_Tasks_Task	$postBody,
			$optParams = array() )

Creates a new task on the specified task list.

(tasks.insert)

Parameters

string	$tasklist	Task list identifier.
Google_Task	$postBody
array	$optParams	Optional parameters.

@opt_param string parent Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional. @opt_param string previous Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.

Return values

Google_Service_Tasks_Task

◆ listTasks()

Google_Service_Tasks_Tasks_Resource::listTasks	(		$tasklist,
			$optParams = array() )

Returns all tasks in the specified task list.

(tasks.listTasks)

Parameters

string	$tasklist	Task list identifier.
array	$optParams	Optional parameters.

@opt_param string dueMax 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. @opt_param bool showDeleted Flag indicating whether deleted tasks are returned in the result. Optional. The default is False. @opt_param string updatedMin 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. @opt_param string completedMin 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. @opt_param string maxResults Maximum number of task lists returned on one page. Optional. The default is 100. @opt_param bool showCompleted Flag indicating whether completed tasks are returned in the result. Optional. The default is True. @opt_param string pageToken Token specifying the result page to return. Optional. @opt_param string completedMax 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. @opt_param bool showHidden Flag indicating whether hidden tasks are returned in the result. Optional. The default is False. @opt_param string dueMin 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.

Return values

Google_Service_Tasks_Tasks

◆ move()

Google_Service_Tasks_Tasks_Resource::move	(	$tasklist,
		$task,
		$optParams = array() )

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. (tasks.move)

Parameters

string	$tasklist	Task list identifier.
string	$task	Task identifier.
array	$optParams	Optional parameters.

@opt_param string parent New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional. @opt_param string previous New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.

Return values

Google_Service_Tasks_Task

◆ patch()

Google_Service_Tasks_Tasks_Resource::patch	(		$tasklist,
			$task,
		Google_Service_Tasks_Task	$postBody,
			$optParams = array() )

Updates the specified task.

This method supports patch semantics. (tasks.patch)

Parameters

string	$tasklist	Task list identifier.
string	$task	Task identifier.
Google_Task	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Tasks_Task

◆ update()

Google_Service_Tasks_Tasks_Resource::update	(		$tasklist,
			$task,
		Google_Service_Tasks_Task	$postBody,
			$optParams = array() )

Updates the specified task.

(tasks.update)

Parameters

string	$tasklist	Task list identifier.
string	$task	Task identifier.
Google_Task	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Tasks_Task

The documentation for this class was generated from the following file:

lib/google/src/Google/Service/Tasks.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ call()

◆ clear()

◆ delete()

◆ get()

◆ insert()

◆ listTasks()

◆ move()

◆ patch()

◆ update()