Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Appengine_AppsModules_Resource Class Reference

The "modules" collection of methods. More...

Inheritance diagram for Google_Service_Appengine_AppsModules_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($appsId, $modulesId, $optParams=array())
 Deletes a module and all enclosed versions.
 
 get ($appsId, $modulesId, $optParams=array())
 Gets the current configuration of the module.
 
 listAppsModules ($appsId, $optParams=array())
 Lists all the modules in the application.
 
 patch ($appsId, $modulesId, Google_Service_Appengine_Module $postBody, $optParams=array())
 Updates the configuration of the specified module.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "modules" collection of methods.

Typical usage is: $appengineService = new Google_Service_Appengine(...); $modules = $appengineService->modules;

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_Appengine_AppsModules_Resource::delete ( $appsId,
$modulesId,
$optParams = array() )

Deletes a module and all enclosed versions.

(modules.delete)

Parameters
string$appsIdPart of name. Name of the resource requested. For example: "apps/myapp/modules/default".
string$modulesIdPart of name. See documentation of appsId.
array$optParamsOptional parameters.
Return values
Google_Service_Appengine_Operation

◆ get()

Google_Service_Appengine_AppsModules_Resource::get ( $appsId,
$modulesId,
$optParams = array() )

Gets the current configuration of the module.

(modules.get)

Parameters
string$appsIdPart of name. Name of the resource requested. For example: "apps/myapp/modules/default".
string$modulesIdPart of name. See documentation of appsId.
array$optParamsOptional parameters.
Return values
Google_Service_Appengine_Module

◆ listAppsModules()

Google_Service_Appengine_AppsModules_Resource::listAppsModules ( $appsId,
$optParams = array() )

Lists all the modules in the application.

(modules.listAppsModules)

Parameters
string$appsIdPart of name. Name of the resource requested. For example: "apps/myapp".
array$optParamsOptional parameters.

@opt_param int pageSize Maximum results to return per page. @opt_param string pageToken Continuation token for fetching the next page of results.

Return values
Google_Service_Appengine_ListModulesResponse

◆ patch()

Google_Service_Appengine_AppsModules_Resource::patch ( $appsId,
$modulesId,
Google_Service_Appengine_Module $postBody,
$optParams = array() )

Updates the configuration of the specified module.

(modules.patch)

Parameters
string$appsIdPart of name. Name of the resource to update. For example: "apps/myapp/modules/default".
string$modulesIdPart of name. See documentation of appsId.
Google_Module$postBody
array$optParamsOptional parameters.

@opt_param bool migrateTraffic Whether to use Traffic Migration to shift traffic gradually. Traffic can only be migrated from a single version to another single version. @opt_param string mask Standard field mask for the set of fields to be updated.

Return values
Google_Service_Appengine_Operation

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