diff --git a/docs/ChangeLog b/docs/ChangeLog index 9d68f90..275d40f 100644 --- a/docs/ChangeLog +++ b/docs/ChangeLog @@ -1,3 +1,11 @@ +Thu Sep 02 09:18:38 PDT 2004 Christian Hammond + + * notification-spec.xml: + - Removed the sound information. + - Fixed several typos and references to KNotify. + - Removed the PID hint. + - Added some D-BUS Error stuff. + Thu Sep 02 01:19:07 PDT 2004 Christian Hammond * notification-spec.xml: diff --git a/docs/notification-spec.xml b/docs/notification-spec.xml index 6debff4..9d4d303 100644 --- a/docs/notification-spec.xml +++ b/docs/notification-spec.xml @@ -118,9 +118,10 @@ Application Name - Application name: This is the optional name of the application sending - the notification. This should be the application's formal name, rather - than some sort of ID. + This is the optional name of the application sending the notification. + This should be the application's formal name, rather than some sort + of ID. An example would be "FredApp E-Mail Client," rather than + "fredapp-email-client." @@ -130,13 +131,6 @@ This should be in PNG or GIF formats. - - Application ID - - An optional byte array containing the application's icon. - This should be in PNG or GIF formats. - - Replaces ID @@ -185,11 +179,7 @@ Images - See . - - - Sounds - See . + See . Actions @@ -220,10 +210,6 @@ notification server's settings, and may vary for the type of notification. - - The expiration time should be respected by implementations, but this is - not required (this is for compatibility with KNotify). - @@ -315,25 +301,23 @@ - + Icons and Sounds - A notification can optionally include an array of images and/or a - single sound. The array of images specifies frames in an animation, - animations always loop. Implementations are free to ignore the - images and sound data, and implementations that support images need not - support animation. + A notification can optionally include an array of images. The array of + images specifies frames in an animation, which always loop. + Implementations are free to ignore the images data, and implementations + that support images need not support animation. If the image array has more than one element, a "primary frame" can - be specified - if not specified it defaults to the first frame. For - implementations that support images but not animation (for instance a - KNotify bridge), only the primary frame will - be used. + be specified. If not specified, it defaults to the first frame. For + implementations that support images but not animation, only the primary + frame will be used. Each element of the array must have the same type as the first - element, mixtures of strings and blobs are not allowed. The element + element. Mixtures of strings and blobs are not allowed. The element types can be one of the following: @@ -377,11 +361,6 @@ - - A sound can be specified, this will be played by the notification - server when the notification is displayed. - Elaborate here! - @@ -434,10 +413,10 @@ them. - Server implementations may use urgency information how they see fit. - Possible implementations may keep critical notifications on the screen - until the user manually closes them, which is our recommendation. However, - there are no user interface guidelines in this area. + For the most part, server implementations may use urgency information + how they see fit. The one exception is the Critical notification. + As Critical notifications are things that the user will most likely want + to know about, they should not be closed until the user dismisses them. @@ -445,8 +424,8 @@ Hints Hints are a way to provide extra data to a notification server that - the server may be able to make use of. Such examples may be the - application's PID or the window ID. + the server may be able to make use of. One such example would be the + window ID. Neither clients nor notification servers are required to support any @@ -469,13 +448,6 @@ - - "pid" - UINT32 - - The Process ID of the application that sent the notification. - - "winid" UINT32 @@ -489,7 +461,7 @@ Third parties, when defining their own hints, should discuss the - possibilty of standardizing on the hint with other parties, preferably + possibility of standardizing on the hint with other parties, preferably in a place such as the xdg mailing list at @@ -565,14 +537,6 @@ free to ignore them and use only the primary frame. - - "sound" - - The server will play the specified sound. Even if this cap is - missing, a sound may still be specified however the server is free - to ignore it. - - "actions" @@ -608,7 +572,6 @@ STRING summary STRING_OR_NIL body ARRAY images - STRING_OR_NIL sound DICT_OR_NIL actions DICT_OR_NIL hints UINT32_OR_NIL expire_time @@ -678,14 +641,9 @@ images ARRAY or NIL - The optional array of images. See . + The optional array of images. See . - - sound - STRING - The optional sound file to play. - actions DICT or NIL @@ -740,7 +698,7 @@ <literal>org.freedesktop.Notifications.CloseNotification</literal> - BOOLEAN + void org.freedesktop.Notifications.CloseNotification UINT32 id @@ -749,7 +707,7 @@ Causes a notification to be forcefully closed and removed from the user's view. It can be used, for example, in the event that what the - notification pertains to is no onger relevant, or to cancel a + notification pertains to is no longer relevant, or to cancel a notification with no expiration time. @@ -757,10 +715,8 @@ method. - This returns TRUE if the notification was closed. - If the notification didn't exist, this will return - FALSE. This can happen if the notification already - expired or was closed, or if the ID was simply invalid. + If the notification no longer exists, an empty D-BUS Error message is + sent back.