cdos-notify

cdos-notify

Functions

Description

Functions

cdos_notify_init ()

gboolean
cdos_notify_init (const char *app_name);

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

Parameters

app_name

The name of the application initializing libcdosnotify.

 

Returns

TRUE if successful, or FALSE on error.


cdos_notify_uninit ()

void
cdos_notify_uninit (void);

Uninitialized libcdosnotify.

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


cdos_notify_is_initted ()

gboolean
cdos_notify_is_initted (void);

Gets whether or not libcdosnotify is initialized.

Returns

TRUE if libcdosnotify is initialized, or FALSE otherwise.


cdos_notify_get_app_name ()

const char *
cdos_notify_get_app_name (void);

Gets the application name registered.

Returns

The registered application name, passed to cdos_notify_init().


cdos_notify_set_app_name ()

void
cdos_notify_set_app_name (const char *app_name);

Sets the application name.

Parameters

app_name

The name of the application

 

cdos_notify_get_server_caps ()

GList *
cdos_notify_get_server_caps (void);

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

Returns

a GList of server capability strings. Free the list elements with g_free() and the list itself with g_list_free().

[transfer full][element-type utf8]


cdos_notify_get_server_info ()

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

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

Parameters

ret_name

a location to store the server name, or NULL.

[out][allow-none][transfer full]

ret_vendor

a location to store the server vendor, or NULL.

[out][allow-none][transfer full]

ret_version

a location to store the server version, or NULL.

[out][allow-none][transfer full]

ret_spec_version

a location to store the version the service is compliant with, or NULL.

[out][allow-none][transfer full]

Returns

TRUE if successful, and the variables passed will be set, FALSE on error. The returned strings must be freed with g_free


cdos_notify_add_notify_blacklist ()

void
cdos_notify_add_notify_blacklist (gchar *app_name,
                                  guint level);

Synchronously add application to blacklist.

Parameters

app_name

The name of the application.

[allow-none]

level

The level id.

 

cdos_notify_add_notify_blacklist_unblock_all ()

void
cdos_notify_add_notify_blacklist_unblock_all
                               ();

Synchronously add application to blacklist.


cdos_notify_add_notify_blacklist_block_all ()

void
cdos_notify_add_notify_blacklist_block_all
                               ();

Synchronously add application to blacklist.


cdos_notify_add_notify_blacklist_block ()

void
cdos_notify_add_notify_blacklist_block
                               (gchar *app_name);

Synchronously add application to blacklist.

Parameters

app_name

The name of the application.

 

cdos_notify_add_notify_blacklist_clean ()

void
cdos_notify_add_notify_blacklist_clean
                               (gchar *app_name);

Synchronously add application to blacklist.

Parameters

app_name

The name of the application.

 

cdos_notify_add_notify_blacklist_dnd ()

void
cdos_notify_add_notify_blacklist_dnd (gchar *app_name);

Synchronously add application to blacklist.

Parameters

app_name

The name of the application.

 

cdos_notify_add_notify_blacklist_silent ()

void
cdos_notify_add_notify_blacklist_silent
                               (gchar *app_name);

Synchronously add application to blacklist.

Parameters

app_name

The name of the application.

 

cdos_notify_add_notify_blacklist_clear ()

void
cdos_notify_add_notify_blacklist_clear
                               (gchar *app_name);

Synchronously add application to blacklist.

Parameters

app_name

The name of the application.

 

Types and Values