/usr/lib/ocaml/obus/notification.mli is in libobus-ocaml-dev 1.1.5-5build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | (*
* notification.mli
* ----------------
* Copyright : (c) 2008, Jeremie Dimino <jeremie@dimino.org>
* Licence : BSD3
*
* This file is a part of obus, an ocaml implementation of D-Bus.
*)
(** Popup notifications *)
(** For complete details about notifications, look at the
{{:http://www.galago-project.org/specs/notification/} the official
specifications} *)
val app_name : string ref
(** Application name used for notification. The default value is
taken from [Sys.argv.(0)] *)
val desktop_entry : string option ref
(** If the application has a desktop entry, it can be specified
here *)
(** {6 Operations on notifications} *)
(** Type of an opened notifications *)
type 'a t
val result : 'a t -> 'a Lwt.t
(** Waits for a notification to be closed then returns:
- [`Closed] if the user clicked on the cross, timeout was
reached or the notification daemon exited
- [`Default] if the default action was invoked, i.e. the user
clicked on the notification, but not on a buttons
- the corresponding action if the user clicked on a button other
than the cross *)
val close : 'a t -> unit Lwt.t
(** Close the notification now *)
(** {6 Opening notifications} *)
type urgency = [ `Low | `Normal | `Critical ]
(** Urgency level of popups *)
(** An image description *)
type image = {
img_width : int;
img_height : int;
img_rowstride : int;
img_has_alpha: bool;
img_bits_per_sample : int;
img_channels : int;
img_data : string;
}
val notify :
?app_name : string ->
?desktop_entry : string ->
?replace : _ t ->
?icon : string ->
?image : image ->
summary : string ->
?body : string ->
?actions : (string * ([> `Default | `Closed ] as 'a)) list ->
?urgency : urgency ->
?category : string ->
?sound_file : string ->
?suppress_sound : bool ->
?pos : int * int ->
?hints : (string * OBus_value.V.single) list ->
?timeout : int ->
unit -> 'a t Lwt.t
(** Open a notification.
- [app_name] and [desktop_entry] can override default values
taken from references
- [replace] is a popup id this notification replace
- [icon] is the notification icon. It is either as a URI (file://...) or a
name in a freedesktop.org-compliant icon theme (not a GTK+ stock ID)
- [image] is an image, it is used if [icon] is not present
- [summary] is a single line overview of the notification
- [body] 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 body may contain simple markup as specified in Markup. It must be
encoded using UTF-8. If the body is omitted, just the summary is
displayed.
- [action] is a list of (text, key) pair, [text] is the text displayed to the user
and [key] is the value which will be returned when the action is invoked
- [category] is a string representing the category of the
notification, for example: "device.added", "email.arrived"
(more category can be found in the specifications)
- [sound_file] is a sound file to play while displaying the notification
- [suppress_sound] tell the daemon to suppress sounds
- [pos] is a screen position
- [hints] is a list of additionnal hints
- [timeout] is a timeout in millisecond
*)
(** {6 Informations} *)
(** Server informations *)
type server_info = {
server_name : string;
server_vendor : string;
server_version : string;
server_spec_version : string;
}
val get_server_information : unit -> server_info Lwt.t
(** Retreive server informations *)
val get_capabilities : unit -> string list Lwt.t
(** Retreive server capabilities, see specification for details *)
|