PluginParameter QML Type

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

Import Statement: import QtLocation 5.3
Since: Qt Location 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.

value : QVariant

This property holds the value of the plugin parameter which support different types of values (variant).

© 2017 The Qt Company Ltd. 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.