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

The "floodlightConfigurations" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_FloodlightConfigurations_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($profileId, $id, $optParams=array())
 Gets one floodlight configuration by ID.
 
 listFloodlightConfigurations ($profileId, $optParams=array())
 Retrieves a list of floodlight configurations, possibly filtered.
 
 patch ($profileId, $id, Google_Service_Dfareporting_FloodlightConfiguration $postBody, $optParams=array())
 Updates an existing floodlight configuration.
 
 update ($profileId, Google_Service_Dfareporting_FloodlightConfiguration $postBody, $optParams=array())
 Updates an existing floodlight configuration.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "floodlightConfigurations" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $floodlightConfigurations = $dfareportingService->floodlightConfigurations;

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

◆ get()

Google_Service_Dfareporting_FloodlightConfigurations_Resource::get ( $profileId,
$id,
$optParams = array() )

Gets one floodlight configuration by ID.

(floodlightConfigurations.get)

Parameters
string$profileIdUser profile ID associated with this request.
string$idFloodlight configuration ID.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_FloodlightConfiguration

◆ listFloodlightConfigurations()

Google_Service_Dfareporting_FloodlightConfigurations_Resource::listFloodlightConfigurations ( $profileId,
$optParams = array() )

Retrieves a list of floodlight configurations, possibly filtered.

(floodlightConfigurations.listFloodlightConfigurations)

Parameters
string$profileIdUser profile ID associated with this request.
array$optParamsOptional parameters.

@opt_param string ids Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.

Return values
Google_Service_Dfareporting_FloodlightConfigurationsListResponse

◆ patch()

Google_Service_Dfareporting_FloodlightConfigurations_Resource::patch ( $profileId,
$id,
Google_Service_Dfareporting_FloodlightConfiguration $postBody,
$optParams = array() )

Updates an existing floodlight configuration.

This method supports patch semantics. (floodlightConfigurations.patch)

Parameters
string$profileIdUser profile ID associated with this request.
string$idFloodlight configuration ID.
Google_FloodlightConfiguration$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_FloodlightConfiguration

◆ update()

Google_Service_Dfareporting_FloodlightConfigurations_Resource::update ( $profileId,
Google_Service_Dfareporting_FloodlightConfiguration $postBody,
$optParams = array() )

Updates an existing floodlight configuration.

(floodlightConfigurations.update)

Parameters
string$profileIdUser profile ID associated with this request.
Google_FloodlightConfiguration$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_FloodlightConfiguration

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