summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_sys_notify_interface.eo
blob: eddf3304969998bf9242a13f10fe567f23eb87c9 (plain)
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
type Elm_Sys_Notify_Send_Cb: __undefined_type; [[elementary system notify send callback type]] 

enum Elm.Sys_Notify.Urgency
{
   [[Urgency levels of a notification

     @since 1.8
   ]]
   low, [[Low urgency]]
   normal, [[Normal urgency]]
   critical [[Critical urgency]]
}

interface Elm.Sys_Notify_Interface
{
   [[Elementary system notify interface]]
   eo_prefix: elm_obj_sys_notify_interface;
   legacy_prefix: elm_sys_notify_interface;

   methods {
      send @const {
         [[Causes a notification to be forcefully closed and removed from the
           user's view. It can be used, for example, in the event that what the
           notification pertains to is no longer relevant, or to cancel a
           notification with no expiration time.

           @since 1.8
         ]]
         params {
            @in replaces_id: uint; [[Notification ID that this notification replaces.
                                     The value 0 means a new notification.]]
            @in icon: string; [[The optional program icon of the calling application]]
            @in summary: string; [[The summary text briefly describing the notification]]
            @in body: string @optional; [[The optional detailed body text. Can be empty]]
            @in urgency: Elm.Sys_Notify.Urgency; [[The urgency level]]
            @in timeout: int; [[Timeout display in milliseconds]]
            @in cb: Elm_Sys_Notify_Send_Cb; [[Callback used to retrieve the notification id
                                              returned by the Notification Server]]
            @in cb_data: const(void_ptr) @optional; [[Optional context data]]
         }
      }
      simple_send @const {
         [[Create a new notification just with Icon, Body and Summary.
           It is a helper that wraps the send method

           @since 1.16
         ]]

         params {
            @in icon: string; [[The optional program icon of the calling application]]
            @in summary: string; [[The summary text briefly describing the notification]]
            @in body: string; [[The optional detailed body text. Can be empty]]
         }
      }
      close @const {
         [[Causes a notification to be forcefully closed and removed from the
           user's view. It can be used, for example, in the event that what the
           notification  pertains to is no longer relevant, or to cancel a
           notification with no expiration time.

           @since 1.8
         ]]
         params {
            @in id: uint; [[Notification ID]]
         }
      }
   }
}