| Name | Description | Type | Use |
|---|---|---|---|
| url | The URL address of the application. | string |
required |
| localUrl | The application's initial location, used when installing it for the first time in the preloaded OTA web application mode. | string |
optional |
| id | The application's unique identifier. | string |
optional |
| name | The application's name. | string |
required |
| icon | Data URI containing a Base64-encoded image in the PNG format. | string |
required |
| version | The version of the application. | string |
optional |
| displayVersion | The version of the application shown to its users. | string |
optional |
| description | The description of the application. | string |
required |
| copyright | The copyright disclaimer. | string |
optional |
| state | The application's current state. The state parameter can take one of the
values presented in the table below. |
string |
optional |
| notCached | The application's caching status. If the value is "true", the application failed to populate the client's cache when it was downloaded. | boolean |
optional |
On Android and iOS, if the id and version
parameters are set, the web application descriptor file can be omitted when installing a web
application. Example:
launchbox.ApplicationManager.installApplications([{ url: applicationURL, version: "1.0.0", id: "webapplication-id" }]);The client may refer to the Application object quoting the
following parameters only: url, name. The profile service needs to
provide the following parameters: url, name,
description and icon.
The object can be in one of the following states:
| State | Description |
|---|---|
| installing | The application is in the process of installing. |
| ready | The application has been installed. |
| updating | The application is in the process of updating. |
| starting | The application is in the process of starting. |
| started | The application has been started. |
| failed | Thrown when the installation or update fails. |