Documentation

Google_Service_PhotosLibrary_Resource_MediaItems extends Google_Service_Resource
in package

The "mediaItems" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchCreate()  : Google_Service_PhotosLibrary_BatchCreateMediaItemsResponse
Creates one or more media items in a user's Google Photos library. If an album id is specified, the media item(s) are also added to the album. By default the media item(s) will be added to the end of the library or album.
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_PhotosLibrary_MediaItem
Returns the media item specified based on a given media item id.
search()  : Google_Service_PhotosLibrary_SearchMediaItemsResponse
Searches for media items in a user's Google Photos library. If no filters are set, then all media items in the user's library will be returned.
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 —

batchCreate()

Creates one or more media items in a user's Google Photos library. If an album id is specified, the media item(s) are also added to the album. By default the media item(s) will be added to the end of the library or album.

public batchCreate(Google_Service_PhotosLibrary_BatchCreateMediaItemsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PhotosLibrary_BatchCreateMediaItemsResponse

If an album id and position are both defined, then the media items will be added to the album at the specified position.

If multiple media items are given, they will be inserted at the specified position. (mediaItems.batchCreate)

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

Optional parameters.

Return values
Google_Service_PhotosLibrary_BatchCreateMediaItemsResponse —

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

search()

Searches for media items in a user's Google Photos library. If no filters are set, then all media items in the user's library will be returned.

public search(Google_Service_PhotosLibrary_SearchMediaItemsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PhotosLibrary_SearchMediaItemsResponse

If an album is set, all media items in the specified album will be returned.

If filters are specified, anything that matches the filters from the user's library will be listed.

If an album and filters are set, then this will result in an error. (mediaItems.search)

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

Optional parameters.

Return values
Google_Service_PhotosLibrary_SearchMediaItemsResponse —

convertToArrayAndStripNulls()

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

Search results