API Documentation
\
Google
Photos
Library
V1
AlbumPosition
Gapic
MediaTypeFilter
GPBMetadata
Google
Photos
Library
V1

\Google\Photos\Library\V1ShareInfo

Information about albums that are shared. This information is only included if you created the album, it is shared and you have the sharing scope.

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

Summary

Methods
Properties
Constants
__construct()
getSharedAlbumOptions()
setSharedAlbumOptions()
getShareableUrl()
setShareableUrl()
getShareToken()
setShareToken()
getIsJoined()
setIsJoined()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$shared_album_options
$shareable_url
$share_token
$is_joined
N/A

Properties

$shared_album_options

$shared_album_options :

Options that control the sharing of an album.

Generated from protobuf field .google.photos.library.v1.SharedAlbumOptions shared_album_options = 1;

Type

$shareable_url

$shareable_url :

A link to the album that's now shared on the Google Photos website and app.

Anyone with the link can access this shared album and see all of the items present in the album.

Generated from protobuf field string shareable_url = 2;

Type

$share_token

$share_token :

A token that can be used by other users to join this shared album via the API.

Generated from protobuf field string share_token = 3;

Type

$is_joined

$is_joined :

True if the user has joined the album. This is always true for the owner of the shared album.

Generated from protobuf field bool is_joined = 4;

Type

Methods

__construct()

__construct(array  $data = NULL)

Constructor.

Parameters

array $data

{ Optional. Data for populating the Message object.

@type \Google\Photos\Library\V1\SharedAlbumOptions $shared_album_options
      Options that control the sharing of an album.
@type string $shareable_url
      A link to the album that's now shared on the Google Photos website and app.
      Anyone with the link can access this shared album and see all of the items
      present in the album.
@type string $share_token
      A token that can be used by other users to join this shared album via the
      API.
@type bool $is_joined
      True if the user has joined the album. This is always true for the owner
      of the shared album.

}

getSharedAlbumOptions()

getSharedAlbumOptions() : \Google\Photos\Library\V1\SharedAlbumOptions

Options that control the sharing of an album.

Generated from protobuf field .google.photos.library.v1.SharedAlbumOptions shared_album_options = 1;

Returns

\Google\Photos\Library\V1\SharedAlbumOptions

setSharedAlbumOptions()

setSharedAlbumOptions(\Google\Photos\Library\V1\SharedAlbumOptions  $var) : $this

Options that control the sharing of an album.

Generated from protobuf field .google.photos.library.v1.SharedAlbumOptions shared_album_options = 1;

Parameters

\Google\Photos\Library\V1\SharedAlbumOptions $var

Returns

$this

getShareableUrl()

getShareableUrl() : string

A link to the album that's now shared on the Google Photos website and app.

Anyone with the link can access this shared album and see all of the items present in the album.

Generated from protobuf field string shareable_url = 2;

Returns

string

setShareableUrl()

setShareableUrl(string  $var) : $this

A link to the album that's now shared on the Google Photos website and app.

Anyone with the link can access this shared album and see all of the items present in the album.

Generated from protobuf field string shareable_url = 2;

Parameters

string $var

Returns

$this

getShareToken()

getShareToken() : string

A token that can be used by other users to join this shared album via the API.

Generated from protobuf field string share_token = 3;

Returns

string

setShareToken()

setShareToken(string  $var) : $this

A token that can be used by other users to join this shared album via the API.

Generated from protobuf field string share_token = 3;

Parameters

string $var

Returns

$this

getIsJoined()

getIsJoined() : boolean

True if the user has joined the album. This is always true for the owner of the shared album.

Generated from protobuf field bool is_joined = 4;

Returns

boolean

setIsJoined()

setIsJoined(boolean  $var) : $this

True if the user has joined the album. This is always true for the owner of the shared album.

Generated from protobuf field bool is_joined = 4;

Parameters

boolean $var

Returns

$this