Safe Haskell	None
Language	GHC2021

Effectful.Notify.Static

Contents

Description
Effect
- Handlers
- Errors
Types

Description

Provides an effect for desktop notifications.

Since: 0.1

Synopsis

data Notify (a :: Type -> Type) b
initNotifyEnv :: forall (es :: [Effect]). (HasCallStack, Notify :> es) => NotifySystemOs -> Eff es NotifyEnv
notify :: forall (es :: [Effect]). (HasCallStack, Notify :> es) => NotifyEnv -> Note -> Eff es ()
runNotify :: forall (es :: [Effect]) a. (HasCallStack, IOE :> es) => Eff (Notify ': es) a -> Eff es a
newtype NotifyInitException = MkNotifyInitException {
- unNotifyInitException :: SomeException
}
data NotifyException = MkNotifyException {
- exception :: SomeException
- fatal :: Bool
- note :: Note
- notifySystem :: NotifySystem
}
catchNonFatalNotify :: forall (es :: [Effect]). (HasCallStack, Notify :> es) => NotifyEnv -> Note -> (NotifyException -> Eff es ()) -> Eff es ()
tryNonFatalNotify :: forall (es :: [Effect]). (HasCallStack, Notify :> es) => NotifyEnv -> Note -> Eff es (Maybe NotifyException)
tryNonFatalNotify_ :: forall (es :: [Effect]). (HasCallStack, Notify :> es) => NotifyEnv -> Note -> Eff es ()
data NotifySystemOs
- = NotifySystemOsDBus
- | NotifySystemOsNotifySend
defaultNotifySystemOs :: NotifySystemOs
data NotifySystem
- = NotifySystemAppleScript
- | NotifySystemDBus
- | NotifySystemNotifySend
- | NotifySystemWindows
defaultNotifySystem :: NotifySystem
notifySystemToOs :: NotifySystem -> Either NotifyParseException NotifySystemOs
notifySystemFromOs :: NotifySystemOs -> NotifySystem
data Os
- = Linux
- | Osx
- | Windows
data NotifyParseException = MkNotifyParseException {
- os :: Os
- system :: NotifySystem
}
data NotifyEnv
notifyEnvToSystemOs :: NotifyEnv -> NotifySystemOs
data Note
mkNote :: Text -> Note
setBody :: Maybe Text -> Note -> Note
getBody :: Note -> Maybe Text
setSummary :: Text -> Note -> Note
getSummary :: Note -> Text
setTimeout :: Maybe NotifyTimeout -> Note -> Note
getTimeout :: Note -> Maybe NotifyTimeout
setTitle :: Maybe Text -> Note -> Note
getTitle :: Note -> Maybe Text
setUrgency :: Maybe NotifyUrgency -> Note -> Note
getUrgency :: Note -> Maybe NotifyUrgency
data NotifyTimeout
- = NotifyTimeoutNever
- | NotifyTimeoutMillis Int
_NotifyTimeoutMillis :: Prism' NotifyTimeout Int
_NotifyTimeoutNever :: Prism' NotifyTimeout ()
data NotifyUrgency
- = NotifyUrgencyLow
- | NotifyUrgencyNormal
- | NotifyUrgencyCritical
_NotifyUrgencyLow :: Prism' NotifyUrgency ()
_NotifyUrgencyNormal :: Prism' NotifyUrgency ()
_NotifyUrgencyCritical :: Prism' NotifyUrgency ()

Description

notify-effectful is a library for implementing cross-platform desktop notifications. Currently supports:

Linux: Supports dbus and notify-send. That is, if there is a running dbus notification server, it can be used directly. notify-send (libnotify) can also be used, though it also requires a running dbus server.
Osx: Supports built-in apple-script i.e. osascript.
Windows: Unsupported. Functions are mere stubs that will compile (with a warning) and do nothing at runtime.

Usage

General usage involves choosing the notification system and using that to initialize the environment:

-- choose system
let systemOs :: NotifySystemOs
    systemOs = ...

-- prepare environment
notifyEnv <- initNotifyEnv systemOs

-- send notification
let note =
      mkNote "A summary"
        & setBody "Some notification"
        & setTitle "My Application"

notify notifyEnv note

Choosing the system is more interesting. If we do not care about being cross-platform, we can simply choose a NotifySystemOs directly and pass it to init:

-- The NotifySystemOsDBus constructor is only available on linux.
let systemOs :: NotifySystemOs
    systemOs = NotifySystemOsDBus

notifyEnv <- initNotifyEnv systemOs
...

If we need to work on several platforms, we can instead use NotifySystem, which includes every possible notification system and is available on all platforms. We then pass it to notifySystemToOs, which -- if successful -- will return the NotifySystemOs and we can continue as normal.

-- All NotifySystem constructors are available on all platforms.
let system :: NotifySystem
    system = ...

systemOs <- notifySystemToOs system >>= \case
  Left ex -> throwM ex
  Right s -> pure s
notifyEnv <- initNotifyEnv systemOs
...

If a system is chosen that is unavailable on the current platform, a NotifyParseException will be returned.

Effect

data Notify (a :: Type -> Type) b Source #

Static notify effect.

Since: 0.1

Instances

Instances details

type DispatchOf Notify Source #
Instance details Defined in Effectful.Notify.Static type DispatchOf Notify = 'Static 'WithSideEffects
data StaticRep Notify Source #
Instance details Defined in Effectful.Notify.Static data StaticRep Notify = MkNotify

initNotifyEnv Source #

Arguments

:: forall (es :: [Effect]). (HasCallStack, Notify :> es)
=> NotifySystemOs	System.
-> Eff es NotifyEnv

Initialize the notification environment.

Since: 0.1

notify Source #

Arguments

:: forall (es :: [Effect]). (HasCallStack, Notify :> es)
=> NotifyEnv	Env.
-> Note	Note.
-> Eff es ()

Send a notification.

Since: 0.1

Handlers

runNotify :: forall (es :: [Effect]) a. (HasCallStack, IOE :> es) => Eff (Notify ': es) a -> Eff es a Source #

Runs a Notify effect in IO.

Since: 0.1

Errors

newtype NotifyInitException Source #

Exceptions thrown when initializing notifications.

Since: 0.1

Constructors

MkNotifyInitException
Fields unNotifyInitException :: SomeException

Instances

Instances details

Exception NotifyInitException Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyInitException Methods toException :: NotifyInitException -> SomeException # fromException :: SomeException -> Maybe NotifyInitException # displayException :: NotifyInitException -> String # backtraceDesired :: NotifyInitException -> Bool #
Show NotifyInitException Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyInitException Methods showsPrec :: Int -> NotifyInitException -> ShowS # show :: NotifyInitException -> String # showList :: [NotifyInitException] -> ShowS #

data NotifyException Source #

Exceptions thrown when sending notifications. The list of non-fatal exceptions includes:

DBus: Non-fatal client errors.

All others are considered fatal.

Since: 0.1

Constructors

MkNotifyException
Fields exception :: SomeException Underlying exception. fatal :: Bool Is fatal? note :: Note Note we attempted to send. notifySystem :: NotifySystem Notification system.

Instances

Instances details

Exception NotifyException Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyException Methods toException :: NotifyException -> SomeException # fromException :: SomeException -> Maybe NotifyException # displayException :: NotifyException -> String # backtraceDesired :: NotifyException -> Bool #
Show NotifyException Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyException Methods showsPrec :: Int -> NotifyException -> ShowS # show :: NotifyException -> String # showList :: [NotifyException] -> ShowS #
(k ~ A_Lens, a ~ SomeException, b ~ SomeException) => LabelOptic "exception" k NotifyException NotifyException a b Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyException Methods labelOptic :: Optic k NoIx NotifyException NotifyException a b Source #
(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "fatal" k NotifyException NotifyException a b Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyException Methods labelOptic :: Optic k NoIx NotifyException NotifyException a b Source #
(k ~ A_Lens, a ~ Note, b ~ Note) => LabelOptic "note" k NotifyException NotifyException a b Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyException Methods labelOptic :: Optic k NoIx NotifyException NotifyException a b Source #
(k ~ A_Lens, a ~ NotifySystem, b ~ NotifySystem) => LabelOptic "notifySystem" k NotifyException NotifyException a b Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyException Methods labelOptic :: Optic k NoIx NotifyException NotifyException a b Source #

catchNonFatalNotify Source #

Arguments

:: forall (es :: [Effect]). (HasCallStack, Notify :> es)
=> NotifyEnv	Env.
-> Note	Note.
-> (NotifyException -> Eff es ())	Handler.
-> Eff es ()

Runs notify and runs the handler on any non-fatal NotifyExceptions. Any other exceptions are rethrown.

Since: 0.1

tryNonFatalNotify Source #

Arguments

:: forall (es :: [Effect]). (HasCallStack, Notify :> es)
=> NotifyEnv	Env.
-> Note	Note.
-> Eff es (Maybe NotifyException)

Like notify, but catches non-fatal NotifyException.

Since: 0.1

tryNonFatalNotify_ Source #

Arguments

:: forall (es :: [Effect]). (HasCallStack, Notify :> es)
=> NotifyEnv	Env.
-> Note	Note.
-> Eff es ()

Like tryNonFatalNotify, but catches and discards the exception.

Since: 0.1

Types

System

Platform-specific

data NotifySystemOs Source #

Notification system. Options are platform specific.

Since: 0.1

Constructors

NotifySystemOsDBus
NotifySystemOsNotifySend

Instances

Instances details

NFData NotifySystemOs Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

rnf :: NotifySystemOs -> () #

Bounded NotifySystemOs Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

minBound :: NotifySystemOs #

maxBound :: NotifySystemOs #

Enum NotifySystemOs Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

succ :: NotifySystemOs -> NotifySystemOs #

pred :: NotifySystemOs -> NotifySystemOs #

toEnum :: Int -> NotifySystemOs #

fromEnum :: NotifySystemOs -> Int #

enumFrom :: NotifySystemOs -> [NotifySystemOs] #

enumFromThen :: NotifySystemOs -> NotifySystemOs -> [NotifySystemOs] #

enumFromTo :: NotifySystemOs -> NotifySystemOs -> [NotifySystemOs] #

enumFromThenTo :: NotifySystemOs -> NotifySystemOs -> NotifySystemOs -> [NotifySystemOs] #

Generic NotifySystemOs Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Associated Types

type Rep NotifySystemOs
Instance details Defined in Effectful.Notify.Internal.Data.NotifySystem type Rep NotifySystemOs = D1 ('MetaData "NotifySystemOs" "Effectful.Notify.Internal.Data.NotifySystem" "notify-effectful-0.1-inplace" 'False) (C1 ('MetaCons "NotifySystemOsDBus" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifySystemOsNotifySend" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: NotifySystemOs -> Rep NotifySystemOs x #

to :: Rep NotifySystemOs x -> NotifySystemOs #

Show NotifySystemOs Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

showsPrec :: Int -> NotifySystemOs -> ShowS #

show :: NotifySystemOs -> String #

showList :: [NotifySystemOs] -> ShowS #

Eq NotifySystemOs Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

(==) :: NotifySystemOs -> NotifySystemOs -> Bool #

(/=) :: NotifySystemOs -> NotifySystemOs -> Bool #

Ord NotifySystemOs Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

compare :: NotifySystemOs -> NotifySystemOs -> Ordering #

(<) :: NotifySystemOs -> NotifySystemOs -> Bool #

(<=) :: NotifySystemOs -> NotifySystemOs -> Bool #

(>) :: NotifySystemOs -> NotifySystemOs -> Bool #

(>=) :: NotifySystemOs -> NotifySystemOs -> Bool #

max :: NotifySystemOs -> NotifySystemOs -> NotifySystemOs #

min :: NotifySystemOs -> NotifySystemOs -> NotifySystemOs #

Display NotifySystemOs Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

displayBuilder :: NotifySystemOs -> Builder Source #

displayList :: [NotifySystemOs] -> Builder Source #

displayPrec :: Int -> NotifySystemOs -> Builder Source #

type Rep NotifySystemOs Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

type Rep NotifySystemOs = D1 ('MetaData "NotifySystemOs" "Effectful.Notify.Internal.Data.NotifySystem" "notify-effectful-0.1-inplace" 'False) (C1 ('MetaCons "NotifySystemOsDBus" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifySystemOsNotifySend" 'PrefixI 'False) (U1 :: Type -> Type))

defaultNotifySystemOs :: NotifySystemOs Source #

Since: 0.1

All platforms

data NotifySystem Source #

Represents all possible notification systems. This is useful for when we want to choose the system in some way that works across multiple platforms without requiring cpp.

Since: 0.1

Constructors

NotifySystemAppleScript
NotifySystemDBus
NotifySystemNotifySend
NotifySystemWindows

Instances

Instances details

NFData NotifySystem Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

rnf :: NotifySystem -> () #

Bounded NotifySystem Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

minBound :: NotifySystem #

maxBound :: NotifySystem #

Enum NotifySystem Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

succ :: NotifySystem -> NotifySystem #

pred :: NotifySystem -> NotifySystem #

toEnum :: Int -> NotifySystem #

fromEnum :: NotifySystem -> Int #

enumFrom :: NotifySystem -> [NotifySystem] #

enumFromThen :: NotifySystem -> NotifySystem -> [NotifySystem] #

enumFromTo :: NotifySystem -> NotifySystem -> [NotifySystem] #

enumFromThenTo :: NotifySystem -> NotifySystem -> NotifySystem -> [NotifySystem] #

Generic NotifySystem Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Associated Types

type Rep NotifySystem

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

type Rep NotifySystem = D1 ('MetaData "NotifySystem" "Effectful.Notify.Internal.Data.NotifySystem" "notify-effectful-0.1-inplace" 'False) ((C1 ('MetaCons "NotifySystemAppleScript" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifySystemDBus" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NotifySystemNotifySend" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifySystemWindows" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: NotifySystem -> Rep NotifySystem x #

to :: Rep NotifySystem x -> NotifySystem #

Show NotifySystem Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

showsPrec :: Int -> NotifySystem -> ShowS #

show :: NotifySystem -> String #

showList :: [NotifySystem] -> ShowS #

Eq NotifySystem Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

(==) :: NotifySystem -> NotifySystem -> Bool #

(/=) :: NotifySystem -> NotifySystem -> Bool #

Ord NotifySystem Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

compare :: NotifySystem -> NotifySystem -> Ordering #

(<) :: NotifySystem -> NotifySystem -> Bool #

(<=) :: NotifySystem -> NotifySystem -> Bool #

(>) :: NotifySystem -> NotifySystem -> Bool #

(>=) :: NotifySystem -> NotifySystem -> Bool #

max :: NotifySystem -> NotifySystem -> NotifySystem #

min :: NotifySystem -> NotifySystem -> NotifySystem #

Display NotifySystem Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

Methods

displayBuilder :: NotifySystem -> Builder Source #

displayList :: [NotifySystem] -> Builder Source #

displayPrec :: Int -> NotifySystem -> Builder Source #

type Rep NotifySystem Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifySystem

type Rep NotifySystem = D1 ('MetaData "NotifySystem" "Effectful.Notify.Internal.Data.NotifySystem" "notify-effectful-0.1-inplace" 'False) ((C1 ('MetaCons "NotifySystemAppleScript" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifySystemDBus" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NotifySystemNotifySend" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifySystemWindows" 'PrefixI 'False) (U1 :: Type -> Type)))

defaultNotifySystem :: NotifySystem Source #

Since: 0.1

notifySystemToOs :: NotifySystem -> Either NotifyParseException NotifySystemOs Source #

Converts platform-agnostic NotifySystem to platform-specific NotifySystemOs. Useful for obtaining a valid system for the current platform without cpp.

Since: 0.1

notifySystemFromOs :: NotifySystemOs -> NotifySystem Source #

Inverse notifySystemToOs.

Since: 0.1

data Os Source #

Os types.

Since: 0.1

Constructors

Linux	Since: 0.1
Osx	Since: 0.1
Windows	Since: 0.1

Instances

Instances details

Bounded Os Source #
Instance details Defined in Effectful.Notify.Internal.Os Methods minBound :: Os # maxBound :: Os #
Show Os Source #
Instance details Defined in Effectful.Notify.Internal.Os Methods showsPrec :: Int -> Os -> ShowS # show :: Os -> String # showList :: [Os] -> ShowS #
Eq Os Source #
Instance details Defined in Effectful.Notify.Internal.Os Methods (==) :: Os -> Os -> Bool # (/=) :: Os -> Os -> Bool #
Display Os Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Os Methods displayBuilder :: Os -> Builder Source # displayList :: [Os] -> Builder Source # displayPrec :: Int -> Os -> Builder Source #

data NotifyParseException Source #

Exceptions thrown when parsing NotifySystem to NotifySystemOs.

Since: 0.1

Constructors

MkNotifyParseException
Fields os :: Os The current `Os`. system :: NotifySystem The `NotifySystem` we attempted to use.

Instances

Instances details

Exception NotifyParseException Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifySystem Methods toException :: NotifyParseException -> SomeException # fromException :: SomeException -> Maybe NotifyParseException # displayException :: NotifyParseException -> String # backtraceDesired :: NotifyParseException -> Bool #
Show NotifyParseException Source #
Instance details Defined in Effectful.Notify.Internal.Data.NotifySystem Methods showsPrec :: Int -> NotifyParseException -> ShowS # show :: NotifyParseException -> String # showList :: [NotifyParseException] -> ShowS #
(k ~ A_Lens, a ~ Os, b ~ Os) => LabelOptic "os" k NotifyParseException NotifyParseException a b Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifySystem Methods labelOptic :: Optic k NoIx NotifyParseException NotifyParseException a b Source #
(k ~ A_Lens, a ~ NotifySystem, b ~ NotifySystem) => LabelOptic "system" k NotifyParseException NotifyParseException a b Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifySystem Methods labelOptic :: Optic k NoIx NotifyParseException NotifyParseException a b Source #

Env

data NotifyEnv Source #

Notification environment.

Since: 0.1

Instances

Instances details

Show NotifyEnv Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyEnv Methods showsPrec :: Int -> NotifyEnv -> ShowS # show :: NotifyEnv -> String # showList :: [NotifyEnv] -> ShowS #
Display NotifyEnv Source #	Since: 0.1
Instance details Defined in Effectful.Notify.Internal.Data.NotifyEnv Methods displayBuilder :: NotifyEnv -> Builder Source # displayList :: [NotifyEnv] -> Builder Source # displayPrec :: Int -> NotifyEnv -> Builder Source #

notifyEnvToSystemOs :: NotifyEnv -> NotifySystemOs Source #

Gives the system for the given environment.

Since: 0.1

Notes

data Note Source #

Notification type.

Since: 0.1

Instances

Instances details

NFData Note Source #

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

rnf :: Note -> () #

Generic Note Source #

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Associated Types

type Rep Note

Instance details

Defined in Effectful.Notify.Internal.Data.Note

type Rep Note = D1 ('MetaData "Note" "Effectful.Notify.Internal.Data.Note" "notify-effectful-0.1-inplace" 'False) (C1 ('MetaCons "MkNoteInternal" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotifyTimeout)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotifyUrgency))))))

Methods

from :: Note -> Rep Note x #

to :: Rep Note x -> Note #

Show Note Source #

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

showsPrec :: Int -> Note -> ShowS #

show :: Note -> String #

showList :: [Note] -> ShowS #

Eq Note Source #

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

(==) :: Note -> Note -> Bool #

(/=) :: Note -> Note -> Bool #

Ord Note Source #

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

compare :: Note -> Note -> Ordering #

(<) :: Note -> Note -> Bool #

(<=) :: Note -> Note -> Bool #

(>) :: Note -> Note -> Bool #

(>=) :: Note -> Note -> Bool #

max :: Note -> Note -> Note #

min :: Note -> Note -> Note #

HasField "summary" Note Text Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

getField :: Note -> Text #

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "body" k Note Note a b Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

labelOptic :: Optic k NoIx Note Note a b Source #

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "summary" k Note Note a b Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

labelOptic :: Optic k NoIx Note Note a b Source #

(k ~ A_Lens, a ~ Maybe NotifyTimeout, b ~ Maybe NotifyTimeout) => LabelOptic "timeout" k Note Note a b Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

labelOptic :: Optic k NoIx Note Note a b Source #

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "title" k Note Note a b Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

labelOptic :: Optic k NoIx Note Note a b Source #

(k ~ A_Lens, a ~ Maybe NotifyUrgency, b ~ Maybe NotifyUrgency) => LabelOptic "urgency" k Note Note a b Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

labelOptic :: Optic k NoIx Note Note a b Source #

HasField "body" Note (Maybe Text) Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

getField :: Note -> Maybe Text #

HasField "timeout" Note (Maybe NotifyTimeout) Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

getField :: Note -> Maybe NotifyTimeout #

HasField "title" Note (Maybe Text) Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

getField :: Note -> Maybe Text #

HasField "urgency" Note (Maybe NotifyUrgency) Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

getField :: Note -> Maybe NotifyUrgency #

type Rep Note Source #

Instance details

Defined in Effectful.Notify.Internal.Data.Note

type Rep Note = D1 ('MetaData "Note" "Effectful.Notify.Internal.Data.Note" "notify-effectful-0.1-inplace" 'False) (C1 ('MetaCons "MkNoteInternal" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotifyTimeout)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotifyUrgency))))))

mkNote :: Text -> Note Source #

Makes a note from a text summary.

setBody :: Maybe Text -> Note -> Note Source #

Since: 0.1

getBody :: Note -> Maybe Text Source #

Since: 0.1

setSummary :: Text -> Note -> Note Source #

Since: 0.1

getSummary :: Note -> Text Source #

Since: 0.1

setTimeout :: Maybe NotifyTimeout -> Note -> Note Source #

Since: 0.1

getTimeout :: Note -> Maybe NotifyTimeout Source #

Since: 0.1

setTitle :: Maybe Text -> Note -> Note Source #

Since: 0.1

getTitle :: Note -> Maybe Text Source #

Since: 0.1

setUrgency :: Maybe NotifyUrgency -> Note -> Note Source #

Since: 0.1

getUrgency :: Note -> Maybe NotifyUrgency Source #

Since: 0.1

Timeout

data NotifyTimeout Source #

Notification timeout, in milliseconds.

Since: 0.1

Constructors

NotifyTimeoutNever
NotifyTimeoutMillis Int

Instances

Instances details

NFData NotifyTimeout Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyTimeout

Methods

rnf :: NotifyTimeout -> () #

Generic NotifyTimeout Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyTimeout

Associated Types

type Rep NotifyTimeout

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyTimeout

type Rep NotifyTimeout = D1 ('MetaData "NotifyTimeout" "Effectful.Notify.Internal.Data.NotifyTimeout" "notify-effectful-0.1-inplace" 'False) (C1 ('MetaCons "NotifyTimeoutNever" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifyTimeoutMillis" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

Methods

from :: NotifyTimeout -> Rep NotifyTimeout x #

to :: Rep NotifyTimeout x -> NotifyTimeout #

Show NotifyTimeout Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyTimeout

Methods

showsPrec :: Int -> NotifyTimeout -> ShowS #

show :: NotifyTimeout -> String #

showList :: [NotifyTimeout] -> ShowS #

Eq NotifyTimeout Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyTimeout

Methods

(==) :: NotifyTimeout -> NotifyTimeout -> Bool #

(/=) :: NotifyTimeout -> NotifyTimeout -> Bool #

Ord NotifyTimeout Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyTimeout

Methods

compare :: NotifyTimeout -> NotifyTimeout -> Ordering #

(<) :: NotifyTimeout -> NotifyTimeout -> Bool #

(<=) :: NotifyTimeout -> NotifyTimeout -> Bool #

(>) :: NotifyTimeout -> NotifyTimeout -> Bool #

(>=) :: NotifyTimeout -> NotifyTimeout -> Bool #

max :: NotifyTimeout -> NotifyTimeout -> NotifyTimeout #

min :: NotifyTimeout -> NotifyTimeout -> NotifyTimeout #

Display NotifyTimeout Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyTimeout

Methods

displayBuilder :: NotifyTimeout -> Builder Source #

displayList :: [NotifyTimeout] -> Builder Source #

displayPrec :: Int -> NotifyTimeout -> Builder Source #

HasField "timeout" Note (Maybe NotifyTimeout) Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

getField :: Note -> Maybe NotifyTimeout #

type Rep NotifyTimeout Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyTimeout

type Rep NotifyTimeout = D1 ('MetaData "NotifyTimeout" "Effectful.Notify.Internal.Data.NotifyTimeout" "notify-effectful-0.1-inplace" 'False) (C1 ('MetaCons "NotifyTimeoutNever" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifyTimeoutMillis" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

_NotifyTimeoutMillis :: Prism' NotifyTimeout Int Source #

Since: 0.1

_NotifyTimeoutNever :: Prism' NotifyTimeout () Source #

Since: 0.1

NotifyUrgency

data NotifyUrgency Source #

Notification urgency. Not supported by all notification systems.

Constructors

NotifyUrgencyLow	Low.
NotifyUrgencyNormal	Normal.
NotifyUrgencyCritical	Critical.

Instances

Instances details

NFData NotifyUrgency Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

Methods

rnf :: NotifyUrgency -> () #

Bounded NotifyUrgency Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

Methods

minBound :: NotifyUrgency #

maxBound :: NotifyUrgency #

Enum NotifyUrgency Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

Methods

succ :: NotifyUrgency -> NotifyUrgency #

pred :: NotifyUrgency -> NotifyUrgency #

toEnum :: Int -> NotifyUrgency #

fromEnum :: NotifyUrgency -> Int #

enumFrom :: NotifyUrgency -> [NotifyUrgency] #

enumFromThen :: NotifyUrgency -> NotifyUrgency -> [NotifyUrgency] #

enumFromTo :: NotifyUrgency -> NotifyUrgency -> [NotifyUrgency] #

enumFromThenTo :: NotifyUrgency -> NotifyUrgency -> NotifyUrgency -> [NotifyUrgency] #

Generic NotifyUrgency Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

Associated Types

type Rep NotifyUrgency

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

type Rep NotifyUrgency = D1 ('MetaData "NotifyUrgency" "Effectful.Notify.Internal.Data.NotifyUrgency" "notify-effectful-0.1-inplace" 'False) (C1 ('MetaCons "NotifyUrgencyLow" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NotifyUrgencyNormal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifyUrgencyCritical" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: NotifyUrgency -> Rep NotifyUrgency x #

to :: Rep NotifyUrgency x -> NotifyUrgency #

Show NotifyUrgency Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

Methods

showsPrec :: Int -> NotifyUrgency -> ShowS #

show :: NotifyUrgency -> String #

showList :: [NotifyUrgency] -> ShowS #

Eq NotifyUrgency Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

Methods

(==) :: NotifyUrgency -> NotifyUrgency -> Bool #

(/=) :: NotifyUrgency -> NotifyUrgency -> Bool #

Ord NotifyUrgency Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

Methods

compare :: NotifyUrgency -> NotifyUrgency -> Ordering #

(<) :: NotifyUrgency -> NotifyUrgency -> Bool #

(<=) :: NotifyUrgency -> NotifyUrgency -> Bool #

(>) :: NotifyUrgency -> NotifyUrgency -> Bool #

(>=) :: NotifyUrgency -> NotifyUrgency -> Bool #

max :: NotifyUrgency -> NotifyUrgency -> NotifyUrgency #

min :: NotifyUrgency -> NotifyUrgency -> NotifyUrgency #

Display NotifyUrgency Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

Methods

displayBuilder :: NotifyUrgency -> Builder Source #

displayList :: [NotifyUrgency] -> Builder Source #

displayPrec :: Int -> NotifyUrgency -> Builder Source #

HasField "urgency" Note (Maybe NotifyUrgency) Source #

Since: 0.1

Instance details

Defined in Effectful.Notify.Internal.Data.Note

Methods

getField :: Note -> Maybe NotifyUrgency #

type Rep NotifyUrgency Source #

Instance details

Defined in Effectful.Notify.Internal.Data.NotifyUrgency

type Rep NotifyUrgency = D1 ('MetaData "NotifyUrgency" "Effectful.Notify.Internal.Data.NotifyUrgency" "notify-effectful-0.1-inplace" 'False) (C1 ('MetaCons "NotifyUrgencyLow" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NotifyUrgencyNormal" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NotifyUrgencyCritical" 'PrefixI 'False) (U1 :: Type -> Type)))

_NotifyUrgencyLow :: Prism' NotifyUrgency () Source #

Since: 0.1

_NotifyUrgencyNormal :: Prism' NotifyUrgency () Source #

Since: 0.1

_NotifyUrgencyCritical :: Prism' NotifyUrgency () Source #

Since: 0.1