IBM Worklight v5.0.5 > Develop IBM Worklight applications > Development guidelines for using native API

Application Descriptor of Native API application for Android


The application descriptor, application-descriptor.xml, is a metadata file used to define various aspects of the application. It is in the application root directory.

<?xml version="1.0" encoding="UTF-8"?>
<nativeAndroidApp 
    id="android"
    platformVersion="5.0.5"
    securityTest="security test name"
    version="1.0"
    xmlns="http://www.worklight.com/native-android-descriptor">
    <displayName>application display name</displayName>
    <description>application description</description>
    <publicSigningKey>application public signing key</techSigningKey>
</nativeAndroidApp>

The <nativeAndroidApp> element is the root element of the descriptor.

id ID of the application. The ID must be identical to the application folder name. It must be an alphanumeric string that starts with a letter. It can contain underscore ("_") characters. It must not be a reserved word in JavaScript.
platformVersion Version of the IBM Worklight Platform on which the app was developed.
version Version of the application. This version is a string of the form x.y, where x and y are numbers. It is visible to users who download the app from the app store or market.
securityTest Security configuration defined in authenticationConfig.xml. When a client attempts to access a protected resource, IBM Worklight checks whether the client is already authenticated according to the security test. If the client is not yet authenticated, IBM Worklight starts the process to obtain the client credentials and to verify them. Optional.
<displayName> Application name. Visible in the IBM Worklight Console and is copied to the descriptor files of various web and desktop environments.
<description> Application description. Visible in the IBM Worklight Console and is copied to the descriptor files of various web and desktop environments.
<publicSigningKey> Public key of the developer certificate used to sign the Android app.
</nativeAndroidApp> This tag closes the content of the application descriptor file.


Parent Development guidelines for using native API