\Google\Photos\Library\V1Album

Representation of an album in Google Photos.

Albums are containers for media items. If an album has been shared by the application, it contains an extra shareInfo property.

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

Summary

Methods

Properties

Constants

__construct()
getId()
setId()
getTitle()
setTitle()
getProductUrl()
setProductUrl()
getIsWriteable()
setIsWriteable()
getShareInfo()
setShareInfo()
getMediaItemsCount()
setMediaItemsCount()
getCoverPhotoBaseUrl()
setCoverPhotoBaseUrl()
getCoverPhotoMediaItemId()
setCoverPhotoMediaItemId()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$id
$title
$product_url
$is_writeable
$share_info
$media_items_count
$cover_photo_base_url
$cover_photo_media_item_id

N/A

File: Google/Photos/Library/V1/Album.php
Package: Default
Class hierarchy: \Google\Protobuf\Internal\Message

\Google\Photos\Library\V1\Album

Properties

$id

$id :

[Ouput only] Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.

Generated from protobuf field string id = 1;

Type

$title

$title :

Name of the album displayed to the user in their Google Photos account.

This string shouldn't be more than 500 characters.

Generated from protobuf field string title = 2;

Type

$product_url

$product_url :

[Output only] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link.

Generated from protobuf field string product_url = 3;

Type

$is_writeable

$is_writeable :

[Output only] True if you can create media items in this album.

This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated.

Generated from protobuf field bool is_writeable = 4;

Type

$share_info

$share_info :

[Output only] Information related to shared albums.

This field is only populated if the album is a shared album, the developer created the album and the user has granted the photoslibrary.sharing scope.

Generated from protobuf field .google.photos.library.v1.ShareInfo share_info = 5;

Type

$media_items_count

$media_items_count :

[Output only] The number of media items in the album.

Generated from protobuf field int64 media_items_count = 6;

Type

$cover_photo_base_url

$cover_photo_base_url :

[Output only] A URL to the cover photo's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. For example, `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of 2048 px and height of 1024 px.

Generated from protobuf field string cover_photo_base_url = 7;

Type

$cover_photo_media_item_id

$cover_photo_media_item_id :

[Output only] Identifier for the media item associated with the cover photo.

Generated from protobuf field string cover_photo_media_item_id = 8;

Type

Methods

__construct()

__construct(array  $data = NULL)

Constructor.

Parameters

array

$data

{ Optional. Data for populating the Message object.

@type string $id
      [Ouput only] Identifier for the album. This is a persistent identifier that
      can be used between sessions to identify this album.
@type string $title
      Name of the album displayed to the user in their Google Photos account.
      This string shouldn't be more than 500 characters.
@type string $product_url
      [Output only] Google Photos URL for the album. The user needs to be signed
      in to their Google Photos account to access this link.
@type bool $is_writeable
      [Output only] True if you can create media items in this album.
      This field is based on the scopes granted and permissions of the album. If
      the scopes are changed or permissions of the album are changed, this field
      is updated.
@type \Google\Photos\Library\V1\ShareInfo $share_info
      [Output only] Information related to shared albums.
      This field is only populated if the album is a shared album, the
      developer created the album and the user has granted the
      `photoslibrary.sharing` scope.
@type int|string $media_items_count
      [Output only] The number of media items in the album.
@type string $cover_photo_base_url
      [Output only] A URL to the cover photo's bytes. This shouldn't be used as
      is. Parameters should be appended to this URL before use. For example,
      `'=w2048-h1024'` sets the dimensions of
      the cover photo to have a width of 2048 px and height of 1024 px.
@type string $cover_photo_media_item_id
      [Output only] Identifier for the media item associated with the cover
      photo.

}

getId()

getId() : string

[Ouput only] Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.

Generated from protobuf field string id = 1;

Returns

string

setId()

setId(string  $var) : $this

[Ouput only] Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.

Generated from protobuf field string id = 1;

Parameters

string

$var

Returns

$this

getTitle()

getTitle() : string

Name of the album displayed to the user in their Google Photos account.

This string shouldn't be more than 500 characters.

Generated from protobuf field string title = 2;

Returns

string

setTitle()

setTitle(string  $var) : $this

Name of the album displayed to the user in their Google Photos account.

This string shouldn't be more than 500 characters.

Generated from protobuf field string title = 2;

Parameters

string

$var

Returns

$this

getProductUrl()

getProductUrl() : string

[Output only] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link.

Generated from protobuf field string product_url = 3;

Returns

string

setProductUrl()

setProductUrl(string  $var) : $this

[Output only] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link.

Generated from protobuf field string product_url = 3;

Parameters

string

$var

Returns

$this

getIsWriteable()

getIsWriteable() : boolean

[Output only] True if you can create media items in this album.

This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated.

Generated from protobuf field bool is_writeable = 4;

Returns

boolean

setIsWriteable()

setIsWriteable(boolean  $var) : $this

[Output only] True if you can create media items in this album.

This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated.

Generated from protobuf field bool is_writeable = 4;

Parameters

boolean

$var

Returns

$this

getShareInfo()

getShareInfo() : \Google\Photos\Library\V1\ShareInfo

[Output only] Information related to shared albums.

This field is only populated if the album is a shared album, the developer created the album and the user has granted the photoslibrary.sharing scope.

Generated from protobuf field .google.photos.library.v1.ShareInfo share_info = 5;

Returns

\Google\Photos\Library\V1\ShareInfo

setShareInfo()

setShareInfo(\Google\Photos\Library\V1\ShareInfo  $var) : $this

[Output only] Information related to shared albums.

This field is only populated if the album is a shared album, the developer created the album and the user has granted the photoslibrary.sharing scope.

Generated from protobuf field .google.photos.library.v1.ShareInfo share_info = 5;

Parameters

\Google\Photos\Library\V1\ShareInfo

$var

Returns

$this

getMediaItemsCount()

getMediaItemsCount() : integer|string

[Output only] The number of media items in the album.

Generated from protobuf field int64 media_items_count = 6;

Returns

integer|string

setMediaItemsCount()

setMediaItemsCount(integer|string  $var) : $this

[Output only] The number of media items in the album.

Generated from protobuf field int64 media_items_count = 6;

Parameters

integer|string

$var

Returns

$this

getCoverPhotoBaseUrl()

getCoverPhotoBaseUrl() : string

Generated from protobuf field string cover_photo_base_url = 7;

Returns

string

setCoverPhotoBaseUrl()

setCoverPhotoBaseUrl(string  $var) : $this

Generated from protobuf field string cover_photo_base_url = 7;

Parameters

string

$var

Returns

$this

getCoverPhotoMediaItemId()

getCoverPhotoMediaItemId() : string

[Output only] Identifier for the media item associated with the cover photo.

Generated from protobuf field string cover_photo_media_item_id = 8;

Returns

string

setCoverPhotoMediaItemId()

setCoverPhotoMediaItemId(string  $var) : $this

[Output only] Identifier for the media item associated with the cover photo.

Generated from protobuf field string cover_photo_media_item_id = 8;

Parameters

string

$var

Returns

$this