jcarr
/
libnotify
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a "replaces" field to the Notify request, add fallback to urgency field

This commit is contained in:
Mike Hearn 2004-07-06 21:18:00 +00:00
parent 0ab190f75e
commit bd9b91a53d
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
SPECIFICATION
View File

@ -8,7 +8,9 @@ ChangeLog:
v0.1: v0.1:
* Initial version * Initial version
v0.2:
* Add replaces field to protocol
--------------------------------------------------------------------- ---------------------------------------------------------------------
OVERVIEW OVERVIEW
@ -54,9 +56,10 @@ only interface required by this version of the specification.
A notification has the following components: A notification has the following components:
- A summary: This is a single line overview of the notification. For - A summary: This is a single line overview of the notification. For
instance "You have mail" or "A friend has come online". It should instance "You have mail" or "A friend has come online". Tip: It
generally not be longer than 40 characters (FIXME: is 40 should generally not be longer than 40 characters though this is not
sane?). The summary must be encoded using UTF-8. a requirement and server implementations should word wrap if
necessary. The summary must be encoded using UTF-8.
- An optional body: This is a multi-line body of text. Each line is a - An optional body: This is a multi-line body of text. Each line is a
paragraph, server implementations are free to word wrap them as they paragraph, server implementations are free to word wrap them as they
@ -83,13 +86,13 @@ A notification has the following components:
notification should close. If one wishes to have an expiration of 5 seconds notification should close. If one wishes to have an expiration of 5 seconds
from now, they must grab the current timestamp and add 5 seconds to it. 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 If zero, the notification's expiration time is dependent on the
server's settings, and may vary for the type of notification. notification server's settings, and may vary for the type of
notification.
The expiration time should be respected by implementations, but this is The expiration time should be respected by implementations, but this is
not required (this is for compatibility with KNotify). not required (this is for compatibility with KNotify).
Each notification displayed is allocated a unique ID by the server. Each notification displayed is allocated a unique ID by the server.
This is unique within the session - while the notification server is This is unique within the session - while the notification server is
running the ID will not be recycled unless the capacity of a uint32 is running the ID will not be recycled unless the capacity of a uint32 is
@ -212,11 +215,13 @@ The following messages must be supported by all implementations.
shown. For some parameters multiple types may be acceptable shown. For some parameters multiple types may be acceptable
BYTE urgency: The urgency level: BYTE urgency: The urgency level:
0 - low urgency 0 - low urgency
1 - medium (default) 1 - medium (default)
2 - high 2 - high
3 - critical 3 - critical
Other values should be treated as "medium" in this version of the spec.
STRING summary STRING summary
STRING/NIL body: if nil the body is considered omitted. STRING/NIL body: if nil the body is considered omitted.
@ -232,6 +237,13 @@ The following messages must be supported by all implementations.
UINT32/NIL expire time: if nil the notification never times out UINT32/NIL expire time: if nil the notification never times out
UINT32/NIL replaces: if non-nil this is the 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.
It returns a UINT32 that will never be reused within a It returns a UINT32 that will never be reused within a
session unless more than MAXINT notifications have been generated session unless more than MAXINT notifications have been generated
(ie an acceptable implementation for this is just an incrementing (ie an acceptable implementation for this is just an incrementing
@ -288,4 +300,4 @@ The following signals MAY be emitted by the server.
specified in the original dictionary. specified in the original dictionary.
REFERENCE