\Google\Photos\Library\V1ListSharedAlbumsRequest

Request to retrieve the user's list of shared albums. This will return the list of albums corresponding to the user's 'Sharing' tab in the Google Photos app.

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

Summary

Methods

Properties

Constants

__construct()
getPageSize()
setPageSize()
getPageToken()
setPageToken()
getExcludeNonAppCreatedData()
setExcludeNonAppCreatedData()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$page_size
$page_token
$exclude_non_app_created_data

N/A

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

\Google\Photos\Library\V1\ListSharedAlbumsRequest

Properties

$page_size

$page_size :

Maximum number of albums to return in the response. The default number of albums to return at a time is 20. The maximum `pageSize` is 50.

Generated from protobuf field int32 page_size = 1;

Type

$page_token

$page_token :

A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listSharedAlbums` request.

Generated from protobuf field string page_token = 2;

Type

$exclude_non_app_created_data

$exclude_non_app_created_data :

If set, the results exclude media items that were not created by this app.

Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.

Generated from protobuf field bool exclude_non_app_created_data = 3;

Type

Methods

__construct()

__construct(array  $data = NULL)

Constructor.

Parameters

array

$data

{ Optional. Data for populating the Message object.

@type int $page_size
      Maximum number of albums to return in the response. The default number of
      albums to return at a time is 20. The maximum `pageSize` is 50.
@type string $page_token
      A continuation token to get the next page of the results. Adding this to
      the request returns the rows after the `pageToken`. The `pageToken` should
      be the value returned in the `nextPageToken` parameter in the response to
      the `listSharedAlbums` request.
@type bool $exclude_non_app_created_data
      If set, the results exclude media items that were not created by this app.
      Defaults to false (all albums are returned). This field is ignored if the
      photoslibrary.readonly.appcreateddata scope is used.

}

getPageSize()

getPageSize() : integer

Maximum number of albums to return in the response. The default number of albums to return at a time is 20. The maximum `pageSize` is 50.

Generated from protobuf field int32 page_size = 1;

Returns

integer

setPageSize()

setPageSize(integer  $var) : $this

Maximum number of albums to return in the response. The default number of albums to return at a time is 20. The maximum `pageSize` is 50.

Generated from protobuf field int32 page_size = 1;

Parameters

integer

$var

Returns

$this

getPageToken()

getPageToken() : string

Generated from protobuf field string page_token = 2;

Returns

string

setPageToken()

setPageToken(string  $var) : $this

Generated from protobuf field string page_token = 2;

Parameters

string

$var

Returns

$this

getExcludeNonAppCreatedData()

getExcludeNonAppCreatedData() : boolean

If set, the results exclude media items that were not created by this app.

Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.

Generated from protobuf field bool exclude_non_app_created_data = 3;

Returns

boolean

setExcludeNonAppCreatedData()

setExcludeNonAppCreatedData(boolean  $var) : $this

If set, the results exclude media items that were not created by this app.

Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.

Generated from protobuf field bool exclude_non_app_created_data = 3;

Parameters

boolean

$var

Returns

$this