| 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.Circles.List
Description
List all of the circles for a user.
See: Google+ Domains API Reference for plusDomains.circles.list.
- 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
Arguments
| :: Text | |
| -> 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
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.