Documentation

Google_Service_Books_Resource_MylibraryBookshelves extends Google_Service_Resource
in package

Application

The "bookshelves" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
addVolume() : Google_Service_Books_BooksEmpty: Adds a volume to a bookshelf. (bookshelves.addVolume)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
clearVolumes() : Google_Service_Books_BooksEmpty: Clears all volumes from a bookshelf. (bookshelves.clearVolumes)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_Books_Bookshelf: Retrieves metadata for a specific bookshelf belonging to the authenticated user. (bookshelves.get)
listMylibraryBookshelves() : Google_Service_Books_Bookshelves: Retrieves a list of bookshelves belonging to the authenticated user.
moveVolume() : Google_Service_Books_BooksEmpty: Moves a volume within a bookshelf. (bookshelves.moveVolume)
removeVolume() : Google_Service_Books_BooksEmpty: Removes a volume from a bookshelf. (bookshelves.removeVolume)
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 —

addVolume()

Adds a volume to a bookshelf. (bookshelves.addVolume)


    public
                addVolume(string $shelf[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_BooksEmpty

Parameters

$shelf : string: ID of bookshelf to which to add a volume.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_BooksEmpty —

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 —

clearVolumes()

Clears all volumes from a bookshelf. (bookshelves.clearVolumes)


    public
                clearVolumes(string $shelf[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_BooksEmpty

Parameters

$shelf : string: ID of bookshelf from which to remove a volume.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_BooksEmpty —

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

get()

Retrieves metadata for a specific bookshelf belonging to the authenticated user. (bookshelves.get)


    public
                get(string $shelf[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_Bookshelf

Parameters

$shelf : string: ID of bookshelf to retrieve.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_Bookshelf —

listMylibraryBookshelves()

Retrieves a list of bookshelves belonging to the authenticated user.


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

(bookshelves.listMylibraryBookshelves)

Parameters

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

Return values

Google_Service_Books_Bookshelves —

moveVolume()

Moves a volume within a bookshelf. (bookshelves.moveVolume)


    public
                moveVolume(string $shelf[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_BooksEmpty

Parameters

$shelf : string: ID of bookshelf with the volume.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_BooksEmpty —

removeVolume()

Removes a volume from a bookshelf. (bookshelves.removeVolume)


    public
                removeVolume(string $shelf[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Books_BooksEmpty

Parameters

$shelf : string: ID of bookshelf from which to remove a volume.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Books_BooksEmpty —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —