navigator_invoke_query_set_action

Set the action type of a query.

Synopsis:

#include <bps/navigator_invoke.h>

BPS_API int navigator_invoke_query_set_action_type(navigator_invoke_query_t *query,
                                                   navigator_invoke_query_action_type_t action_type)

Since:

BlackBerry 10.0.0

Arguments:

query: A pointer to the navigator_invoke_query_t structure whose action_type member you want to set.

action_type: An action type corresponding to an entry in the navigator_invoke_query_action_type_t enumeration.

Library:

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

Description:

The navigator_invoke_query_set_action_type() function sets the action type of a given navigator_invoke_query_t structure. The action_type member indicates whether the invocation query returns only menu actions (actions that have an icon and label) or both brokered and menu actions (which may not all have an icon and label).

If you don't assign an action_type member to an invocation query, the brokering system doesn't filter for any specific action type.

The possible values that you can set to this member are:

NAVIGATOR_INVOKE_QUERY_ACTION_TYPE_MENU
NAVIGATOR_INVOKE_QUERY_ACTION_TYPE_ALL

See the navigator_invoke_query_action_type_t enumeration for details.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.