| Copyright | (c) 2015 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
Description
Returns a list of comment threads that match the API request parameters.
See: YouTube Data API Reference for youtube.commentThreads.list.
- 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
Arguments
| :: Text | |
| -> 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.
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.)
ctlAllThreadsRelatedToChannelId :: Lens' CommentThreadsList (Maybe Text) Source
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.