navigator_invoke_invocation_set

Set the action of an invocation.

Synopsis:

#include <bps/navigator_invoke.h>

BPS_API int navigator_invoke_invocation_set_action(navigator_invoke_invocation_t *invocation,
                                                   const char *action)

Since:

BlackBerry 10.0.0

Arguments:

invocation: A pointer to the navigator_invoke_invocation_t structure whose action member you want to set.

action: The action you want the invocation target to perform. The value must conform to the "[Domain][Sub-domain]" format (see description for further information).

Library:

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

Description:

The navigator_invoke_invocation_set_action() function sets the action of a given navigator_invoke_invocation_t structure. The action member identifies the action to be performed by the invocation target.

If you assign an action member to an invocation but don't assign a target (using the navigator_invoke_invocation_set_target() function), the brokering system uses the action value to filter for target handlers that support that action. If a type member is also assigned (using the navigator_invoke_invocation_set_type() function), the brokering system uses that information to filter for handler(s) that support both the given action and type. If only a type member is assigned, the brokering system doesn't filter for any specific action.

The format of an action member must conform to the following guidelines:

Maximum 50 characters
Action: [Domain][Sub-domain]
Sub-domain: NUL | .[Domain][Sub-domain]
Domain: [a-zA-Z]([a-zA-Z0-9_])*

Example: "bb.action.SHARE"

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.