Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Coordinate_Jobs_Resource Class Reference

The "jobs" collection of methods. More...

Inheritance diagram for Google_Service_Coordinate_Jobs_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($teamId, $jobId, $optParams=array())
 Retrieves a job, including all the changes made to the job.
 
 insert ($teamId, $address, $lat, $lng, $title, Google_Service_Coordinate_Job $postBody, $optParams=array())
 Inserts a new job.
 
 listJobs ($teamId, $optParams=array())
 Retrieves jobs created or modified since the given timestamp.
 
 patch ($teamId, $jobId, Google_Service_Coordinate_Job $postBody, $optParams=array())
 Updates a job.
 
 update ($teamId, $jobId, Google_Service_Coordinate_Job $postBody, $optParams=array())
 Updates a job.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "jobs" collection of methods.

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

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

◆ get()

Google_Service_Coordinate_Jobs_Resource::get ( $teamId,
$jobId,
$optParams = array() )

Retrieves a job, including all the changes made to the job.

(jobs.get)

Parameters
string$teamIdTeam ID
string$jobIdJob number
array$optParamsOptional parameters.
Return values
Google_Service_Coordinate_Job

◆ insert()

Google_Service_Coordinate_Jobs_Resource::insert ( $teamId,
$address,
$lat,
$lng,
$title,
Google_Service_Coordinate_Job $postBody,
$optParams = array() )

Inserts a new job.

Only the state field of the job should be set. (jobs.insert)

Parameters
string$teamIdTeam ID
string$addressJob address as newline (Unix) separated string
double$latThe latitude coordinate of this job's location.
double$lngThe longitude coordinate of this job's location.
string$titleJob title
Google_Job$postBody
array$optParamsOptional parameters.

@opt_param string customerName Customer name @opt_param string note Job note as newline (Unix) separated string @opt_param string assignee Assignee email address, or empty string to unassign. @opt_param string customerPhoneNumber Customer phone number @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.

Return values
Google_Service_Coordinate_Job

◆ listJobs()

Google_Service_Coordinate_Jobs_Resource::listJobs ( $teamId,
$optParams = array() )

Retrieves jobs created or modified since the given timestamp.

(jobs.listJobs)

Parameters
string$teamIdTeam ID
array$optParamsOptional parameters.

@opt_param string minModifiedTimestampMs Minimum time a job was modified in milliseconds since epoch. @opt_param string pageToken Continuation token @opt_param string maxResults Maximum number of results to return in one page. @opt_param bool omitJobChanges Whether to omit detail job history information.

Return values
Google_Service_Coordinate_JobListResponse

◆ patch()

Google_Service_Coordinate_Jobs_Resource::patch ( $teamId,
$jobId,
Google_Service_Coordinate_Job $postBody,
$optParams = array() )

Updates a job.

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

Parameters
string$teamIdTeam ID
string$jobIdJob number
Google_Job$postBody
array$optParamsOptional parameters.

@opt_param string customerName Customer name @opt_param string title Job title @opt_param string note Job note as newline (Unix) separated string @opt_param string assignee Assignee email address, or empty string to unassign. @opt_param string customerPhoneNumber Customer phone number @opt_param string address Job address as newline (Unix) separated string @opt_param double lat The latitude coordinate of this job's location. @opt_param string progress Job progress @opt_param double lng The longitude coordinate of this job's location. @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.

Return values
Google_Service_Coordinate_Job

◆ update()

Google_Service_Coordinate_Jobs_Resource::update ( $teamId,
$jobId,
Google_Service_Coordinate_Job $postBody,
$optParams = array() )

Updates a job.

Fields that are set in the job state will be updated. (jobs.update)

Parameters
string$teamIdTeam ID
string$jobIdJob number
Google_Job$postBody
array$optParamsOptional parameters.

@opt_param string customerName Customer name @opt_param string title Job title @opt_param string note Job note as newline (Unix) separated string @opt_param string assignee Assignee email address, or empty string to unassign. @opt_param string customerPhoneNumber Customer phone number @opt_param string address Job address as newline (Unix) separated string @opt_param double lat The latitude coordinate of this job's location. @opt_param string progress Job progress @opt_param double lng The longitude coordinate of this job's location. @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.

Return values
Google_Service_Coordinate_Job

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