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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a list of comments that match the API request parameters.

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

Synopsis

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

commentsList Source #

Arguments

:: Text	`cllPart`
-> 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.

Instances

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

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.