* The Google App State API. *

* *

* For more information about this service, see the API * Documentation *

* * @author Google, Inc. */ class Google_Service_AppState extends Google_Service { /** View and manage your data for this application. */ const APPSTATE = "https://www.googleapis.com/auth/appstate"; public $states; /** * Constructs the internal representation of the AppState service. * * @param Google_Client $client */ public function __construct(Google_Client $client) { parent::__construct($client); $this->servicePath = 'appstate/v1/'; $this->version = 'v1'; $this->serviceName = 'appstate'; $this->states = new Google_Service_AppState_States_Resource( $this, $this->serviceName, 'states', array( 'methods' => array( 'clear' => array( 'path' => 'states/{stateKey}/clear', 'httpMethod' => 'POST', 'parameters' => array( 'stateKey' => array( 'location' => 'path', 'type' => 'integer', 'required' => true, ), 'currentDataVersion' => array( 'location' => 'query', 'type' => 'string', ), ), ),'delete' => array( 'path' => 'states/{stateKey}', 'httpMethod' => 'DELETE', 'parameters' => array( 'stateKey' => array( 'location' => 'path', 'type' => 'integer', 'required' => true, ), ), ),'get' => array( 'path' => 'states/{stateKey}', 'httpMethod' => 'GET', 'parameters' => array( 'stateKey' => array( 'location' => 'path', 'type' => 'integer', 'required' => true, ), ), ),'list' => array( 'path' => 'states', 'httpMethod' => 'GET', 'parameters' => array( 'includeData' => array( 'location' => 'query', 'type' => 'boolean', ), ), ),'update' => array( 'path' => 'states/{stateKey}', 'httpMethod' => 'PUT', 'parameters' => array( 'stateKey' => array( 'location' => 'path', 'type' => 'integer', 'required' => true, ), 'currentStateVersion' => array( 'location' => 'query', 'type' => 'string', ), ), ), ) ) ); } } /** * The "states" collection of methods. * Typical usage is: * * $appstateService = new Google_Service_AppState(...); * $states = $appstateService->states; * */ class Google_Service_AppState_States_Resource extends Google_Service_Resource { /** * 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. * * @opt_param string currentDataVersion * The version of the data to be cleared. Version strings are returned by the server. * @return Google_Service_AppState_WriteResult */ public function clear($stateKey, $optParams = array()) { $params = array('stateKey' => $stateKey); $params = array_merge($params, $optParams); return $this->call('clear', array($params), "Google_Service_AppState_WriteResult"); } /** * 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. */ public function delete($stateKey, $optParams = array()) { $params = array('stateKey' => $stateKey); $params = array_merge($params, $optParams); return $this->call('delete', array($params)); } /** * 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 */ public function get($stateKey, $optParams = array()) { $params = array('stateKey' => $stateKey); $params = array_merge($params, $optParams); return $this->call('get', array($params), "Google_Service_AppState_GetResponse"); } /** * Lists all the states keys, and optionally the state data. (states.listStates) * * @param array $optParams Optional parameters. * * @opt_param bool includeData * Whether to include the full data in addition to the version number * @return Google_Service_AppState_ListResponse */ public function listStates($optParams = array()) { $params = array(); $params = array_merge($params, $optParams); return $this->call('list', array($params), "Google_Service_AppState_ListResponse"); } /** * 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. * * @opt_param string currentStateVersion * The version of the app state your application is attempting to update. If this does not match * the current version, this method will return a conflict error. If there is no data stored on the * server for this key, the update will succeed irrespective of the value of this parameter. * @return Google_Service_AppState_WriteResult */ public function update($stateKey, Google_Service_AppState_UpdateRequest $postBody, $optParams = array()) { $params = array('stateKey' => $stateKey, 'postBody' => $postBody); $params = array_merge($params, $optParams); return $this->call('update', array($params), "Google_Service_AppState_WriteResult"); } } class Google_Service_AppState_GetResponse extends Google_Model { public $currentStateVersion; public $data; public $kind; public $stateKey; public function setCurrentStateVersion($currentStateVersion) { $this->currentStateVersion = $currentStateVersion; } public function getCurrentStateVersion() { return $this->currentStateVersion; } public function setData($data) { $this->data = $data; } public function getData() { return $this->data; } public function setKind($kind) { $this->kind = $kind; } public function getKind() { return $this->kind; } public function setStateKey($stateKey) { $this->stateKey = $stateKey; } public function getStateKey() { return $this->stateKey; } } class Google_Service_AppState_ListResponse extends Google_Collection { protected $collection_key = 'items'; protected $itemsType = 'Google_Service_AppState_GetResponse'; protected $itemsDataType = 'array'; public $kind; public $maximumKeyCount; public function setItems($items) { $this->items = $items; } public function getItems() { return $this->items; } public function setKind($kind) { $this->kind = $kind; } public function getKind() { return $this->kind; } public function setMaximumKeyCount($maximumKeyCount) { $this->maximumKeyCount = $maximumKeyCount; } public function getMaximumKeyCount() { return $this->maximumKeyCount; } } class Google_Service_AppState_UpdateRequest extends Google_Model { public $data; public $kind; public function setData($data) { $this->data = $data; } public function getData() { return $this->data; } public function setKind($kind) { $this->kind = $kind; } public function getKind() { return $this->kind; } } class Google_Service_AppState_WriteResult extends Google_Model { public $currentStateVersion; public $kind; public $stateKey; public function setCurrentStateVersion($currentStateVersion) { $this->currentStateVersion = $currentStateVersion; } public function getCurrentStateVersion() { return $this->currentStateVersion; } public function setKind($kind) { $this->kind = $kind; } public function getKind() { return $this->kind; } public function setStateKey($stateKey) { $this->stateKey = $stateKey; } public function getStateKey() { return $this->stateKey; } }