Search moodle.org's
Developer Documentation

See Release Notes

  • 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.
<?php
/*
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

/**
 * Service definition for SiteVerification (v1).
 *
 * <p>
 * Lets you programatically verify ownership of websites or domains with Google.</p>
 *
 * <p>
 * For more information about this service, see the API
 * <a href="https://developers.google.com/site-verification/" target="_blank">Documentation</a>
 * </p>
 *
 * @author Google, Inc.
 */
> #[AllowDynamicProperties]
class Google_Service_SiteVerification extends Google_Service { /** Manage the list of sites and domains you control. */ const SITEVERIFICATION = "https://www.googleapis.com/auth/siteverification"; /** Manage your new site verifications with Google. */ const SITEVERIFICATION_VERIFY_ONLY = "https://www.googleapis.com/auth/siteverification.verify_only"; public $webResource; /** * Constructs the internal representation of the SiteVerification service. * * @param Google_Client $client */ public function __construct(Google_Client $client) { parent::__construct($client); $this->rootUrl = 'https://www.googleapis.com/'; $this->servicePath = 'siteVerification/v1/'; $this->version = 'v1'; $this->serviceName = 'siteVerification'; $this->webResource = new Google_Service_SiteVerification_WebResource_Resource( $this, $this->serviceName, 'webResource', array( 'methods' => array( 'delete' => array( 'path' => 'webResource/{id}', 'httpMethod' => 'DELETE', 'parameters' => array( 'id' => array( 'location' => 'path', 'type' => 'string', 'required' => true, ), ), ),'get' => array( 'path' => 'webResource/{id}', 'httpMethod' => 'GET', 'parameters' => array( 'id' => array( 'location' => 'path', 'type' => 'string', 'required' => true, ), ), ),'getToken' => array( 'path' => 'token', 'httpMethod' => 'POST', 'parameters' => array(), ),'insert' => array( 'path' => 'webResource', 'httpMethod' => 'POST', 'parameters' => array( 'verificationMethod' => array( 'location' => 'query', 'type' => 'string', 'required' => true, ), ), ),'list' => array( 'path' => 'webResource', 'httpMethod' => 'GET', 'parameters' => array(), ),'patch' => array( 'path' => 'webResource/{id}', 'httpMethod' => 'PATCH', 'parameters' => array( 'id' => array( 'location' => 'path', 'type' => 'string', 'required' => true, ), ), ),'update' => array( 'path' => 'webResource/{id}', 'httpMethod' => 'PUT', 'parameters' => array( 'id' => array( 'location' => 'path', 'type' => 'string', 'required' => true, ), ), ), ) ) ); } } /** * The "webResource" collection of methods. * Typical usage is: * <code> * $siteVerificationService = new Google_Service_SiteVerification(...); * $webResource = $siteVerificationService->webResource; * </code> */
> #[AllowDynamicProperties]
class Google_Service_SiteVerification_WebResource_Resource extends Google_Service_Resource { /** * Relinquish ownership of a website or domain. (webResource.delete) * * @param string $id The id of a verified site or domain. * @param array $optParams Optional parameters. */ public function delete($id, $optParams = array()) { $params = array('id' => $id); $params = array_merge($params, $optParams); return $this->call('delete', array($params)); } /** * Get the most current data for a website or domain. (webResource.get) * * @param string $id The id of a verified site or domain. * @param array $optParams Optional parameters. * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource */ public function get($id, $optParams = array()) { $params = array('id' => $id); $params = array_merge($params, $optParams); return $this->call('get', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource"); } /** * Get a verification token for placing on a website or domain. * (webResource.getToken) * * @param Google_SiteVerificationWebResourceGettokenRequest $postBody * @param array $optParams Optional parameters. * @return Google_Service_SiteVerification_SiteVerificationWebResourceGettokenResponse */ public function getToken(Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequest $postBody, $optParams = array()) { $params = array('postBody' => $postBody); $params = array_merge($params, $optParams); return $this->call('getToken', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceGettokenResponse"); } /** * Attempt verification of a website or domain. (webResource.insert) * * @param string $verificationMethod The method to use for verifying a site or * domain. * @param Google_SiteVerificationWebResourceResource $postBody * @param array $optParams Optional parameters. * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource */ public function insert($verificationMethod, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array()) { $params = array('verificationMethod' => $verificationMethod, 'postBody' => $postBody); $params = array_merge($params, $optParams); return $this->call('insert', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource"); } /** * Get the list of your verified websites and domains. * (webResource.listWebResource) * * @param array $optParams Optional parameters. * @return Google_Service_SiteVerification_SiteVerificationWebResourceListResponse */ public function listWebResource($optParams = array()) { $params = array(); $params = array_merge($params, $optParams); return $this->call('list', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceListResponse"); } /** * Modify the list of owners for your website or domain. This method supports * patch semantics. (webResource.patch) * * @param string $id The id of a verified site or domain. * @param Google_SiteVerificationWebResourceResource $postBody * @param array $optParams Optional parameters. * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource */ public function patch($id, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array()) { $params = array('id' => $id, 'postBody' => $postBody); $params = array_merge($params, $optParams); return $this->call('patch', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource"); } /** * Modify the list of owners for your website or domain. (webResource.update) * * @param string $id The id of a verified site or domain. * @param Google_SiteVerificationWebResourceResource $postBody * @param array $optParams Optional parameters. * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource */ public function update($id, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array()) { $params = array('id' => $id, 'postBody' => $postBody); $params = array_merge($params, $optParams); return $this->call('update', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource"); } }
> #[AllowDynamicProperties]
class Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequest extends Google_Model { protected $internal_gapi_mappings = array( ); protected $siteType = 'Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequestSite'; protected $siteDataType = ''; public $verificationMethod; public function setSite(Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequestSite $site) { $this->site = $site; } public function getSite() { return $this->site; } public function setVerificationMethod($verificationMethod) { $this->verificationMethod = $verificationMethod; } public function getVerificationMethod() { return $this->verificationMethod; } }
> #[AllowDynamicProperties]
class Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequestSite extends Google_Model { protected $internal_gapi_mappings = array( ); public $identifier; public $type; public function setIdentifier($identifier) { $this->identifier = $identifier; } public function getIdentifier() { return $this->identifier; } public function setType($type) { $this->type = $type; } public function getType() { return $this->type; } }
> #[AllowDynamicProperties]
class Google_Service_SiteVerification_SiteVerificationWebResourceGettokenResponse extends Google_Model { protected $internal_gapi_mappings = array( ); public $method; public $token; public function setMethod($method) { $this->method = $method; } public function getMethod() { return $this->method; } public function setToken($token) { $this->token = $token; } public function getToken() { return $this->token; } }
> #[AllowDynamicProperties]
class Google_Service_SiteVerification_SiteVerificationWebResourceListResponse extends Google_Collection { protected $collection_key = 'items'; protected $internal_gapi_mappings = array( ); protected $itemsType = 'Google_Service_SiteVerification_SiteVerificationWebResourceResource'; protected $itemsDataType = 'array'; public function setItems($items) { $this->items = $items; } public function getItems() { return $this->items; } }
> #[AllowDynamicProperties]
class Google_Service_SiteVerification_SiteVerificationWebResourceResource extends Google_Collection { protected $collection_key = 'owners'; protected $internal_gapi_mappings = array( ); public $id; public $owners; protected $siteType = 'Google_Service_SiteVerification_SiteVerificationWebResourceResourceSite'; protected $siteDataType = ''; public function setId($id) { $this->id = $id; } public function getId() { return $this->id; } public function setOwners($owners) { $this->owners = $owners; } public function getOwners() { return $this->owners; } public function setSite(Google_Service_SiteVerification_SiteVerificationWebResourceResourceSite $site) { $this->site = $site; } public function getSite() { return $this->site; } }
> #[AllowDynamicProperties]
class Google_Service_SiteVerification_SiteVerificationWebResourceResourceSite extends Google_Model { protected $internal_gapi_mappings = array( ); public $identifier; public $type; public function setIdentifier($identifier) { $this->identifier = $identifier; } public function getIdentifier() { return $this->identifier; } public function setType($type) { $this->type = $type; } public function getType() { return $this->type; } }