navigator_invoke_query

The opaque query argument type.

Synopsis:

#include <bps/navigator_invoke.h>

typedef struct navigator_invoke_query_t navigator_invoke_query_t;

Since:

BlackBerry 10.0.0

Library:

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

Description:

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

ID: the ID used to identify the query (navigator_invoke_query_set_id())
Action: the action query results should be able to perform (navigator_invoke_query_set_action())
Type: the MIME type the query results should be able to act on (navigator_invoke_query_set_type())
File URI: the URI to the type interface the query results should be able to act on (navigator_invoke_query_get_file_uri())
Target type: the type of targets the query should filter for (navigator_invoke_query_set_target_type_mask())
Action type: the type of actions the query should filter for (navigator_invoke_query_set_action_type())
Perimeter: the perimeter the query results should be invoked in (navigator_invoke_query_set_perimeter())

To perform an invocation query, you must:

Instantiate a navigator_invoke_query_t structure with the navigator_invoke_query_create() function.
Set all desired members with the navigator_invoke_query_set_*() functions to match the purpose of the query.
Send the query with the navigator_invoke_query_send() function. The query is sent to the brokering system, which returns a set of results that correspond to the navigator_invoke_query_t structure parameters.
Deallocate the memory reserved for the navigator_invoke_query_t structure with the navigator_invoke_query_destroy() function.