ApplicationObject QML Type

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

Import Statement: import QtApplicationManager.SystemUI 2.0

Properties

Signals

Methods

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

Detailed Description

Each instance of this class represents a single application known to the application manager.

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

Items of this type are not creatable from QML code. Only functions and properties of ApplicationManager and ApplicationModel will return pointers to this class.

Make sure to not save references to an ApplicationObject across function calls: packages (and with that, the applications contained within) can be deinstalled at any time, invalidating your reference. In case you do need a persistent handle, use the id string.

Property Documentation

[read-only] alias : bool

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

This was used to distinguish between application aliases, which have been replaced by the intents mechanism.

Always returns false.


[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] blocked : bool

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use PackageObject::version.


[read-only] builtIn : bool

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use PackageObject::builtIn


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

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use PackageObject::categories.


[read-only] codeDir : string

The absolute path to the application's installation directory.


[read-only] documentUrl : string

This was used to distinguish between application aliases, which have been replaced by the intents mechanism.

Always returns an empty string.


[read-only] icon : url

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use PackageObject::icon


[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

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

This was used to distinguish between application aliases, which have been replaced by the intents mechanism.

Always returns the ApplicationObject itself.


[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 method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use PackageObject::state.


[read-only] supportedMimeTypes : list<string>

An array of MIME types the application can handle.


[read-only] version : string

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use PackageObject::version.


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.

Note: The corresponding handler is onActivated.


Method Documentation

bool debug(string 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(string language)

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use the PackageObject::names property.

Returns the name of the application in the given language.


bool start(string 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(bool 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.