notify

notify — Notification API

Synopsis

gboolean            notify_init                         (const char *app_name);
void                notify_uninit                       (void);
gboolean            notify_is_initted                   (void);
const gchar*        notify_get_app_name                 (void);
GList*              notify_get_server_caps              (void);
gboolean            notify_get_server_info              (char **ret_name,
                                                         char **ret_vendor,
                                                         char **ret_version,
                                                         char **ret_spec_version);

Description

Details

notify_init ()

gboolean            notify_init                         (const char *app_name);

Initialized libnotify. This must be called before any other functions.

app_name :

 The name of the application initializing libnotify.

Returns :

 TRUE if successful, or FALSE on error.

notify_uninit ()

void                notify_uninit                       (void);

Uninitialized libnotify.

This should be called when the program no longer needs libnotify for the rest of its lifecycle, typically just before exitting.

notify_is_initted ()

gboolean            notify_is_initted                   (void);

Gets whether or not libnotify is initialized.

Returns :

 TRUE if libnotify is initialized, or FALSE otherwise.

notify_get_app_name ()

const gchar*        notify_get_app_name                 (void);

Gets the application name registered.

Returns :

 The registered application name, passed to notify_init().

notify_get_server_caps ()

GList*              notify_get_server_caps              (void);

Queries the server for its capabilities and returns them in a GList.

Returns :

 A GList of server capability strings.

notify_get_server_info ()

gboolean            notify_get_server_info              (char **ret_name,
                                                         char **ret_vendor,
                                                         char **ret_version,
                                                         char **ret_spec_version);

Queries the server for its information, specifically, the name, vendor, server version, and the version of the notifications specification that it is compliant with.

ret_name :

 The resulting server name.

ret_vendor :

 The resulting server vendor.

ret_version :

 The resulting server version.

ret_spec_version :

 The resulting version of the specification the server is compliant with.

Returns :

 TRUE if successful, and the variables passed will be set. FALSE on failure.