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

The "onboarding" collection of methods. More...

Inheritance diagram for Google_Service_Books_Onboarding_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 listCategories ($optParams=array())
 List categories for onboarding experience.
 
 listCategoryVolumes ($optParams=array())
 List available volumes under categories for onboarding experience.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "onboarding" collection of methods.

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

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

◆ listCategories()

Google_Service_Books_Onboarding_Resource::listCategories ( $optParams = array())

List categories for onboarding experience.

(onboarding.listCategories)

Parameters
array$optParamsOptional parameters.

@opt_param string locale ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.

Return values
Google_Service_Books_Category

◆ listCategoryVolumes()

Google_Service_Books_Onboarding_Resource::listCategoryVolumes ( $optParams = array())

List available volumes under categories for onboarding experience.

(onboarding.listCategoryVolumes)

Parameters
array$optParamsOptional parameters.

@opt_param string locale ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. @opt_param string pageToken The value of the nextToken from the previous page. @opt_param string maxAllowedMaturityRating The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out. @opt_param string categoryId List of category ids requested. @opt_param string pageSize Number of maximum results per page to be included in the response.

Return values
Google_Service_Books_Volume2

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