Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.PhotosLibrary.MediaItems.Search

Contents

REST Resource
Creating a Request
Request Lenses

Description

Searches for media items in a user's Google Photos library. If no filters are set, then all media items in the user's library will be returned. If an album is set, all media items in the specified album will be returned. If filters are specified, anything that matches the filters from the user's library will be listed. If an album and filters are set, then this will result in an error.

See: Photos Library API Reference for photoslibrary.mediaItems.search.

Synopsis

type MediaItemsSearchResource = "v1" :> ("mediaItems:search" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SearchMediaItemsRequest :> Post '[JSON] SearchMediaItemsResponse))))))))))
mediaItemsSearch :: SearchMediaItemsRequest -> MediaItemsSearch
data MediaItemsSearch
misXgafv :: Lens' MediaItemsSearch (Maybe Xgafv)
misUploadProtocol :: Lens' MediaItemsSearch (Maybe Text)
misPp :: Lens' MediaItemsSearch Bool
misAccessToken :: Lens' MediaItemsSearch (Maybe Text)
misUploadType :: Lens' MediaItemsSearch (Maybe Text)
misPayload :: Lens' MediaItemsSearch SearchMediaItemsRequest
misBearerToken :: Lens' MediaItemsSearch (Maybe Text)
misCallback :: Lens' MediaItemsSearch (Maybe Text)

REST Resource

type MediaItemsSearchResource = "v1" :> ("mediaItems:search" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SearchMediaItemsRequest :> Post '[JSON] SearchMediaItemsResponse)))))))))) Source #

A resource alias for photoslibrary.mediaItems.search method which the MediaItemsSearch request conforms to.

Creating a Request

mediaItemsSearch Source #

Arguments

:: SearchMediaItemsRequest	`misPayload`
-> MediaItemsSearch

Creates a value of MediaItemsSearch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data MediaItemsSearch Source #

Searches for media items in a user's Google Photos library. If no filters are set, then all media items in the user's library will be returned. If an album is set, all media items in the specified album will be returned. If filters are specified, anything that matches the filters from the user's library will be listed. If an album and filters are set, then this will result in an error.

See: mediaItemsSearch smart constructor.

Instances

Eq MediaItemsSearch Source #
Instance details Defined in Network.Google.Resource.PhotosLibrary.MediaItems.Search Methods (==) :: MediaItemsSearch -> MediaItemsSearch -> Bool # (/=) :: MediaItemsSearch -> MediaItemsSearch -> Bool #
Data MediaItemsSearch Source #
Instance details Defined in Network.Google.Resource.PhotosLibrary.MediaItems.Search Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MediaItemsSearch -> c MediaItemsSearch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MediaItemsSearch # toConstr :: MediaItemsSearch -> Constr # dataTypeOf :: MediaItemsSearch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MediaItemsSearch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MediaItemsSearch) # gmapT :: (forall b. Data b => b -> b) -> MediaItemsSearch -> MediaItemsSearch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MediaItemsSearch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MediaItemsSearch -> r # gmapQ :: (forall d. Data d => d -> u) -> MediaItemsSearch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MediaItemsSearch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MediaItemsSearch -> m MediaItemsSearch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaItemsSearch -> m MediaItemsSearch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaItemsSearch -> m MediaItemsSearch #
Show MediaItemsSearch Source #
Instance details Defined in Network.Google.Resource.PhotosLibrary.MediaItems.Search Methods showsPrec :: Int -> MediaItemsSearch -> ShowS # show :: MediaItemsSearch -> String # showList :: [MediaItemsSearch] -> ShowS #
Generic MediaItemsSearch Source #
Instance details Defined in Network.Google.Resource.PhotosLibrary.MediaItems.Search Associated Types type Rep MediaItemsSearch :: Type -> Type # Methods from :: MediaItemsSearch -> Rep MediaItemsSearch x # to :: Rep MediaItemsSearch x -> MediaItemsSearch #
GoogleRequest MediaItemsSearch Source #
Instance details Defined in Network.Google.Resource.PhotosLibrary.MediaItems.Search Associated Types type Rs MediaItemsSearch :: Type # type Scopes MediaItemsSearch :: [Symbol] # Methods requestClient :: MediaItemsSearch -> GClient (Rs MediaItemsSearch) #
type Rep MediaItemsSearch Source #
Instance details Defined in Network.Google.Resource.PhotosLibrary.MediaItems.Search type Rep MediaItemsSearch = D1 (MetaData "MediaItemsSearch" "Network.Google.Resource.PhotosLibrary.MediaItems.Search" "gogol-photoslibrary-0.4.0-GpZ5alnuI5C2GY8YRh8G4V" False) (C1 (MetaCons "MediaItemsSearch'" PrefixI True) (((S1 (MetaSel (Just "_misXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_misUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_misPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: S1 (MetaSel (Just "_misAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_misUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_misPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SearchMediaItemsRequest)) :: (S1 (MetaSel (Just "_misBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_misCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes MediaItemsSearch Source #
Instance details Defined in Network.Google.Resource.PhotosLibrary.MediaItems.Search type Scopes MediaItemsSearch = "https://www.googleapis.com/auth/drive.photos.readonly" ': ("https://www.googleapis.com/auth/photoslibrary" ': ("https://www.googleapis.com/auth/photoslibrary.readonly" ': ("https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata" ': ([] :: [Symbol]))))
type Rs MediaItemsSearch Source #
Instance details Defined in Network.Google.Resource.PhotosLibrary.MediaItems.Search type Rs MediaItemsSearch = SearchMediaItemsResponse

Request Lenses

misXgafv :: Lens' MediaItemsSearch (Maybe Xgafv) Source #

V1 error format.

misUploadProtocol :: Lens' MediaItemsSearch (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

misPp :: Lens' MediaItemsSearch Bool Source #

Pretty-print response.

misAccessToken :: Lens' MediaItemsSearch (Maybe Text) Source #

OAuth access token.

misUploadType :: Lens' MediaItemsSearch (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

misPayload :: Lens' MediaItemsSearch SearchMediaItemsRequest Source #

Multipart request metadata.

misBearerToken :: Lens' MediaItemsSearch (Maybe Text) Source #

OAuth bearer token.

misCallback :: Lens' MediaItemsSearch (Maybe Text) Source #

JSONP