notification_message_set_item_id()

#include <bps/notification.h>
 

BPS_API int notification_message_set_item_id(notification_message_t *message,
                                             const char *item_id)

Since:

BlackBerry 10.0.0

Arguments:

message

A pointer to the notification_message_t structure whose item_id you want to set.

item_id

The item ID you want to identify the message by.

Library:

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

Description:

The notification_message_set_item_id() function sets the item ID of a given notification_message_t structure. An item ID is required on all messages used by the notification_alert() or notification_notify() functions. The item_id member is valid in the notification_cancel() and notification_delete() functions as well.

Each item ID should be unique. If a notification with a given item_id is currently active, sending another alert or notify message with the same item_id will result in an error.

An item ID should only contain alphanumeric characters and underscores.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.