app

The sos.management.app API groups together methods for managing the signageOS application installed on the system.

Methods

getType()

The getType() method returns type of the platform the application is running on.

info

If you need to get specific Android brand or Raspberry Pi model, use the sos.management.firmware.getType().

getType(): Promise<AppType>;

getVersion()

The getVersion() method returns version of the application currently running.

info

This API is only available for Applets deployed via Timing from Box or REST API.

getVersion(): Promise<string>;

upgrade(appUri)

The upgrade(appUri) method upgrades the signageOS application with provided appUri. Open users can upgrade app passing FQN uri where the application main file is located.

This file type/extension differs for every platform. E.g.:

• SSSP: http://example.com/apps/sssp_config.xml or http://example.com/apps/ApplicationName.zip
• Tizen: http://example.com/apps/sssp_config.xml or http://example.com/apps/ApplicationName.wgt
• Webos 1, 2: http://example.com/apps/ApplicationName.zip
• Webos 3+: http://example.com/apps/ApplicationName.ipk
• Brightsign: http://example.com/apps/ApplicationName.zip
• Linux: http://example.com/apps/ApplicationName.apk
• Android: http://example.com/apps/ApplicationName.apk

upgrade(appUri: string): Promise<void>;

Params

Name	Type	Required	Description
appUri	string	Yes	FQN uri where the application main file is located.

upgrade(baseUrl, version)

The upgrade(baseUrl, version) does the same as upgrade(version, baseUrl).

upgrade(baseUrl: string, version: string): Promise<void>;

Params

Name	Type	Required	Description
baseUrl	string	Yes	The server URL where application files are located.
version	string	Yes	The version of the application being installed.

upgrade(version, baseUrl)

The upgrade(version, baseUrl?) method upgrades the signageOS application using version and baseUrl. Platform users can install general application version directly with passing just version number. Optionally, the baseUrl can be passed as argument to specify server where the application files are accessible.

upgrade(version: string, baseUrl?: string): Promise<void>;

Params

Name	Type	Required	Description
version	string	Yes	The version of the application being installed.
baseUrl	string	No	Optional server URL where application files are located. (Default value: "https://2.signageos.io")