Documentation

Google_Service_Books_Resource_Myconfig extends Google_Service_Resource
in package

Application

The "myconfig" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
getUserSettings() : Google_Service_Books_Usersettings: Gets the current settings for the user. (myconfig.getUserSettings)
releaseDownloadAccess() : Google_Service_Books_DownloadAccesses: Release downloaded content access restriction.
requestAccess() : Google_Service_Books_RequestAccessData: Request concurrent and download access restrictions. (myconfig.requestAccess)
syncVolumeLicenses() : Google_Service_Books_Volumes: Request downloaded content access for specified volumes on the My eBooks shelf. (myconfig.syncVolumeLicenses)
updateUserSettings() : Google_Service_Books_Usersettings: 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)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

getUserSettings()

Gets the current settings for the user. (myconfig.getUserSettings)


    public
                getUserSettings([array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Usersettings

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_Usersettings —

releaseDownloadAccess()

Release downloaded content access restriction.


    public
                releaseDownloadAccess([array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_DownloadAccesses

(myconfig.releaseDownloadAccess)

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_DownloadAccesses —

requestAccess()

Request concurrent and download access restrictions. (myconfig.requestAccess)


    public
                requestAccess([array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_RequestAccessData

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_RequestAccessData —

syncVolumeLicenses()

Request downloaded content access for specified volumes on the My eBooks shelf. (myconfig.syncVolumeLicenses)


    public
                syncVolumeLicenses([array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Volumes

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_Volumes —

updateUserSettings()

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)


    public
                updateUserSettings(Google_Service_Books_Usersettings $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Usersettings

Parameters

$postBody : Google_Service_Books_Usersettings
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_Usersettings —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —