navigator_invoke_event_get_viewer_relay_window_id()

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

Synopsis:

#include <bps/navigator_invoke.h>

BPS_API const char* navigator_invoke_event_get_viewer_relay_window_id(bps_event_t *event) BPS_DEPRECATED

Since:

BlackBerry 10.0.0

Arguments:

event: The NAVIGATOR_INVOKE_VIEWER_RELAY event targeted by the viewer.

Library:

libbps

Description:

Deprecated:

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

The navigator_invoke_event_get_viewer_relay_window_id() function extracts the window ID of a given viewer relay message (created and sent using the navigator_invoke_viewer_relay() function). The window_id member is used by the receiving target to identify the viewer that sent the message. Call this function in the parent application upon receiving the NAVIGATOR_INVOKE_VIEWER_RELAY event to identify the corresponding viewer. This function doesn't copy data and the returned values are released once the bps_get_event() function is called again.

Returns:

The window ID of the viewer that sent the relay data, NULL with errno set otherwise.