From b9dd64dce425e3f12ba957cc72a13f64fe4a6bf4 Mon Sep 17 00:00:00 2001 From: Christian Hammond Date: Wed, 1 Sep 2004 07:51:10 +0000 Subject: [PATCH] Moved the notification components into a table. --- docs/ChangeLog | 5 + docs/notification-spec.xml | 265 +++++++++++++++++-------------------- 2 files changed, 129 insertions(+), 141 deletions(-) diff --git a/docs/ChangeLog b/docs/ChangeLog index 5bbd673..3629269 100644 --- a/docs/ChangeLog +++ b/docs/ChangeLog @@ -1,3 +1,8 @@ +Wed Sep 01 00:50:51 PDT 2004 Christian Hammond + + * notification-spec.xml: + - Moved the notification components into a table. + Wed Sep 01 00:38:46 PDT 2004 Christian Hammond * notification-spec.xml: diff --git a/docs/notification-spec.xml b/docs/notification-spec.xml index 417d7fc..6535558 100644 --- a/docs/notification-spec.xml +++ b/docs/notification-spec.xml @@ -105,147 +105,130 @@ A notification has the following components: - - - 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. - - - - - Application Icon - - - An optional byte array containing the application's icon. - 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 - - - An optional ID of an existing notification that this - notification is intended to replace. - - - - - Notification Type ID - - - An optional ID representing the notification type. See - . - - - - - Urgency Level - - - The urgency of the notification. See . - - - - - Summary - - - This is a single line overview of the notification. For instance, - "You have mail" or "A friend has come online". It should generally - not be longer than 40 characters, though this is not a requirement, - and server implementations should word wrap if necessary. The summary - must be encoded using UTF-8. - - - - - Body - - - This is a multi-line body of text. Each line is a paragraph, server - implementations are free to word wrap them as they see fit. - - - The text may contain simple markup as specified in - . It must be encoded using UTF-8. - - - If the body is omitted just the summary is displayed. - - - - - Images - - - See . - - - - - Sounds - - - See . - - - - - Actions - - - The actions send a request message back to the notification client - when invoked. This functionality may not be implemented by the - notification server, conforming clients should check if it is available - before using it (see the GetCapabilities message in - . An implementation is free to ignore any - requested by the client. As an example one possible rendering of - actions would be as buttons in the notification popup. - - - - - Hints - - - See . - - - - - Expiration Time - - - The timestamp in seconds since the epoch that the notification should - close. For example, if one wishes to have an expiration of 5 seconds - from now, they must grab the current timestamp and add 5 seconds to it. - - - If zero, the notification's expiration time is dependent on the - 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). - - - - + + Notification Components + + + + Component + Description + + + + + 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. + + + + Application Icon + + An optional byte array containing the application's icon. + 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 + + An optional ID of an existing notification that this + notification is intended to replace. + + + + Notification Type ID + + An optional ID representing the notification type. See + . + + + + Urgency Level + + The urgency of the notification. See . + + + + Summary + + This is a single line overview of the notification. For instance, + "You have mail" or "A friend has come online". It should generally + not be longer than 40 characters, though this is not a requirement, + and server implementations should word wrap if necessary. The summary + must be encoded using UTF-8. + + + + Body + + + This is a multi-line body of text. Each line is a paragraph, server + implementations are free to word wrap them as they see fit. + + + The text may contain simple markup as specified in + . It must be encoded using UTF-8. + + + If the body is omitted just the summary is displayed. + + + + + Images + See . + + + Sounds + See . + + + Actions + + The actions send a request message back to the notification client + when invoked. This functionality may not be implemented by the + notification server, conforming clients should check if it is available + before using it (see the GetCapabilities message in + . An implementation is free to ignore any + requested by the client. As an example one possible rendering of + actions would be as buttons in the notification popup. + + + + Hints + See . + + + Expiration Time + + + The timestamp in seconds since the epoch that the notification should + close. For example, if one wishes to have an expiration of 5 seconds + from now, they must grab the current timestamp and add 5 seconds to it. + + + If zero, the notification's expiration time is dependent on the + 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). + + + + + +
Each notification displayed is allocated a unique ID by the server.