| 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.Comments.List
Description
Returns a list of comments that match the API request parameters.
See: YouTube Data API Reference for youtube.comments.list.
- type CommentsListResource = "youtube" :> ("v3" :> ("comments" :> (QueryParam "part" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "textFormat" CommentsListTextFormat :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "parentId" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` CommentListResponse)))))))))
- commentsList :: Text -> CommentsList
- data CommentsList
- cllPart :: Lens' CommentsList Text
- cllId :: Lens' CommentsList (Maybe Text)
- cllPageToken :: Lens' CommentsList (Maybe Text)
- cllTextFormat :: Lens' CommentsList CommentsListTextFormat
- cllMaxResults :: Lens' CommentsList Word32
- cllParentId :: Lens' CommentsList (Maybe Text)
REST Resource
type CommentsListResource = "youtube" :> ("v3" :> ("comments" :> (QueryParam "part" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "textFormat" CommentsListTextFormat :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "parentId" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` CommentListResponse))))))))) Source
A resource alias for youtube.comments.list method which the
CommentsList request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> CommentsList |
Creates a value of CommentsList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CommentsList Source
Returns a list of comments that match the API request parameters.
See: commentsList smart constructor.
Request Lenses
cllPart :: Lens' CommentsList Text Source
The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.
cllId :: Lens' CommentsList (Maybe Text) Source
The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.
cllPageToken :: Lens' CommentsList (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.
cllTextFormat :: Lens' CommentsList CommentsListTextFormat Source
This parameter indicates whether the API should return comments formatted as HTML or as plain text.
cllMaxResults :: Lens' CommentsList 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.
cllParentId :: Lens' CommentsList (Maybe Text) Source
The parentId parameter specifies the ID of the comment for which replies should be retrieved. Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.