luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-22 10:12:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

GNotification: Improve category property

Browse Source 
This adds a number of standardized categories, which should help the user
to pick the correct one. It also improves the wording of the
documentation for categories.
This commit is contained in:
Julian Sparber 2024-05-02 09:42:40 +02:00
parent b3c01aa5b1
commit 1242c28e9a
2 changed files with 118 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
gio/gnotification.c
View File

@ -506,12 +506,25 @@ g_notification_get_category (GNotification *notification)
* @notification: a #GNotification
* @category: (nullable): the category for @notification, or %NULL for no category
*
* Sets the type of @notification to @category. Categories have a main
* type like `email`, `im` or `device` and can have a detail separated
* by a `.`, e.g. `im.received` or `email.arrived`. Setting the category
* helps the notification server to select proper feedback to the user.
* The notification server may use @category to present the @notification
* specially.
*
* Standard categories are [listed in the specification](https://specifications.freedesktop.org/notification-spec/latest/ar01s06.html).
* Standardized categories are:
*
* - [const@Gio.NOTIFICATION_CATEGORY_IM_RECEIVED]
* - [const@Gio.NOTIFICATION_CATEGORY_ALARM_RINGING]
* - [const@Gio.NOTIFICATION_CATEGORY_CALL_INCOMING]
* - [const@Gio.NOTIFICATION_CATEGORY_CALL_OUTGOING]
* - [const@Gio.NOTIFICATION_CATEGORY_CALL_UNANSWERED]
* - [const@Gio.NOTIFICATION_CATEGORY_WEATHER_WARNING_EXTREME]
* - [const@Gio.NOTIFICATION_CATEGORY_CELLBROADCAST_DANGER_SEVERE]
* - [const@Gio.NOTIFICATION_CATEGORY_CELLBROADCAST_AMBER_ALERT]
* - [const@Gio.NOTIFICATION_CATEGORY_CELLBROADCAST_TEST]
* - [const@Gio.NOTIFICATION_CATEGORY_OS_BATTERY_LOW]
* - [const@Gio.NOTIFICATION_CATEGORY_BROWSER_WEB_NOTIFICATION]
*
* It's possible to specify custom categories but they should use `x-vendor.`
* as prefix, where vendor is the platform implementing the category.
*
* Since: 2.70
*/

100
gio/gnotification.h
View File

@ -110,6 +110,106 @@ void g_notification_set_default_action_and_target_value (GNotifi
const gchar *action,
GVariant *target);
/**
* G_NOTIFICATION_CATEGORY_IM_RECEIVED:
*
* Intended for instant messaging apps displaying notifications for received messages.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_IM_RECEIVED "im.received"
/**
* G_NOTIFICATION_CATEGORY_ALARM_RINGING:
*
* Intended for alarm clock apps when an alarm is ringing.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_ALARM_RINGING "alarm.ringing"
/**
* G_NOTIFICATION_CATEGORY_CALL_INCOMING:
*
* Intended for call apps to notify the user about an incoming call.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_CALL_INCOMING "call.incoming"
/**
* G_NOTIFICATION_CATEGORY_CALL_OUTGOING:
*
* Intended for call apps to notify the user about an ongoing call.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_CALL_OUTGOING "call.ongoing"
/**
* G_NOTIFICATION_CATEGORY_CALL_MISSED:
*
* Intended for call apps to notify the user about a missed call.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_CALL_UNANSWERED "call.unanswered"
/**
* G_NOTIFICATION_CATEGORY_WEATHER_WARNING_EXTREME:
*
* Intended to be used to notify the user about extreme weather conditions.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_WEATHER_WARNING_EXTREME "weather.warning.extreme"
/**
* G_NOTIFICATION_CATEGORY_CELLBROADCAST_DANGER_SEVERE:
*
* Intended to be used to notify users about severe danger warnings broadcasted by the cell network.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_CELLBROADCAST_DANGER_SEVERE "cellbroadcast.danger.extreme"
/**
* G_NOTIFICATION_CATEGORY_CELLBROADCAST_AMBER_ALERT:
*
* Intended to be used to notify users about amber alerts broadcasted by the cell network.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_CELLBROADCAST_AMBER_ALERT "cellbroadcast.amber-alert"
/**
* G_NOTIFICATION_CATEGORY_CELLBROADCAST_TEST:
*
* Intended to be used to notify users about tests broadcasted by the cell network.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_CELLBROADCAST_TEST "cellbroadcast.test"
/**
* G_NOTIFICATION_CATEGORY_OS_BATTERY_LOW:
*
* Intended to be used to indicate that the system is low on battery.
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_OS_BATTERY_LOW "os.battery.low"
/**
* G_NOTIFICATION_CATEGORY_BROWSER_WEB_NOTIFICATION:
*
* Intended to be used by browsers to mark notifications sent by websites via
* the [Notifications API](https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API).
*
* Since: 2.84
*/
#define G_NOTIFICATION_CATEGORY_BROWSER_WEB_NOTIFICATION "browser.web-notification"
G_END_DECLS
#endif