Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.NotificationSubsystem

Synopsis

data Recipient = Recipient {
- recipientUserId :: UserId
- recipientClients :: RecipientClients
}
data Push = Push {
- _pushConn :: Maybe ConnId
- _pushTransient :: Bool
- _pushRoute :: Route
- _pushNativePriority :: Maybe Priority
- pushOrigin :: Maybe UserId
- _pushRecipients :: NonEmpty Recipient
- pushJson :: Object
- _pushApsData :: Maybe ApsData
}
pushTransient :: Lens' Push Bool
pushRoute :: Lens' Push Route
pushRecipients :: Lens' Push (NonEmpty Recipient)
pushNativePriority :: Lens' Push (Maybe Priority)
pushConn :: Lens' Push (Maybe ConnId)
pushApsData :: Lens' Push (Maybe ApsData)
data NotificationSubsystem m a where
- PushNotifications :: [Push] -> NotificationSubsystem m ()
- PushNotificationsSlowly :: [Push] -> NotificationSubsystem m ()
- PushNotificationsAsync :: [Push] -> NotificationSubsystem m (Async (Maybe ()))
- CleanupUser :: UserId -> NotificationSubsystem m ()
- UnregisterPushClient :: UserId -> ClientId -> NotificationSubsystem m ()
- GetPushTokens :: UserId -> NotificationSubsystem m [PushToken]
getPushTokens :: forall r. Member NotificationSubsystem r => UserId -> Sem r [PushToken]
unregisterPushClient :: forall r. Member NotificationSubsystem r => UserId -> ClientId -> Sem r ()
cleanupUser :: forall r. Member NotificationSubsystem r => UserId -> Sem r ()
pushNotificationsAsync :: forall r. Member NotificationSubsystem r => [Push] -> Sem r (Async (Maybe ()))
pushNotificationsSlowly :: forall r. Member NotificationSubsystem r => [Push] -> Sem r ()
pushNotifications :: forall r. Member NotificationSubsystem r => [Push] -> Sem r ()
newPush1 :: Maybe UserId -> Object -> NonEmpty Recipient -> Push
newPush :: Maybe UserId -> Object -> [Recipient] -> Maybe Push
newPushLocal :: UserId -> Object -> [Recipient] -> Maybe Push
newPushLocal1 :: UserId -> Object -> NonEmpty Recipient -> Push

Documentation

data Recipient Source #

Constructors

Recipient
Fields recipientUserId :: UserId recipientClients :: RecipientClients

Instances

Instances details

Arbitrary Recipient Source #
Instance details Defined in Wire.NotificationSubsystem Methods arbitrary :: Gen Recipient Source # shrink :: Recipient -> [Recipient] Source #
Generic Recipient Source #
Instance details Defined in Wire.NotificationSubsystem Associated Types type Rep Recipient :: Type -> Type # Methods from :: Recipient -> Rep Recipient x # to :: Rep Recipient x -> Recipient #
Show Recipient Source #
Instance details Defined in Wire.NotificationSubsystem Methods showsPrec :: Int -> Recipient -> ShowS # show :: Recipient -> String # showList :: [Recipient] -> ShowS #
Eq Recipient Source #
Instance details Defined in Wire.NotificationSubsystem Methods (==) :: Recipient -> Recipient -> Bool # (/=) :: Recipient -> Recipient -> Bool #
Ord Recipient Source #
Instance details Defined in Wire.NotificationSubsystem Methods compare :: Recipient -> Recipient -> Ordering # (<) :: Recipient -> Recipient -> Bool # (<=) :: Recipient -> Recipient -> Bool # (>) :: Recipient -> Recipient -> Bool # (>=) :: Recipient -> Recipient -> Bool # max :: Recipient -> Recipient -> Recipient # min :: Recipient -> Recipient -> Recipient #
type Rep Recipient Source #
Instance details Defined in Wire.NotificationSubsystem type Rep Recipient = D1 ('MetaData "Recipient" "Wire.NotificationSubsystem" "wire-subsystems-0.1.0-yiYZiegPZRHMEY53V2BOj" 'False) (C1 ('MetaCons "Recipient" 'PrefixI 'True) (S1 ('MetaSel ('Just "recipientUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "recipientClients") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RecipientClients)))

data Push Source #

Constructors

Push
Fields _pushConn :: Maybe ConnId _pushTransient :: Bool _pushRoute :: Route _pushNativePriority :: Maybe Priority pushOrigin :: Maybe UserId _pushRecipients :: NonEmpty Recipient pushJson :: Object _pushApsData :: Maybe ApsData

Instances

Instances details

Arbitrary Push Source #
Instance details Defined in Wire.NotificationSubsystem Methods arbitrary :: Gen Push Source # shrink :: Push -> [Push] Source #
Generic Push Source #
Instance details Defined in Wire.NotificationSubsystem Associated Types type Rep Push :: Type -> Type # Methods from :: Push -> Rep Push x # to :: Rep Push x -> Push #
Show Push Source #
Instance details Defined in Wire.NotificationSubsystem Methods showsPrec :: Int -> Push -> ShowS # show :: Push -> String # showList :: [Push] -> ShowS #
Eq Push Source #
Instance details Defined in Wire.NotificationSubsystem Methods (==) :: Push -> Push -> Bool # (/=) :: Push -> Push -> Bool #
type Rep Push Source #
Instance details Defined in Wire.NotificationSubsystem type Rep Push = D1 ('MetaData "Push" "Wire.NotificationSubsystem" "wire-subsystems-0.1.0-yiYZiegPZRHMEY53V2BOj" 'False) (C1 ('MetaCons "Push" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_pushConn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ConnId)) :: S1 ('MetaSel ('Just "_pushTransient") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "_pushRoute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Route) :: S1 ('MetaSel ('Just "_pushNativePriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Priority)))) :: ((S1 ('MetaSel ('Just "pushOrigin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UserId)) :: S1 ('MetaSel ('Just "_pushRecipients") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty Recipient))) :: (S1 ('MetaSel ('Just "pushJson") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Object) :*: S1 ('MetaSel ('Just "_pushApsData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ApsData))))))

pushTransient :: Lens' Push Bool Source #

pushRoute :: Lens' Push Route Source #

pushRecipients :: Lens' Push (NonEmpty Recipient) Source #

pushNativePriority :: Lens' Push (Maybe Priority) Source #

pushConn :: Lens' Push (Maybe ConnId) Source #

pushApsData :: Lens' Push (Maybe ApsData) Source #

data NotificationSubsystem m a where Source #

This subsystem governs mechanisms to send notifications to users.

Constructors

PushNotifications :: [Push] -> NotificationSubsystem m ()	Bulk push notifications
PushNotificationsSlowly :: [Push] -> NotificationSubsystem m ()	Bulk push notifications, but slowly. This should be used when there are many notifications to be sent which could cause too much resource usage.
PushNotificationsAsync :: [Push] -> NotificationSubsystem m (Async (Maybe ()))	Bulk push notifications, but async. This should be used when failure to send notifications is not critical. See `Async` to know more about the `Maybe`
CleanupUser :: UserId -> NotificationSubsystem m ()
UnregisterPushClient :: UserId -> ClientId -> NotificationSubsystem m ()
GetPushTokens :: UserId -> NotificationSubsystem m [PushToken]

getPushTokens :: forall r. Member NotificationSubsystem r => UserId -> Sem r [PushToken] Source #

unregisterPushClient :: forall r. Member NotificationSubsystem r => UserId -> ClientId -> Sem r () Source #

cleanupUser :: forall r. Member NotificationSubsystem r => UserId -> Sem r () Source #

pushNotificationsAsync :: forall r. Member NotificationSubsystem r => [Push] -> Sem r (Async (Maybe ())) Source #

Bulk push notifications, but async. This should be used when failure to send notifications is not critical.

See Async to know more about the Maybe

pushNotificationsSlowly :: forall r. Member NotificationSubsystem r => [Push] -> Sem r () Source #

Bulk push notifications, but slowly. This should be used when there are many notifications to be sent which could cause too much resource usage.

pushNotifications :: forall r. Member NotificationSubsystem r => [Push] -> Sem r () Source #

Bulk push notifications

newPush1 :: Maybe UserId -> Object -> NonEmpty Recipient -> Push Source #

newPush :: Maybe UserId -> Object -> [Recipient] -> Maybe Push Source #

newPushLocal :: UserId -> Object -> [Recipient] -> Maybe Push Source #

newPushLocal1 :: UserId -> Object -> NonEmpty Recipient -> Push Source #