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

The "schemas" collection of methods. More...

Inheritance diagram for Google_Service_Directory_Schemas_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($customerId, $schemaKey, $optParams=array())
 Delete schema (schemas.delete)
 
 get ($customerId, $schemaKey, $optParams=array())
 Retrieve schema (schemas.get)
 
 insert ($customerId, Google_Service_Directory_Schema $postBody, $optParams=array())
 Create schema.
 
 listSchemas ($customerId, $optParams=array())
 Retrieve all schemas for a customer (schemas.listSchemas)
 
 patch ($customerId, $schemaKey, Google_Service_Directory_Schema $postBody, $optParams=array())
 Update schema.
 
 update ($customerId, $schemaKey, Google_Service_Directory_Schema $postBody, $optParams=array())
 Update schema (schemas.update)
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "schemas" collection of methods.

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

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_Schemas_Resource::delete ( $customerId,
$schemaKey,
$optParams = array() )

Delete schema (schemas.delete)

Parameters
string$customerIdImmutable id of the Google Apps account
string$schemaKeyName or immutable Id of the schema
array$optParamsOptional parameters.

◆ get()

Google_Service_Directory_Schemas_Resource::get ( $customerId,
$schemaKey,
$optParams = array() )

Retrieve schema (schemas.get)

Parameters
string$customerIdImmutable id of the Google Apps account
string$schemaKeyName or immutable Id of the schema
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Schema

◆ insert()

Google_Service_Directory_Schemas_Resource::insert ( $customerId,
Google_Service_Directory_Schema $postBody,
$optParams = array() )

Create schema.

(schemas.insert)

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

◆ listSchemas()

Google_Service_Directory_Schemas_Resource::listSchemas ( $customerId,
$optParams = array() )

Retrieve all schemas for a customer (schemas.listSchemas)

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

◆ patch()

Google_Service_Directory_Schemas_Resource::patch ( $customerId,
$schemaKey,
Google_Service_Directory_Schema $postBody,
$optParams = array() )

Update schema.

This method supports patch semantics. (schemas.patch)

Parameters
string$customerIdImmutable id of the Google Apps account
string$schemaKeyName or immutable Id of the schema.
Google_Schema$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Schema

◆ update()

Google_Service_Directory_Schemas_Resource::update ( $customerId,
$schemaKey,
Google_Service_Directory_Schema $postBody,
$optParams = array() )

Update schema (schemas.update)

Parameters
string$customerIdImmutable id of the Google Apps account
string$schemaKeyName or immutable Id of the schema.
Google_Schema$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_Schema

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