Documentation

Google_Service_PhotosLibrary_Resource_SharedAlbums extends Google_Service_Resource
in package

The "sharedAlbums" collection of methods.

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

Table of Contents

$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.
join()  : Google_Service_PhotosLibrary_JoinSharedAlbumResponse
Joins a shared album on behalf of the Google Photos user. (sharedAlbums.join)
listSharedAlbums()  : Google_Service_PhotosLibrary_ListSharedAlbumsResponse
Lists all shared albums shown to a user in the 'Sharing' tab of the Google Photos app. (sharedAlbums.listSharedAlbums)
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 —

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

join()

Joins a shared album on behalf of the Google Photos user. (sharedAlbums.join)

public join(Google_Service_PhotosLibrary_JoinSharedAlbumRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PhotosLibrary_JoinSharedAlbumResponse
Parameters
$postBody : Google_Service_PhotosLibrary_JoinSharedAlbumRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_PhotosLibrary_JoinSharedAlbumResponse —

listSharedAlbums()

Lists all shared albums shown to a user in the 'Sharing' tab of the Google Photos app. (sharedAlbums.listSharedAlbums)

public listSharedAlbums([array<string|int, mixed> $optParams = array() ]) : Google_Service_PhotosLibrary_ListSharedAlbumsResponse
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 listSharedAlbums 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_ListSharedAlbumsResponse —

convertToArrayAndStripNulls()

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

Search results