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
|
notify2 API documentation
=========================
notify2 is a replacement for pynotify which can be used from different GUI toolkits
and from programs without a GUI. The API is largely the same as that of pynotify,
but some less important parts are left out.
You can alternatively use the GObject Introspection bindings to libnotify
(``from gi.repository import Notify``). I'd recommend that for GTK applications,
while notify2 has fewer dependencies for non-GTK applications. It should be easy
to switch between the two.
Notifications are sent to a notification daemon over `D-Bus <http://www.freedesktop.org/wiki/Software/dbus/>`_,
according to the `Desktop notifications spec <http://people.gnome.org/~mccann/docs/notification-spec/notification-spec-latest.html>`_,
and the server is responsible for displaying them to the user. So your application
has limited control over when and how a notification appears. For example,
Ubuntu uses the `NotifyOSD daemon <https://wiki.ubuntu.com/NotifyOSD>`_.
.. toctree::
:maxdepth: 1
license
.. module:: notify2
.. autofunction:: init
.. autofunction:: get_server_caps
.. autofunction:: get_server_info
Creating and showing notifications
----------------------------------
.. autoclass:: Notification
.. automethod:: show
.. automethod:: update
.. automethod:: close
Extra parameters
----------------
.. class:: Notification
.. automethod:: set_urgency
.. automethod:: set_timeout
.. automethod:: set_category
.. automethod:: set_location
.. automethod:: set_icon_from_pixbuf
.. automethod:: set_hint
.. automethod:: set_hint_byte
Callbacks
---------
To receive callbacks, you must have set a D-Bus event loop when you called
:func:`init`.
.. class:: Notification
.. automethod:: connect
.. automethod:: add_action
Constants
---------
.. data:: URGENCY_LOW
URGENCY_NORMAL
URGENCY_CRITICAL
Urgency levels to pass to :meth:`Notification.set_urgency`.
.. data:: EXPIRES_DEFAULT
EXPIRES_NEVER
Special expiration times to pass to :meth:`Notification.set_timeout`.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
