navigator_card_request_card_ready_check()

#include <bps/navigator.h>
 

BPS_API int navigator_card_request_card_ready_check(bool check)

Since:

BlackBerry 10.0.0

Arguments:

check

Whether to be notified by navigator before the card's window is shown.

Library:

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

Description:

The navigator_card_request_card_ready_check() function sends a request to the Navigator so that when the navigator is ready to show the card's window, e.g., after being brought back from pooling, it will send a NAVIGATOR_CARD_READY_CHECK event. This allows the card to delay its window being shown until it sends a navigator_card_send_card_ready() message.

Note that the Navigator will show the window after some timeout regardless of whether navigator_card_send_card_ready() is called.

The request can be made at any time during the card's lifecycle, and applies to all subsequent times that the card's window is shown. If requesting for the first run of the card, this request must proceed the posting of a window.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.