Google_Service_Books_Myconfig_Resource Class Reference

The "myconfig" collection of methods. More...

Inheritance diagram for Google_Service_Books_Myconfig_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	getUserSettings ($optParams=array())
	Gets the current settings for the user.
	releaseDownloadAccess ($volumeIds, $cpksver, $optParams=array())
	Release downloaded content access restriction.
	requestAccess ($source, $volumeId, $nonce, $cpksver, $optParams=array())
	Request concurrent and download access restrictions.
	syncVolumeLicenses ($source, $nonce, $cpksver, $optParams=array())
	Request downloaded content access for specified volumes on the My eBooks shelf.
	updateUserSettings (Google_Service_Books_Usersettings $postBody, $optParams=array())
	Sets the settings for the user.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "myconfig" collection of methods.

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

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

getUserSettings()

Google_Service_Books_Myconfig_Resource::getUserSettings

(

$optParams = array()

)

Gets the current settings for the user.

(myconfig.getUserSettings)

Parameters

array

$optParams

Optional parameters.

Return values

Google_Service_Books_Usersettings

releaseDownloadAccess()

Google_Service_Books_Myconfig_Resource::releaseDownloadAccess	(		$volumeIds,
			$cpksver,
			$optParams = array() )

Release downloaded content access restriction.

(myconfig.releaseDownloadAccess)

Parameters

string	$volumeIds	The volume(s) to release restrictions for.
string	$cpksver	The device/version ID from which to release the restriction.
array	$optParams	Optional parameters.

@opt_param string locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. @opt_param string source String to identify the originator of this request.

Return values

Google_Service_Books_DownloadAccesses

requestAccess()

Google_Service_Books_Myconfig_Resource::requestAccess	(		$source,
			$volumeId,
			$nonce,
			$cpksver,
			$optParams = array() )

Request concurrent and download access restrictions.

(myconfig.requestAccess)

Parameters

string	$source	String to identify the originator of this request.
string	$volumeId	The volume to request concurrent/download restrictions for.
string	$nonce	The client nonce value.
string	$cpksver	The device/version ID from which to request the restrictions.
array	$optParams	Optional parameters.

@opt_param string licenseTypes The type of access license to request. If not specified, the default is BOTH. @opt_param string locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

Return values

Google_Service_Books_RequestAccess

syncVolumeLicenses()

Google_Service_Books_Myconfig_Resource::syncVolumeLicenses	(		$source,
			$nonce,
			$cpksver,
			$optParams = array() )

Request downloaded content access for specified volumes on the My eBooks shelf.

(myconfig.syncVolumeLicenses)

Parameters

string	$source	String to identify the originator of this request.
string	$nonce	The client nonce value.
string	$cpksver	The device/version ID from which to release the restriction.
array	$optParams	Optional parameters.

@opt_param string features List of features supported by the client, i.e., 'RENTALS' @opt_param string locale ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. @opt_param bool showPreorders Set to true to show pre-ordered books. Defaults to false. @opt_param string volumeIds The volume(s) to request download restrictions for.

Return values

Google_Service_Books_Volumes

updateUserSettings()

Google_Service_Books_Myconfig_Resource::updateUserSettings	(	Google_Service_Books_Usersettings	$postBody,
			$optParams = array() )

Sets the settings for the user.

If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub- objects will retain the existing value. (myconfig.updateUserSettings)

Parameters

Google_Usersettings	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Books_Usersettings

---

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

• lib/google/src/Google/Service/Books.php