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

The "readingpositions" collection of methods. More...

Inheritance diagram for Google_Service_Books_MylibraryReadingpositions_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($volumeId, $optParams=array())
 Retrieves my reading position information for a volume.
 
 setPosition ($volumeId, $timestamp, $position, $optParams=array())
 Sets my reading position information for a volume.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "readingpositions" collection of methods.

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

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

Retrieves my reading position information for a volume.

(readingpositions.get)

Parameters
string$volumeIdID of volume for which to retrieve a reading position.
array$optParamsOptional parameters.

@opt_param string source String to identify the originator of this request. @opt_param string contentVersion Volume content version for which this reading position is requested.

Return values
Google_Service_Books_ReadingPosition

◆ setPosition()

Google_Service_Books_MylibraryReadingpositions_Resource::setPosition ( $volumeId,
$timestamp,
$position,
$optParams = array() )

Sets my reading position information for a volume.

(readingpositions.setPosition)

Parameters
string$volumeIdID of volume for which to update the reading position.
string$timestampRFC 3339 UTC format timestamp associated with this reading position.
string$positionPosition string for the new volume reading position.
array$optParamsOptional parameters.

@opt_param string deviceCookie Random persistent device cookie optional on set position. @opt_param string source String to identify the originator of this request. @opt_param string contentVersion Volume content version for which this reading position applies. @opt_param string action Action that caused this reading position to be set.


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