Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Books_VolumesRecommended_Resource Class Reference

The "recommended" collection of methods. More...

Inheritance diagram for Google_Service_Books_VolumesRecommended_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 listVolumesRecommended ($optParams=array())
 Return a list of recommended books for the current user.
 
 rate ($rating, $volumeId, $optParams=array())
 Rate a recommended book for the current user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "recommended" collection of methods.

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

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

◆ listVolumesRecommended()

Google_Service_Books_VolumesRecommended_Resource::listVolumesRecommended ( $optParams = array())

Return a list of recommended books for the current user.

(recommended.listVolumesRecommended)

Parameters
array$optParamsOptional parameters.

@opt_param string locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. @opt_param string source String to identify the originator of this request. @opt_param string maxAllowedMaturityRating The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

Return values
Google_Service_Books_Volumes

◆ rate()

Google_Service_Books_VolumesRecommended_Resource::rate ( $rating,
$volumeId,
$optParams = array() )

Rate a recommended book for the current user.

(recommended.rate)

Parameters
string$ratingRating to be given to the volume.
string$volumeIdID of the source volume.
array$optParamsOptional parameters.

@opt_param string locale ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations. @opt_param string source String to identify the originator of this request.

Return values
Google_Service_Books_BooksVolumesRecommendedRateResponse

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