| Copyright | (c) 2015 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.People.List
Description
List all of the people in the specified collection.
See: Google+ Domains API Reference for plusDomains.people.list.
- 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)))))))))
- peopleList :: PeopleListCollection -> Text -> PeopleList
- data PeopleList
- plOrderBy :: Lens' PeopleList (Maybe PeopleListOrderBy)
- plCollection :: Lens' PeopleList PeopleListCollection
- plUserId :: Lens' PeopleList Text
- plPageToken :: Lens' PeopleList (Maybe Text)
- plMaxResults :: Lens' PeopleList Word32
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))))))))) Source
A resource alias for plusDomains.people.list method which the
PeopleList request conforms to.
Creating a Request
Arguments
| :: PeopleListCollection | |
| -> Text | |
| -> 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:
data PeopleList Source
List all of the people in the specified collection.
See: peopleList smart constructor.
Instances
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.