aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Albinus2012-04-24 19:56:30 +0200
committerMichael Albinus2012-04-24 19:56:30 +0200
commite43042fe33b3cf184e31219d4aef08a5a59815f9 (patch)
tree6d28bd2d15a95cd9f023e57346b23928574aa115 /doc
parent1ec00a232a98f971c7b4c46f74636d14e48990a2 (diff)
downloademacs-e43042fe33b3cf184e31219d4aef08a5a59815f9.tar.gz
emacs-e43042fe33b3cf184e31219d4aef08a5a59815f9.zip
* notifications.el (notifications-specification-version): Change to "1.2".
(notifications-notify): Add :action-items, :resident and :transient hints. Change "image_data" to "image-data" and "image_path" to "image-path". (notifications-get-capabilities): Return a list of keywords. * os.texi (Notifications): Extend possible notification hints.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog3
-rw-r--r--doc/lispref/os.texi43
2 files changed, 33 insertions, 13 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 3bb2abd7cfe..1c37e1600f4 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,6 +1,7 @@
12012-04-24 Michael Albinus <michael.albinus@gmx.de> 12012-04-24 Michael Albinus <michael.albinus@gmx.de>
2 2
3 * os.texi: (Notifications): Add notifications-get-capabilities. 3 * os.texi (Notifications): Extend possible notification hints.
4 Add notifications-get-capabilities.
4 5
52012-04-20 Chong Yidong <cyd@gnu.org> 62012-04-20 Chong Yidong <cyd@gnu.org>
6 7
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index 424cddaff0a..d825a3f18c4 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -2271,7 +2271,7 @@ The notification title.
2271@item :body @var{text} 2271@item :body @var{text}
2272The notification body text. Depending on the implementation of the 2272The notification body text. Depending on the implementation of the
2273notification server, the text could contain HTML markups, like 2273notification server, the text could contain HTML markups, like
2274@samp{"<b>bold text</b>"}, or hyperlinks. 2274@samp{"<b>bold text</b>"}, hyperlinks, or images.
2275 2275
2276@item :app-name @var{name} 2276@item :app-name @var{name}
2277The name of the application sending the notification. The default is 2277The name of the application sending the notification. The default is
@@ -2301,6 +2301,10 @@ the notification never expires. Default value is -1.
2301@item :urgency @var{urgency} 2301@item :urgency @var{urgency}
2302The urgency level. It can be @code{low}, @code{normal}, or @code{critical}. 2302The urgency level. It can be @code{low}, @code{normal}, or @code{critical}.
2303 2303
2304@item :action-items
2305When this keyword is given, the @var{title} string of the actions is
2306interpreted as icon name.
2307
2304@item :category @var{category} 2308@item :category @var{category}
2305The type of notification this is, a string. 2309The type of notification this is, a string.
2306 2310
@@ -2331,6 +2335,17 @@ example would be @samp{"message-new-instant"}.
2331Causes the server to suppress playing any sounds, if it has that 2335Causes the server to suppress playing any sounds, if it has that
2332ability. 2336ability.
2333 2337
2338@item :resident
2339When set the server will not automatically remove the notification
2340when an action has been invoked. The notification will remain resident
2341in the server until it is explicitly removed by the user or by the
2342sender. This hint is likely only useful when the server has the
2343@code{:persistence} capability.
2344
2345@item :transient
2346When set the server will treat the notification as transient and
2347by-pass the server's persistence capability, if it should exist.
2348
2334@item :x @var{position} 2349@item :x @var{position}
2335@itemx :y @var{position} 2350@itemx :y @var{position}
2336Specifies the X, Y location on the screen that the 2351Specifies the X, Y location on the screen that the
@@ -2402,35 +2417,39 @@ This function closes a notification with identifier @var{id}.
2402Returns the capabilities of the notification server, a list of strings. 2417Returns the capabilities of the notification server, a list of strings.
2403The following capabilities can be expected: 2418The following capabilities can be expected:
2404 2419
2405@table @asis 2420@table @code
2406@item "actions" 2421@item :actions
2407The server will provide the specified actions to the user. 2422The server will provide the specified actions to the user.
2408 2423
2409@item "body" 2424@item :body
2410Supports body text. 2425Supports body text.
2411 2426
2412@item "body-hyperlinks" 2427@item :body-hyperlinks
2413The server supports hyperlinks in the notifications. 2428The server supports hyperlinks in the notifications.
2414 2429
2415@item "body-images" 2430@item :body-images
2416The server supports images in the notifications. 2431The server supports images in the notifications.
2417 2432
2418@item "body-markup" 2433@item :body-markup
2419Supports markup in the body text. 2434Supports markup in the body text.
2420 2435
2421@item "icon-multi" 2436@item :icon-multi
2422The server will render an animation of all the frames in a given image 2437The server will render an animation of all the frames in a given image
2423array. 2438array.
2424 2439
2425@item "icon-static" 2440@item :icon-static
2426Supports display of exactly 1 frame of any given image array. This 2441Supports display of exactly 1 frame of any given image array. This
2427value is mutually exclusive with "icon-multi". 2442value is mutually exclusive with @code{:icon-multi}.
2443
2444@item :persistence
2445The server supports persistence of notifications.
2428 2446
2429@item "sound" 2447@item :sound
2430The server supports sounds on notifications. 2448The server supports sounds on notifications.
2431@end table 2449@end table
2432 2450
2433Further vendor-specific caps start with "x-vendor", like "x-gnome-foo-cap". 2451Further vendor-specific caps start with @code{:x-vendor}, like
2452@code{:x-gnome-foo-cap}.
2434@end defun 2453@end defun
2435 2454
2436 2455