Documentation

Google_Service_Libraryagent_Resource_ShelvesBooks extends Google_Service_Resource
in package

The "books" collection of methods.

Typical usage is: $libraryagentService = new Google_Service_Libraryagent(...); $books = $libraryagentService->books;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
borrow()  : Google_Service_Libraryagent_GoogleExampleLibraryagentV1Book
Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Libraryagent_GoogleExampleLibraryagentV1Book
Gets a book. Returns NOT_FOUND if the book does not exist. (books.get)
listShelvesBooks()  : Google_Service_Libraryagent_GoogleExampleLibraryagentV1ListBooksResponse
Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist. (books.listShelvesBooks)
returnShelvesBooks()  : Google_Service_Libraryagent_GoogleExampleLibraryagentV1Book
Return a book to the library. Returns the book if it is returned to the library successfully. Returns error if the book does not belong to the library or the users didn't borrow before. (books.returnShelvesBooks)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

borrow()

Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library.

public borrow(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Libraryagent_GoogleExampleLibraryagentV1Book

Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions. (books.borrow)

Parameters
$name : string

Required. The name of the book to borrow.

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

Optional parameters.

Return values
Google_Service_Libraryagent_GoogleExampleLibraryagentV1Book —

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
Tags
throws
Google_Exception
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>
Tags
static
Return values
string —

$requestUrl

listShelvesBooks()

Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist. (books.listShelvesBooks)

public listShelvesBooks(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Libraryagent_GoogleExampleLibraryagentV1ListBooksResponse
Parameters
$parent : string

Required. The name of the shelf whose books we'd like to list.

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

Optional parameters.

Tags
opt_param

int pageSize Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.

opt_param

string pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBooksResponse.next_page_token. returned from the previous call to ListBooks method.

Return values
Google_Service_Libraryagent_GoogleExampleLibraryagentV1ListBooksResponse —

returnShelvesBooks()

Return a book to the library. Returns the book if it is returned to the library successfully. Returns error if the book does not belong to the library or the users didn't borrow before. (books.returnShelvesBooks)

public returnShelvesBooks(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Libraryagent_GoogleExampleLibraryagentV1Book
Parameters
$name : string

Required. The name of the book to return.

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

Optional parameters.

Return values
Google_Service_Libraryagent_GoogleExampleLibraryagentV1Book —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results