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

Contents

REST Resource
Creating a Request
Request Lenses

Description

List all of the circles for a user.

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

Synopsis

type CirclesListResource = "plusDomains" :> ("v1" :> ("people" :> (Capture "userId" Text :> ("circles" :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CircleFeed)))))))
circlesList :: Text -> CirclesList
data CirclesList
cUserId :: Lens' CirclesList Text
cPageToken :: Lens' CirclesList (Maybe Text)
cMaxResults :: Lens' CirclesList Word32

REST Resource

type CirclesListResource = "plusDomains" :> ("v1" :> ("people" :> (Capture "userId" Text :> ("circles" :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CircleFeed))))))) Source #

A resource alias for plusDomains.circles.list method which the CirclesList request conforms to.

Creating a Request

circlesList Source #

Arguments

:: Text	`cUserId`
-> CirclesList

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

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

data CirclesList Source #

List all of the circles for a user.

See: circlesList smart constructor.

Instances

Eq CirclesList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Circles.List Methods (==) :: CirclesList -> CirclesList -> Bool # (/=) :: CirclesList -> CirclesList -> Bool #
Data CirclesList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Circles.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CirclesList -> c CirclesList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CirclesList # toConstr :: CirclesList -> Constr # dataTypeOf :: CirclesList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CirclesList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CirclesList) # gmapT :: (forall b. Data b => b -> b) -> CirclesList -> CirclesList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CirclesList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CirclesList -> r # gmapQ :: (forall d. Data d => d -> u) -> CirclesList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CirclesList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CirclesList -> m CirclesList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CirclesList -> m CirclesList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CirclesList -> m CirclesList #
Show CirclesList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Circles.List Methods showsPrec :: Int -> CirclesList -> ShowS # show :: CirclesList -> String # showList :: [CirclesList] -> ShowS #
Generic CirclesList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Circles.List Associated Types type Rep CirclesList :: Type -> Type # Methods from :: CirclesList -> Rep CirclesList x # to :: Rep CirclesList x -> CirclesList #
GoogleRequest CirclesList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Circles.List Associated Types type Rs CirclesList :: Type # type Scopes CirclesList :: [Symbol] # Methods requestClient :: CirclesList -> GClient (Rs CirclesList) #
type Rep CirclesList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Circles.List type Rep CirclesList = D1 (MetaData "CirclesList" "Network.Google.Resource.PlusDomains.Circles.List" "gogol-plus-domains-0.4.0-34lALQjqVKZA6ahc5WKRcy" False) (C1 (MetaCons "CirclesList'" PrefixI True) (S1 (MetaSel (Just "_cUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_cPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))
type Scopes CirclesList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Circles.List type Scopes CirclesList = "https://www.googleapis.com/auth/plus.circles.read" ': ("https://www.googleapis.com/auth/plus.login" ': ("https://www.googleapis.com/auth/plus.me" ': ([] :: [Symbol])))
type Rs CirclesList Source #
Instance details Defined in Network.Google.Resource.PlusDomains.Circles.List type Rs CirclesList = CircleFeed

Request Lenses

cUserId :: Lens' CirclesList Text Source #

The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user.

cPageToken :: Lens' CirclesList (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.

cMaxResults :: Lens' CirclesList Word32 Source #

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