{-# 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.LiveBroadcasts.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 YouTube broadcasts that match the API request -- parameters. -- -- /See:/ for @youtube.liveBroadcasts.list@. module Network.Google.Resource.YouTube.LiveBroadcasts.List ( -- * REST Resource LiveBroadcastsListResource -- * Creating a Request , liveBroadcastsList , LiveBroadcastsList -- * Request Lenses , lblPart , lblMine , lblBroadcastStatus , lblOnBehalfOfContentOwner , lblBroadcastType , lblOnBehalfOfContentOwnerChannel , lblId , lblPageToken , lblMaxResults ) where import Network.Google.Prelude import Network.Google.YouTube.Types -- | A resource alias for @youtube.liveBroadcasts.list@ method which the -- 'LiveBroadcastsList' request conforms to. type LiveBroadcastsListResource = "youtube" :> "v3" :> "liveBroadcasts" :> QueryParam "part" Text :> QueryParam "mine" Bool :> QueryParam "broadcastStatus" LiveBroadcastsListBroadcastStatus :> QueryParam "onBehalfOfContentOwner" Text :> QueryParam "broadcastType" LiveBroadcastsListBroadcastType :> QueryParam "onBehalfOfContentOwnerChannel" Text :> QueryParam "id" Text :> QueryParam "pageToken" Text :> QueryParam "maxResults" (Textual Word32) :> QueryParam "alt" AltJSON :> Get '[JSON] LiveBroadcastListResponse -- | Returns a list of YouTube broadcasts that match the API request -- parameters. -- -- /See:/ 'liveBroadcastsList' smart constructor. data LiveBroadcastsList = LiveBroadcastsList' { _lblPart :: !Text , _lblMine :: !(Maybe Bool) , _lblBroadcastStatus :: !(Maybe LiveBroadcastsListBroadcastStatus) , _lblOnBehalfOfContentOwner :: !(Maybe Text) , _lblBroadcastType :: !LiveBroadcastsListBroadcastType , _lblOnBehalfOfContentOwnerChannel :: !(Maybe Text) , _lblId :: !(Maybe Text) , _lblPageToken :: !(Maybe Text) , _lblMaxResults :: !(Textual Word32) } deriving (Eq,Show,Data,Typeable,Generic) -- | Creates a value of 'LiveBroadcastsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'lblPart' -- -- * 'lblMine' -- -- * 'lblBroadcastStatus' -- -- * 'lblOnBehalfOfContentOwner' -- -- * 'lblBroadcastType' -- -- * 'lblOnBehalfOfContentOwnerChannel' -- -- * 'lblId' -- -- * 'lblPageToken' -- -- * 'lblMaxResults' liveBroadcastsList :: Text -- ^ 'lblPart' -> LiveBroadcastsList liveBroadcastsList pLblPart_ = LiveBroadcastsList' { _lblPart = pLblPart_ , _lblMine = Nothing , _lblBroadcastStatus = Nothing , _lblOnBehalfOfContentOwner = Nothing , _lblBroadcastType = Event , _lblOnBehalfOfContentOwnerChannel = Nothing , _lblId = Nothing , _lblPageToken = Nothing , _lblMaxResults = 5 } -- | The part parameter specifies a comma-separated list of one or more -- liveBroadcast resource properties that the API response will include. -- The part names that you can include in the parameter value are id, -- snippet, contentDetails, and status. lblPart :: Lens' LiveBroadcastsList Text lblPart = lens _lblPart (\ s a -> s{_lblPart = a}) -- | The mine parameter can be used to instruct the API to only return -- broadcasts owned by the authenticated user. Set the parameter value to -- true to only retrieve your own broadcasts. lblMine :: Lens' LiveBroadcastsList (Maybe Bool) lblMine = lens _lblMine (\ s a -> s{_lblMine = a}) -- | The broadcastStatus parameter filters the API response to only include -- broadcasts with the specified status. lblBroadcastStatus :: Lens' LiveBroadcastsList (Maybe LiveBroadcastsListBroadcastStatus) lblBroadcastStatus = lens _lblBroadcastStatus (\ s a -> s{_lblBroadcastStatus = 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. lblOnBehalfOfContentOwner :: Lens' LiveBroadcastsList (Maybe Text) lblOnBehalfOfContentOwner = lens _lblOnBehalfOfContentOwner (\ s a -> s{_lblOnBehalfOfContentOwner = a}) -- | The broadcastType parameter filters the API response to only include -- broadcasts with the specified type. This is only compatible with the -- mine filter for now. lblBroadcastType :: Lens' LiveBroadcastsList LiveBroadcastsListBroadcastType lblBroadcastType = lens _lblBroadcastType (\ s a -> s{_lblBroadcastType = 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. lblOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsList (Maybe Text) lblOnBehalfOfContentOwnerChannel = lens _lblOnBehalfOfContentOwnerChannel (\ s a -> s{_lblOnBehalfOfContentOwnerChannel = a}) -- | The id parameter specifies a comma-separated list of YouTube broadcast -- IDs that identify the broadcasts being retrieved. In a liveBroadcast -- resource, the id property specifies the broadcast\'s ID. lblId :: Lens' LiveBroadcastsList (Maybe Text) lblId = lens _lblId (\ s a -> s{_lblId = 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. lblPageToken :: Lens' LiveBroadcastsList (Maybe Text) lblPageToken = lens _lblPageToken (\ s a -> s{_lblPageToken = a}) -- | The maxResults parameter specifies the maximum number of items that -- should be returned in the result set. lblMaxResults :: Lens' LiveBroadcastsList Word32 lblMaxResults = lens _lblMaxResults (\ s a -> s{_lblMaxResults = a}) . _Coerce instance GoogleRequest LiveBroadcastsList where type Rs LiveBroadcastsList = LiveBroadcastListResponse type Scopes LiveBroadcastsList = '["https://www.googleapis.com/auth/youtube", "https://www.googleapis.com/auth/youtube.force-ssl", "https://www.googleapis.com/auth/youtube.readonly"] requestClient LiveBroadcastsList'{..} = go (Just _lblPart) _lblMine _lblBroadcastStatus _lblOnBehalfOfContentOwner (Just _lblBroadcastType) _lblOnBehalfOfContentOwnerChannel _lblId _lblPageToken (Just _lblMaxResults) (Just AltJSON) youTubeService where go = buildClient (Proxy :: Proxy LiveBroadcastsListResource) mempty