Safe Haskell	None

System.Libnotify

Description

System.Libnotify module deals with notification session processing.

Synopsis

Documentation

data Notify a Source

Notification monad. Saves notification context.

Instances

Monad Notify
Functor Notify
MonadIO Notify

data NotifyState Source

Notification state. Contains next rendered notification data.

data NotifyError Source

Libnotify errors.

Constructors

NotifyInitHasFailed	notify_init() has failed.
NewCalledBeforeInit	`new` has called before notify_init().

Instances

Show NotifyError

oneShot :: Title -> Body -> Icon -> Maybe [Hint] -> IO (Either NotifyError ())Source

Function for one-time notification with hints perhaps. Should be enough for a vast majority of applications.

withNotifications :: Maybe String -> IO a -> IO (Either NotifyError ())Source

Initializes and uninitializes libnotify API. Any notifications API calls should be wrapped into withNotifications, i.e.

 main = withNotifications (Just "api-name") $ do { ... here are notification API calls ... }

new :: Title -> Body -> Icon -> Notify t -> IO (Either NotifyError (Notification, NotifyState))Source

Creates new notification session. Inside new call one can manage current notification via update or render calls. Returns notification pointer. This could be useful if one wants to update or close the same notification after some time (see continue).

continue :: (Notification, NotifyState) -> Notify a -> IO NotifyState Source

Continues old notification session.

update :: Maybe Title -> Maybe Body -> Maybe Icon -> Notify Bool Source

Updates notification Title, Body and Icon. User can update notification partially, passing Nothing to arguments that should not changed.

render :: Notify Bool Source

Shows notification to user.

close :: Notify Bool Source

Closes notification.

setTimeout :: Timeout -> Notify ()Source

Sets notification Timeout.

setCategory :: Category -> Notify ()Source

Sets notification Category.