Class

PurpleNotification

Description [src]

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

An object that represents a notification.

Available since:3.0.0

Ancestors

Constructors

purple_notification_new

Creates a new notification with the given properties. account is optional.

Available since: 3.0.0

purple_notification_new_from_add_contact_request

Creates a new PurpleNotification for request. This helper will automatically fill out the notification according to the information in request.

Available since: 3.0.0.

purple_notification_new_from_authorization_request

Creates a new PurpleNotification for the authorization_request. This helper will automatically fill out the notification according to the information in authorization_request.

Available since: 3.0.0

purple_notification_new_from_connection_error

Creates a new PurpleNotification for account with the info for the connection. This helper will automatically fill out the notification according to the given parameters.

Available since: 3.0.0

Functions

purple_notification_compare

A comparison function for PurpleNotification that is suitable as a GCompareFunc.

Available since: 3.0.0

Instance methods

purple_notification_delete

Emits the PurpleNotification::deleted signal. This is typically called by a user interface when the user has deleted a notification.

Available since: 3.0.0

purple_notification_get_account

Gets the PurpleAccount of notification.

Available since: 3.0.0

purple_notification_get_created_timestamp

Gets the created time of notification.

Available since: 3.0.0

purple_notification_get_data

Gets the data that notification was created with.

Available since: 3.0.0

purple_notification_get_icon_name

Gets the named icon for notification.

Available since: 3.0.0

purple_notification_get_id

Gets the identifier of notification.

Available since: 3.0.0

purple_notification_get_interactive

Gets whether or not notification can be interacted with.

Available since: 3.0.0

purple_notification_get_notification_type

Gets the PurpleNotificationType of notification.

Available since: 3.0.0

purple_notification_get_read

Gets whether or not notification has been read.

Available since: 3.0.0

purple_notification_get_title

Gets the title of notification.

Available since: 3.0.0

purple_notification_set_created_timestamp

Sets the created timestamp of notification to timestamp.

Available since: 3.0.0

purple_notification_set_icon_name

Sets the named icon for notification to icon_name.

Available since: 3.0.0

purple_notification_set_interactive

Sets notifications interactive state to interactive.

Available since: 3.0.0

purple_notification_set_read

Sets notifications read state to read.

Available since: 3.0.0

purple_notification_set_title

Sets the title of notification to title.

Available since: 3.0.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Notification:account

An optional PurpleAccount that this notification is for.

Available since: 3.0.0

Purple.Notification:created-timestamp

The creation time of this notification. This always represented as UTC internally, and will be set to UTC now by default.

Available since: 3.0.0

Purple.Notification:data

Data specific to the PurpleNotificationType for the notification.

Available since: 3.0.0

Purple.Notification:data-destroy-func

A function to call to free PurpleNotification:data.

Available since: 3.0.0

Purple.Notification:icon-name

The icon-name in the icon theme to use for the notification. A user interface may or may not choose to use this when display the notification.

Available since: 3.0.0

Purple.Notification:id

The ID of the notification. Used for things that need to address it. This is auto populated at creation time.

Available since: 3.0.0

Purple.Notification:interactive

Whether or not the notification can be interacted with.

Available since: 3.0.0

Purple.Notification:read

Whether or not the notification has been read.

Available since: 3.0.0

Purple.Notification:title

An optional title for this notification. A user interface may or may not choose to use this when displaying the notification. Regardless, this should be a translated string.

Available since: 3.0.0

Purple.Notification:type

The PurpleNotificationType of this notification.

Available since: 3.0.0

Signals

Purple.Notification::deleted

Emitted when the notification is deleted. This is typically done by a user interface calling purple_notification_delete().

Available since: 3.0.0

Signals inherited from GObject (1)
GObject.Object::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 PurpleNotificationClass {
  GObjectClass parent_class;
  
}
Class members
parent_class
GObjectClass
  No description available.