gogol-android-enterprise-0.4.0: Google Play EMM 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.AndroidEnterprise.Enterprises.PullNotificationSet

Contents

Description

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.

See: Google Play EMM API Reference for androidenterprise.enterprises.pullNotificationSet.

Synopsis

REST Resource

type EnterprisesPullNotificationSetResource = "androidenterprise" :> ("v1" :> ("enterprises" :> ("pullNotificationSet" :> (QueryParam "requestMode" EnterprisesPullNotificationSetRequestMode :> (QueryParam "alt" AltJSON :> Post '[JSON] NotificationSet))))) Source #

A resource alias for androidenterprise.enterprises.pullNotificationSet method which the EnterprisesPullNotificationSet request conforms to.

Creating a Request

enterprisesPullNotificationSet :: EnterprisesPullNotificationSet Source #

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

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

data EnterprisesPullNotificationSet Source #

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.

See: enterprisesPullNotificationSet smart constructor.

Instances
Eq EnterprisesPullNotificationSet Source # 
Instance details

Defined in Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet

Data EnterprisesPullNotificationSet Source # 
Instance details

Defined in Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet

Methods

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

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

toConstr :: EnterprisesPullNotificationSet -> Constr #

dataTypeOf :: EnterprisesPullNotificationSet -> DataType #

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

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

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

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

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

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

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

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

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

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

Show EnterprisesPullNotificationSet Source # 
Instance details

Defined in Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet

Generic EnterprisesPullNotificationSet Source # 
Instance details

Defined in Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet

Associated Types

type Rep EnterprisesPullNotificationSet :: Type -> Type #

GoogleRequest EnterprisesPullNotificationSet Source # 
Instance details

Defined in Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet

type Rep EnterprisesPullNotificationSet Source # 
Instance details

Defined in Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet

type Rep EnterprisesPullNotificationSet = D1 (MetaData "EnterprisesPullNotificationSet" "Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet" "gogol-android-enterprise-0.4.0-AXWt9Q8V4E0DkwyzrsX7x3" True) (C1 (MetaCons "EnterprisesPullNotificationSet'" PrefixI True) (S1 (MetaSel (Just "_epnsRequestMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe EnterprisesPullNotificationSetRequestMode))))
type Scopes EnterprisesPullNotificationSet Source # 
Instance details

Defined in Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet

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

Defined in Network.Google.Resource.AndroidEnterprise.Enterprises.PullNotificationSet

Request Lenses

epnsRequestMode :: Lens' EnterprisesPullNotificationSet (Maybe EnterprisesPullNotificationSetRequestMode) Source #

The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.