Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Directory_Customers_Resource Class Reference

The "customers" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Customers_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($customerKey, $optParams=array())
 Retrives a customer.
 
 patch ($customerKey, Google_Service_Directory_Customer $postBody, $optParams=array())
 Updates a customer.
 
 update ($customerKey, Google_Service_Directory_Customer $postBody, $optParams=array())
 Updates a customer.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "customers" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $customers = $adminService->customers;

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_Directory_Customers_Resource::get ( $customerKey,
$optParams = array() )

Retrives a customer.

(customers.get)

Parameters
string$customerKeyId of the customer to be retrieved
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Customer

◆ patch()

Google_Service_Directory_Customers_Resource::patch ( $customerKey,
Google_Service_Directory_Customer $postBody,
$optParams = array() )

Updates a customer.

This method supports patch semantics. (customers.patch)

Parameters
string$customerKeyId of the customer to be updated
Google_Customer$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Customer

◆ update()

Google_Service_Directory_Customers_Resource::update ( $customerKey,
Google_Service_Directory_Customer $postBody,
$optParams = array() )

Updates a customer.

(customers.update)

Parameters
string$customerKeyId of the customer to be updated
Google_Customer$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Customer

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