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 |
Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.
See: YouTube Data API Reference for youtube.liveBroadcasts.update
.
Synopsis
- type LiveBroadcastsUpdateResource = "youtube" :> ("v3" :> ("liveBroadcasts" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] LiveBroadcast :> Put '[JSON] LiveBroadcast)))))))
- liveBroadcastsUpdate :: Text -> LiveBroadcast -> LiveBroadcastsUpdate
- data LiveBroadcastsUpdate
- lbuPart :: Lens' LiveBroadcastsUpdate Text
- lbuPayload :: Lens' LiveBroadcastsUpdate LiveBroadcast
- lbuOnBehalfOfContentOwner :: Lens' LiveBroadcastsUpdate (Maybe Text)
- lbuOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsUpdate (Maybe Text)
REST Resource
type LiveBroadcastsUpdateResource = "youtube" :> ("v3" :> ("liveBroadcasts" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] LiveBroadcast :> Put '[JSON] LiveBroadcast))))))) Source #
A resource alias for youtube.liveBroadcasts.update
method which the
LiveBroadcastsUpdate
request conforms to.
Creating a Request
Creates a value of LiveBroadcastsUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data LiveBroadcastsUpdate Source #
Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.
See: liveBroadcastsUpdate
smart constructor.
Instances
Request Lenses
lbuPart :: Lens' LiveBroadcastsUpdate 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. The part properties that you can include in the parameter value are id, snippet, contentDetails, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a broadcast's privacy status is defined in the status part. As such, if your request is updating a private or unlisted broadcast, and the request's part parameter value includes the status part, the broadcast's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the broadcast will revert to the default privacy setting.
lbuPayload :: Lens' LiveBroadcastsUpdate LiveBroadcast Source #
Multipart request metadata.
lbuOnBehalfOfContentOwner :: Lens' LiveBroadcastsUpdate (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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
lbuOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsUpdate (Maybe Text) Source #
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.