Network.Google.Resource.YouTube.LiveChatMessages.List

Lists live chat messages for a specific chat.

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

REST Resource

type LiveChatMessagesListResource = "youtube" :> ("v3" :> ("liveChat" :> ("messages" :> (QueryParam "liveChatId" Text :> (QueryParam "part" Text :> (QueryParam "hl" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "profileImageSize" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] LiveChatMessageListResponse))))))))))

A resource alias for youtube.liveChatMessages.list method which the LiveChatMessagesList request conforms to.

Creating a Request

liveChatMessagesList

Arguments

:: Text

lcmlPart

-> Text

lcmlLiveChatId

-> LiveChatMessagesList

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

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

• lcmlPart
• lcmlLiveChatId
• lcmlHl
• lcmlPageToken
• lcmlMaxResults
• lcmlProFileImageSize

data LiveChatMessagesList

Lists live chat messages for a specific chat.

See: liveChatMessagesList smart constructor.

Instances

Eq LiveChatMessagesList

Methods

(==) :: LiveChatMessagesList -> LiveChatMessagesList -> Bool

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

Data LiveChatMessagesList

Methods

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

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

toConstr :: LiveChatMessagesList -> Constr

dataTypeOf :: LiveChatMessagesList -> DataType

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

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

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

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

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

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

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

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

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

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

Show LiveChatMessagesList

Methods

showsPrec :: Int -> LiveChatMessagesList -> ShowS

show :: LiveChatMessagesList -> String

showList :: [LiveChatMessagesList] -> ShowS

Generic LiveChatMessagesList

Associated Types

type Rep LiveChatMessagesList :: * -> *

Methods

from :: LiveChatMessagesList -> Rep LiveChatMessagesList x

to :: Rep LiveChatMessagesList x -> LiveChatMessagesList

GoogleRequest LiveChatMessagesList

Associated Types

type Rs LiveChatMessagesList :: *

type Scopes LiveChatMessagesList :: [Symbol]

Methods

requestClient :: LiveChatMessagesList -> Client (Rs LiveChatMessagesList)

type Rep LiveChatMessagesList

type Rep LiveChatMessagesList = D1 (MetaData "LiveChatMessagesList" "Network.Google.Resource.YouTube.LiveChatMessages.List" "gogol-youtube-0.1.0-8YXXHGFWPJC4XWVMAKZOnQ" False) (C1 (MetaCons "LiveChatMessagesList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lcmlPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_lcmlLiveChatId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_lcmlHl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_lcmlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lcmlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))) (S1 (MetaSel (Just Symbol "_lcmlProFileImageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))))))))

type Scopes LiveChatMessagesList

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

type Rs LiveChatMessagesList

type Rs LiveChatMessagesList = LiveChatMessageListResponse

Request Lenses

lcmlPart :: Lens' LiveChatMessagesList Text

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

lcmlLiveChatId :: Lens' LiveChatMessagesList Text

The liveChatId parameter specifies the ID of the chat whose messages will be returned.

lcmlHl :: Lens' LiveChatMessagesList (Maybe Text)

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.

lcmlPageToken :: Lens' LiveChatMessagesList (Maybe Text)

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

lcmlMaxResults :: Lens' LiveChatMessagesList Word32

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

lcmlProFileImageSize :: Lens' LiveChatMessagesList (Maybe Word32)

The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set. Default: 88.