notification_message_set_invocation_payload

Set a payload_uri to be provided to a launch target.

Synopsis:

#include <bps/notification.h>

BPS_API int notification_message_set_invocation_payload_uri(notification_message_t *message,
                                                            const char *payload_uri)

Since:

BlackBerry 10.0.0

Arguments:

message: A pointer to the notification_message_t structure whose payload_uri you want to set.

payload_uri: The path to the payload.

Library:

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

Description:

The notification_message_set_invocation_payload_uri() function passes the invoked application a URI to a payload, instead of directly including the data in a notify message.

The payload_uri member is used only with the notification_notify() function, and only when a payload isn't provided through the notification_message_set_invocation_encoded_payload() or notification_message_set_invocation_payload() functions.

If you don't call this function, data is taken from the payload member (defined using either the notification_message_set_invocation_payload() or notification_message_set_invocation_encoded_payload() function), or if you haven't specified one, no data is delivered on invocation.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.