Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_Books_Layers_Resource Class Reference

The "layers" collection of methods. More...

Inheritance diagram for Google_Service_Books_Layers_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($volumeId, $summaryId, $optParams=array())
 Gets the layer summary for a volume.
 
 listLayers ($volumeId, $optParams=array())
 List the layer summaries for a volume.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "layers" collection of methods.

Typical usage is: $booksService = new Google_Service_Books(...); $layers = $booksService->layers;

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_Books_Layers_Resource::get ( $volumeId,
$summaryId,
$optParams = array() )

Gets the layer summary for a volume.

(layers.get)

Parameters
string$volumeIdThe volume to retrieve layers for.
string$summaryIdThe ID for the layer to get the summary for.
array$optParamsOptional parameters.

@opt_param string source String to identify the originator of this request. @opt_param string contentVersion The content version for the requested volume.

Return values
Google_Service_Books_Layersummary

◆ listLayers()

Google_Service_Books_Layers_Resource::listLayers ( $volumeId,
$optParams = array() )

List the layer summaries for a volume.

(layers.listLayers)

Parameters
string$volumeIdThe volume to retrieve layers for.
array$optParamsOptional parameters.

@opt_param string pageToken The value of the nextToken from the previous page. @opt_param string contentVersion The content version for the requested volume. @opt_param string maxResults Maximum number of results to return @opt_param string source String to identify the originator of this request.

Return values
Google_Service_Books_Layersummaries

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