Documentation

Google_Service_Tasks_Resource_Tasks extends Google_Service_Resource
in package

The "tasks" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
clear()  : mixed
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)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes the specified task from the task list. (tasks.delete)
get()  : Google_Service_Tasks_Task
Returns the specified task. (tasks.get)
insert()  : Google_Service_Tasks_Task
Creates a new task on the specified task list. (tasks.insert)
listTasks()  : Google_Service_Tasks_Tasks
Returns all tasks in the specified task list. (tasks.listTasks)
move()  : Google_Service_Tasks_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. (tasks.move)
patch()  : Google_Service_Tasks_Task
Updates the specified task. This method supports patch semantics.
update()  : Google_Service_Tasks_Task
Updates the specified task. (tasks.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

clear()

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)

public clear(string $tasklist[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$tasklist : string

Task list identifier.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes the specified task from the task list. (tasks.delete)

public delete(string $tasklist, string $task[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$tasklist : string

Task list identifier.

$task : string

Task identifier.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

get()

Returns the specified task. (tasks.get)

public get(string $tasklist, string $task[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Tasks_Task
Parameters
$tasklist : string

Task list identifier.

$task : string

Task identifier.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Tasks_Task —

insert()

Creates a new task on the specified task list. (tasks.insert)

public insert(string $tasklist, Google_Service_Tasks_Task $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Tasks_Task
Parameters
$tasklist : string

Task list identifier.

$postBody : Google_Service_Tasks_Task
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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()

Returns all tasks in the specified task list. (tasks.listTasks)

public listTasks(string $tasklist[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Tasks_Tasks
Parameters
$tasklist : string

Task list identifier.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int maxResults Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).

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

bool showDeleted Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.

opt_param

string pageToken Token specifying the result page to return. Optional.

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.

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

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

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

bool showCompleted 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.

Return values
Google_Service_Tasks_Tasks —

move()

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)

public move(string $tasklist, string $task[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Tasks_Task
Parameters
$tasklist : string

Task list identifier.

$task : string

Task identifier.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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()

Updates the specified task. This method supports patch semantics.

public patch(string $tasklist, string $task, Google_Service_Tasks_Task $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Tasks_Task

(tasks.patch)

Parameters
$tasklist : string

Task list identifier.

$task : string

Task identifier.

$postBody : Google_Service_Tasks_Task
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Tasks_Task —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results