uds_inbox_item_data_set_description()

Set the description for the specified inbox item data.

Synopsis:

#include "bb/pim/unified/unified_data_source.h"
 

void uds_inbox_item_data_set_description(uds_inbox_item_data_t *inbox_item, const char *description)

Since:

BlackBerry 10.2.0

Arguments:

inbox_item

The inbox item to set the description for. This inbox item is represented by a uds_inbox_item_data_t and is created using uds_inbox_item_data_create().

description

The description to set.

Library:

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

Description:

This description appears at the bottom of the inbox list item (beneath the name) when the list item is displayed in the BlackBerry Hub. This description could include more detailed information about the inbox item, such as the subject of a message. The string value that you pass in as the description parameter must remain valid until the data is used in a call to uds_item_added() or uds_item_updated().

Returns:

Parent topic: Inbox item functions in unified_data_source.h