navigator_invoke_event_get_viewer_relay_message_name()

#include <bps/navigator_invoke.h>
 

BPS_API const char* navigator_invoke_event_get_viewer_relay_message_name(bps_event_t *event) BPS_DEPRECATED

Since:

BlackBerry 10.0.0

Arguments:

event

The NAVIGATOR_INVOKE_VIEWER_RELAY event targeted by the sender of the viewer relay message.

Library:

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

Description:

Deprecated:

The use of viewers has been deprecated - use applications or cards as invocation targets instead.

The navigator_invoke_event_get_viewer_relay_message_name() function extracts the name of a given viewer relay message (created and sent using the navigator_invoke_viewer_relay() function). The name member is used by the receiving target (either the viewer or parent application) to identify the name of the message sent by the sender (if the receiver is the viewer, then the sender is the parent application, and vice versa). Call this function upon receiving the NAVIGATOR_INVOKE_VIEWER_RELAY event to identify the message name. This function doesn't copy data and the returned values are released once the bps_get_event() function is called again.

Returns:

The name of the message set by the viewer relay sender, NULL with errno set otherwise.