navigator_event_get_card_peek

Retrieve the type of the card peek action.

Synopsis:

#include <bps/navigator.h>

BPS_API int navigator_event_get_card_peek_type(bps_event_t *event)

Since:

BlackBerry 10.0.0

Arguments:

event: The NAVIGATOR_CARD_PEEK_STARTED event.

Library:

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

Description:

The navigator_event_get_card_peek_type() function retrieves the type of peek action that a card stack should perform. The choices are NAVIGATOR_PEEK_ROOT to peek to the bottom root of the card stack or NAVIGATOR_PEEK_PARENT to peek to only the parent of the selected card. Call this function from the card application upon receiving the NAVIGATOR_CARD_PEEK_STARTED event to extract the peek type.

Returns:

The peek type upon success, BPS_FAILURE with errno set otherwise.