Copyright | (c) 2015 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 |
Deletes a specified caption track.
See: YouTube Data API Reference for youtube.captions.delete
.
- type CaptionsDeleteResource = "youtube" :> ("v3" :> ("captions" :> (QueryParam "id" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> Delete `[JSON]` ()))))))
- captionsDelete :: Text -> CaptionsDelete
- data CaptionsDelete
- cddOnBehalfOf :: Lens' CaptionsDelete (Maybe Text)
- cddOnBehalfOfContentOwner :: Lens' CaptionsDelete (Maybe Text)
- cddId :: Lens' CaptionsDelete Text
REST Resource
type CaptionsDeleteResource = "youtube" :> ("v3" :> ("captions" :> (QueryParam "id" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> Delete `[JSON]` ())))))) Source
A resource alias for youtube.captions.delete
method which the
CaptionsDelete
request conforms to.
Creating a Request
:: Text | |
-> CaptionsDelete |
Creates a value of CaptionsDelete
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CaptionsDelete Source
Deletes a specified caption track.
See: captionsDelete
smart constructor.
Request Lenses
cddOnBehalfOf :: Lens' CaptionsDelete (Maybe Text) Source
ID of the Google+ Page for the channel that the request is be on behalf of
cddOnBehalfOfContentOwner :: Lens' CaptionsDelete (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.
cddId :: Lens' CaptionsDelete Text Source
The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.