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.LiveBroadcasts.Bind

Contents

REST Resource
Creating a Request
Request Lenses

Description

Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.

See: YouTube Data API Reference for youtube.liveBroadcasts.bind.

Synopsis

type LiveBroadcastsBindResource = "youtube" :> ("v3" :> ("liveBroadcasts" :> ("bind" :> (QueryParam "id" Text :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "streamId" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] LiveBroadcast)))))))))
liveBroadcastsBind :: Text -> Text -> LiveBroadcastsBind
data LiveBroadcastsBind
lbbPart :: Lens' LiveBroadcastsBind Text
lbbOnBehalfOfContentOwner :: Lens' LiveBroadcastsBind (Maybe Text)
lbbOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsBind (Maybe Text)
lbbId :: Lens' LiveBroadcastsBind Text
lbbStreamId :: Lens' LiveBroadcastsBind (Maybe Text)

REST Resource

type LiveBroadcastsBindResource = "youtube" :> ("v3" :> ("liveBroadcasts" :> ("bind" :> (QueryParam "id" Text :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "streamId" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] LiveBroadcast))))))))) Source #

A resource alias for youtube.liveBroadcasts.bind method which the LiveBroadcastsBind request conforms to.

Creating a Request

liveBroadcastsBind Source #

Arguments

:: Text	`lbbPart`
-> Text	`lbbId`
-> LiveBroadcastsBind

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

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

data LiveBroadcastsBind Source #

Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.

See: liveBroadcastsBind smart constructor.

Instances

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

Request Lenses

lbbPart :: Lens' LiveBroadcastsBind Text Source #

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

lbbOnBehalfOfContentOwner :: Lens' LiveBroadcastsBind (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.

lbbOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsBind (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.

lbbId :: Lens' LiveBroadcastsBind Text Source #

The id parameter specifies the unique ID of the broadcast that is being bound to a video stream.

lbbStreamId :: Lens' LiveBroadcastsBind (Maybe Text) Source #

The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.