Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
Differences Between: [Versions 310 and 402] [Versions 310 and 403]
(no description)
| File Size: | 369 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 6 classes
Google_Service_AppState:: (1 method):
__construct()
Google_Service_AppState_States_Resource:: (5 methods):
clear()
delete()
get()
listStates()
update()
Google_Service_AppState_GetResponse:: (8 methods):
setCurrentStateVersion()
getCurrentStateVersion()
setData()
getData()
setKind()
getKind()
setStateKey()
getStateKey()
Google_Service_AppState_ListResponse:: (6 methods):
setItems()
getItems()
setKind()
getKind()
setMaximumKeyCount()
getMaximumKeyCount()
Google_Service_AppState_UpdateRequest:: (4 methods):
setData()
getData()
setKind()
getKind()
Google_Service_AppState_WriteResult:: (6 methods):
setCurrentStateVersion()
getCurrentStateVersion()
setKind()
getKind()
setStateKey()
getStateKey()
Class: Google_Service_AppState - X-Ref
Service definition for AppState (v1).<p>
The Google App State API.</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/games/services/web/api/states" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the AppState service. param: Google_Client $client |
Class: Google_Service_AppState_States_Resource - X-Ref
The "states" collection of methods.Typical usage is:
<code>
$appstateService = new Google_Service_AppState(...);
$states = $appstateService->states;
</code>
| clear($stateKey, $optParams = array() X-Ref |
| Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch. (states.clear) param: int $stateKey The key for the data to be retrieved. param: array $optParams Optional parameters. return: Google_Service_AppState_WriteResult |
| delete($stateKey, $optParams = array() X-Ref |
| Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption. (states.delete) param: int $stateKey The key for the data to be retrieved. param: array $optParams Optional parameters. |
| get($stateKey, $optParams = array() X-Ref |
| Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned. (states.get) param: int $stateKey The key for the data to be retrieved. param: array $optParams Optional parameters. return: Google_Service_AppState_GetResponse |
| listStates($optParams = array() X-Ref |
| Lists all the states keys, and optionally the state data. (states.listStates) param: array $optParams Optional parameters. return: Google_Service_AppState_ListResponse |
| update($stateKey, Google_Service_AppState_UpdateRequest $postBody, $optParams = array() X-Ref |
| Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB. (states.update) param: int $stateKey The key for the data to be retrieved. param: Google_UpdateRequest $postBody param: array $optParams Optional parameters. return: Google_Service_AppState_WriteResult |
Class: Google_Service_AppState_GetResponse - X-Ref
| setCurrentStateVersion($currentStateVersion) X-Ref |
| No description |
| getCurrentStateVersion() X-Ref |
| No description |
| setData($data) X-Ref |
| No description |
| getData() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setStateKey($stateKey) X-Ref |
| No description |
| getStateKey() X-Ref |
| No description |
Class: Google_Service_AppState_ListResponse - X-Ref
| setItems($items) X-Ref |
| No description |
| getItems() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setMaximumKeyCount($maximumKeyCount) X-Ref |
| No description |
| getMaximumKeyCount() X-Ref |
| No description |
Class: Google_Service_AppState_WriteResult - X-Ref
| setCurrentStateVersion($currentStateVersion) X-Ref |
| No description |
| getCurrentStateVersion() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setStateKey($stateKey) X-Ref |
| No description |
| getStateKey() X-Ref |
| No description |
