navigator_invoke_invocation_set_id()

#include <bps/navigator_invoke.h>
 

BPS_API int navigator_invoke_invocation_set_id(navigator_invoke_invocation_t *invocation,
                                               const char *id)

Since:

BlackBerry 10.0.0

Arguments:

invocation

A pointer to the navigator_invoke_invocation_t structure whose id you want to set.

id

The invocation ID you want to display on the delivery receipt response. This value must be in numerical format. For example, a valid id would be "42".

Library:

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

Description:

The navigator_invoke_invocation_set_id() function sets the invocation ID of a given navigator_invoke_invocation_t structure. Assign an id member to any invocation for which you would like to receive a delivery receipt response. The id member you assign through a sender appears in its corresponding delivery receipt. The receipt is returned once the invocation is dispatched to a target, but does not imply that the target has processed the invocation. If the sender terminates before receiving a receipt response then it is forfeit.

Assigning an id member to an invocation is not mandatory, but if you do not assign one there is no way to determine the result of the invocation request. Don't assign an invocation ID if you don't want to receive a delivery receipt response.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.