navigator_invoke_viewer

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

Synopsis:

#include <bps/navigator_invoke.h>

typedef struct navigator_invoke_viewer_t navigator_invoke_viewer_t;

Since:

BlackBerry 10.0.0

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.

This type defines the navigator_invoke_viewer_t structure used by several functions in the invocation framework. Use this to create and control viewers. The navigator_invoke_viewer_t structure is opaque, but includes the following members:

Invocation: the invocation associated with the viewer (navigator_invoke_viewer_create())
Window ID: the ID used to identify the viewer (navigator_invoke_viewer_set_window_id())
Width: the width of the viewer (navigator_invoke_viewer_set_width())
Height: the height of the viewer (navigator_invoke_viewer_set_height())

To create an invocation viewer, you must:

Instantiate a navigator_invoke_viewer_t structure with the navigator_invoke_viewer_create() function.
Set all desired members with the navigator_invoke_viewer_set_*() functions to match the purpose of the viewer.
Send the viewer with the navigator_invoke_viewer_send() function. The invocation is sent to an event handler, triggering the NAVIGATOR_INVOKE_VIEWER event.
Retrieve the data from a viewer in an event handler by using the navigator_invoke_viewer_get_*() functions, within this, further data from the invocation can be retrieved through the navigator_invoke_invocation_t structure using the navigator_invoke_viewer_get_invocation() function followed by the navigator_invoke_invocation_get_*() functions.
Deallocate the memory reserved for the navigator_invoke_viewer_t with the navigator_invoke_viewer_destroy() function.