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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a list of comment threads that match the API request parameters.

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

Synopsis

type CommentThreadsListResource = "youtube" :> ("v3" :> ("commentThreads" :> (QueryParam "part" Text :> (QueryParam "moderationStatus" CommentThreadsListModerationStatus :> (QueryParam "searchTerms" Text :> (QueryParam "channelId" Text :> (QueryParam "allThreadsRelatedToChannelId" Text :> (QueryParam "videoId" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "order" CommentThreadsListOrder :> (QueryParam "textFormat" CommentThreadsListTextFormat :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CommentThreadListResponse))))))))))))))
commentThreadsList :: Text -> CommentThreadsList
data CommentThreadsList
ctlPart :: Lens' CommentThreadsList Text
ctlModerationStatus :: Lens' CommentThreadsList CommentThreadsListModerationStatus
ctlSearchTerms :: Lens' CommentThreadsList (Maybe Text)
ctlChannelId :: Lens' CommentThreadsList (Maybe Text)
ctlAllThreadsRelatedToChannelId :: Lens' CommentThreadsList (Maybe Text)
ctlVideoId :: Lens' CommentThreadsList (Maybe Text)
ctlId :: Lens' CommentThreadsList (Maybe Text)
ctlPageToken :: Lens' CommentThreadsList (Maybe Text)
ctlOrder :: Lens' CommentThreadsList CommentThreadsListOrder
ctlTextFormat :: Lens' CommentThreadsList CommentThreadsListTextFormat
ctlMaxResults :: Lens' CommentThreadsList Word32

REST Resource

type CommentThreadsListResource = "youtube" :> ("v3" :> ("commentThreads" :> (QueryParam "part" Text :> (QueryParam "moderationStatus" CommentThreadsListModerationStatus :> (QueryParam "searchTerms" Text :> (QueryParam "channelId" Text :> (QueryParam "allThreadsRelatedToChannelId" Text :> (QueryParam "videoId" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "order" CommentThreadsListOrder :> (QueryParam "textFormat" CommentThreadsListTextFormat :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CommentThreadListResponse)))))))))))))) Source #

A resource alias for youtube.commentThreads.list method which the CommentThreadsList request conforms to.

Creating a Request

commentThreadsList Source #

Arguments

:: Text	`ctlPart`
-> CommentThreadsList

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

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

data CommentThreadsList Source #

Returns a list of comment threads that match the API request parameters.

See: commentThreadsList smart constructor.

Instances

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

Request Lenses

ctlPart :: Lens' CommentThreadsList Text Source #

The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.

ctlModerationStatus :: Lens' CommentThreadsList CommentThreadsListModerationStatus Source #

Set this parameter to limit the returned comment threads to a particular moderation state. Note: This parameter is not supported for use in conjunction with the id parameter.

ctlSearchTerms :: Lens' CommentThreadsList (Maybe Text) Source #

The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms. Note: This parameter is not supported for use in conjunction with the id parameter.

ctlChannelId :: Lens' CommentThreadsList (Maybe Text) Source #

The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.)

The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos.

ctlVideoId :: Lens' CommentThreadsList (Maybe Text) Source #

The videoId parameter instructs the API to return comment threads associated with the specified video ID.

ctlId :: Lens' CommentThreadsList (Maybe Text) Source #

The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.

ctlPageToken :: Lens' CommentThreadsList (Maybe Text) Source #

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved. Note: This parameter is not supported for use in conjunction with the id parameter.

ctlOrder :: Lens' CommentThreadsList CommentThreadsListOrder Source #

The order parameter specifies the order in which the API response should list comment threads. Valid values are: - time - Comment threads are ordered by time. This is the default behavior. - relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.

ctlTextFormat :: Lens' CommentThreadsList CommentThreadsListTextFormat Source #

Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.

ctlMaxResults :: Lens' CommentThreadsList Word32 Source #

The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is not supported for use in conjunction with the id parameter.