Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
Google_Service_Dfareporting_ReportsFiles_Resource Class Reference

The "files" collection of methods. More...

Inheritance diagram for Google_Service_Dfareporting_ReportsFiles_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($profileId, $reportId, $fileId, $optParams=array())
 Retrieves a report file.
 
 listReportsFiles ($profileId, $reportId, $optParams=array())
 Lists files for a report.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "files" collection of methods.

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

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_ReportsFiles_Resource::get ( $profileId,
$reportId,
$fileId,
$optParams = array() )

Retrieves a report file.

(files.get)

Parameters
string$profileIdThe DFA profile ID.
string$reportIdThe ID of the report.
string$fileIdThe ID of the report file.
array$optParamsOptional parameters.
Return values
Google_Service_Dfareporting_DfareportingFile

◆ listReportsFiles()

Google_Service_Dfareporting_ReportsFiles_Resource::listReportsFiles ( $profileId,
$reportId,
$optParams = array() )

Lists files for a report.

(files.listReportsFiles)

Parameters
string$profileIdThe DFA profile ID.
string$reportIdThe ID of the parent report.
array$optParamsOptional parameters.

@opt_param string sortField The field by which to sort the list. @opt_param int maxResults Maximum number of results to return. @opt_param string pageToken The value of the nextToken from the previous result page. @opt_param string sortOrder Order of sorted results, default is 'DESCENDING'.

Return values
Google_Service_Dfareporting_FileList

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