navigator_event_get_peek_stopped_swipe_away()

#include <bps/navigator.h>
 

BPS_API int navigator_event_get_peek_stopped_swipe_away(bps_event_t *event,
                                                        bool *is_swipe_away)

Since:

BlackBerry 10.0.0

Arguments:

event

The NAVIGATOR_PEEK_STOPPED event.

is_swipe_away

If true the peek action of the card stopped due to a swipe away gesture, if false the card peek was stopped normally.

Library:

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

Description:

The navigator_event_get_peek_stopped_swipe_away() function determines whether a peek action of this card stopped due to the user swiping away the card to navigate to the content being peeked at, or whether the peek action of this card stopped due to the user returning the card to the stack, resuming the activity on the current card. Call this function from the card application upon receiving the NAVIGATOR_PEEK_STOPPED event to extract the manner in which the peek was stopped.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.