It seems like the browser you are using has JavaScript disabled. As a result, the site will not function properly. We really want you to enable it so you may experience our site as we intended it. If you have no idea what we are talking about or if you need help, visit http://www.enable-javascript.com×
This website uses cookies. By continuing to browse this site you are agreeing to our use of cookies. Find out more on our cookie page.×

Oops, it seems like you're using an old browser that we do not fully support. If you're able to, please upgrade your browser here.×
This website uses cookies. By continuing to browse this site you are agreeing to our use of cookies. Find out more on our cookie page.×

Since:

Data:

Indicates that the application is a registered URL handler, and the navigator is invoking a URL type on the application.

For example, a web browser might need to handle an http invoke request from another application, and load the website that is associated with the request.

NAVIGATOR_EXIT

Indicates that the user has quit the application, the device is rebooting, or some other event has occurred that results in the application needing to terminate.

After this type of event is received, the application has a short amount of time (3 seconds) to terminate itself. If the application has not terminated after this time has elapsed, the navigator terminates the application.

NAVIGATOR_WINDOW_STATE

Indicates that the state of the application window has changed.

For example, the application window might have changed to full screen from a thumbnail. The navigator_window_state_t enumeration defines the possible states that an application window can be in.

NAVIGATOR_SWIPE_DOWN

Indicates that the user has performed a downward swipe gesture from the top of the device screen.

By convention, this gesture displays a menu.

NAVIGATOR_SWIPE_START

Indicates that the user has started a swipe gesture.

This type of event is generated if the application has requested swipe start events by calling navigator_request_swipe_start(). For example, if an application calls navigator_request_swipe_start() and the user performs a downward swipe gesture from the top of the device screen, the application receives a NAVIGATOR_SWIPE_START event followed by a series of touch events. This functionality can be useful if the application wants to respond more appropriately to swipe gestures (for example, by displaying the menu in sync with the user's downward swipe gesture).

NAVIGATOR_LOW_MEMORY

Indicates that the device is low on memory.

To prevent degraded performance and a potentially poor user experience, an application should respond to this event by freeing any memory that it isn't using.

NAVIGATOR_ORIENTATION_CHECK

Indicates that the device has rotated.

An application should respond to this event by calling navigator_orientation_check_response() and indicating whether it intends to rotate along with the device rotation. If the application indicates that it intends to rotate, the navigator sends a follow-up NAVIGATOR_ORIENTATION event when it is time for the application to resize its screen.

NAVIGATOR_ORIENTATION

Indicates that an application should resize its screen in response to the rotation of the device.

If the current process is the parent application of the viewer it indicates that the response message from the viewer was received.

If the current process is the viewer it indicates that the response message from the parent application was received. In case of an error in delivering the request message to the peer the event contains an error message. To retrieve the error message use navigator_event_get_err() function. If the error message is NULL in the event the following functions should be used to retrieve the message name, the data and the window ID of the viewer:

Indicates to the parent of a card application that the child card has been closed.

When this event is triggered, the Navigator delivers a message to the parent of the closed child card containing information about the closure as well as any response data sent by the card (if the card requested the closure).

The members contained in the message and the functions the parent application must use to retrieve them are as follows:

Pooling is a feature that allows a card of a certain type to be opened multiple times in quick sucession, such as when viewing a series of emails one after the other. This event informs the card that it should clean-up its state and listen for further invocations. When a card receives the event it should assume that its child card is also closed. A card may retrieve the reason for its closure by calling the navigator_event_get_card_closed_reason() function.

Indicates that the navigator would like to pool your application or card.

Pooled means that the application is still running as a process but its window is not visible to the user.

If an application would like to be pooled it must reply to this message by calling navigator_pooled_response() within 1 second. If there is no response within 1 second, the application will be terminated. When pooled, an application is also put into the stopped partition after 10 seconds. An application that supports pooling is responsible for closing files, connections and resources and is also responsible for restoring them when the the application gets the active signal again. This means that an application has 10 seconds to prepare itself to sit dormant in the pool.

The application decides if it wants to return to the last state it was in or to reset the state to something else. These decisions should be made when the application receives the NAVIGATOR_POOLED event so that it's ready to be displayed when it pulled from the pool later. Trying to change scenes/render new graphics, etc., when the application is made active again may result in flicker or stale data when the window is made visible again. So it's best to put the application in its "restore" state when it goes into the pool.

This event will occur after a NAVIGATOR_ORIENTATION_CHECK event and before a NAVIGATOR_ORIENTATION event. It will indicate what the window size will be after the rotation is completed. For the vast majority of apps, the width and height will simply be swapped from the current width and height.

This event will occur after a NAVIGATOR_CARD_PEEK_STARTED event and before a NAVIGATOR_CARD_PEEK_STOPPED or NAVIGATOR_INVOKE_LIST_ITEM_SELECTED event. It will indicate that the application should select the next available item in the invoke list as a candidate for the next invoke request.

Use navigator_invoke_get_list_id() to extract the id of the list that this request corresponds to, and navigator_invoke_get_list_cursor_direction() to extract the direction of movement.

NAVIGATOR_INVOKE_LIST_ITEM_SELECTED

Informs the app that an invoke list item has been selected.

This event may occur after a NAVIGATOR_CARD_PEEK_STARTED event and before a NAVIGATOR_CARD_PEEK_STOPPED event. It will indicate that the application should invoke the currently selected invoke item belonging to the list in question based on previous NAVIGATOR_INVOKE_LIST_CURSOR_MOVED events. In these instances, navigator_invoke_get_list_item_selection() returns NAVIGATOR_INVOKE_LIST_CURSOR_DIRECTION_UNSPECIFIED.

This event may also occur outside of peeking, in which case navigator_invoke_get_list_item_selection() returns the item that should be selected.

Use navigator_invoke_get_list_id() to extract the list ID of the list that this request corresponds to, and navigator_invoke_get_list_item_selection() to extract the direction of movement.

Library:

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

Description:

This enumeration defines the event codes for the types of events that the navigator service may return. Note that a reply is expected when your application receives a NAVIGATOR_ORIENTATION or NAVIGATOR_ORIENTATION_CHECK event. See the navigator_orientation_check_response() and navigator_done_orientation() functions for more information.

Last modified: 2014-09-30

Got questions about leaving a comment? Get answers from our Disqus FAQ.

1. Download the tools

Before you start developing, you'll need to visit the Downloads tab. Here you'll find downloads for the BlackBerry 10 Native SDK, BlackBerry 10 Device Simulator, and some other useful tools.

2. Try the sample apps

Now featuring a filter control, the Sample apps tab allows you to search for samples by name or by feature.

Select either the Core or Cascades radio buttons to display the samples relevant to you.

3. Educate yourself

The Documentation tab contains tons of examples, tutorials, and best practices to guide you along the path towards building an awesome app.

You can access all the documentation that you need in the left-hand navigation.

4. Start developing

The Reference tab is where you'll find essential details about how to use our APIs.

You can use the left-hand navigation to choose how you would like to browse the reference: by module, by topic, or alphabetically. If you have an idea of what you are looking for, start typing it in the Filter box.