notification_message_set_invocation_type()

#include <bps/notification.h>
 

BPS_API int notification_message_set_invocation_type(notification_message_t *message,
                                                     const char *invocation_type)

Since:

BlackBerry 10.0.0

Arguments:

message

A pointer to the notification_message_t structure that you want to specify the invocation_type for.

invocation_type

The MIME type of an included payload. This is ignored if you do not include a payload.

Library:

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

Description:

The notification_message_set_invocation_type() function specifies the content-type of a given payload. This is provided to the invocation framework if an application is launched based on this notification.

The invocation_type member is used only with the notification_notify() function, and only when you've provided a payload through the notification_message_set_invocation_encoded_payload(), notification_message_set_invocation_payload(), or notification_message_set_invocation_payload_uri() function.

If you don't call this function, a provided payload is assumed to be "text/plain".

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.