Network.Google.Resource.YouTube.LiveBroadcasts.Update

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.

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)))))))

A resource alias for youtube.liveBroadcasts.update method which the LiveBroadcastsUpdate request conforms to.

Creating a Request

liveBroadcastsUpdate

Arguments

:: Text

lbuPart

-> LiveBroadcast

lbuPayload

-> LiveBroadcastsUpdate

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:

• lbuPart
• lbuPayload
• lbuOnBehalfOfContentOwner
• lbuOnBehalfOfContentOwnerChannel

data LiveBroadcastsUpdate

Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object.

See: liveBroadcastsUpdate smart constructor.

Instances

Eq LiveBroadcastsUpdate

Methods

(==) :: LiveBroadcastsUpdate -> LiveBroadcastsUpdate -> Bool

(/=) :: LiveBroadcastsUpdate -> LiveBroadcastsUpdate -> Bool

Data LiveBroadcastsUpdate

Methods

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

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

toConstr :: LiveBroadcastsUpdate -> Constr

dataTypeOf :: LiveBroadcastsUpdate -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LiveBroadcastsUpdate)

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

gmapT :: (forall b. Data b => b -> b) -> LiveBroadcastsUpdate -> LiveBroadcastsUpdate

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

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

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

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

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

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

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

Show LiveBroadcastsUpdate

Methods

showsPrec :: Int -> LiveBroadcastsUpdate -> ShowS

show :: LiveBroadcastsUpdate -> String

showList :: [LiveBroadcastsUpdate] -> ShowS

Generic LiveBroadcastsUpdate

Associated Types

type Rep LiveBroadcastsUpdate :: * -> *

Methods

from :: LiveBroadcastsUpdate -> Rep LiveBroadcastsUpdate x

to :: Rep LiveBroadcastsUpdate x -> LiveBroadcastsUpdate

GoogleRequest LiveBroadcastsUpdate

Associated Types

type Rs LiveBroadcastsUpdate :: *

type Scopes LiveBroadcastsUpdate :: [Symbol]

Methods

requestClient :: LiveBroadcastsUpdate -> Client (Rs LiveBroadcastsUpdate)

type Rep LiveBroadcastsUpdate

type Rep LiveBroadcastsUpdate = D1 (MetaData "LiveBroadcastsUpdate" "Network.Google.Resource.YouTube.LiveBroadcasts.Update" "gogol-youtube-0.1.0-8YXXHGFWPJC4XWVMAKZOnQ" False) (C1 (MetaCons "LiveBroadcastsUpdate'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lbuPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_lbuPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LiveBroadcast))) ((:*:) (S1 (MetaSel (Just Symbol "_lbuOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lbuOnBehalfOfContentOwnerChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes LiveBroadcastsUpdate

type Scopes LiveBroadcastsUpdate = (:) Symbol "https://www.googleapis.com/auth/youtube" ((:) Symbol "https://www.googleapis.com/auth/youtube.force-ssl" ([] Symbol))

type Rs LiveBroadcastsUpdate

type Rs LiveBroadcastsUpdate = LiveBroadcast

Request Lenses

lbuPart :: Lens' LiveBroadcastsUpdate Text

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

Multipart request metadata.

lbuOnBehalfOfContentOwner :: Lens' LiveBroadcastsUpdate (Maybe Text)

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)

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.