PluginParameter QML Type

The PluginParameter type describes a parameter for a plugin, either geoservice Plugin, or position plugin. More...

Import Statement: import QtPositioning 5.15
Since: QtPositioning 5.14


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, or the serial port to which a serial GPS receiver is connected.

To set such a parameter, declare a PluginParameter inside an element that accepts plugin parameters as configuration objects, such as a Plugin object, or a PositionSource object, and give it name and value properties. A list of valid parameter names for each plugin is available from the plugin reference pages for geoservice plugins, and Qt Positioning plugins#Default plugins for position plugins.

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.