{-# LANGUAGE DataKinds #-} {-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeOperators #-} {-# OPTIONS_GHC -fno-warn-duplicate-exports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} -- | -- Module : Network.Google.Resource.YouTube.LiveStreams.List -- Copyright : (c) 2015-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Returns a list of video streams that match the API request parameters. -- -- /See:/ for @youtube.liveStreams.list@. module Network.Google.Resource.YouTube.LiveStreams.List ( -- * REST Resource LiveStreamsListResource -- * Creating a Request , liveStreamsList , LiveStreamsList -- * Request Lenses , lslPart , lslMine , lslOnBehalfOfContentOwner , lslOnBehalfOfContentOwnerChannel , lslId , lslPageToken , lslMaxResults ) where import Network.Google.Prelude import Network.Google.YouTube.Types -- | A resource alias for @youtube.liveStreams.list@ method which the -- 'LiveStreamsList' request conforms to. type LiveStreamsListResource = "youtube" :> "v3" :> "liveStreams" :> QueryParam "part" Text :> QueryParam "mine" Bool :> QueryParam "onBehalfOfContentOwner" Text :> QueryParam "onBehalfOfContentOwnerChannel" Text :> QueryParam "id" Text :> QueryParam "pageToken" Text :> QueryParam "maxResults" (Textual Word32) :> QueryParam "alt" AltJSON :> Get '[JSON] LiveStreamListResponse -- | Returns a list of video streams that match the API request parameters. -- -- /See:/ 'liveStreamsList' smart constructor. data LiveStreamsList = LiveStreamsList' { _lslPart :: !Text , _lslMine :: !(Maybe Bool) , _lslOnBehalfOfContentOwner :: !(Maybe Text) , _lslOnBehalfOfContentOwnerChannel :: !(Maybe Text) , _lslId :: !(Maybe Text) , _lslPageToken :: !(Maybe Text) , _lslMaxResults :: !(Textual Word32) } deriving (Eq, Show, Data, Typeable, Generic) -- | Creates a value of 'LiveStreamsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'lslPart' -- -- * 'lslMine' -- -- * 'lslOnBehalfOfContentOwner' -- -- * 'lslOnBehalfOfContentOwnerChannel' -- -- * 'lslId' -- -- * 'lslPageToken' -- -- * 'lslMaxResults' liveStreamsList :: Text -- ^ 'lslPart' -> LiveStreamsList liveStreamsList pLslPart_ = LiveStreamsList' { _lslPart = pLslPart_ , _lslMine = Nothing , _lslOnBehalfOfContentOwner = Nothing , _lslOnBehalfOfContentOwnerChannel = Nothing , _lslId = Nothing , _lslPageToken = Nothing , _lslMaxResults = 5 } -- | The part parameter specifies a comma-separated list of one or more -- liveStream resource properties that the API response will include. The -- part names that you can include in the parameter value are id, snippet, -- cdn, and status. lslPart :: Lens' LiveStreamsList Text lslPart = lens _lslPart (\ s a -> s{_lslPart = a}) -- | The mine parameter can be used to instruct the API to only return -- streams owned by the authenticated user. Set the parameter value to true -- to only retrieve your own streams. lslMine :: Lens' LiveStreamsList (Maybe Bool) lslMine = lens _lslMine (\ s a -> s{_lslMine = a}) -- | Note: This parameter is intended exclusively for YouTube content -- partners. The onBehalfOfContentOwner parameter indicates that the -- request\'s authorization credentials identify a YouTube CMS user who is -- acting on behalf of the content owner specified in the parameter value. -- This parameter is intended for YouTube content partners that own and -- manage many different YouTube channels. It allows content owners to -- authenticate once and get access to all their video and channel data, -- without having to provide authentication credentials for each individual -- channel. The CMS account that the user authenticates with must be linked -- to the specified YouTube content owner. lslOnBehalfOfContentOwner :: Lens' LiveStreamsList (Maybe Text) lslOnBehalfOfContentOwner = lens _lslOnBehalfOfContentOwner (\ s a -> s{_lslOnBehalfOfContentOwner = a}) -- | This parameter can only be used in a properly authorized request. Note: -- This parameter is intended exclusively for YouTube content partners. The -- onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID -- of the channel to which a video is being added. This parameter is -- required when a request specifies a value for the onBehalfOfContentOwner -- parameter, and it can only be used in conjunction with that parameter. -- In addition, the request must be authorized using a CMS account that is -- linked to the content owner that the onBehalfOfContentOwner parameter -- specifies. Finally, the channel that the onBehalfOfContentOwnerChannel -- parameter value specifies must be linked to the content owner that the -- onBehalfOfContentOwner parameter specifies. This parameter is intended -- for YouTube content partners that own and manage many different YouTube -- channels. It allows content owners to authenticate once and perform -- actions on behalf of the channel specified in the parameter value, -- without having to provide authentication credentials for each separate -- channel. lslOnBehalfOfContentOwnerChannel :: Lens' LiveStreamsList (Maybe Text) lslOnBehalfOfContentOwnerChannel = lens _lslOnBehalfOfContentOwnerChannel (\ s a -> s{_lslOnBehalfOfContentOwnerChannel = a}) -- | The id parameter specifies a comma-separated list of YouTube stream IDs -- that identify the streams being retrieved. In a liveStream resource, the -- id property specifies the stream\'s ID. lslId :: Lens' LiveStreamsList (Maybe Text) lslId = lens _lslId (\ s a -> s{_lslId = a}) -- | The pageToken parameter identifies a specific page in the result set -- that should be returned. In an API response, the nextPageToken and -- prevPageToken properties identify other pages that could be retrieved. lslPageToken :: Lens' LiveStreamsList (Maybe Text) lslPageToken = lens _lslPageToken (\ s a -> s{_lslPageToken = a}) -- | The maxResults parameter specifies the maximum number of items that -- should be returned in the result set. lslMaxResults :: Lens' LiveStreamsList Word32 lslMaxResults = lens _lslMaxResults (\ s a -> s{_lslMaxResults = a}) . _Coerce instance GoogleRequest LiveStreamsList where type Rs LiveStreamsList = LiveStreamListResponse type Scopes LiveStreamsList = '["https://www.googleapis.com/auth/youtube", "https://www.googleapis.com/auth/youtube.force-ssl", "https://www.googleapis.com/auth/youtube.readonly"] requestClient LiveStreamsList'{..} = go (Just _lslPart) _lslMine _lslOnBehalfOfContentOwner _lslOnBehalfOfContentOwnerChannel _lslId _lslPageToken (Just _lslMaxResults) (Just AltJSON) youTubeService where go = buildClient (Proxy :: Proxy LiveStreamsListResource) mempty