notification_message_set_invocation_encoded_payload()

Specify a base64-encoded payload of arbitrary data to be sent to the target application.

Synopsis:

#include <bps/notification.h>
 
BPS_API int notification_message_set_invocation_encoded_payload(notification_message_t *message,
                                                                const char *payload)

Since:

BlackBerry 10.0.0

Arguments:

message

A pointer to the notification_message_t structure that you want to set the encoded payload for.

payload

The data to be handed to the application via invocation framework on launch. Encode the payload as base64 before passing it to this function to match the invocation framework.

Library:

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

Description:

The notification_message_set_invocation_encoded_payload() function specifies an encoded payload of arbitrary data to be sent to the target application via the invocation framework.

The encoded payload member is used only with the notification_notify() function, and only when you've set an invocation target via the notification_message_set_invocation_target() function, and no payload has been provided through the notification_message_set_invocation_payload() or notification_message_set_invocation_payload_uri() function.

If you don't call this function, a payload URI (defined using the notification_message_set_invocation_payload_uri() function) is sent instead, or if you haven't specified one, no data is delivered on invocation.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.

Last modified: 2014-09-30



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus