The "readingpositions" collection of methods.
More...
|
| 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.
|
|
|
| convertToArrayAndStripNulls ($o) |
|
The "readingpositions" collection of methods.
Typical usage is: $booksService = new Google_Service_Books(...); $readingpositions = $booksService->readingpositions;
◆ 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
-
◆ get()
Google_Service_Books_MylibraryReadingpositions_Resource::get |
( |
| $volumeId, |
|
|
| $optParams = array() ) |
Retrieves my reading position information for a volume.
(readingpositions.get)
- Parameters
-
string | $volumeId | ID of volume for which to retrieve a reading position. |
array | $optParams | Optional 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
-
◆ setPosition()
Google_Service_Books_MylibraryReadingpositions_Resource::setPosition |
( |
| $volumeId, |
|
|
| $timestamp, |
|
|
| $position, |
|
|
| $optParams = array() ) |
Sets my reading position information for a volume.
(readingpositions.setPosition)
- Parameters
-
string | $volumeId | ID of volume for which to update the reading position. |
string | $timestamp | RFC 3339 UTC format timestamp associated with this reading position. |
string | $position | Position string for the new volume reading position. |
array | $optParams | Optional 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:
- lib/google/src/Google/Service/Books.php