Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 311 and 402] [Versions 311 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 Appsactivity (v1).
  20   *
  21   * <p>
  22   * Provides a historical view of activity.</p>
  23   *
  24   * <p>
  25   * For more information about this service, see the API
  26   * <a href="https://developers.google.com/google-apps/activity/" target="_blank">Documentation</a>
  27   * </p>
  28   *
  29   * @author Google, Inc.
  30   */
  31  class Google_Service_Appsactivity extends Google_Service
  32  {
  33    /** View the activity history of your Google Apps. */
  34    const ACTIVITY =
  35        "https://www.googleapis.com/auth/activity";
  36    /** View and manage the files in your Google Drive. */
  37    const DRIVE =
  38        "https://www.googleapis.com/auth/drive";
  39    /** View and manage metadata of files in your Google Drive. */
  40    const DRIVE_METADATA =
  41        "https://www.googleapis.com/auth/drive.metadata";
  42    /** View metadata for files in your Google Drive. */
  43    const DRIVE_METADATA_READONLY =
  44        "https://www.googleapis.com/auth/drive.metadata.readonly";
  45    /** View the files in your Google Drive. */
  46    const DRIVE_READONLY =
  47        "https://www.googleapis.com/auth/drive.readonly";
  48  
  49    public $activities;
  50    
  51  
  52    /**
  53     * Constructs the internal representation of the Appsactivity service.
  54     *
  55     * @param Google_Client $client
  56     */
  57    public function __construct(Google_Client $client)
  58    {
  59      parent::__construct($client);
  60      $this->rootUrl = 'https://www.googleapis.com/';
  61      $this->servicePath = 'appsactivity/v1/';
  62      $this->version = 'v1';
  63      $this->serviceName = 'appsactivity';
  64  
  65      $this->activities = new Google_Service_Appsactivity_Activities_Resource(
  66          $this,
  67          $this->serviceName,
  68          'activities',
  69          array(
  70            'methods' => array(
  71              'list' => array(
  72                'path' => 'activities',
  73                'httpMethod' => 'GET',
  74                'parameters' => array(
  75                  'drive.ancestorId' => array(
  76                    'location' => 'query',
  77                    'type' => 'string',
  78                  ),
  79                  'pageSize' => array(
  80                    'location' => 'query',
  81                    'type' => 'integer',
  82                  ),
  83                  'pageToken' => array(
  84                    'location' => 'query',
  85                    'type' => 'string',
  86                  ),
  87                  'userId' => array(
  88                    'location' => 'query',
  89                    'type' => 'string',
  90                  ),
  91                  'groupingStrategy' => array(
  92                    'location' => 'query',
  93                    'type' => 'string',
  94                  ),
  95                  'drive.fileId' => array(
  96                    'location' => 'query',
  97                    'type' => 'string',
  98                  ),
  99                  'source' => array(
 100                    'location' => 'query',
 101                    'type' => 'string',
 102                  ),
 103                ),
 104              ),
 105            )
 106          )
 107      );
 108    }
 109  }
 110  
 111  
 112  /**
 113   * The "activities" collection of methods.
 114   * Typical usage is:
 115   *  <code>
 116   *   $appsactivityService = new Google_Service_Appsactivity(...);
 117   *   $activities = $appsactivityService->activities;
 118   *  </code>
 119   */
 120  class Google_Service_Appsactivity_Activities_Resource extends Google_Service_Resource
 121  {
 122  
 123    /**
 124     * Returns a list of activities visible to the current logged in user. Visible
 125     * activities are determined by the visiblity settings of the object that was
 126     * acted on, e.g. Drive files a user can see. An activity is a record of past
 127     * events. Multiple events may be merged if they are similar. A request is
 128     * scoped to activities from a given Google service using the source parameter.
 129     * (activities.listActivities)
 130     *
 131     * @param array $optParams Optional parameters.
 132     *
 133     * @opt_param string drive.ancestorId Identifies the Drive folder containing the
 134     * items for which to return activities.
 135     * @opt_param int pageSize The maximum number of events to return on a page. The
 136     * response includes a continuation token if there are more events.
 137     * @opt_param string pageToken A token to retrieve a specific page of results.
 138     * @opt_param string userId Indicates the user to return activity for. Use the
 139     * special value me to indicate the currently authenticated user.
 140     * @opt_param string groupingStrategy Indicates the strategy to use when
 141     * grouping singleEvents items in the associated combinedEvent object.
 142     * @opt_param string drive.fileId Identifies the Drive item to return activities
 143     * for.
 144     * @opt_param string source The Google service from which to return activities.
 145     * Possible values of source are: - drive.google.com
 146     * @return Google_Service_Appsactivity_ListActivitiesResponse
 147     */
 148    public function listActivities($optParams = array())
 149    {
 150      $params = array();
 151      $params = array_merge($params, $optParams);
 152      return $this->call('list', array($params), "Google_Service_Appsactivity_ListActivitiesResponse");
 153    }
 154  }
 155  
 156  
 157  
 158  
 159  class Google_Service_Appsactivity_Activity extends Google_Collection
 160  {
 161    protected $collection_key = 'singleEvents';
 162    protected $internal_gapi_mappings = array(
 163    );
 164    protected $combinedEventType = 'Google_Service_Appsactivity_Event';
 165    protected $combinedEventDataType = '';
 166    protected $singleEventsType = 'Google_Service_Appsactivity_Event';
 167    protected $singleEventsDataType = 'array';
 168  
 169  
 170    public function setCombinedEvent(Google_Service_Appsactivity_Event $combinedEvent)
 171    {
 172      $this->combinedEvent = $combinedEvent;
 173    }
 174    public function getCombinedEvent()
 175    {
 176      return $this->combinedEvent;
 177    }
 178    public function setSingleEvents($singleEvents)
 179    {
 180      $this->singleEvents = $singleEvents;
 181    }
 182    public function getSingleEvents()
 183    {
 184      return $this->singleEvents;
 185    }
 186  }
 187  
 188  class Google_Service_Appsactivity_Event extends Google_Collection
 189  {
 190    protected $collection_key = 'permissionChanges';
 191    protected $internal_gapi_mappings = array(
 192    );
 193    public $additionalEventTypes;
 194    public $eventTimeMillis;
 195    public $fromUserDeletion;
 196    protected $moveType = 'Google_Service_Appsactivity_Move';
 197    protected $moveDataType = '';
 198    protected $permissionChangesType = 'Google_Service_Appsactivity_PermissionChange';
 199    protected $permissionChangesDataType = 'array';
 200    public $primaryEventType;
 201    protected $renameType = 'Google_Service_Appsactivity_Rename';
 202    protected $renameDataType = '';
 203    protected $targetType = 'Google_Service_Appsactivity_Target';
 204    protected $targetDataType = '';
 205    protected $userType = 'Google_Service_Appsactivity_User';
 206    protected $userDataType = '';
 207  
 208  
 209    public function setAdditionalEventTypes($additionalEventTypes)
 210    {
 211      $this->additionalEventTypes = $additionalEventTypes;
 212    }
 213    public function getAdditionalEventTypes()
 214    {
 215      return $this->additionalEventTypes;
 216    }
 217    public function setEventTimeMillis($eventTimeMillis)
 218    {
 219      $this->eventTimeMillis = $eventTimeMillis;
 220    }
 221    public function getEventTimeMillis()
 222    {
 223      return $this->eventTimeMillis;
 224    }
 225    public function setFromUserDeletion($fromUserDeletion)
 226    {
 227      $this->fromUserDeletion = $fromUserDeletion;
 228    }
 229    public function getFromUserDeletion()
 230    {
 231      return $this->fromUserDeletion;
 232    }
 233    public function setMove(Google_Service_Appsactivity_Move $move)
 234    {
 235      $this->move = $move;
 236    }
 237    public function getMove()
 238    {
 239      return $this->move;
 240    }
 241    public function setPermissionChanges($permissionChanges)
 242    {
 243      $this->permissionChanges = $permissionChanges;
 244    }
 245    public function getPermissionChanges()
 246    {
 247      return $this->permissionChanges;
 248    }
 249    public function setPrimaryEventType($primaryEventType)
 250    {
 251      $this->primaryEventType = $primaryEventType;
 252    }
 253    public function getPrimaryEventType()
 254    {
 255      return $this->primaryEventType;
 256    }
 257    public function setRename(Google_Service_Appsactivity_Rename $rename)
 258    {
 259      $this->rename = $rename;
 260    }
 261    public function getRename()
 262    {
 263      return $this->rename;
 264    }
 265    public function setTarget(Google_Service_Appsactivity_Target $target)
 266    {
 267      $this->target = $target;
 268    }
 269    public function getTarget()
 270    {
 271      return $this->target;
 272    }
 273    public function setUser(Google_Service_Appsactivity_User $user)
 274    {
 275      $this->user = $user;
 276    }
 277    public function getUser()
 278    {
 279      return $this->user;
 280    }
 281  }
 282  
 283  class Google_Service_Appsactivity_ListActivitiesResponse extends Google_Collection
 284  {
 285    protected $collection_key = 'activities';
 286    protected $internal_gapi_mappings = array(
 287    );
 288    protected $activitiesType = 'Google_Service_Appsactivity_Activity';
 289    protected $activitiesDataType = 'array';
 290    public $nextPageToken;
 291  
 292  
 293    public function setActivities($activities)
 294    {
 295      $this->activities = $activities;
 296    }
 297    public function getActivities()
 298    {
 299      return $this->activities;
 300    }
 301    public function setNextPageToken($nextPageToken)
 302    {
 303      $this->nextPageToken = $nextPageToken;
 304    }
 305    public function getNextPageToken()
 306    {
 307      return $this->nextPageToken;
 308    }
 309  }
 310  
 311  class Google_Service_Appsactivity_Move extends Google_Collection
 312  {
 313    protected $collection_key = 'removedParents';
 314    protected $internal_gapi_mappings = array(
 315    );
 316    protected $addedParentsType = 'Google_Service_Appsactivity_Parent';
 317    protected $addedParentsDataType = 'array';
 318    protected $removedParentsType = 'Google_Service_Appsactivity_Parent';
 319    protected $removedParentsDataType = 'array';
 320  
 321  
 322    public function setAddedParents($addedParents)
 323    {
 324      $this->addedParents = $addedParents;
 325    }
 326    public function getAddedParents()
 327    {
 328      return $this->addedParents;
 329    }
 330    public function setRemovedParents($removedParents)
 331    {
 332      $this->removedParents = $removedParents;
 333    }
 334    public function getRemovedParents()
 335    {
 336      return $this->removedParents;
 337    }
 338  }
 339  
 340  class Google_Service_Appsactivity_Parent extends Google_Model
 341  {
 342    protected $internal_gapi_mappings = array(
 343    );
 344    public $id;
 345    public $isRoot;
 346    public $title;
 347  
 348  
 349    public function setId($id)
 350    {
 351      $this->id = $id;
 352    }
 353    public function getId()
 354    {
 355      return $this->id;
 356    }
 357    public function setIsRoot($isRoot)
 358    {
 359      $this->isRoot = $isRoot;
 360    }
 361    public function getIsRoot()
 362    {
 363      return $this->isRoot;
 364    }
 365    public function setTitle($title)
 366    {
 367      $this->title = $title;
 368    }
 369    public function getTitle()
 370    {
 371      return $this->title;
 372    }
 373  }
 374  
 375  class Google_Service_Appsactivity_Permission extends Google_Model
 376  {
 377    protected $internal_gapi_mappings = array(
 378    );
 379    public $name;
 380    public $permissionId;
 381    public $role;
 382    public $type;
 383    protected $userType = 'Google_Service_Appsactivity_User';
 384    protected $userDataType = '';
 385    public $withLink;
 386  
 387  
 388    public function setName($name)
 389    {
 390      $this->name = $name;
 391    }
 392    public function getName()
 393    {
 394      return $this->name;
 395    }
 396    public function setPermissionId($permissionId)
 397    {
 398      $this->permissionId = $permissionId;
 399    }
 400    public function getPermissionId()
 401    {
 402      return $this->permissionId;
 403    }
 404    public function setRole($role)
 405    {
 406      $this->role = $role;
 407    }
 408    public function getRole()
 409    {
 410      return $this->role;
 411    }
 412    public function setType($type)
 413    {
 414      $this->type = $type;
 415    }
 416    public function getType()
 417    {
 418      return $this->type;
 419    }
 420    public function setUser(Google_Service_Appsactivity_User $user)
 421    {
 422      $this->user = $user;
 423    }
 424    public function getUser()
 425    {
 426      return $this->user;
 427    }
 428    public function setWithLink($withLink)
 429    {
 430      $this->withLink = $withLink;
 431    }
 432    public function getWithLink()
 433    {
 434      return $this->withLink;
 435    }
 436  }
 437  
 438  class Google_Service_Appsactivity_PermissionChange extends Google_Collection
 439  {
 440    protected $collection_key = 'removedPermissions';
 441    protected $internal_gapi_mappings = array(
 442    );
 443    protected $addedPermissionsType = 'Google_Service_Appsactivity_Permission';
 444    protected $addedPermissionsDataType = 'array';
 445    protected $removedPermissionsType = 'Google_Service_Appsactivity_Permission';
 446    protected $removedPermissionsDataType = 'array';
 447  
 448  
 449    public function setAddedPermissions($addedPermissions)
 450    {
 451      $this->addedPermissions = $addedPermissions;
 452    }
 453    public function getAddedPermissions()
 454    {
 455      return $this->addedPermissions;
 456    }
 457    public function setRemovedPermissions($removedPermissions)
 458    {
 459      $this->removedPermissions = $removedPermissions;
 460    }
 461    public function getRemovedPermissions()
 462    {
 463      return $this->removedPermissions;
 464    }
 465  }
 466  
 467  class Google_Service_Appsactivity_Photo extends Google_Model
 468  {
 469    protected $internal_gapi_mappings = array(
 470    );
 471    public $url;
 472  
 473  
 474    public function setUrl($url)
 475    {
 476      $this->url = $url;
 477    }
 478    public function getUrl()
 479    {
 480      return $this->url;
 481    }
 482  }
 483  
 484  class Google_Service_Appsactivity_Rename extends Google_Model
 485  {
 486    protected $internal_gapi_mappings = array(
 487    );
 488    public $newTitle;
 489    public $oldTitle;
 490  
 491  
 492    public function setNewTitle($newTitle)
 493    {
 494      $this->newTitle = $newTitle;
 495    }
 496    public function getNewTitle()
 497    {
 498      return $this->newTitle;
 499    }
 500    public function setOldTitle($oldTitle)
 501    {
 502      $this->oldTitle = $oldTitle;
 503    }
 504    public function getOldTitle()
 505    {
 506      return $this->oldTitle;
 507    }
 508  }
 509  
 510  class Google_Service_Appsactivity_Target extends Google_Model
 511  {
 512    protected $internal_gapi_mappings = array(
 513    );
 514    public $id;
 515    public $mimeType;
 516    public $name;
 517  
 518  
 519    public function setId($id)
 520    {
 521      $this->id = $id;
 522    }
 523    public function getId()
 524    {
 525      return $this->id;
 526    }
 527    public function setMimeType($mimeType)
 528    {
 529      $this->mimeType = $mimeType;
 530    }
 531    public function getMimeType()
 532    {
 533      return $this->mimeType;
 534    }
 535    public function setName($name)
 536    {
 537      $this->name = $name;
 538    }
 539    public function getName()
 540    {
 541      return $this->name;
 542    }
 543  }
 544  
 545  class Google_Service_Appsactivity_User extends Google_Model
 546  {
 547    protected $internal_gapi_mappings = array(
 548    );
 549    public $name;
 550    protected $photoType = 'Google_Service_Appsactivity_Photo';
 551    protected $photoDataType = '';
 552  
 553  
 554    public function setName($name)
 555    {
 556      $this->name = $name;
 557    }
 558    public function getName()
 559    {
 560      return $this->name;
 561    }
 562    public function setPhoto(Google_Service_Appsactivity_Photo $photo)
 563    {
 564      $this->photo = $photo;
 565    }
 566    public function getPhoto()
 567    {
 568      return $this->photo;
 569    }
 570  }