GI.Gio.Objects.Notification

Notification is a mechanism for creating a notification to be shown to the user -- typically as a pop-up notification presented by the desktop environment shell.

The key difference between Notification and other similar APIs is that, if supported by the desktop environment, notifications sent with Notification will persist after the application has exited, and even across system reboots.

Since the user may click on a notification while the application is not running, applications using Notification should be able to be started as a D-Bus service, using Application.

User interaction with a notification (either the default action, or buttons) must be associated with actions on the application (ie: "app." actions). It is not possible to route user interaction through the notification itself, because the object will not exist if the application is autostarted as a result of a notification being clicked.

A notification can be sent with applicationSendNotification.

Since: 2.40

Exported types

newtype Notification

Memory-managed wrapper type.

Constructors

Notification (ManagedPtr Notification)

Instances

Eq Notification

Defined in GI.Gio.Objects.Notification

Methods

(==) :: Notification -> Notification -> Bool

(/=) :: Notification -> Notification -> Bool

IsGValue Notification

Convert Notification to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.Notification

Methods

toGValue :: Notification -> IO GValue

fromGValue :: GValue -> IO Notification

ManagedPtrNewtype Notification

Defined in GI.Gio.Objects.Notification

Methods

toManagedPtr :: Notification -> ManagedPtr Notification

TypedObject Notification

Defined in GI.Gio.Objects.Notification

Methods

glibType :: IO GType

GObject Notification

Defined in GI.Gio.Objects.Notification

HasParentTypes Notification

Defined in GI.Gio.Objects.Notification

type ParentTypes Notification

Defined in GI.Gio.Objects.Notification

type ParentTypes Notification = '[Object]

class (GObject o, IsDescendantOf Notification o) => IsNotification o

Type class for types which can be safely cast to Notification, for instance with toNotification.

Instances

(GObject o, IsDescendantOf Notification o) => IsNotification o

Defined in GI.Gio.Objects.Notification

toNotification :: (MonadIO m, IsNotification o) => o -> m Notification

Cast to Notification, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

addButton

notificationAddButton

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Text

label: label of the button

-> Text

detailedAction: a detailed action name

-> m ()

Adds a button to notification that activates the action in detailedAction when clicked. That action must be an application-wide action (starting with "app."). If detailedAction contains a target, the action will be activated with that target as its parameter.

See actionParseDetailedName for a description of the format for detailedAction.

Since: 2.40

addButtonWithTarget

notificationAddButtonWithTarget

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Text

label: label of the button

-> Text

action: an action name

-> Maybe GVariant

target: a GVariant to use as action's parameter, or Nothing

-> m ()

Adds a button to notification that activates action when clicked. action must be an application-wide action (it must start with "app.").

If target is non-Nothing, action will be activated with target as its parameter.

Since: 2.40

new

notificationNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

title: the title of the notification

-> m Notification

Returns: a new Notification instance

Creates a new Notification with title as its title.

After populating notification with more details, it can be sent to the desktop shell with applicationSendNotification. Changing any properties after this call will not have any effect until resending notification.

Since: 2.40

setBody

notificationSetBody

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Maybe Text

body: the new body for notification, or Nothing

-> m ()

Sets the body of notification to body.

Since: 2.40

setDefaultAction

notificationSetDefaultAction

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Text

detailedAction: a detailed action name

-> m ()

Sets the default action of notification to detailedAction. This action is activated when the notification is clicked on.

The action in detailedAction must be an application-wide action (it must start with "app."). If detailedAction contains a target, the given action will be activated with that target as its parameter. See actionParseDetailedName for a description of the format for detailedAction.

When no default action is set, the application that the notification was sent on is activated.

Since: 2.40

setDefaultActionAndTarget

notificationSetDefaultActionAndTarget

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Text

action: an action name

-> Maybe GVariant

target: a GVariant to use as action's parameter, or Nothing

-> m ()

Sets the default action of notification to action. This action is activated when the notification is clicked on. It must be an application-wide action (start with "app.").

If target is non-Nothing, action will be activated with target as its parameter.

When no default action is set, the application that the notification was sent on is activated.

Since: 2.40

setIcon

notificationSetIcon

Arguments

:: (HasCallStack, MonadIO m, IsNotification a, IsIcon b)

=> a

notification: a Notification

-> b

icon: the icon to be shown in notification, as a Icon

-> m ()

Sets the icon of notification to icon.

Since: 2.40

setPriority

notificationSetPriority

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> NotificationPriority

priority: a NotificationPriority

-> m ()

Sets the priority of notification to priority. See NotificationPriority for possible values.

setTitle

notificationSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Text

title: the new title for notification

-> m ()

Sets the title of notification to title.

Since: 2.40

setUrgent

notificationSetUrgent

Arguments

:: (HasCallStack, MonadIO m, IsNotification a)

=> a

notification: a Notification

-> Bool

urgent: True if notification is urgent

-> m ()

Deprecated: (Since version 2.42)Since 2.42, this has been deprecated in favour of notificationSetPriority.

Deprecated in favor of notificationSetPriority.

Since: 2.40