aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref/os.texi
diff options
context:
space:
mode:
authorMichael Albinus <[email protected]>2012-04-24 17:19:07 +0200
committerMichael Albinus <[email protected]>2012-04-24 17:19:07 +0200
commitb613912badfb9050e6310ee14fddc90e0fd16b2c (patch)
tree4272e3287e843d565c07b06acd7d1d53ffae8a41 /doc/lispref/os.texi
parent257440aa1c368048203a111db15f5a791a07f53f (diff)
* notifications.el (notifications-interface)
(notifications-notify-method, notifications-notify) (notifications-close-notification-method): Fix docstring. (notifications-get-capabilities-method): New defconst. (notifications-get-capabilities): New defun. * os.texi: (Notifications): Add notifications-get-capabilities.
Diffstat (limited to 'doc/lispref/os.texi')
-rw-r--r--doc/lispref/os.texi39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index aae2e4434d..424cddaff0 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -2355,6 +2355,9 @@ by the user. The function receive the notification @var{id} and the closing
@end itemize
@end table
+Which parameters are accepted by the notification server can be
+checked via @code{notifications-get-capabilities}.
+
This function returns a notification id, an integer, which can be used
to manipulate the notification item with
@code{notifications-close-notification} or the @code{:replaces-id}
@@ -2395,6 +2398,42 @@ A message window opens on the desktop. Press "I agree"
This function closes a notification with identifier @var{id}.
@end defun
+@defun notifications-get-capabilities
+Returns the capabilities of the notification server, a list of strings.
+The following capabilities can be expected:
+
+@table @asis
+@item "actions"
+The server will provide the specified actions to the user.
+
+@item "body"
+Supports body text.
+
+@item "body-hyperlinks"
+The server supports hyperlinks in the notifications.
+
+@item "body-images"
+The server supports images in the notifications.
+
+@item "body-markup"
+Supports markup in the body text.
+
+@item "icon-multi"
+The server will render an animation of all the frames in a given image
+array.
+
+@item "icon-static"
+Supports display of exactly 1 frame of any given image array. This
+value is mutually exclusive with "icon-multi".
+
+@item "sound"
+The server supports sounds on notifications.
+@end table
+
+Further vendor-specific caps start with "x-vendor", like "x-gnome-foo-cap".
+@end defun
+
+
@node Dynamic Libraries
@section Dynamically Loaded Libraries
@cindex dynamic libraries