Appinfo.json
From WebOS101
Each application must have an appinfo.json file. This file contains information about your app that is used by webOS and the App Catalog.
Standard Fields
| parameter | required | description | example |
|---|---|---|---|
| dockmode | No | Boolean: Set to True if your application will support Exhibition mode. Only available in webOS 2.x+ | true |
| icon | No | This is a file path relative to the appinfo.json file. The default is icon.png. | "myicon.png" |
| id | Yes | This is the ID for this application. Every application has a unique ID, created from reverse DNS naming conventions. The launcher uses the ID to uniquely identify your application and displays it with the title above. The application ID is unique, set once, and cannot be changed after publishing the application. | "com.newco.app.myApp" |
| keywords | No | Array of keywords to locate your application using Just Type/Universal Search | "messaging", "facebook", "chat" |
| main | Yes | The launch point for the app. This is a file path relative to the appinfo.json file and needs to point to an HTML file. It defaults to index.html. | "index.html" |
| miniicon | No | Used for notifications. This is a file path relative to the appinfo.json file. The default is miniicon.png. | "mini-icon.png" |
| noDeprecatedStyles | No | When set to true, suppresses loading of the global-deprecated.css style sheet, slightly improving the framework load time. | true |
| noWindow | No | Is this app a headless app? (default is false). Allowed values are true or false. | false |
| plug-ins | No | Boolean: Set to True if your application requires the use of hybrid Plugins. Only available in webOS 2.x+ | true |
| requiredMemory | Depends | Required for native apps, not used for web or plugin apps. Maximum amount of memory required to operate in megabytes | 48 |
| splashicon | No | Icon to be shown during launch | icon-256×256.png |
| splashBackground | No | Background to be shown during launch, not available in webOS 3.x | images/splash-screenshot-default.png |
| tapToShareSupported | No | Set to true if your app wishes to make use of the Touch2Share feature via the Seamless Transitions service - com.palm.stservice. | true |
| theme | No | When set to "light" the dark CSS styles are not loaded, slightly improving the framework load time. | "dark" |
| title | Yes | The title of the application as it shows in the Launcher and the app window. The application title is unique, set once, and cannot be changed after publishing the application. | "myApp" |
| type | Yes | Identifies the type of application. Options are "web" for pure web or hybrid web/pdk apps, or "pdk" for pure native apps | "web" |
| uiRevision | No | Only useful value at the moment is 2, which signifies that the app should run full screen on a TouchPad, otherwise it will run in a phone-window | 2 |
| universalSearch | No | JSON object identifying the Just Type / Universal Search configuration for this application | See Below |
| vendor | Yes | A string representing the maker of the application. This is used in the launcher and deviceinfo dialogs. | "newco" |
| vendorurl | No | A string representing a URL that turns the vendor portion in deviceinfo dialogs to hyperlinks. | |
| version | Yes | The application version number, in the format ... The major, minor, and revision numbers are all mandatory non-negative integers. Leading zeros are stripped. The major, minor, and revision numbers are discrete. For example, 1.5.3 is a lower version than 1.15.3. After uploading an application, the same version cannot be uploaded again. To update and re-upload an application, you must increase the version number. | "1.0.3" |
Note: If you don't specify miniicon in appinfo.json, webOS will use a scaled black & white version of your app icon for notifications. If you want a color icon for notifications, specify miniicon (16x16).
Automatic Help Scene
As of webOS 1.3.1 you can include information in the appinfo.json file which will automatically generate a help scene for your app. The help scene is pushed via a call to pushAppSupportInfoScene. This is probably not supported in webOS 3.x, as the Mojo framework is deprecated.
Example help information:
"support": {
"url": "http://support.mycompany.com",
"email": {
"address": "support@mycompany.com",
"subject": "Support"
},
"phone": "555-555-5555",
"resources": [
{
"type": "scene",
"label": "Help Topics",
"sceneName": "topics"
},
{
"type": "web",
"label": "Discussion Forums",
"url": "http://forums.mycompany.com/"
}
]
}
Example call:
this.controller.stageController.pushAppSupportInfoScene();
Universal Search
Coming soon. For now, visit the HP-Palm webOS doc page for appinfo.json at:
