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

The "domainAliases" collection of methods. More...

Inheritance diagram for Google_Service_Directory_DomainAliases_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($customer, $domainAliasName, $optParams=array())
 Deletes a Domain Alias of the customer.
 
 get ($customer, $domainAliasName, $optParams=array())
 Retrieves a domain alias of the customer.
 
 insert ($customer, Google_Service_Directory_DomainAlias $postBody, $optParams=array())
 Inserts a Domain alias of the customer.
 
 listDomainAliases ($customer, $optParams=array())
 Lists the domain aliases of the customer.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "domainAliases" collection of methods.

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

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_DomainAliases_Resource::delete ( $customer,
$domainAliasName,
$optParams = array() )

Deletes a Domain Alias of the customer.

(domainAliases.delete)

Parameters
string$customerImmutable id of the Google Apps account.
string$domainAliasNameName of domain alias to be retrieved.
array$optParamsOptional parameters.

◆ get()

Google_Service_Directory_DomainAliases_Resource::get ( $customer,
$domainAliasName,
$optParams = array() )

Retrieves a domain alias of the customer.

(domainAliases.get)

Parameters
string$customerImmutable id of the Google Apps account.
string$domainAliasNameName of domain alias to be retrieved.
array$optParamsOptional parameters.
Return values
Google_Service_Directory_DomainAlias

◆ insert()

Google_Service_Directory_DomainAliases_Resource::insert ( $customer,
Google_Service_Directory_DomainAlias $postBody,
$optParams = array() )

Inserts a Domain alias of the customer.

(domainAliases.insert)

Parameters
string$customerImmutable id of the Google Apps account.
Google_DomainAlias$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_DomainAlias

◆ listDomainAliases()

Google_Service_Directory_DomainAliases_Resource::listDomainAliases ( $customer,
$optParams = array() )

Lists the domain aliases of the customer.

(domainAliases.listDomainAliases)

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

@opt_param string parentDomainName Name of the parent domain for which domain aliases are to be fetched.

Return values
Google_Service_Directory_DomainAliases

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