ApplicationIPCManager QML Type

Registers an IPC interface object to extend the communication API between applications and the Application Manager itself. The interface object is an ApplicationIPCInterface item, that needs to stay valid during the whole lifetime of the System UI. The name of the interface has to adhere to D-Bus standards, so it needs to contain at least one period ('.') character (for example, io.qt.test). The interface is available to all applications matching the filter criteria (see below) on the private Peer-To-Peer D-Bus as a standard, typed D-Bus interface.

Because there is no way to add type information to the parameters of JavaScript functions, the interface is scanned for special annotation properties that are only used to deduce type information, but are not exported to the applications:

readonly property var _decltype_<function-name>: { "<return type>": [ "<param 1 type>", "<param 2 type>", ...] }

The following types are supported:

A simple example showing how to add these annotations to a function definition:

readonly property var _decltype_testFunction: { "var": [ "int", "string" ] }
function testFunction(ivar, strvar) {
    return { "strvar": strvar, "intvar": intvar }
}

You can restrict the availability of the interface in applications via the filter parameter: either pass an empty JavaScript object ({}) or use any combination of these available field names:

All of the filter fields have to match, but only fields that are actually set are taken into consideration.

import QtQuick 2.0
import QtApplicationManager.SystemUI 2.0

ApplicationIPCInterface {
    id: extension

    property bool pbool: true
    property double pdouble: 3.14

    signal testSignal(string str, variant list)

    readonly property var _decltype_testFunction: { "void": [ "int", "string" ] }
    function testFunction(foo, bar) {
        console.log("testFunction was called: " + foo + " " + bar)
    }

    Component.onCompleted: {
        ApplicationIPCManager.registerInterface(extension, "io.qt.test.interface",
                                                { "capabilities": [ "media", "camera" ] })
    }
}

Returns true if the registration was successful, false otherwise.