Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Directory_UsersPhotos_Resource Class Reference

The "photos" collection of methods. More...

Inheritance diagram for Google_Service_Directory_UsersPhotos_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($userKey, $optParams=array())
 Remove photos for the user (photos.delete)
 
 get ($userKey, $optParams=array())
 Retrieve photo of a user (photos.get)
 
 patch ($userKey, Google_Service_Directory_UserPhoto $postBody, $optParams=array())
 Add a photo for the user.
 
 update ($userKey, Google_Service_Directory_UserPhoto $postBody, $optParams=array())
 Add a photo for the user (photos.update)
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "photos" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $photos = $adminService->photos;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Directory_UsersPhotos_Resource::delete ( $userKey,
$optParams = array() )

Remove photos for the user (photos.delete)

Parameters
string$userKeyEmail or immutable Id of the user
array$optParamsOptional parameters.

◆ get()

Google_Service_Directory_UsersPhotos_Resource::get ( $userKey,
$optParams = array() )

Retrieve photo of a user (photos.get)

Parameters
string$userKeyEmail or immutable Id of the user
array$optParamsOptional parameters.
Return values
Google_Service_Directory_UserPhoto

◆ patch()

Google_Service_Directory_UsersPhotos_Resource::patch ( $userKey,
Google_Service_Directory_UserPhoto $postBody,
$optParams = array() )

Add a photo for the user.

This method supports patch semantics. (photos.patch)

Parameters
string$userKeyEmail or immutable Id of the user
Google_UserPhoto$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_UserPhoto

◆ update()

Google_Service_Directory_UsersPhotos_Resource::update ( $userKey,
Google_Service_Directory_UserPhoto $postBody,
$optParams = array() )

Add a photo for the user (photos.update)

Parameters
string$userKeyEmail or immutable Id of the user
Google_UserPhoto$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Directory_UserPhoto

The documentation for this class was generated from the following file: