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

The "bookshelves" collection of methods. More...

Inheritance diagram for Google_Service_Books_Bookshelves_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($userId, $shelf, $optParams=array())
 Retrieves metadata for a specific bookshelf for the specified user.
 
 listBookshelves ($userId, $optParams=array())
 Retrieves a list of public bookshelves for the specified user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "bookshelves" collection of methods.

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

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_Bookshelves_Resource::get ( $userId,
$shelf,
$optParams = array() )

Retrieves metadata for a specific bookshelf for the specified user.

(bookshelves.get)

Parameters
string$userIdID of user for whom to retrieve bookshelves.
string$shelfID of bookshelf to retrieve.
array$optParamsOptional parameters.

@opt_param string source String to identify the originator of this request.

Return values
Google_Service_Books_Bookshelf

◆ listBookshelves()

Google_Service_Books_Bookshelves_Resource::listBookshelves ( $userId,
$optParams = array() )

Retrieves a list of public bookshelves for the specified user.

(bookshelves.listBookshelves)

Parameters
string$userIdID of user for whom to retrieve bookshelves.
array$optParamsOptional parameters.

@opt_param string source String to identify the originator of this request.

Return values
Google_Service_Books_Bookshelves

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