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.YouTube.Captions.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.

See: YouTube Data API Reference for youtube.captions.list.

Synopsis

type CaptionsListResource = "youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "videoId" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "id" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] CaptionListResponse))))))))
captionsList :: Text -> Text -> CaptionsList
data CaptionsList
clOnBehalfOf :: Lens' CaptionsList (Maybe Text)
clPart :: Lens' CaptionsList Text
clOnBehalfOfContentOwner :: Lens' CaptionsList (Maybe Text)
clVideoId :: Lens' CaptionsList Text
clId :: Lens' CaptionsList (Maybe Text)

REST Resource

type CaptionsListResource = "youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "videoId" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "id" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] CaptionListResponse)))))))) Source #

A resource alias for youtube.captions.list method which the CaptionsList request conforms to.

Creating a Request

captionsList Source #

Arguments

:: Text	`clPart`
-> Text	`clVideoId`
-> CaptionsList

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

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

data CaptionsList Source #

Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.

See: captionsList smart constructor.

Instances

Eq CaptionsList Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.List Methods (==) :: CaptionsList -> CaptionsList -> Bool # (/=) :: CaptionsList -> CaptionsList -> Bool #
Data CaptionsList Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CaptionsList -> c CaptionsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CaptionsList # toConstr :: CaptionsList -> Constr # dataTypeOf :: CaptionsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CaptionsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CaptionsList) # gmapT :: (forall b. Data b => b -> b) -> CaptionsList -> CaptionsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CaptionsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CaptionsList -> r # gmapQ :: (forall d. Data d => d -> u) -> CaptionsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CaptionsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CaptionsList -> m CaptionsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CaptionsList -> m CaptionsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CaptionsList -> m CaptionsList #
Show CaptionsList Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.List Methods showsPrec :: Int -> CaptionsList -> ShowS # show :: CaptionsList -> String # showList :: [CaptionsList] -> ShowS #
Generic CaptionsList Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.List Associated Types type Rep CaptionsList :: Type -> Type # Methods from :: CaptionsList -> Rep CaptionsList x # to :: Rep CaptionsList x -> CaptionsList #
GoogleRequest CaptionsList Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.List Associated Types type Rs CaptionsList :: Type # type Scopes CaptionsList :: [Symbol] # Methods requestClient :: CaptionsList -> GClient (Rs CaptionsList) #
type Rep CaptionsList Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.List type Rep CaptionsList = D1 (MetaData "CaptionsList" "Network.Google.Resource.YouTube.Captions.List" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "CaptionsList'" PrefixI True) ((S1 (MetaSel (Just "_clOnBehalfOf") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_clPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_clOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_clVideoId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_clId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CaptionsList Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.List type Scopes CaptionsList = "https://www.googleapis.com/auth/youtube.force-ssl" ': ("https://www.googleapis.com/auth/youtubepartner" ': ([] :: [Symbol]))
type Rs CaptionsList Source #
Instance details Defined in Network.Google.Resource.YouTube.Captions.List type Rs CaptionsList = CaptionListResponse

Request Lenses

clOnBehalfOf :: Lens' CaptionsList (Maybe Text) Source #

ID of the Google+ Page for the channel that the request is on behalf of.

clPart :: Lens' CaptionsList Text Source #

The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.

clOnBehalfOfContentOwner :: Lens' CaptionsList (Maybe Text) Source #

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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

clVideoId :: Lens' CaptionsList Text Source #

The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks.

clId :: Lens' CaptionsList (Maybe Text) Source #

The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved. Each ID must identify a caption track associated with the specified video.