ApplicationObject QML Type

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

Import Statement: import QtApplicationManager.SystemUI 2.0

Properties

Signals

Methods

  • bool debug(debugWrapper, string document)
  • string name(language)
  • bool start(document)
  • stop(forceKill)

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.

Property Documentation

[read-only] alias : bool

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

See also nonAliased.


[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] 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] 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.

  • Am.NormalExit - The application exited normally.
  • Am.CrashExit - The application crashed.
  • Am.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 : ApplicationObject

If this ApplicationObject is an alias, then you can access the non-alias, base ApplicationObject via this property, otherwise it contains a reference to itself. This means that if you're interested in accessing the base application regardless of whether the object at hand is just an alias, you can always safely refer to this property.

If you want to know whether this object is an alias or a base ApplicationObject, use ApplicationObject::alias instead.


[read-only] runState : enumeration

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

  • Am.NotRunning - the application has not been started yet.
  • Am.StartingUp - the application has been started and is initializing.
  • Am.Running - the application is running.
  • Am.ShuttingDown - the application has been stopped and is cleaning up (in multi-process mode this state is only reached, if the application is terminating gracefully).

[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:

  • ApplicationObject.Installed - The application is completely installed and ready to be used.
  • ApplicationObject.BeingInstalled - The application is currently in the process of being installed.
  • ApplicationObject.BeingUpdated - The application is currently in the process of being updated.
  • ApplicationObject.BeingDowngraded - The application is currently in the process of being downgraded. That can only happen for a built-in application that was previously upgraded. It will then be brought back to its original, built-in, version and its state will go back to ApplicationObject.Installed.
  • ApplicationObject.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.


Method Documentation

bool debug(debugWrapper, string document)

Same as start() with the difference that it is started via the given debugWrapper. The optional argument document will be supplied to the application as is - most commonly this is used to refer to a document to display.

Please see the Debugging page for more information on how to setup and use these debug-wrappers.

Returns a bool value indicating success. See the full documentation at ApplicationManager::debugApplication for more information.


string name(language)

Returns the name of the application in the given language, as provided in the the info.yaml file.


bool start(document)

Starts the application. The optional argument document will be supplied to the application as is - most commonly this is used to refer to a document to display.

Returns a bool value indicating success. See the full documentation at ApplicationManager::startApplication for more information.


stop(forceKill)

Stops the application. The meaning of the forceKill parameter is runtime dependent, but in general you should always try to stop an application with forceKill set to false first in order to allow a clean shutdown. Use forceKill set to true only as a last resort to kill hanging applications.

See also ApplicationManager::stopApplication.


© 2019 Luxoft Sweden AB. 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.