Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403]

   1  <?php
   2  /*
   3   * Copyright 2010 Google Inc.
   4   *
   5   * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   6   * use this file except in compliance with the License. You may obtain a copy of
   7   * the License at
   8   *
   9   * http://www.apache.org/licenses/LICENSE-2.0
  10   *
  11   * Unless required by applicable law or agreed to in writing, software
  12   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14   * License for the specific language governing permissions and limitations under
  15   * the License.
  16   */
  17  
  18  /**
  19   * Service definition for Groupssettings (v1).
  20   *
  21   * <p>
  22   * Lets you manage permission levels and related settings of a group.</p>
  23   *
  24   * <p>
  25   * For more information about this service, see the API
  26   * <a href="https://developers.google.com/google-apps/groups-settings/get_started" target="_blank">Documentation</a>
  27   * </p>
  28   *
  29   * @author Google, Inc.
  30   */
  31  #[AllowDynamicProperties]
  32  class Google_Service_Groupssettings extends Google_Service
  33  {
  34    /** View and manage the settings of a Google Apps Group. */
  35    const APPS_GROUPS_SETTINGS =
  36        "https://www.googleapis.com/auth/apps.groups.settings";
  37  
  38    public $groups;
  39    
  40  
  41    /**
  42     * Constructs the internal representation of the Groupssettings service.
  43     *
  44     * @param Google_Client $client
  45     */
  46    public function __construct(Google_Client $client)
  47    {
  48      parent::__construct($client);
  49      $this->rootUrl = 'https://www.googleapis.com/';
  50      $this->servicePath = 'groups/v1/groups/';
  51      $this->version = 'v1';
  52      $this->serviceName = 'groupssettings';
  53  
  54      $this->groups = new Google_Service_Groupssettings_Groups_Resource(
  55          $this,
  56          $this->serviceName,
  57          'groups',
  58          array(
  59            'methods' => array(
  60              'get' => array(
  61                'path' => '{groupUniqueId}',
  62                'httpMethod' => 'GET',
  63                'parameters' => array(
  64                  'groupUniqueId' => array(
  65                    'location' => 'path',
  66                    'type' => 'string',
  67                    'required' => true,
  68                  ),
  69                ),
  70              ),'patch' => array(
  71                'path' => '{groupUniqueId}',
  72                'httpMethod' => 'PATCH',
  73                'parameters' => array(
  74                  'groupUniqueId' => array(
  75                    'location' => 'path',
  76                    'type' => 'string',
  77                    'required' => true,
  78                  ),
  79                ),
  80              ),'update' => array(
  81                'path' => '{groupUniqueId}',
  82                'httpMethod' => 'PUT',
  83                'parameters' => array(
  84                  'groupUniqueId' => array(
  85                    'location' => 'path',
  86                    'type' => 'string',
  87                    'required' => true,
  88                  ),
  89                ),
  90              ),
  91            )
  92          )
  93      );
  94    }
  95  }
  96  
  97  
  98  /**
  99   * The "groups" collection of methods.
 100   * Typical usage is:
 101   *  <code>
 102   *   $groupssettingsService = new Google_Service_Groupssettings(...);
 103   *   $groups = $groupssettingsService->groups;
 104   *  </code>
 105   */
 106  #[AllowDynamicProperties]
 107  class Google_Service_Groupssettings_Groups_Resource extends Google_Service_Resource
 108  {
 109  
 110    /**
 111     * Gets one resource by id. (groups.get)
 112     *
 113     * @param string $groupUniqueId The resource ID
 114     * @param array $optParams Optional parameters.
 115     * @return Google_Service_Groupssettings_Groups
 116     */
 117    public function get($groupUniqueId, $optParams = array())
 118    {
 119      $params = array('groupUniqueId' => $groupUniqueId);
 120      $params = array_merge($params, $optParams);
 121      return $this->call('get', array($params), "Google_Service_Groupssettings_Groups");
 122    }
 123  
 124    /**
 125     * Updates an existing resource. This method supports patch semantics.
 126     * (groups.patch)
 127     *
 128     * @param string $groupUniqueId The resource ID
 129     * @param Google_Groups $postBody
 130     * @param array $optParams Optional parameters.
 131     * @return Google_Service_Groupssettings_Groups
 132     */
 133    public function patch($groupUniqueId, Google_Service_Groupssettings_Groups $postBody, $optParams = array())
 134    {
 135      $params = array('groupUniqueId' => $groupUniqueId, 'postBody' => $postBody);
 136      $params = array_merge($params, $optParams);
 137      return $this->call('patch', array($params), "Google_Service_Groupssettings_Groups");
 138    }
 139  
 140    /**
 141     * Updates an existing resource. (groups.update)
 142     *
 143     * @param string $groupUniqueId The resource ID
 144     * @param Google_Groups $postBody
 145     * @param array $optParams Optional parameters.
 146     * @return Google_Service_Groupssettings_Groups
 147     */
 148    public function update($groupUniqueId, Google_Service_Groupssettings_Groups $postBody, $optParams = array())
 149    {
 150      $params = array('groupUniqueId' => $groupUniqueId, 'postBody' => $postBody);
 151      $params = array_merge($params, $optParams);
 152      return $this->call('update', array($params), "Google_Service_Groupssettings_Groups");
 153    }
 154  }
 155  
 156  
 157  
 158  
 159  #[AllowDynamicProperties]
 160  class Google_Service_Groupssettings_Groups extends Google_Model
 161  {
 162    protected $internal_gapi_mappings = array(
 163    );
 164    public $allowExternalMembers;
 165    public $allowGoogleCommunication;
 166    public $allowWebPosting;
 167    public $archiveOnly;
 168    public $customReplyTo;
 169    public $defaultMessageDenyNotificationText;
 170    public $description;
 171    public $email;
 172    public $includeInGlobalAddressList;
 173    public $isArchived;
 174    public $kind;
 175    public $maxMessageBytes;
 176    public $membersCanPostAsTheGroup;
 177    public $messageDisplayFont;
 178    public $messageModerationLevel;
 179    public $name;
 180    public $primaryLanguage;
 181    public $replyTo;
 182    public $sendMessageDenyNotification;
 183    public $showInGroupDirectory;
 184    public $spamModerationLevel;
 185    public $whoCanContactOwner;
 186    public $whoCanInvite;
 187    public $whoCanJoin;
 188    public $whoCanLeaveGroup;
 189    public $whoCanPostMessage;
 190    public $whoCanViewGroup;
 191    public $whoCanViewMembership;
 192  
 193  
 194    public function setAllowExternalMembers($allowExternalMembers)
 195    {
 196      $this->allowExternalMembers = $allowExternalMembers;
 197    }
 198    public function getAllowExternalMembers()
 199    {
 200      return $this->allowExternalMembers;
 201    }
 202    public function setAllowGoogleCommunication($allowGoogleCommunication)
 203    {
 204      $this->allowGoogleCommunication = $allowGoogleCommunication;
 205    }
 206    public function getAllowGoogleCommunication()
 207    {
 208      return $this->allowGoogleCommunication;
 209    }
 210    public function setAllowWebPosting($allowWebPosting)
 211    {
 212      $this->allowWebPosting = $allowWebPosting;
 213    }
 214    public function getAllowWebPosting()
 215    {
 216      return $this->allowWebPosting;
 217    }
 218    public function setArchiveOnly($archiveOnly)
 219    {
 220      $this->archiveOnly = $archiveOnly;
 221    }
 222    public function getArchiveOnly()
 223    {
 224      return $this->archiveOnly;
 225    }
 226    public function setCustomReplyTo($customReplyTo)
 227    {
 228      $this->customReplyTo = $customReplyTo;
 229    }
 230    public function getCustomReplyTo()
 231    {
 232      return $this->customReplyTo;
 233    }
 234    public function setDefaultMessageDenyNotificationText($defaultMessageDenyNotificationText)
 235    {
 236      $this->defaultMessageDenyNotificationText = $defaultMessageDenyNotificationText;
 237    }
 238    public function getDefaultMessageDenyNotificationText()
 239    {
 240      return $this->defaultMessageDenyNotificationText;
 241    }
 242    public function setDescription($description)
 243    {
 244      $this->description = $description;
 245    }
 246    public function getDescription()
 247    {
 248      return $this->description;
 249    }
 250    public function setEmail($email)
 251    {
 252      $this->email = $email;
 253    }
 254    public function getEmail()
 255    {
 256      return $this->email;
 257    }
 258    public function setIncludeInGlobalAddressList($includeInGlobalAddressList)
 259    {
 260      $this->includeInGlobalAddressList = $includeInGlobalAddressList;
 261    }
 262    public function getIncludeInGlobalAddressList()
 263    {
 264      return $this->includeInGlobalAddressList;
 265    }
 266    public function setIsArchived($isArchived)
 267    {
 268      $this->isArchived = $isArchived;
 269    }
 270    public function getIsArchived()
 271    {
 272      return $this->isArchived;
 273    }
 274    public function setKind($kind)
 275    {
 276      $this->kind = $kind;
 277    }
 278    public function getKind()
 279    {
 280      return $this->kind;
 281    }
 282    public function setMaxMessageBytes($maxMessageBytes)
 283    {
 284      $this->maxMessageBytes = $maxMessageBytes;
 285    }
 286    public function getMaxMessageBytes()
 287    {
 288      return $this->maxMessageBytes;
 289    }
 290    public function setMembersCanPostAsTheGroup($membersCanPostAsTheGroup)
 291    {
 292      $this->membersCanPostAsTheGroup = $membersCanPostAsTheGroup;
 293    }
 294    public function getMembersCanPostAsTheGroup()
 295    {
 296      return $this->membersCanPostAsTheGroup;
 297    }
 298    public function setMessageDisplayFont($messageDisplayFont)
 299    {
 300      $this->messageDisplayFont = $messageDisplayFont;
 301    }
 302    public function getMessageDisplayFont()
 303    {
 304      return $this->messageDisplayFont;
 305    }
 306    public function setMessageModerationLevel($messageModerationLevel)
 307    {
 308      $this->messageModerationLevel = $messageModerationLevel;
 309    }
 310    public function getMessageModerationLevel()
 311    {
 312      return $this->messageModerationLevel;
 313    }
 314    public function setName($name)
 315    {
 316      $this->name = $name;
 317    }
 318    public function getName()
 319    {
 320      return $this->name;
 321    }
 322    public function setPrimaryLanguage($primaryLanguage)
 323    {
 324      $this->primaryLanguage = $primaryLanguage;
 325    }
 326    public function getPrimaryLanguage()
 327    {
 328      return $this->primaryLanguage;
 329    }
 330    public function setReplyTo($replyTo)
 331    {
 332      $this->replyTo = $replyTo;
 333    }
 334    public function getReplyTo()
 335    {
 336      return $this->replyTo;
 337    }
 338    public function setSendMessageDenyNotification($sendMessageDenyNotification)
 339    {
 340      $this->sendMessageDenyNotification = $sendMessageDenyNotification;
 341    }
 342    public function getSendMessageDenyNotification()
 343    {
 344      return $this->sendMessageDenyNotification;
 345    }
 346    public function setShowInGroupDirectory($showInGroupDirectory)
 347    {
 348      $this->showInGroupDirectory = $showInGroupDirectory;
 349    }
 350    public function getShowInGroupDirectory()
 351    {
 352      return $this->showInGroupDirectory;
 353    }
 354    public function setSpamModerationLevel($spamModerationLevel)
 355    {
 356      $this->spamModerationLevel = $spamModerationLevel;
 357    }
 358    public function getSpamModerationLevel()
 359    {
 360      return $this->spamModerationLevel;
 361    }
 362    public function setWhoCanContactOwner($whoCanContactOwner)
 363    {
 364      $this->whoCanContactOwner = $whoCanContactOwner;
 365    }
 366    public function getWhoCanContactOwner()
 367    {
 368      return $this->whoCanContactOwner;
 369    }
 370    public function setWhoCanInvite($whoCanInvite)
 371    {
 372      $this->whoCanInvite = $whoCanInvite;
 373    }
 374    public function getWhoCanInvite()
 375    {
 376      return $this->whoCanInvite;
 377    }
 378    public function setWhoCanJoin($whoCanJoin)
 379    {
 380      $this->whoCanJoin = $whoCanJoin;
 381    }
 382    public function getWhoCanJoin()
 383    {
 384      return $this->whoCanJoin;
 385    }
 386    public function setWhoCanLeaveGroup($whoCanLeaveGroup)
 387    {
 388      $this->whoCanLeaveGroup = $whoCanLeaveGroup;
 389    }
 390    public function getWhoCanLeaveGroup()
 391    {
 392      return $this->whoCanLeaveGroup;
 393    }
 394    public function setWhoCanPostMessage($whoCanPostMessage)
 395    {
 396      $this->whoCanPostMessage = $whoCanPostMessage;
 397    }
 398    public function getWhoCanPostMessage()
 399    {
 400      return $this->whoCanPostMessage;
 401    }
 402    public function setWhoCanViewGroup($whoCanViewGroup)
 403    {
 404      $this->whoCanViewGroup = $whoCanViewGroup;
 405    }
 406    public function getWhoCanViewGroup()
 407    {
 408      return $this->whoCanViewGroup;
 409    }
 410    public function setWhoCanViewMembership($whoCanViewMembership)
 411    {
 412      $this->whoCanViewMembership = $whoCanViewMembership;
 413    }
 414    public function getWhoCanViewMembership()
 415    {
 416      return $this->whoCanViewMembership;
 417    }
 418  }