gogol-youtube-0.4.0: Google YouTube Data SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.YouTube.Captions.Update

Contents

Description

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

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

Synopsis

REST Resource

type CaptionsUpdateResource = ("youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "sync" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Caption :> Put '[JSON] Caption))))))))) :<|> ("upload" :> ("youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "sync" Bool :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] Caption :> Put '[JSON] Caption))))))))))) Source #

A resource alias for youtube.captions.update method which the CaptionsUpdate request conforms to.

Creating a Request

captionsUpdate Source #

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

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

data CaptionsUpdate Source #

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

See: captionsUpdate smart constructor.

Instances
Eq CaptionsUpdate Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

Data CaptionsUpdate Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CaptionsUpdate -> c CaptionsUpdate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CaptionsUpdate #

toConstr :: CaptionsUpdate -> Constr #

dataTypeOf :: CaptionsUpdate -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CaptionsUpdate) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CaptionsUpdate) #

gmapT :: (forall b. Data b => b -> b) -> CaptionsUpdate -> CaptionsUpdate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CaptionsUpdate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CaptionsUpdate -> r #

gmapQ :: (forall d. Data d => d -> u) -> CaptionsUpdate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CaptionsUpdate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CaptionsUpdate -> m CaptionsUpdate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CaptionsUpdate -> m CaptionsUpdate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CaptionsUpdate -> m CaptionsUpdate #

Show CaptionsUpdate Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

Generic CaptionsUpdate Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

Associated Types

type Rep CaptionsUpdate :: Type -> Type #

GoogleRequest CaptionsUpdate Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

Associated Types

type Rs CaptionsUpdate :: Type #

type Scopes CaptionsUpdate :: [Symbol] #

GoogleRequest (MediaUpload CaptionsUpdate) Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

type Rep CaptionsUpdate Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

type Rep CaptionsUpdate = D1 (MetaData "CaptionsUpdate" "Network.Google.Resource.YouTube.Captions.Update" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "CaptionsUpdate'" PrefixI True) ((S1 (MetaSel (Just "_capOnBehalfOf") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_capPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_capPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Caption) :*: (S1 (MetaSel (Just "_capOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_capSync") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))
type Scopes CaptionsUpdate Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

type Scopes CaptionsUpdate = "https://www.googleapis.com/auth/youtube.force-ssl" ': ("https://www.googleapis.com/auth/youtubepartner" ': ([] :: [Symbol]))
type Rs CaptionsUpdate Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

type Scopes (MediaUpload CaptionsUpdate) Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

type Rs (MediaUpload CaptionsUpdate) Source # 
Instance details

Defined in Network.Google.Resource.YouTube.Captions.Update

Request Lenses

capOnBehalfOf :: Lens' CaptionsUpdate (Maybe Text) Source #

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

capPart :: Lens' CaptionsUpdate Text Source #

The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.

capPayload :: Lens' CaptionsUpdate Caption Source #

Multipart request metadata.

capOnBehalfOfContentOwner :: Lens' CaptionsUpdate (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.

capSync :: Lens' CaptionsUpdate (Maybe Bool) Source #

Note: The API server only processes the parameter value if the request contains an updated caption file. The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.