navigator_card_peek()

Request the Navigator to perform the card peek action.

Synopsis:

#include <bps/navigator.h>

BPS_API int navigator_card_peek(navigator_peek_type_t peek_type)

Since:

BlackBerry 10.0.0

Arguments:

peek_type: The type of peek to 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.

Library:

libbps

Description:

The navigator_card_peek() function sends a request to the Navigator to perform a card peek action of a given type. Peeking is the ability to see behind a card using a gesture to drag the card off screen and expose the card's parent or root (depending on the type of peek action). Call this function from the card application to trigger a NAVIGATOR_CARD_PEEK_STARTED event.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.