Copyright	(c) 2015-2016 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.People.People.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified.

See: People API Reference for people.people.get.

Synopsis

type PeopleGetResource = "v1" :> (Capture "resourceName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "requestMask.includeField" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "personFields" GFieldMask :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Person)))))))))
peopleGet :: Text -> PeopleGet
data PeopleGet
pgXgafv :: Lens' PeopleGet (Maybe Xgafv)
pgUploadProtocol :: Lens' PeopleGet (Maybe Text)
pgResourceName :: Lens' PeopleGet Text
pgRequestMaskIncludeField :: Lens' PeopleGet (Maybe GFieldMask)
pgAccessToken :: Lens' PeopleGet (Maybe Text)
pgUploadType :: Lens' PeopleGet (Maybe Text)
pgPersonFields :: Lens' PeopleGet (Maybe GFieldMask)
pgCallback :: Lens' PeopleGet (Maybe Text)

REST Resource

type PeopleGetResource = "v1" :> (Capture "resourceName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "requestMask.includeField" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "personFields" GFieldMask :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Person))))))))) Source #

A resource alias for people.people.get method which the PeopleGet request conforms to.

Creating a Request

peopleGet Source #

Arguments

:: Text	`pgResourceName`
-> PeopleGet

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

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

data PeopleGet Source #

Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified.

See: peopleGet smart constructor.

Instances

Eq PeopleGet Source #
Instance details Defined in Network.Google.Resource.People.People.Get Methods (==) :: PeopleGet -> PeopleGet -> Bool # (/=) :: PeopleGet -> PeopleGet -> Bool #
Data PeopleGet Source #
Instance details Defined in Network.Google.Resource.People.People.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PeopleGet -> c PeopleGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PeopleGet # toConstr :: PeopleGet -> Constr # dataTypeOf :: PeopleGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PeopleGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PeopleGet) # gmapT :: (forall b. Data b => b -> b) -> PeopleGet -> PeopleGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PeopleGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PeopleGet -> r # gmapQ :: (forall d. Data d => d -> u) -> PeopleGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PeopleGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PeopleGet -> m PeopleGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PeopleGet -> m PeopleGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PeopleGet -> m PeopleGet #
Show PeopleGet Source #
Instance details Defined in Network.Google.Resource.People.People.Get Methods showsPrec :: Int -> PeopleGet -> ShowS # show :: PeopleGet -> String # showList :: [PeopleGet] -> ShowS #
Generic PeopleGet Source #
Instance details Defined in Network.Google.Resource.People.People.Get Associated Types type Rep PeopleGet :: Type -> Type # Methods from :: PeopleGet -> Rep PeopleGet x # to :: Rep PeopleGet x -> PeopleGet #
GoogleRequest PeopleGet Source #
Instance details Defined in Network.Google.Resource.People.People.Get Associated Types type Rs PeopleGet :: Type # type Scopes PeopleGet :: [Symbol] # Methods requestClient :: PeopleGet -> GClient (Rs PeopleGet) #
type Rep PeopleGet Source #
Instance details Defined in Network.Google.Resource.People.People.Get type Rep PeopleGet = D1 (MetaData "PeopleGet" "Network.Google.Resource.People.People.Get" "gogol-people-0.4.0-E13x4gVqkHzANg1IJZFmJ4" False) (C1 (MetaCons "PeopleGet'" PrefixI True) (((S1 (MetaSel (Just "_pgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_pgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pgResourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pgRequestMaskIncludeField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)))) :: ((S1 (MetaSel (Just "_pgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pgPersonFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :*: S1 (MetaSel (Just "_pgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes PeopleGet Source #
Instance details Defined in Network.Google.Resource.People.People.Get type Scopes PeopleGet = "https://www.googleapis.com/auth/contacts" ': ("https://www.googleapis.com/auth/contacts.readonly" ': ("https://www.googleapis.com/auth/plus.login" ': ("https://www.googleapis.com/auth/user.addresses.read" ': ("https://www.googleapis.com/auth/user.birthday.read" ': ("https://www.googleapis.com/auth/user.emails.read" ': ("https://www.googleapis.com/auth/user.phonenumbers.read" ': ("https://www.googleapis.com/auth/userinfo.email" ': ("https://www.googleapis.com/auth/userinfo.profile" ': ([] :: [Symbol])))))))))
type Rs PeopleGet Source #
Instance details Defined in Network.Google.Resource.People.People.Get type Rs PeopleGet = Person

Request Lenses

pgXgafv :: Lens' PeopleGet (Maybe Xgafv) Source #

V1 error format.

pgUploadProtocol :: Lens' PeopleGet (Maybe Text) Source #

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

pgResourceName :: Lens' PeopleGet Text Source #

The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by `people.connections.list`.

pgRequestMaskIncludeField :: Lens' PeopleGet (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`.

pgAccessToken :: Lens' PeopleGet (Maybe Text) Source #

OAuth access token.

pgUploadType :: Lens' PeopleGet (Maybe Text) Source #

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

pgPersonFields :: Lens' PeopleGet (Maybe GFieldMask) Source #

*Required.** A field mask to restrict which fields on the 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

pgCallback :: Lens' PeopleGet (Maybe Text) Source #

JSONP