Class

PhoshNotification

Description [src]

class Phosh.Notification : GObject.Object
{
  /* No available fields */
}

A notification displayed to the user

A notification usually consists of a summary, a body (the content) and an icon.

Ancestors

Constructors

phosh_notification_new
No description available.

Instance methods

phosh_notification_activate
No description available.

phosh_notification_close
No description available.

phosh_notification_do_action
No description available.

phosh_notification_expires

Set self to expire after timeout (from this call).

phosh_notification_get_actions
No description available.

phosh_notification_get_app_icon
No description available.

phosh_notification_get_app_info
No description available.

phosh_notification_get_app_name
No description available.

phosh_notification_get_body
No description available.

phosh_notification_get_category

Get the category hint the notification was sent with.

phosh_notification_get_id
No description available.

phosh_notification_get_image
No description available.

phosh_notification_get_profile

Get the intended feedback profile for the event related to this notification.

phosh_notification_get_resident

When TRUE invoking an action doesn’t dismiss the notification.

phosh_notification_get_summary
No description available.

phosh_notification_get_timestamp
No description available.

phosh_notification_get_transient

Transient notifications don’t go to the message tray.

phosh_notification_get_urgency
No description available.

phosh_notification_set_actions
No description available.

phosh_notification_set_app_icon
No description available.

phosh_notification_set_app_info
No description available.

phosh_notification_set_app_name
No description available.

phosh_notification_set_body
No description available.

phosh_notification_set_category

Set the category of the notification, such as email.arrived.

phosh_notification_set_id
No description available.

phosh_notification_set_image
No description available.

phosh_notification_set_profile

Set the feedback profile (constrained by feedbackd’s global policy) for the event related to this notification.

phosh_notification_set_resident

Set whether or not invoking actions dismiss self.

phosh_notification_set_summary
No description available.

phosh_notification_set_timestamp

Sets the timestamp of a notification. If NULL is passed it’s set to the current date and time.

phosh_notification_set_transient

Set if self should go to the message tray.

phosh_notification_set_urgency
No description available.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Phosh.Notification:actions
No description available.

Phosh.Notification:app-icon
No description available.

Phosh.Notification:app-info

When non-NULL this overrides the values of PhoshNotification:app-name and PhoshNotification:app-icon with those from the GAppInfo.

Phosh.Notification:app-name
No description available.

Phosh.Notification:body
No description available.

Phosh.Notification:category
No description available.

Phosh.Notification:id
No description available.

Phosh.Notification:image
No description available.

Phosh.Notification:profile

The feedback profile to use for the event triggered by this notification. Valid values from Feedbackd’s Feedback Theme Specification as well as the value none meaning: don’t trigger any feedback for this event. If NULL (the default) the decision is left to feedbackd.

Phosh.Notification:resident
No description available.

Phosh.Notification:summary
No description available.

Phosh.Notification:timestamp
No description available.

Phosh.Notification:transient
No description available.

Phosh.Notification:urgency
No description available.

Signals

Phosh.Notification::actioned

Emitted when the user activates one of the provided actions.

Phosh.Notification::closed

Emitted when the notification has been closed.

Phosh.Notification::expired

Emitted when the timeout set by phosh_notification_expires() has expired.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct PhoshNotificationClass {
  GObjectClass parent_class;
  void (* do_action) (
    PhoshNotification* self,
    guint id,
    const char* action
  );
  
}

No description available.

Class members
parent_class: GObjectClass

The object class structure needs to be the first element in the widget class structure in order for the class mechanism to work correctly. This allows a PhoshNotificationClass pointer to be cast to a GObjectClass pointer.

do_action: void (* do_action) ( PhoshNotification* self, guint id, const char* action )

This function allows the notification to implement their own action behaviour instead of the default DBus interface.

Virtual methods

Phosh.NotificationClass.do_action

This function allows the notification to implement their own action behaviour instead of the default DBus interface.