Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 368 lines (9 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 11 classes
Google_Service_Script:: (1 method):
__construct()
Google_Service_Script_Scripts_Resource:: (1 method):
run()
Google_Service_Script_ExecutionError:: (6 methods):
setErrorMessage()
getErrorMessage()
setErrorType()
getErrorType()
setScriptStackTraceElements()
getScriptStackTraceElements()
Google_Service_Script_ExecutionRequest:: (8 methods):
setDevMode()
getDevMode()
setFunction()
getFunction()
setParameters()
getParameters()
setSessionState()
getSessionState()
Google_Service_Script_ExecutionResponse:: (2 methods):
setResult()
getResult()
Google_Service_Script_Operation:: (10 methods):
setDone()
getDone()
setError()
getError()
setMetadata()
getMetadata()
setName()
getName()
setResponse()
getResponse()
Google_Service_Script_OperationMetadata:: (0 methods):
Google_Service_Script_OperationResponse:: (0 methods):
Google_Service_Script_ScriptStackTraceElement:: (4 methods):
setFunction()
getFunction()
setLineNumber()
getLineNumber()
Google_Service_Script_Status:: (6 methods):
setCode()
getCode()
setDetails()
getDetails()
setMessage()
getMessage()
Google_Service_Script_StatusDetails:: (0 methods):
Class: Google_Service_Script - X-Ref
Service definition for Script (v1).<p>
An API for executing Google Apps Script projects.</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/apps-script/execution/rest/v1/run" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Script service. param: Google_Client $client |
Class: Google_Service_Script_Scripts_Resource - X-Ref
The "scripts" collection of methods.Typical usage is:
<code>
$scriptService = new Google_Service_Script(...);
$scripts = $scriptService->scripts;
</code>
| run($scriptId, Google_Service_Script_ExecutionRequest $postBody, $optParams = array() X-Ref |
| Runs a function in an Apps Script project that has been deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authentication](#authentication) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab. (scripts.run) param: string $scriptId The project key of the script to be executed. To find param: Google_ExecutionRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Script_Operation |
Class: Google_Service_Script_ExecutionError - X-Ref
| setErrorMessage($errorMessage) X-Ref |
| No description |
| getErrorMessage() X-Ref |
| No description |
| setErrorType($errorType) X-Ref |
| No description |
| getErrorType() X-Ref |
| No description |
| setScriptStackTraceElements($scriptStackTraceElements) X-Ref |
| No description |
| getScriptStackTraceElements() X-Ref |
| No description |
Class: Google_Service_Script_ExecutionRequest - X-Ref
| setDevMode($devMode) X-Ref |
| No description |
| getDevMode() X-Ref |
| No description |
| setFunction($function) X-Ref |
| No description |
| getFunction() X-Ref |
| No description |
| setParameters($parameters) X-Ref |
| No description |
| getParameters() X-Ref |
| No description |
| setSessionState($sessionState) X-Ref |
| No description |
| getSessionState() X-Ref |
| No description |
Class: Google_Service_Script_Operation - X-Ref
| setDone($done) X-Ref |
| No description |
| getDone() X-Ref |
| No description |
| setError(Google_Service_Script_Status $error) X-Ref |
| No description |
| getError() X-Ref |
| No description |
| setMetadata($metadata) X-Ref |
| No description |
| getMetadata() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setResponse($response) X-Ref |
| No description |
| getResponse() X-Ref |
| No description |
Class: Google_Service_Script_ScriptStackTraceElement - X-Ref
| setFunction($function) X-Ref |
| No description |
| getFunction() X-Ref |
| No description |
| setLineNumber($lineNumber) X-Ref |
| No description |
| getLineNumber() X-Ref |
| No description |
Class: Google_Service_Script_Status - X-Ref
| setCode($code) X-Ref |
| No description |
| getCode() X-Ref |
| No description |
| setDetails($details) X-Ref |
| No description |
| getDetails() X-Ref |
| No description |
| setMessage($message) X-Ref |
| No description |
| getMessage() X-Ref |
| No description |
Class: Google_Service_Script_StatusDetails - X-Ref
