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

The "orgunits" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Orgunits_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($customerId, $orgUnitPath, $optParams=array())
 Remove Organization Unit (orgunits.delete)
 
 get ($customerId, $orgUnitPath, $optParams=array())
 Retrieve Organization Unit (orgunits.get)
 
 insert ($customerId, Google_Service_Directory_OrgUnit $postBody, $optParams=array())
 Add Organization Unit (orgunits.insert)
 
 listOrgunits ($customerId, $optParams=array())
 Retrieve all Organization Units (orgunits.listOrgunits)
 
 patch ($customerId, $orgUnitPath, Google_Service_Directory_OrgUnit $postBody, $optParams=array())
 Update Organization Unit.
 
 update ($customerId, $orgUnitPath, Google_Service_Directory_OrgUnit $postBody, $optParams=array())
 Update Organization Unit (orgunits.update)
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "orgunits" collection of methods.

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

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

◆ delete()

Google_Service_Directory_Orgunits_Resource::delete ( $customerId,
$orgUnitPath,
$optParams = array() )

Remove Organization Unit (orgunits.delete)

Parameters
string$customerIdImmutable id of the Google Apps account
string$orgUnitPathFull path of the organization unit or its Id
array$optParamsOptional parameters.

◆ get()

Google_Service_Directory_Orgunits_Resource::get ( $customerId,
$orgUnitPath,
$optParams = array() )

Retrieve Organization Unit (orgunits.get)

Parameters
string$customerIdImmutable id of the Google Apps account
string$orgUnitPathFull path of the organization unit or its Id
array$optParamsOptional parameters.
Return values
Google_Service_Directory_OrgUnit

◆ insert()

Google_Service_Directory_Orgunits_Resource::insert ( $customerId,
Google_Service_Directory_OrgUnit $postBody,
$optParams = array() )

Add Organization Unit (orgunits.insert)

Parameters
string$customerIdImmutable id of the Google Apps account
Google_OrgUnit$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_OrgUnit

◆ listOrgunits()

Google_Service_Directory_Orgunits_Resource::listOrgunits ( $customerId,
$optParams = array() )

Retrieve all Organization Units (orgunits.listOrgunits)

Parameters
string$customerIdImmutable id of the Google Apps account
array$optParamsOptional parameters.

@opt_param string type Whether to return all sub-organizations or just immediate children @opt_param string orgUnitPath the URL-encoded organization unit's path or its Id

Return values
Google_Service_Directory_OrgUnits

◆ patch()

Google_Service_Directory_Orgunits_Resource::patch ( $customerId,
$orgUnitPath,
Google_Service_Directory_OrgUnit $postBody,
$optParams = array() )

Update Organization Unit.

This method supports patch semantics. (orgunits.patch)

Parameters
string$customerIdImmutable id of the Google Apps account
string$orgUnitPathFull path of the organization unit or its Id
Google_OrgUnit$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_OrgUnit

◆ update()

Google_Service_Directory_Orgunits_Resource::update ( $customerId,
$orgUnitPath,
Google_Service_Directory_OrgUnit $postBody,
$optParams = array() )

Update Organization Unit (orgunits.update)

Parameters
string$customerIdImmutable id of the Google Apps account
string$orgUnitPathFull path of the organization unit or its Id
Google_OrgUnit$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_OrgUnit

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