Application QML Type

The handle for an application known to the ApplicationManager. More...

Import Statement: import QtApplicationManager 1.0

Properties

Signals

Detailed Description

Most of the read-only properties map directly to values read from the application's info.yaml file - these are documented in the Manifest Definition.

Note: There is an unfortunate naming conflict with the (undocumented) Application object returned from Qt.application. If you want to use the enums defined in the application-manager's Application class, you need to use an alias import:

import QtApplicationManager 1.0 as AppMan

...

if (app.lastExitStatus == AppMan.Application.NormalExit)
    ...

Property Documentation

[read-only] alias : bool

Will return true if this Application object is an alias to another one.


[read-only] applicationProperties : object

All user-defined properties of this application as listed in the private and protected sections of the applicationProperties field in the manifest file.


[read-only] backgroundMode : enumeration

Specifies if and why the application needs to be kept running in the background - can be one of:

  • Application.Auto - The application does not care.
  • Application.Never - The application should not be kept running in the background.
  • Application.ProvidesVoIP - The application provides VoIP services while in the background.
  • Application.PlaysAudio - The application plays audio while in the background.
  • Application.TracksLocation - The application tracks the current location while in the background.

By default, the background mode is Auto. This is just a hint for the System-UI - the application-manager itself will not enforce this policy.


[read-only] builtIn : bool

This property describes, if this application is part of the built-in set of applications of the current System-UI.


[read-only] capabilities : list<string>

A list of special access rights for the application - these capabilities can later be queried and verified by the middleware via the application-manager.


[read-only] categories : list<string>

A list of category names the application should be associated with. This is mainly for the automated app-store uploads as well as displaying the application within a fixed set of categories in the System-UI.


[read-only] codeDir : string

The absolute path to the application's installation directory. Please note this directory might not always be available for applications that were installed onto removable media.

See also Installation Locations.


[read-only] documentUrl : string

This property always returns the default documentUrl specified in the manifest file, even if a different URL was used to start the application.


[read-only] icon : url

The URL of the application's icon - can be used as the source property of an Image.


[read-only] id : string

This property returns the unique id of the application.


[read-only] importance : real

A value between 0.0 and 1.0 specifying the inverse probability of being terminated in out-of-memory situations (the default is 0.0 - unimportant).


[read-only] lastExitCode : int

This property holds the last exit-code of the application's process in multi-process mode. On successful application shutdown, this value should normally be 0, but can be whatever the application returns from its main() function.


[read-only] lastExitStatus : enumeration

This property returns the last exit-status of the application's process in multi-process mode.

  • Application.NormalExit - The application exited normally.
  • Application.CrashExit - The application crashed.
  • Application.ForcedExit - The application was killed by the application-manager, since it ignored the quit request originating from a call to ApplicationManager::stopApplication.

See also ApplicationInterface::quit and ApplicationInterface::acknowledgeQuit.


[read-only] nonAliased : Application

If this Application object is an alias, then you can access the non-alias, base Application object via this property.


[read-only] preload : bool

When set to true, the application-manager tries to start the application immediately after boot, but keeps it in the background.


[read-only] runtime : Runtime

Will return a valid Runtime object, if the application is currently starting, running or shutting down. May return a null object, if the application was not yet started.


[read-only] runtimeName : string

This property holds the name of the runtime, necessary to run the application's code.


[read-only] runtimeParameters : object

This property holds a QVariantMap that is passed onto, and interpreted by the application's runtime.


[read-only] state : enumeration

This property holds the current installation state of the application. It can be one of:

  • Application.Installed - The application is completely installed and ready to be used.
  • Application.BeingInstalled - The application is currently in the process of being installed.
  • Application.BeingUpdated - The application is currently in the process of being updated.
  • Application.BeingRemoved - The application is currently in the process of being removed.

[read-only] supportedMimeTypes : list<string>

An array of MIME types the application can handle.


[read-only] version : string

Holds the version of the application as a string.


Signal Documentation

activated()

This signal is emitted when the application is started or when it's already running but has been requested to be brought to foreground or raised.


© 2018 Pelagicore AG. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.