gogol-people-0.4.0: Google People 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.People.People.Connections.List

Contents

Description

Provides a list of the authenticated user's contacts merged with any connected profiles. The request throws a 400 error if 'personFields' is not specified.

See: People API Reference for people.people.connections.list.

Synopsis

REST Resource

type PeopleConnectionsListResource = "v1" :> (Capture "resourceName" Text :> ("connections" :> (QueryParam "syncToken" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "requestMask.includeField" GFieldMask :> (QueryParam "requestSyncToken" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "sortOrder" Text :> (QueryParam "personFields" GFieldMask :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListConnectionsResponse))))))))))))))) Source #

A resource alias for people.people.connections.list method which the PeopleConnectionsList request conforms to.

Creating a Request

peopleConnectionsList Source #

Arguments

:: Text

pclResourceName

-> PeopleConnectionsList 

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

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

data PeopleConnectionsList Source #

Provides a list of the authenticated user's contacts merged with any connected profiles. The request throws a 400 error if 'personFields' is not specified.

See: peopleConnectionsList smart constructor.

Instances
Eq PeopleConnectionsList Source # 
Instance details

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

Methods

(==) :: PeopleConnectionsList -> PeopleConnectionsList -> Bool #

(/=) :: PeopleConnectionsList -> PeopleConnectionsList -> Bool #

Data PeopleConnectionsList Source # 
Instance details

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

Methods

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

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

toConstr :: PeopleConnectionsList -> Constr #

dataTypeOf :: PeopleConnectionsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show PeopleConnectionsList Source # 
Instance details

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

Methods

showsPrec :: Int -> PeopleConnectionsList -> ShowS #

show :: PeopleConnectionsList -> String #

showList :: [PeopleConnectionsList] -> ShowS #

Generic PeopleConnectionsList Source # 
Instance details

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

Associated Types

type Rep PeopleConnectionsList :: Type -> Type #

Methods

from :: PeopleConnectionsList -> Rep PeopleConnectionsList x #

to :: Rep PeopleConnectionsList x -> PeopleConnectionsList #

GoogleRequest PeopleConnectionsList Source # 
Instance details

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

Associated Types

type Rs PeopleConnectionsList :: Type #

type Scopes PeopleConnectionsList :: [Symbol] #

Methods

requestClient :: PeopleConnectionsList -> GClient (Rs PeopleConnectionsList) #

type Rep PeopleConnectionsList Source # 
Instance details

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

type Rep PeopleConnectionsList = D1 (MetaData "PeopleConnectionsList" "Network.Google.Resource.People.People.Connections.List" "gogol-people-0.4.0-E13x4gVqkHzANg1IJZFmJ4" False) (C1 (MetaCons "PeopleConnectionsList'" PrefixI True) (((S1 (MetaSel (Just "_pclSyncToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pclXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_pclUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_pclResourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_pclRequestMaskIncludeField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :*: S1 (MetaSel (Just "_pclRequestSyncToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 (MetaSel (Just "_pclAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pclUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pclSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pclPersonFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :*: S1 (MetaSel (Just "_pclPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pclPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_pclCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes PeopleConnectionsList Source # 
Instance details

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

type Scopes PeopleConnectionsList = "https://www.googleapis.com/auth/contacts" ': ("https://www.googleapis.com/auth/contacts.readonly" ': ([] :: [Symbol]))
type Rs PeopleConnectionsList Source # 
Instance details

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

type Rs PeopleConnectionsList = ListConnectionsResponse

Request Lenses

pclSyncToken :: Lens' PeopleConnectionsList (Maybe Text) Source #

A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit.

pclXgafv :: Lens' PeopleConnectionsList (Maybe Xgafv) Source #

V1 error format.

pclUploadProtocol :: Lens' PeopleConnectionsList (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

pclResourceName :: Lens' PeopleConnectionsList Text Source #

The resource name to return connections for. Only `people/me` is valid.

pclRequestMaskIncludeField :: Lens' PeopleConnectionsList (Maybe GFieldMask) Source #

  • *Required.** Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

pclRequestSyncToken :: Lens' PeopleConnectionsList (Maybe Bool) Source #

Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.

pclAccessToken :: Lens' PeopleConnectionsList (Maybe Text) Source #

OAuth access token.

pclUploadType :: Lens' PeopleConnectionsList (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

pclSortOrder :: Lens' PeopleConnectionsList (Maybe Text) Source #

The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.

pclPersonFields :: Lens' PeopleConnectionsList (Maybe GFieldMask) Source #

  • *Required.** A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos
  • relations * relationshipInterests * relationshipStatuses * residences
  • sipAddresses * skills * taglines * urls * userDefined

pclPageToken :: Lens' PeopleConnectionsList (Maybe Text) Source #

The token of the page to be returned.

pclPageSize :: Lens' PeopleConnectionsList (Maybe Int32) Source #

The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100.

pclCallback :: Lens' PeopleConnectionsList (Maybe Text) Source #

JSONP