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.SuperChatEvents.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists Super Chat events for a channel.

See: YouTube Data API Reference for youtube.superChatEvents.list.

Synopsis

type SuperChatEventsListResource = "youtube" :> ("v3" :> ("superChatEvents" :> (QueryParam "part" Text :> (QueryParam "hl" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] SuperChatEventListResponse)))))))
superChatEventsList :: Text -> SuperChatEventsList
data SuperChatEventsList
scelPart :: Lens' SuperChatEventsList Text
scelHl :: Lens' SuperChatEventsList (Maybe Text)
scelPageToken :: Lens' SuperChatEventsList (Maybe Text)
scelMaxResults :: Lens' SuperChatEventsList Word32

REST Resource

type SuperChatEventsListResource = "youtube" :> ("v3" :> ("superChatEvents" :> (QueryParam "part" Text :> (QueryParam "hl" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] SuperChatEventListResponse))))))) Source #

A resource alias for youtube.superChatEvents.list method which the SuperChatEventsList request conforms to.

Creating a Request

superChatEventsList Source #

Arguments

:: Text	`scelPart`
-> SuperChatEventsList

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

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

data SuperChatEventsList Source #

Lists Super Chat events for a channel.

See: superChatEventsList smart constructor.

Instances

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

Request Lenses

scelPart :: Lens' SuperChatEventsList Text Source #

The part parameter specifies the superChatEvent resource parts that the API response will include. Supported values are id and snippet.

scelHl :: Lens' SuperChatEventsList (Maybe Text) Source #

The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.

scelPageToken :: Lens' SuperChatEventsList (Maybe Text) Source #

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

scelMaxResults :: Lens' SuperChatEventsList Word32 Source #

The maxResults parameter specifies the maximum number of items that should be returned in the result set.