\Google\Photos\TypesShareInfo

__construct()

__construct(array  $data = NULL) : mixed

Constructor.

Parameters

@type \Google\Photos\Types\SharedAlbumOptions $shared_album_options
      Options that control whether someone can add media items to, or comment on
      a shared album.
@type string $shareable_url
      A link to the shared Google Photos album. Anyone with the link can view the
      contents of the album, so it should be treated with care.
      The `shareableUrl` parameter is only returned if the album has link sharing
      turned on. If a user is already joined to an album that isn't link-shared,
      they can use the album's
      [`productUrl`](https://developers.google.com/photos/library/reference/rest/v1/albums#Album)
      to access it instead.
      A `shareableUrl` is invalidated if the owner turns off link sharing in the
      Google Photos app, or if the album is unshared.
@type string $share_token
      A token that is used to join, leave, or retrieve the details of a shared
      album on behalf of a user who isn't the owner.
      A `shareToken` is invalidated if the owner turns off link sharing in the
      Google Photos app, or if the album is unshared.
@type bool $is_joined
      True if the user is joined to the album. This is always true for
      the owner of the album.
@type bool $is_owned
      True if the user owns the album.
@type bool $is_joinable
      True if the album can be joined by users.

Returns

getSharedAlbumOptions()

getSharedAlbumOptions() : \Google\Photos\Types\SharedAlbumOptions

Options that control whether someone can add media items to, or comment on a shared album.

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

Returns

setSharedAlbumOptions()

setSharedAlbumOptions(\Google\Photos\Types\SharedAlbumOptions  $var) : $this

Options that control whether someone can add media items to, or comment on a shared album.

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

Parameters

Returns

getShareableUrl()

getShareableUrl() : string

A link to the shared Google Photos album. Anyone with the link can view the contents of the album, so it should be treated with care.

The shareableUrl parameter is only returned if the album has link sharing turned on. If a user is already joined to an album that isn't link-shared, they can use the album's productUrl to access it instead. A shareableUrl is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.

Generated from protobuf field string shareable_url = 2;

Returns

setShareableUrl()

setShareableUrl(string  $var) : $this

A link to the shared Google Photos album. Anyone with the link can view the contents of the album, so it should be treated with care.

The shareableUrl parameter is only returned if the album has link sharing turned on. If a user is already joined to an album that isn't link-shared, they can use the album's productUrl to access it instead. A shareableUrl is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.

Generated from protobuf field string shareable_url = 2;

Parameters

Returns

getShareToken()

getShareToken() : string

A token that is used to join, leave, or retrieve the details of a shared album on behalf of a user who isn't the owner.

A shareToken is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.

Generated from protobuf field string share_token = 3;

Returns

setShareToken()

setShareToken(string  $var) : $this

A token that is used to join, leave, or retrieve the details of a shared album on behalf of a user who isn't the owner.

A shareToken is invalidated if the owner turns off link sharing in the Google Photos app, or if the album is unshared.

Generated from protobuf field string share_token = 3;

Parameters

Returns

getIsJoined()

getIsJoined() : bool

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

Generated from protobuf field bool is_joined = 4;

Returns

setIsJoined()

setIsJoined(bool  $var) : $this

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

Generated from protobuf field bool is_joined = 4;

Parameters

Returns

getIsOwned()

getIsOwned() : bool

True if the user owns the album.

Generated from protobuf field bool is_owned = 5;

Returns

setIsOwned()

setIsOwned(bool  $var) : $this

True if the user owns the album.

Generated from protobuf field bool is_owned = 5;

Parameters

Returns

getIsJoinable()

getIsJoinable() : bool

True if the album can be joined by users.

Generated from protobuf field bool is_joinable = 6;

Returns

setIsJoinable()

setIsJoinable(bool  $var) : $this

True if the album can be joined by users.

Generated from protobuf field bool is_joinable = 6;

Parameters

Returns