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.Gmail.Users.Watch

Contents

REST Resource
Creating a Request
Request Lenses

Description

Set up or update a push notification watch on the given user mailbox.

See: Gmail API Reference for gmail.users.watch.

Synopsis

type UsersWatchResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("watch" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] WatchRequest :> Post '[JSON] WatchResponse))))))
usersWatch :: WatchRequest -> UsersWatch
data UsersWatch
uwPayload :: Lens' UsersWatch WatchRequest
uwUserId :: Lens' UsersWatch Text

REST Resource

type UsersWatchResource = "gmail" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("watch" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] WatchRequest :> Post '[JSON] WatchResponse)))))) Source #

A resource alias for gmail.users.watch method which the UsersWatch request conforms to.

Creating a Request

usersWatch Source #

Arguments

:: WatchRequest	`uwPayload`
-> UsersWatch

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

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

uwPayload
uwUserId

data UsersWatch Source #

Set up or update a push notification watch on the given user mailbox.

See: usersWatch smart constructor.

Instances

Eq UsersWatch Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Watch Methods (==) :: UsersWatch -> UsersWatch -> Bool # (/=) :: UsersWatch -> UsersWatch -> Bool #
Data UsersWatch Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Watch Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsersWatch -> c UsersWatch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsersWatch # toConstr :: UsersWatch -> Constr # dataTypeOf :: UsersWatch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UsersWatch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsersWatch) # gmapT :: (forall b. Data b => b -> b) -> UsersWatch -> UsersWatch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsersWatch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsersWatch -> r # gmapQ :: (forall d. Data d => d -> u) -> UsersWatch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UsersWatch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsersWatch -> m UsersWatch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersWatch -> m UsersWatch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsersWatch -> m UsersWatch #
Show UsersWatch Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Watch Methods showsPrec :: Int -> UsersWatch -> ShowS # show :: UsersWatch -> String # showList :: [UsersWatch] -> ShowS #
Generic UsersWatch Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Watch Associated Types type Rep UsersWatch :: Type -> Type # Methods from :: UsersWatch -> Rep UsersWatch x # to :: Rep UsersWatch x -> UsersWatch #
GoogleRequest UsersWatch Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Watch Associated Types type Rs UsersWatch :: Type # type Scopes UsersWatch :: [Symbol] # Methods requestClient :: UsersWatch -> GClient (Rs UsersWatch) #
type Rep UsersWatch Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Watch type Rep UsersWatch = D1 (MetaData "UsersWatch" "Network.Google.Resource.Gmail.Users.Watch" "gogol-gmail-0.4.0-EDJmLuxza63I9QV4rXNgT4" False) (C1 (MetaCons "UsersWatch'" PrefixI True) (S1 (MetaSel (Just "_uwPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WatchRequest) :*: S1 (MetaSel (Just "_uwUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Scopes UsersWatch Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Watch type Scopes UsersWatch = "https://mail.google.com/" ': ("https://www.googleapis.com/auth/gmail.metadata" ': ("https://www.googleapis.com/auth/gmail.modify" ': ("https://www.googleapis.com/auth/gmail.readonly" ': ([] :: [Symbol]))))
type Rs UsersWatch Source #
Instance details Defined in Network.Google.Resource.Gmail.Users.Watch type Rs UsersWatch = WatchResponse

Request Lenses

uwPayload :: Lens' UsersWatch WatchRequest Source #

Multipart request metadata.

uwUserId :: Lens' UsersWatch Text Source #

The user's email address. The special value me can be used to indicate the authenticated user.