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

Contents

REST Resource
Creating a Request
Request Lenses

Description

List all of the comments for an activity.

See: Google+ Domains API Reference for plusDomains.comments.list.

Synopsis

type CommentsListResource = "plusDomains" :> ("v1" :> ("activities" :> (Capture "activityId" Text :> ("comments" :> (QueryParam "sortOrder" CommentsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CommentFeed))))))))
commentsList :: Text -> CommentsList
data CommentsList
clActivityId :: Lens' CommentsList Text
clSortOrder :: Lens' CommentsList CommentsListSortOrder
clPageToken :: Lens' CommentsList (Maybe Text)
clMaxResults :: Lens' CommentsList Word32

REST Resource

type CommentsListResource = "plusDomains" :> ("v1" :> ("activities" :> (Capture "activityId" Text :> ("comments" :> (QueryParam "sortOrder" CommentsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CommentFeed)))))))) Source #

A resource alias for plusDomains.comments.list method which the CommentsList request conforms to.

Creating a Request

commentsList Source #

Arguments

:: Text	`clActivityId`
-> 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 #

List all of the comments for an activity.

See: commentsList smart constructor.

Instances

Eq CommentsList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Comments.List Methods (==) :: CommentsList -> CommentsList -> Bool # (/=) :: CommentsList -> CommentsList -> Bool #
Data CommentsList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.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.PlusDomains.Comments.List Methods showsPrec :: Int -> CommentsList -> ShowS # show :: CommentsList -> String # showList :: [CommentsList] -> ShowS #
Generic CommentsList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.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.PlusDomains.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.PlusDomains.Comments.List type Rep CommentsList = D1 (MetaData "CommentsList" "Network.Google.Resource.PlusDomains.Comments.List" "gogol-plus-domains-0.4.0-34lALQjqVKZA6ahc5WKRcy" False) (C1 (MetaCons "CommentsList'" PrefixI True) ((S1 (MetaSel (Just "_clActivityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_clSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CommentsListSortOrder)) :: (S1 (MetaSel (Just "_clPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))
type Scopes CommentsList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Comments.List type Scopes CommentsList = "https://www.googleapis.com/auth/plus.login" ': ("https://www.googleapis.com/auth/plus.stream.read" ': ([] :: [Symbol]))
type Rs CommentsList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Comments.List type Rs CommentsList = CommentFeed

Request Lenses

clActivityId :: Lens' CommentsList Text Source #

The ID of the activity to get comments for.

clSortOrder :: Lens' CommentsList CommentsListSortOrder Source #

The order in which to sort the list of comments.

clPageToken :: Lens' CommentsList (Maybe Text) Source #

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

clMaxResults :: Lens' CommentsList Word32 Source #

The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.