From d8c0864049501507bc76d830beb278dc9f7b43b7 Mon Sep 17 00:00:00 2001 From: Christian Hammond Date: Fri, 1 Apr 2005 17:12:51 +0000 Subject: [PATCH] - Removed all references to NIL, and explained briefly how each parameter can be made empty. - Bumped to version 0.6. --- docs/ChangeLog | 7 +++++ docs/notification-spec.xml | 61 ++++++++++++++++++++++++-------------- 2 files changed, 45 insertions(+), 23 deletions(-) diff --git a/docs/ChangeLog b/docs/ChangeLog index e00b761..3027087 100644 --- a/docs/ChangeLog +++ b/docs/ChangeLog @@ -1,3 +1,10 @@ +Fri Apr 01 09:11:38 PST 2005 Christian Hammond + + * notification-spec.xml: + - Removed all references to NIL, and explained briefly how each + parameter can be made empty. + - Bumped to version 0.6. + Fri Oct 01 23:44:40 PDT 2004 Christian Hammond * notification-spec.xml: diff --git a/docs/notification-spec.xml b/docs/notification-spec.xml index e52661d..484a212 100644 --- a/docs/notification-spec.xml +++ b/docs/notification-spec.xml @@ -29,6 +29,14 @@ + + 0.6 + 1 April 2005 + cdh + + Updated to work with D-BUS 0.31+. + + 0.5 2 October 2004 @@ -835,16 +843,16 @@ UINT32 org.freedesktop.Notifications.Notify - STRING_OR_NIL app_name - BYTE_ARRAY_OR_STRING_OR_NIL app_icon - UINT32_OR_NIL replaces_id - STRING_OR_NIL notification_type + STRING app_name + BYTE_ARRAY_OR_STRING app_icon + UINT32 replaces_id + STRING notification_type BYTE urgency_level STRING summary - STRING_OR_NIL body + STRING body ARRAY images - DICT_OR_NIL actions - DICT_OR_NIL hints + DICT actions + DICT hints BOOL expires UINT32 expire_timeout @@ -865,36 +873,40 @@ app_name - STRING or NIL + STRING The optional name of the application sending the notification. + Can be blank. app_icon - BYTE_ARRAY or STRING or NIL + BYTE_ARRAY or STRING The optional program icon of the calling application. This is in the same format as an image frame. See . + Can be an empty string, indicating no icon. replaces_id - UINT32 or NIL + UINT32 The optional notification ID that this notification replaces. The server must atomically (ie with no flicker or other visual cues) replace the given notification with this one. This allows clients to - effectively modify the notification while it's active. + effectively modify the notification while it's active. A value of + value of 0 means that this notification won't replace any + existing notifications. notification_type - STRING or NIL + STRING The optional notification type ID, for potential server categorization and logging purposes. See - . + . Can be empty. @@ -909,35 +921,38 @@ body - STRING or NIL - The optional detailed body text. + STRING + The optional detailed body text. Can be empty. images - ARRAY or NIL + ARRAY - The optional array of images. See . + The optional array of images. See . Can + be empty. actions - DICT or NIL + DICT A dictionary key of actions. Each key is the localized name of the action, as it should appear to the user, and maps to a UINT32 value containing a program-specific action code. This code will be reported - back to the program if the action is invoked by the user. + back to the program if the action is invoked by the user. Can be + empty. hints - DICT or NIL + DICT Optional hints that can be passed to the server from the client program. Although clients and servers should never assume each other supports any specific hints, they can be used to pass along information, such as the process PID or window ID, that the server - may be able to make use of. See . + may be able to make use of. See . Can be + empty. @@ -968,7 +983,7 @@ - If replaces_id is NIL, the return value is a + If replaces_id is 0, the return value is a UINT32 that represent the notification. It is unique, and will not be reused unless a MAXINT number of notifications have been generated. An acceptable implementation may just use an @@ -976,7 +991,7 @@ zero. Servers must make sure not to return zero as an ID. - If replaces_id is not NIL, the returned value + If replaces_id is not 0, the returned value is the same value as replaces_id.