/Qt 5.11

PluginParameter QML Type

The PluginParameter type describes a parameter to a Plugin. More...

Import Statement: import QtLocation 5.11
Since: QtLocation 5.5


Detailed Description

The PluginParameter object is used to provide a parameter of some kind to a Plugin. Typically these parameters contain details like an application token for access to a service, or a proxy server to use for network access.

To set such a parameter, declare a PluginParameter inside a Plugin object, and give it name and value properties. A list of valid parameter names for each plugin is available from the plugin reference pages.

Example Usage

The following example shows an instantiation of the HERE plugin with a mapping API app_id and token pair specific to the application.

Plugin {
    name: "here"
    PluginParameter { name: "here.app_id"; value: "EXAMPLE_API_ID" }
    PluginParameter { name: "here.token"; value: "EXAMPLE_TOKEN_123" }

Property Documentation

name : string

This property holds the name of the plugin parameter as a single formatted string. This property is a write-once property.

value : QVariant

This property holds the value of the plugin parameter which support different types of values (variant). This property is a write-once property.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.