The "jobs" collection of methods.
More...
|
| 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.
|
|
|
| convertToArrayAndStripNulls ($o) |
|
The "jobs" collection of methods.
Typical usage is: $coordinateService = new Google_Service_Coordinate(...); $jobs = $coordinateService->jobs;
◆ 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
-
◆ 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 | $teamId | Team ID |
string | $jobId | Job number |
array | $optParams | Optional parameters. |
- Return values
-
◆ 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 | $teamId | Team ID |
string | $address | Job address as newline (Unix) separated string |
double | $lat | The latitude coordinate of this job's location. |
double | $lng | The longitude coordinate of this job's location. |
string | $title | Job title |
Google_Job | $postBody | |
array | $optParams | Optional 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
-
◆ listJobs()
Google_Service_Coordinate_Jobs_Resource::listJobs |
( |
| $teamId, |
|
|
| $optParams = array() ) |
Retrieves jobs created or modified since the given timestamp.
(jobs.listJobs)
- Parameters
-
string | $teamId | Team ID |
array | $optParams | Optional 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
-
◆ patch()
Updates a job.
Fields that are set in the job state will be updated. This method supports patch semantics. (jobs.patch)
- Parameters
-
string | $teamId | Team ID |
string | $jobId | Job number |
Google_Job | $postBody | |
array | $optParams | Optional 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
-
◆ update()
Updates a job.
Fields that are set in the job state will be updated. (jobs.update)
- Parameters
-
string | $teamId | Team ID |
string | $jobId | Job number |
Google_Job | $postBody | |
array | $optParams | Optional 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
-
The documentation for this class was generated from the following file:
- lib/google/src/Google/Service/Coordinate.php