Documentation

Google_Service_PhotosLibrary_Resource_Albums extends Google_Service_Resource
in package

The "albums" collection of methods.

Typical usage is: $photoslibraryService = new Google_Service_PhotosLibrary(...); $albums = $photoslibraryService->albums;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
addEnrichment()  : Google_Service_PhotosLibrary_AddEnrichmentToAlbumResponse
Adds an enrichment to a specified position in a defined album.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_PhotosLibrary_Album
Creates an album in a user's Google Photos library. (albums.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_PhotosLibrary_Album
Returns the album specified by the given album id. (albums.get)
listAlbums()  : Google_Service_PhotosLibrary_ListAlbumsResponse
Lists all albums shown to a user in the 'Albums' tab of the Google Photos app. (albums.listAlbums)
share()  : Google_Service_PhotosLibrary_ShareAlbumResponse
Marks an album as 'shared' and accessible to other users. This action can only be performed on albums which were created by the developer via the API.
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 —

addEnrichment()

Adds an enrichment to a specified position in a defined album.

public addEnrichment(string $albumId, Google_Service_PhotosLibrary_AddEnrichmentToAlbumRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PhotosLibrary_AddEnrichmentToAlbumResponse

(albums.addEnrichment)

Parameters
$albumId : string

Identifier of the album where the enrichment will be added.

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

Optional parameters.

Return values
Google_Service_PhotosLibrary_AddEnrichmentToAlbumResponse —

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

get()

Returns the album specified by the given album id. (albums.get)

public get(string $albumId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PhotosLibrary_Album
Parameters
$albumId : string

Identifier of the album to be requested.

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

Optional parameters.

Return values
Google_Service_PhotosLibrary_Album —

listAlbums()

Lists all albums shown to a user in the 'Albums' tab of the Google Photos app. (albums.listAlbums)

public listAlbums([array<string|int, mixed> $optParams = array() ]) : Google_Service_PhotosLibrary_ListAlbumsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken A continuation token to get the next page of the results. Adding this to the request will return the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the listAlbums request.

opt_param

int pageSize Maximum number of albums to return in the response. The default number of albums to return at a time is 20. The maximum page size is 50.

Return values
Google_Service_PhotosLibrary_ListAlbumsResponse —

share()

Marks an album as 'shared' and accessible to other users. This action can only be performed on albums which were created by the developer via the API.

public share(string $albumId, Google_Service_PhotosLibrary_ShareAlbumRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PhotosLibrary_ShareAlbumResponse

(albums.share)

Parameters
$albumId : string

Identifier of the album to be shared. This album id must belong to an album created by the developer. .

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

Optional parameters.

Return values
Google_Service_PhotosLibrary_ShareAlbumResponse —

convertToArrayAndStripNulls()

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

Search results