App
Management API app lets you check application type and upgrade the application.
All methods
| Method | Description | Supported since |
|---|---|---|
getType() | Information about the platform your application is running on (eg. Tizen) | |
getVersion() | Information about current version of your application is running on the device (eg. 2.0.5) | |
upgrade() | Upgrade/Downgrade the Core App |
getType()
Method getType() returns the display type of application on the device.
await sos.management.app.getType(); // Returns ex. sssp, android
Returns one of the following types:
androidbrightsigndefault(Emulator)linux(Raspberry Pi)sssptizenweboswindows
If you need to get specific Android brand or Raspberry Pi model, use the Firmware API getType().
getVersion()
Method getVersion() returns the version of Core App application on the device.
This API is only available for Applets deployed via Timing from Box or REST API.
await sos.management.app.getVersion(); // Returns ex. 2.0.0
upgrade()
Method upgrade() will upgrade the Core App on the device.
A) Upgrading signageOS Core App
To upgrade to signageOS Core App, use the following parameters:
| Param | Type | Value | Description |
|---|---|---|---|
baseUrl | String | https://cdn.your-cms.com/tizen/ | Location of the new version of the Core App |
version | String | x.x.x | Core App version |
Javascript example
await sos.management.app.upgrade('https://example.com/signageos-core-app.zip', '2.0.0');
B) Upgrading Open Core App with built-in Applet
If you are building your own Core App with the built-in Applet, use only one parameter absolutePathUrl.
The absolutePathUrl should point to the application file, e.g. https://cdn.your-cms.com/rpi/linux_202006100815_1.0.1_779c303408.zip.
| Param | Type | Value | Description |
|---|---|---|---|
absolutePathUrl | String | https://cdn.your-cms.com/rpi/linux_xxx.zip | Location of the new version of the Open Core App with built-in Applet |
Javascript example
await sos.management.app.upgrade('https://cdn.your-cms.com/rpi/linux_xxx.zip');
Because each of the platforms (Tizen, webOS, BrightSign, etc.) are different, use the following table to define correct absolutePathUrl:
| Platform | absolutePathUrl | Note |
|---|---|---|
| Tizen | https://cdn.your-cms.com/core-apps/landscape https://cdn.your-cms.com/core-apps/portrait | |
| SSSP | https://cdn.your-cms.com/core-apps/landscape_full-hd https://cdn.your-cms.com/core-apps/portrait_full-hd | |
| webOS | https://cdn.your-cms.com/core-apps/com.lg.app.signage_latest.ipk https://cdn.your-cms.com/core-apps/com.lg.app.signage_latest.zip | .zip is for old webOS 1.0 and 2.0 only |
| Android | https://cdn.your-cms.com/core-apps/io.signageos.open_3.1.0.android.apk | If you are building for specific version of Android (e.g. Benq) you will have a BenQ specific apk |
| BrightSign | https://cdn.your-cms.com/core-apps/display-brightsign.zip | |
| NEC / RPi | https://cdn.your-cms.com/core-apps/linux_202006100815_1.0.1_779c303408.zip |