Documentation
\
Google
Photos
Library
V1
AlbumPosition
FeatureFilter
Gapic
MediaTypeFilter
Types
GPBMetadata
Google
Photos
Library
V1
Types

\Google\Photos\Library\V1UpdateAlbumRequest

Request to update an album in Google Photos.

Generated from protobuf message google.photos.library.v1.UpdateAlbumRequest

Summary

Methods
Properties
Constants
__construct()
getAlbum()
setAlbum()
getUpdateMask()
setUpdateMask()
No public properties found
No constants found
No protected methods found
$album
$update_mask
N/A
No private methods found
No private properties found
N/A

Properties

$album

$album

Required. The [Album][google.photos.types.Album] to update.

The album’s id field is used to identify the album to be updated. The album’s title field is used to set the new album title. The album’s cover_photo_media_item_id field is used to set the new album cover photo.

Generated from protobuf field .google.photos.types.Album album = 1 [(.google.api.field_behavior) = REQUIRED];

$update_mask

$update_mask

Indicate what fields in the provided album to update.

The only valid values are title and cover_photo_media_item_id.

Generated from protobuf field .google.protobuf.FieldMask update_mask = 2;

Methods

__construct()

__construct(array  $data = NULL) : mixed

Constructor.

Parameters

array $data

{ Optional. Data for populating the Message object.

@type \Google\Photos\Types\Album $album
      Required. The [Album][google.photos.types.Album] to update.
      The album’s `id` field is used to identify the album to be updated.
      The album’s `title` field is used to set the new album title.
      The album’s `cover_photo_media_item_id` field is used to set the new album
      cover photo.
@type \Google\Protobuf\FieldMask $update_mask
      Indicate what fields in the provided album to update.
      The only valid values are `title` and `cover_photo_media_item_id`.

}

Returns

mixed

getAlbum()

getAlbum() : \Google\Photos\Types\Album

Required. The [Album][google.photos.types.Album] to update.

The album’s id field is used to identify the album to be updated. The album’s title field is used to set the new album title. The album’s cover_photo_media_item_id field is used to set the new album cover photo.

Generated from protobuf field .google.photos.types.Album album = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

\Google\Photos\Types\Album

setAlbum()

setAlbum(\Google\Photos\Types\Album  $var) : $this

Required. The [Album][google.photos.types.Album] to update.

The album’s id field is used to identify the album to be updated. The album’s title field is used to set the new album title. The album’s cover_photo_media_item_id field is used to set the new album cover photo.

Generated from protobuf field .google.photos.types.Album album = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters

\Google\Photos\Types\Album $var

Returns

$this

getUpdateMask()

getUpdateMask() : \Google\Protobuf\FieldMask

Indicate what fields in the provided album to update.

The only valid values are title and cover_photo_media_item_id.

Generated from protobuf field .google.protobuf.FieldMask update_mask = 2;

Returns

\Google\Protobuf\FieldMask

setUpdateMask()

setUpdateMask(\Google\Protobuf\FieldMask  $var) : $this

Indicate what fields in the provided album to update.

The only valid values are title and cover_photo_media_item_id.

Generated from protobuf field .google.protobuf.FieldMask update_mask = 2;

Parameters

\Google\Protobuf\FieldMask $var

Returns

$this