Application page

This page maintains the attributes for the application entry point. Since you can localize the entry point name, description, icon, and splash image, they appear in a detail view that's determined by your language selection on the Localization page.

Option XML element Description Default
Category <category> Optional. Specify the BlackBerry 10 OS home screen category in which your application should appear. The value must be one of:
  • (Uncategorized): your application will appear under the All category.
  • Games ( your application appears under the Games category on the BlackBerry 10 OS home screen.
  • Media ( your application appears under the Media category on the BlackBerry 10 OS home screen.
You can specify only one element of this type in your bar-descriptor.xml configuration file. By default, if no category is specified (Uncategorized), your application will appear under the All category.
Orientation For Default, N/A , for Auto-orient: <autoOrients>true</autoOrients>, for Landscape: <aspectRatio>landscape</aspectRatio>, and for Portrait: <aspectRatio>portrait</aspectRatio> Optional. Set the orientation for the application; the physical orientation of the device. This orientation option provides you with ways to control the rotation of the content on the screen so that it's easier to view on the device:
  • Default: use the default orientation for the device.
  • Auto-orient: the screen orientation changes according to the orientation of the BlackBerry device. By default, if you don't specify the orientation element, don't specify it with any attributes, or specify it incorrectly, the orientation is set to auto.
  • Landscape: the screen orientation remains in landscape mode, regardless of the orientation of the device.
  • Portrait: the screen orientation remains in portrait mode, regardless of the orientation of the device.
Chrome <initialwindow> <systemchrome> Optional. The type of system chrome to use (such as the borders, title bar, menu bar, and window control buttons). You can specify:
  • standard: your application will use the standard system chrome elements. A window that uses system chrome is always opaque.
  • none: your application will be transparent. This means that the application must provide its own mechanisms for controlling the window and its background.
The default is standard if nothing is specified.
Transparent main window <initialwindow> <transparent> Optional. Specify whether the window is transparent. Only applicable when the Chrome field is set to none; otherwise, the window is opaque. Not Selected
Permissions <permission system="true">run_native</permission> Request permission to execute native code; required for native applications. Set by default.
Permission <permission> Optional. Specify the device capabilities that your application needs to access.

The BlackBerry 10 device contains functionality that can capture rich information from its environment, such as the GPS receiver, a microphone, and so on. To help protect against potentially malicious code, users must grant your application access to the functionality. For example, the user must grant your application permission to use the GPS or the microphone.

The BlackBerry 10 OS prompts a user to allow your application to use any device capability you specify in this element. You can specify one capability per permission element.

If an application uses APIs that access restricted functionality, and the application doesn't request access to a device capability, the APIs return errors. For example, if you attempt to access a file in a shared folder without the access_shared capability, you get a "permission denied" error on the open action. Your application must handle these errors gracefully.

For more information about the available application permissions, see App permissions.

None selected.
Select All N/A Select all of the permissions in the list; these are the permissions that are requested by your application. N/A
Deselect All N/A Remove the selection for all permissions in the list; none of these permissions will be requested by your application. N/A
Description N/A Descriptive information about a selected permission. N/A
Entry point text and Images N/A Text and graphics that the BlackBerry 10 OS Navigator uses to represent your application. N/A
Name <name> The name that's displayed in the BlackBerry 10 OS application installer. May have multiple values for each language. The file name associated with your project for your application.
Description <description> Optional. A brief description of your application. The description you initially assigned to your project.
Icon <icon><image> The icon to display for your application in the BlackBerry 10 OS home screen. Your icon should be 114 by 114 pixels. The icon image format is .png 24-bit with an alpha channel. The icon must be included in your .bar file, and can be a .png, .jpg, .jpeg, .gif, or .bmp file.

An icon that's larger than 114-by-114 pixels can't be displayed on the screen. You specify the file name for the icon within the <image> element (e.g. <icon><image>icon.png</image></icon>). For more information about designing application icons, see the BlackBerry UI Guidelines .

Browse N/A Optional. Locate an icon that the system uses for the application. The icon for your project can be a .png, .jpg, .jpeg, .gif, or .bmp file.

You can drag the icon asset from the Project Explorer or from the file browser on the host, and then drop it onto the Icon field.

Clear N/A Clear the image selection you made for the application's icon. N/A
Splash Screens <splashScreen> Specify the image to display while the device loads your application. You can specify up to two files (used if your application supports rotation; one for each portrait and landscape orientation). If you specify one file, the device displays the file in a landscape orientation. If you specify two files, the first file is used when the device is in an landscape orientation, and the second file is used when the device is in a portrait orientation. The image for your splash screen must be included in your .bar file and can be a .png, .jpg, .jpeg, .gif, or .bmp file.

The screen resolution of your device can be found in the BlackBerry UI Guidelines . Your splash screen should be the entire resolution size to fill the screen.

You can drag the splashscreen assets from the Project Explorer or from the host OS file browser and drop it onto the Icon field.


Last modified: 2013-12-21

comments powered by Disqus