Xlet Properties
The properties of an Xlet must be specified by a file with the name xlet.properties that is added to the topmost directory of the Xlet jar file. This file has the format of a Java properties file specified in the Java API.
Example:
xlet.name = TestXlet
xlet.appId = “0ae60f0f-45f9-4f6a-881d-cdfe124bc7d6”
xlet.mainClass = com.aicas.xlet.example.testxlet.TestXlet
Properties:
kona Version
If you have an app that is dependent on the kona version these two properties can be added. Your app can check to see if the version of Kona is compatible using the API XletInfo.getXletInfo().isKonaCompatibile(), see API Specification.
kona.minimum.version
Example - kona.minimum.version=14.06.13
kona.maximum.version
Example - kona.maximum.version=14.07.01
xlet.name
- Name that will be displayed in the HU app list.
- Property must be less than 20 characters.
xlet.LargeIconPath
- URI of the large icon packaged in the jar. used for app list Icon.
Example - xlet.LargeIconPath=res/largeIcon.png
xlet.SmallIconPath
- URI of the small icon packaged in the jar. used for status bar Icon.
Example - xlet.SmallIconPath=res/largeIcon.png
xlet.ExLargeIconPath
- URI of the extra large icon packaged in the jar. used for the too many running apps popup.
Example - xlet.ExLargeIconPath=res/largeIcon.png
xlet.AppCategory
xlet.daemon
- Usage:xlet.daemon=<value>, Value = True or False
- A daemon Xlet is an Xlet that is declared to be a daemon Xlet via a property in the xlet.properties file (xlet.daemon=true), and does not get screen focus
- All Xlets, including daemon Xlets, can request screen focus via the method XletContext.resumeRequest()
- The decision whether screen focus is granted will be delegated to a screen arbitrator outside the AMS
xlet.headless
- Usage:xlet.headless=<value>, Value = True or False
- Visible flag in properties file
- Determines if app is displayed in the app list
xlet.jarFile
- All xlets must include the xlet.jarFile attribute which indicates the name of the jar file.
xlet.PauseAllowed
- Usage:xlet.PauseAllowed=<value>, Value = True or False
- If xlet.PauseAllowed field is True, the Application Manager shall be permitted to send the xlet to the pause state
- If xlet.PauseAllowed field is False, the Application Manager shall destroy this xlet when any other xlet becomes active
xlet.StatusBarVisible
- Usage:xlet.StatusBarVisible=<value>, Value = True or False
- If the xlet.StatusBarVisible field is True, the App’s icon shall be displayed in the status bar when the App is in the active state or pause state.
- If the xlet.StatusBarVisible field is False, the App’s icon shall not be displayed in the status bar when the App is in any state
- If this property is not present, the default value for this property is false
- Used for Media apps only.
xlet.StatusBarVisible
- Usage:xlet.StatusBarVisible = <value>, Value = True or False
- If the xlet.StatusBarVisible field is True, the App’s icon shall be displayed in the status bar when the App is in the active state or pause state.
- If the xlet.StatusBarVisible field is False, the App’s icon shall not be displayed in the status bar when the App is in any state
- If this property is not present, the default value for this property is false
- Used for Media apps only.
xlet.AppVRName
- The xlet.AppVRName field shall give the name of the xlet that the app manager shall add to the App VR list used by the VR engine to start apps while in the main VR
- Used when HU is in English
xlet.DeleteAllowed
- Usage:xlet.DeleteAllowed = <value>, Value = True or False
- The xlet.DeleteAllowed field shall allow the application manager know when an application is available to be deleted from the HMI
- If this property is not present, the default value for this property is false.
xlet.isAudio
- Usage:xlet.isAudio = <value>, Value = True or False.
- The xlet.isAudio field shall allow the application manager to know if an xlet is an xlet that utilizes the media apis to play audio.
- If this property is not present, the default value for this property is false.
xlet.isTTS
- Usage:xlet.isTTS = <value>, Value = True or False.
- The xlet.isTTS field shall allow the application manager to know if an xlet is an xlet that utilizes the TTS engine to play TTS strings.
- If this property is not present, the default value for this property is false.
xlet.isVR
- Usage:xlet.isVR = <value>, Value = True or False.
- The xlet.isVR field shall allow the application manager to know if an xlet is an xlet that utilizes the VR engine for on-board or off-board voice recognition..
- If this property is not present, the default value for this property is false.
xlet.ecoPath
- The xlet.ecoPath field shall allow the application manager to know which folder the eco files reside in the .JAR file.
- The application manager shall use this path to extract all eco files upon install or update.
xlet.ecoFiles
- The xlet.ecoFiles field shall allow the application manager to know the names of the eco files to extract after install or update.
- The eco files shall be listed seperated by commas.
xlet.writeEnabled
- Usage:xlet.writeEnabled = <value>, Value = True or False.
- The xlet.writeEnabled field shall allow the application manager to determine if the xlet is allowed to write to the file system.
- The downloader xlet is currently the only xlet that is allowed to have this access.
- If this property is not present, the default value for this property is false.
xlet.VRNameLanguages
- This property allows the apps to give VR Names for different languages that the HU's support for use by the VR engine to start the app through VR.
- The locales and Names are separated by a “:” and the pairs are separated by commas.
- Usage: xlet.VRNameLanguages=es_US:VRTestXlet,fr_CA:VRTestXlet.
xlet.NameLanguages
- This property allows the apps to give Names for different languages that the HU's support to be displayed in the App List.
- The locales and Names are separated by a “:” and the pairs are separated by commas.
- Usage: xlet.NameLanguages=es_US:VRTestXlet,fr_CA:VRTestXlet.
xlet.showConditions
- The xlet which has this property in its xlet.properties will be made or not made visible in the App screen based on the conditions listed.
- All conditions must be satisfied to be shown in the apps list.
- If this property is not present (default), the xlet will be visible in the App screen.
Example:
xlet.showConditions=/pps/can/vehcfg/VC_PP_Prsnt:1,/pps/can/vehcfg/VC_VEH_LINE:1
xlet.showConditions=/pps/can/vehcfg/VC_VehCfg3_Stat:1,/pps/can/vehcfg/VC_VEH_BRAND:{1;2;3}
xlet.appId
- Unique UUID for each app.
xlet.mainClass
- Entry point for each xlet.
xlet.version
- Version Number of the xlet.
xlet.policy
- xlet.policy=security.policy.
- Security Policy for each app.
xlet.policy.default
- xlet.policy.default=full.policy.
- System Security Policy used by app.
xlet.audioSource
- Usage:xlet.writeEnabled = <value>, Value = True or False .
- The xlet.writeEnabled field shall allow the application manager to determine if the xlet is allowed to write to the file system.
- The downloader xlet is currently the only xlet that is allowed to have this access.
- If this property is not present, the default value for this property is false.
Top