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

\Google\Photos\Library\V1Filters

Filters that can be applied to a media item search.

If multiple filter options are specified, they're treated as AND with each other.

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

Summary

Methods
Properties
Constants
__construct()
getDateFilter()
setDateFilter()
getContentFilter()
setContentFilter()
getMediaTypeFilter()
setMediaTypeFilter()
getFeatureFilter()
setFeatureFilter()
getIncludeArchivedMedia()
setIncludeArchivedMedia()
getExcludeNonAppCreatedData()
setExcludeNonAppCreatedData()
No public properties found
No constants found
No protected methods found
$date_filter
$content_filter
$media_type_filter
$feature_filter
$include_archived_media
$exclude_non_app_created_data
N/A
No private methods found
No private properties found
N/A

Properties

$date_filter

$date_filter

Filters the media items based on their creation date.

Generated from protobuf field .google.photos.library.v1.DateFilter date_filter = 1;

$content_filter

$content_filter

Filters the media items based on their content.

Generated from protobuf field .google.photos.library.v1.ContentFilter content_filter = 2;

$media_type_filter

$media_type_filter

Filters the media items based on the type of media.

Generated from protobuf field .google.photos.library.v1.MediaTypeFilter media_type_filter = 3;

$feature_filter

$feature_filter

Filters the media items based on their features.

Generated from protobuf field .google.photos.library.v1.FeatureFilter feature_filter = 7;

$include_archived_media

$include_archived_media

If set, the results include media items that the user has archived.

Defaults to false (archived media items aren't included).

Generated from protobuf field bool include_archived_media = 4;

$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 media items are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.

Generated from protobuf field bool exclude_non_app_created_data = 5;

Methods

__construct()

__construct(array  $data = NULL) : mixed

Constructor.

Parameters

array $data

{ Optional. Data for populating the Message object.

@type \Google\Photos\Library\V1\DateFilter $date_filter
      Filters the media items based on their creation date.
@type \Google\Photos\Library\V1\ContentFilter $content_filter
      Filters the media items based on their content.
@type \Google\Photos\Library\V1\MediaTypeFilter $media_type_filter
      Filters the media items based on the type of media.
@type \Google\Photos\Library\V1\FeatureFilter $feature_filter
      Filters the media items based on their features.
@type bool $include_archived_media
      If set, the results include media items that the user has archived.
      Defaults to false (archived media items aren't included).
@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 media items are returned). This field is ignored if
      the photoslibrary.readonly.appcreateddata scope is used.

}

Returns

mixed

getDateFilter()

getDateFilter() : \Google\Photos\Library\V1\DateFilter

Filters the media items based on their creation date.

Generated from protobuf field .google.photos.library.v1.DateFilter date_filter = 1;

Returns

\Google\Photos\Library\V1\DateFilter

setDateFilter()

setDateFilter(\Google\Photos\Library\V1\DateFilter  $var) : $this

Filters the media items based on their creation date.

Generated from protobuf field .google.photos.library.v1.DateFilter date_filter = 1;

Parameters

\Google\Photos\Library\V1\DateFilter $var

Returns

$this

getContentFilter()

getContentFilter() : \Google\Photos\Library\V1\ContentFilter

Filters the media items based on their content.

Generated from protobuf field .google.photos.library.v1.ContentFilter content_filter = 2;

Returns

\Google\Photos\Library\V1\ContentFilter

setContentFilter()

setContentFilter(\Google\Photos\Library\V1\ContentFilter  $var) : $this

Filters the media items based on their content.

Generated from protobuf field .google.photos.library.v1.ContentFilter content_filter = 2;

Parameters

\Google\Photos\Library\V1\ContentFilter $var

Returns

$this

getMediaTypeFilter()

getMediaTypeFilter() : \Google\Photos\Library\V1\MediaTypeFilter

Filters the media items based on the type of media.

Generated from protobuf field .google.photos.library.v1.MediaTypeFilter media_type_filter = 3;

Returns

\Google\Photos\Library\V1\MediaTypeFilter

setMediaTypeFilter()

setMediaTypeFilter(\Google\Photos\Library\V1\MediaTypeFilter  $var) : $this

Filters the media items based on the type of media.

Generated from protobuf field .google.photos.library.v1.MediaTypeFilter media_type_filter = 3;

Parameters

\Google\Photos\Library\V1\MediaTypeFilter $var

Returns

$this

getFeatureFilter()

getFeatureFilter() : \Google\Photos\Library\V1\FeatureFilter

Filters the media items based on their features.

Generated from protobuf field .google.photos.library.v1.FeatureFilter feature_filter = 7;

Returns

\Google\Photos\Library\V1\FeatureFilter

setFeatureFilter()

setFeatureFilter(\Google\Photos\Library\V1\FeatureFilter  $var) : $this

Filters the media items based on their features.

Generated from protobuf field .google.photos.library.v1.FeatureFilter feature_filter = 7;

Parameters

\Google\Photos\Library\V1\FeatureFilter $var

Returns

$this

getIncludeArchivedMedia()

getIncludeArchivedMedia() : bool

If set, the results include media items that the user has archived.

Defaults to false (archived media items aren't included).

Generated from protobuf field bool include_archived_media = 4;

Returns

bool

setIncludeArchivedMedia()

setIncludeArchivedMedia(bool  $var) : $this

If set, the results include media items that the user has archived.

Defaults to false (archived media items aren't included).

Generated from protobuf field bool include_archived_media = 4;

Parameters

bool $var

Returns

$this

getExcludeNonAppCreatedData()

getExcludeNonAppCreatedData() : bool

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

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

Generated from protobuf field bool exclude_non_app_created_data = 5;

Returns

bool

setExcludeNonAppCreatedData()

setExcludeNonAppCreatedData(bool  $var) : $this

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

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

Generated from protobuf field bool exclude_non_app_created_data = 5;

Parameters

bool $var

Returns

$this