notification_cancel()

Cancel a request for ongoing notifications like LED, dialog, etc.

Synopsis:

#include <bps/notification.h>

BPS_API int notification_cancel(notification_message_t *message)

Since:

BlackBerry 10.0.0

Arguments:

message: A pointer to a notification_message_t structure. An item_id can be included. If additional members are provided, they are ignored by this call.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

The notification_cancel() function cancels a previous request for a notification. Normally, the function attempts to cancel all notifications that have been previously sent by the application. This causes the LED to stop flashing, repeating sound/vibration to stop, and dialogs and badges to be removed.

If an item ID is provided in the notification_message_t structure, the function attempts to cancel the notification with the same item_id.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.