Elements in BlackBerry device application .alx file

Element

Attributes

Description

application

id

platformVersion

blackBerryVersion

The application element contains the elements for a single BlackBerry® device application.

The application element can also contain additional nested application elements. Nesting lets you require that, when a BlackBerry device application is loaded on the BlackBerry device, its prerequisite modules are also loaded on the BlackBerry device.

The id attribute specifies a unique identifier for the BlackBerry device application. To provide uniqueness, use an ID that includes your company domain in reverse order. For example, com.rim.samples.docs.helloworld.

The platformVersion attribute specifies the version of the operating system software on a BlackBerry device that a BlackBerry device application requires.

The blackBerryVersion attribute specifies the version of the BlackBerry® Device Software that a BlackBerry device application requires.

copyright

The copyright element provides copyright information, which appears in the application loader tool of the BlackBerry® Desktop Manager.

description

The description element provides a brief description of the BlackBerry device application, which appears in the application loader tool of the BlackBerry Desktop Manager.

directory

platformVersion

blackBerryVersion

The directory element provides the location of a set of files. The directory element is optional. If you do not specify a directory, the files must exist in the same location as the .alx file. The directory element specifies the directory relative to the location of the .alx file.

directory elements are cumulative within a BlackBerry device application.

For example:

<application id="com.abc.my.app">
<directory>MyCodFiles</directory>
<fileset Java="1.0">
<files>
a.cod //resolves to <.alx location>\MyCodFiles
b.cod
</files>
</fileset>
<directory>MyCodFiles</directory>
<fileset Java="1.0">
<files>
c.cod //resolves to <.alx location>\MyCodFiles\MyCodFiles
d.cod
</files>
</fileset>
</application>

The platformVersion attribute specifies the version of the operating system software on a BlackBerry device that a BlackBerry device application requires.

The blackBerryVersion attribute specifies the version of the BlackBerry Device Software that a BlackBerry device application requires.

files

The files element provides a list of one or more BlackBerry device application .cod files, in a single directory, to load on the BlackBerry device.

fileset

Java

radio

langid

Colour

platformVersion

blackBerryVersion

The fileset element includes an optional directory element and one or more files elements. It specifies a set of .cod files, in a single directory, to load onto the BlackBerry device. To load files from more than one directory, include one or more fileset elements in the .alx file.

The Java attribute specifies the minimum version of the BlackBerry® Java® Virtual Machine with which the .cod files are compatible. The Java attribute is required.

The radio attribute lets you load different BlackBerry device applications or modules on the BlackBerry device depending on the network type of the BlackBerry device. Possible values include Mobitex, DataTAC, GPRS, CDMA, and IDEN. The radio attribute is optional.

The langid attribute lets you load different BlackBerry device applications or modules depending on the language support that BlackBerry device users add to the BlackBerry device. The value is a Win32 langid code; for example: 0x0009 (English), 0x0007 (German), 0x000a (Spanish), and 0x000c (French). The langid attribute is optional.

The colour attribute lets you load different BlackBerry device applications or modules for color or monochrome displays. The value is a Boolean; true means color display and false means monochrome.

The platformVersion attribute specifies the version of the operating system software on a BlackBerry device that a BlackBerry device application requires.

The blackBerryVersion attribute specifies the version of the BlackBerry Device Software that a BlackBerry device application requires.

hidden

The hidden element hides a package so that it does not appear to BlackBerry device users in the Application Loader. To hide a package, add the following line: <hidden>true</hidden>.

Use this element in conjunction with the required element to load the BlackBerry device application by default, or set the requires tag to load this package if another BlackBerry device application exists.

Only corporate system administrators should use the hidden tag. This tag is not intended for use by third-party software vendors.

The BlackBerry Desktop Software version 3.6 or later supports this element.

language

langid

The language element lets you override the text that appears in the Application Loader when the Application Loader runs in the language that the langid attribute specifies.

To support multiple languages, specify multiple language elements. To specify the name, description, version, vendor, and copyright elements for each language, nest these elements in the language element. If you do not nest a element, the text appears in the default language.

The langid attribute specifies the Win32 langid code for the language to which this information applies. For example, some Win32 langid codes are: 0x0009 (English), 0x0007 (German), 0x000a (Spanish), and 0x000c (French).

library

id

You can use the library element instead of the application element. It contains the elements for a single library module. You cannot nest modules. By default, a library module does not appear in the application loader tool of the BlackBerry Desktop Manager.

Typically, use the library element as the target of a <requires> element, so that when a particular BlackBerry device application loads onto the BlackBerry device, a required library also loads onto the BlackBerry device.

BlackBerry Desktop Software version 3.6 or later supports this element.

loader

version

The loader element contains one or more application element.

The version attribute specifies the version of the application loader tool of the BlackBerry Desktop Manager.

name

The name element provides a descriptive name for the BlackBerry device application, which appears in the application loader tool of the BlackBerry Desktop Manager.

required

The required element lets you force an application to load. The application loader tool of the BlackBerry Desktop Manager selects the BlackBerry device application for installation, and the BlackBerry device user cannot change this selection. Add the following line: <required>true</required>.

Only corporate system administrators should use the required tag. This tag should not be used by third-party software vendors.

BlackBerry Desktop Software version 3.5 or later supports this element.

requires

id

The requires element is an optional element that specifies the id of a package on which this BlackBerry device application depends. This element can appear more than once, if the BlackBerry device application depends on more than one BlackBerry device application . When a BlackBerry device application loads onto the BlackBerry device, all packages that the <requires> tag specifies also load onto the BlackBerry device.

BlackBerry Desktop Software version 3.6 or later supports this element.

vendor

The vendor element provides the name of the company that created the BlackBerry device application, which appears in the application loader tool of the BlackBerry Desktop Manager.

version

The version element provides the version number of the BlackBerry device application, which appears in the application loader tool of the BlackBerry Desktop Manager. This version number is for information purposes only.

Index


Was this information helpful? Send us your comments.