gogol-plus-0.4.0: Google + SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Plus.People.List

Contents

Description

List all of the people in the specified collection.

See: Google+ API Reference for plus.people.list.

Synopsis

REST Resource

type PeopleListResource = "plus" :> ("v1" :> ("people" :> (Capture "userId" Text :> ("people" :> (Capture "collection" PeopleListCollection :> (QueryParam "orderBy" PeopleListOrderBy :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] PeopleFeed))))))))) Source #

A resource alias for plus.people.list method which the PeopleList request conforms to.

Creating a Request

peopleList Source #

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

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

data PeopleList Source #

List all of the people in the specified collection.

See: peopleList smart constructor.

Instances
Eq PeopleList Source # 
Instance details

Defined in Network.Google.Resource.Plus.People.List

Data PeopleList Source # 
Instance details

Defined in Network.Google.Resource.Plus.People.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PeopleList -> c PeopleList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PeopleList #

toConstr :: PeopleList -> Constr #

dataTypeOf :: PeopleList -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PeopleList) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PeopleList) #

gmapT :: (forall b. Data b => b -> b) -> PeopleList -> PeopleList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PeopleList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PeopleList -> r #

gmapQ :: (forall d. Data d => d -> u) -> PeopleList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PeopleList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PeopleList -> m PeopleList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PeopleList -> m PeopleList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PeopleList -> m PeopleList #

Show PeopleList Source # 
Instance details

Defined in Network.Google.Resource.Plus.People.List

Generic PeopleList Source # 
Instance details

Defined in Network.Google.Resource.Plus.People.List

Associated Types

type Rep PeopleList :: Type -> Type #

GoogleRequest PeopleList Source # 
Instance details

Defined in Network.Google.Resource.Plus.People.List

Associated Types

type Rs PeopleList :: Type #

type Scopes PeopleList :: [Symbol] #

type Rep PeopleList Source # 
Instance details

Defined in Network.Google.Resource.Plus.People.List

type Rep PeopleList = D1 (MetaData "PeopleList" "Network.Google.Resource.Plus.People.List" "gogol-plus-0.4.0-LafSt72moobCI7cgdcTCH9" False) (C1 (MetaCons "PeopleList'" PrefixI True) ((S1 (MetaSel (Just "_plOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PeopleListOrderBy)) :*: S1 (MetaSel (Just "_plCollection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PeopleListCollection)) :*: (S1 (MetaSel (Just "_plUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_plPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_plMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))
type Scopes PeopleList Source # 
Instance details

Defined in Network.Google.Resource.Plus.People.List

type Scopes PeopleList = "https://www.googleapis.com/auth/plus.login" ': ("https://www.googleapis.com/auth/plus.me" ': ([] :: [Symbol]))
type Rs PeopleList Source # 
Instance details

Defined in Network.Google.Resource.Plus.People.List

Request Lenses

plOrderBy :: Lens' PeopleList (Maybe PeopleListOrderBy) Source #

The order to return people in.

plCollection :: Lens' PeopleList PeopleListCollection Source #

The collection of people to list.

plUserId :: Lens' PeopleList Text Source #

Get the collection of people for the person identified. Use "me" to indicate the authenticated user.

plPageToken :: Lens' PeopleList (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.

plMaxResults :: Lens' PeopleList Word32 Source #

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