Documentation

Google_Service_Coordinate_Resource_Jobs extends Google_Service_Resource
in package

The "jobs" collection of methods.

Typical usage is: $coordinateService = new Google_Service_Coordinate(...); $jobs = $coordinateService->jobs;

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Coordinate_Job
Retrieves a job, including all the changes made to the job. (jobs.get)
insert()  : Google_Service_Coordinate_Job
Inserts a new job. Only the state field of the job should be set.
listJobs()  : Google_Service_Coordinate_JobListResponse
Retrieves jobs created or modified since the given timestamp. (jobs.listJobs)
patch()  : Google_Service_Coordinate_Job
Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics. (jobs.patch)
update()  : Google_Service_Coordinate_Job
Updates a job. Fields that are set in the job state will be updated.
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

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

get()

Retrieves a job, including all the changes made to the job. (jobs.get)

public get(string $teamId, string $jobId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Coordinate_Job
Parameters
$teamId : string

Team ID

$jobId : string

Job number

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

Optional parameters.

Return values
Google_Service_Coordinate_Job

insert()

Inserts a new job. Only the state field of the job should be set.

public insert(string $teamId, string $address, float $lat, float $lng, string $title, Google_Service_Coordinate_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Coordinate_Job

(jobs.insert)

Parameters
$teamId : string

Team ID

$address : string

Job address as newline (Unix) separated string

$lat : float

The latitude coordinate of this job's location.

$lng : float

The longitude coordinate of this job's location.

$title : string

Job title

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

Optional parameters.

Tags
opt_param

string assignee Assignee email address, or empty string to unassign.

opt_param

string customField Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.

opt_param

string customerName Customer name

opt_param

string customerPhoneNumber Customer phone number

opt_param

string note Job note as newline (Unix) separated string

Return values
Google_Service_Coordinate_Job

listJobs()

Retrieves jobs created or modified since the given timestamp. (jobs.listJobs)

public listJobs(string $teamId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Coordinate_JobListResponse
Parameters
$teamId : string

Team ID

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

Optional parameters.

Tags
opt_param

string maxResults Maximum number of results to return in one page.

opt_param

string minModifiedTimestampMs Minimum time a job was modified in milliseconds since epoch.

opt_param

bool omitJobChanges Whether to omit detail job history information.

opt_param

string pageToken Continuation token

Return values
Google_Service_Coordinate_JobListResponse

patch()

Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics. (jobs.patch)

public patch(string $teamId, string $jobId, Google_Service_Coordinate_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Coordinate_Job
Parameters
$teamId : string

Team ID

$jobId : string

Job number

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

Optional parameters.

Tags
opt_param

string address Job address as newline (Unix) separated string

opt_param

string assignee Assignee email address, or empty string to unassign.

opt_param

string customField Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.

opt_param

string customerName Customer name

opt_param

string customerPhoneNumber Customer phone number

opt_param

double lat The latitude coordinate of this job's location.

opt_param

double lng The longitude coordinate of this job's location.

opt_param

string note Job note as newline (Unix) separated string

opt_param

string progress Job progress

opt_param

string title Job title

Return values
Google_Service_Coordinate_Job

update()

Updates a job. Fields that are set in the job state will be updated.

public update(string $teamId, string $jobId, Google_Service_Coordinate_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Coordinate_Job

(jobs.update)

Parameters
$teamId : string

Team ID

$jobId : string

Job number

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

Optional parameters.

Tags
opt_param

string address Job address as newline (Unix) separated string

opt_param

string assignee Assignee email address, or empty string to unassign.

opt_param

string customField Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.

opt_param

string customerName Customer name

opt_param

string customerPhoneNumber Customer phone number

opt_param

double lat The latitude coordinate of this job's location.

opt_param

double lng The longitude coordinate of this job's location.

opt_param

string note Job note as newline (Unix) separated string

opt_param

string progress Job progress

opt_param

string title Job title

Return values
Google_Service_Coordinate_Job

convertToArrayAndStripNulls()

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

Search results