Skip to content

AppManagement

AppManagement service implementation.

AppManagement

Bases: ONVIFService

0.0.1 19.12

AppManagement service client.

Property Details
First introduced ONVIF 19.12 (December 2019)
Binding name AppManagementBinding (ver10/appmgmt/wsdl/appmgmt.wsdl)
Operations appmgmt.wsdl
Spec AppMgmt

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the app management service.

Output
  • Capabilities [Capabilities]
    The capabilities of the service.
    • FormatsSupported - optional; [StringAttrList]
      List of supported app container formats that can be uploaded via this service.
    • Licensing - optional; [boolean]
      Signals support for licensing of applications.
    • UploadPath - optional; [anyURI]
      Path part of the URI to which applications can be uploaded via http POST. Clients shall use protocol, hostname and port of the service address since the device may e.g. reside behind NAT translation firewall.
    • EventTopicPrefix - optional; [string]
      Optional Event Topic prefix used when delivering app events in eventservice.

Uninstall 

Uninstall(AppID)

Removes an app from a device.

This method shall return immedeiately and not wait until the application is completely removed. On completion or failure the method shall generate an UninstallCompletion event.

Input
  • AppID [string]
    App to be uninstalled. Possible failures during deinstallation will be delivered via an event.

GetInstalledApps 

GetInstalledApps()

List installed apps on the device.

Output
  • App - optional, unbounded; [complexType]
    List of installed apps providing both user readable name and token.
    • Name [string]
    • AppID [string]

GetAppsInfo 

GetAppsInfo(AppID=None)

The caller may provide an application ID to retrieve the information for a single application.

If no application ID is provided the device shall report the information for all installed applications.

Input
  • AppID - optional; [string]
    Optional ID to only retrieve information for a single application.
Output
  • Info - optional, unbounded; [AppInfo]
    • AppID [string]
      Unique app identifier of the application instance.
    • Name [string]
      User readable application name
    • Version [string]
      Version of the installed application. The details of the format are outside of the scope of this specificaton.
    • Licenses - optional, unbounded; [LicenseInfo]
      Licenses associated with the application.
      • Name [string]
        Textual name of the license
      • ValidFrom - optional; [dateTime]
        Start time of validity
      • ValidUntil - optional; [dateTime]
        End time of validity
    • Privileges - optional, unbounded; [string]
      List of privileges granted to the application.
    • InstallationDate [dateTime]
      Date and time when the application has been installed.
    • LastUpdate [dateTime]
      Time of last update to this app, i.e. the time when this particular version was installed.
    • State [AppState]
      InstallationFailed state shall not be used here.
      Enum Value Enum Description
      Active —
      Inactive —
      Installing —
      Uninstalling —
      Removed —
      InstallationFailed —
    • Status [string]
      Supplemental information why the application is in the current state. In error cases this field contains the error reason.
    • Autostart [boolean]
      If set the application will start automatically after booting of the device.
    • Website [anyURI]
      Link to supplementary information about the application or its vendor.
    • OpenSource - optional; [anyURI]
      Link to a list of open source licenses used by the application.
    • Configuration - optional; [anyURI]
      Optional Uri for backup and restore of the application configuration.
    • InterfaceDescription - optional, unbounded; [anyURI]
      Optional reference to the interface definition of the application.

Activate 

Activate(AppID)

Starts an application.

Input
  • AppID [string]
    App identifier.

Deactivate 

Deactivate(AppID)

Stops an application.

Input
  • AppID [string]
    App identifier.

InstallLicense 

InstallLicense(License, AppID=None)

Installs a license to the device.

If the device requires PerApp licensing than the AppID parameter shall be provided.

Input
  • AppID - optional; [string]
    Application the license shall be associated to.
  • License [string]
    Opaque machine readable license string.

GetDeviceId 

GetDeviceId()

Get the unique device id to which the licenses are issued.

Output
  • DeviceId [string]