Network.Google.Resource.PlusDomains.People.List

List all of the people in the specified collection.

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

REST Resource

type PeopleListResource = "plusDomains" :> ("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)))))))))

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

Creating a Request

peopleList

Arguments

:: PeopleListCollection

plCollection

-> Text

plUserId

-> PeopleList

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:

• plOrderBy
• plCollection
• plUserId
• plPageToken
• plMaxResults

data PeopleList

List all of the people in the specified collection.

See: peopleList smart constructor.

Instances

Eq PeopleList

Methods

(==) :: PeopleList -> PeopleList -> Bool

(/=) :: PeopleList -> PeopleList -> Bool

Data PeopleList

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

Methods

showsPrec :: Int -> PeopleList -> ShowS

show :: PeopleList -> String

showList :: [PeopleList] -> ShowS

Generic PeopleList

Associated Types

type Rep PeopleList :: * -> *

Methods

from :: PeopleList -> Rep PeopleList x

to :: Rep PeopleList x -> PeopleList

GoogleRequest PeopleList

Associated Types

type Rs PeopleList :: *

type Scopes PeopleList :: [Symbol]

Methods

requestClient :: PeopleList -> Client (Rs PeopleList)

type Rep PeopleList

type Rep PeopleList = D1 (MetaData "PeopleList" "Network.Google.Resource.PlusDomains.People.List" "gogol-plus-domains-0.1.1-LNJP6Tobwh23lq6Hc2Os4A" False) (C1 (MetaCons "PeopleList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_plOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PeopleListOrderBy))) (S1 (MetaSel (Just Symbol "_plCollection") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 PeopleListCollection))) ((:*:) (S1 (MetaSel (Just Symbol "_plUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_plPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_plMaxResults") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 (Textual Word32)))))))

type Scopes PeopleList

type Scopes PeopleList = (:) Symbol "https://www.googleapis.com/auth/plus.circles.read" ((:) Symbol "https://www.googleapis.com/auth/plus.login" ((:) Symbol "https://www.googleapis.com/auth/plus.me" ([] Symbol)))

type Rs PeopleList

type Rs PeopleList = PeopleFeed

Request Lenses

plOrderBy :: Lens' PeopleList (Maybe PeopleListOrderBy)

The order to return people in.

plCollection :: Lens' PeopleList PeopleListCollection

The collection of people to list.

plUserId :: Lens' PeopleList Text

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

plPageToken :: Lens' PeopleList (Maybe Text)

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

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.