gogol-plus-0.3.0: Google + 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.Plus.People.Search

Contents

Description

Search all public profiles.

See: Google+ API Reference for plus.people.search.

Synopsis

REST Resource

type PeopleSearchResource = "plus" :> ("v1" :> ("people" :> (QueryParam "query" Text :> (QueryParam "language" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] PeopleFeed))))))) #

A resource alias for plus.people.search method which the PeopleSearch request conforms to.

Creating a Request

peopleSearch #

Arguments

:: Text

psQuery

-> PeopleSearch 

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

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

data PeopleSearch #

Search all public profiles.

See: peopleSearch smart constructor.

Instances

Eq PeopleSearch # 
Data PeopleSearch # 

Methods

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

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

toConstr :: PeopleSearch -> Constr #

dataTypeOf :: PeopleSearch -> DataType #

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

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

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

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

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

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

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

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

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

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

Show PeopleSearch # 
Generic PeopleSearch # 

Associated Types

type Rep PeopleSearch :: * -> * #

GoogleRequest PeopleSearch # 

Associated Types

type Rs PeopleSearch :: * #

type Scopes PeopleSearch :: [Symbol] #

type Rep PeopleSearch # 
type Rep PeopleSearch = D1 (MetaData "PeopleSearch" "Network.Google.Resource.Plus.People.Search" "gogol-plus-0.3.0-81DZRySM4JlBh9aZdIa9oH" False) (C1 (MetaCons "PeopleSearch'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_psQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_psLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_psPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_psMaxResults") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 (Textual Word32))))))
type Scopes PeopleSearch # 
type Scopes PeopleSearch = (:) Symbol "https://www.googleapis.com/auth/plus.login" ((:) Symbol "https://www.googleapis.com/auth/plus.me" ([] Symbol))
type Rs PeopleSearch # 

Request Lenses

psQuery :: Lens' PeopleSearch Text #

Specify a query string for full text search of public text in all profiles.

psLanguage :: Lens' PeopleSearch Text #

Specify the preferred language to search with. See search language codes for available values.

psPageToken :: Lens' PeopleSearch (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. This token can be of any length.

psMaxResults :: Lens' PeopleSearch 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.