summaryrefslogtreecommitdiff
path: root/src/location/doc/src/plugins/nokia.qdoc
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@digia.com>2015-05-22 14:04:55 +0200
committerAlex Blasche <alexander.blasche@theqtcompany.com>2015-05-27 12:14:36 +0000
commitdf1b7cc4c9b423c730354925bd35cc8bca63c6ca (patch)
treee3a989f1f47855eabdaa6ce8caa980742242f447 /src/location/doc/src/plugins/nokia.qdoc
parent445c799514388ae15bc513419a48461a6c7bd573 (diff)
downloadqtlocation-df1b7cc4c9b423c730354925bd35cc8bca63c6ca.tar.gz
Add "here" prefix to all Here geoservices parameters
Task-number: QTBUG-42151 Change-Id: I3d71ee77327478dfdda23af709bee489f83bb9f6 Reviewed-by: Michal Klocek <michal.klocek@theqtcompany.com> Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src/location/doc/src/plugins/nokia.qdoc')
-rw-r--r--src/location/doc/src/plugins/nokia.qdoc38
1 files changed, 21 insertions, 17 deletions
diff --git a/src/location/doc/src/plugins/nokia.qdoc b/src/location/doc/src/plugins/nokia.qdoc
index 296cab06..f1a6828a 100644
--- a/src/location/doc/src/plugins/nokia.qdoc
+++ b/src/location/doc/src/plugins/nokia.qdoc
@@ -56,10 +56,10 @@ The following table lists mandatory parameters that \e must be passed to the HER
\li Parameter
\li Description
\row
- \li app_id
+ \li here.app_id
\li Client \e app_id part of the app_id/token pair used for authentication by all managers.
\row
- \li token
+ \li here.token
\li Client \e token part of the app_id/token pair for the service used for authentication by all managers.
\endtable
@@ -69,46 +69,50 @@ application with the HERE services. To obtain an application id and token pair
\section2 Optional parameters
The following table lists optional parameters that can be passed to the HERE plugin.
+
+\note Since Qt 5.5 all parameters below must be prefixed with \c here. Previous versions did not require
+a prefix.
+
\table
\header
\li Parameter
\li Description
\row
- \li proxy
+ \li here.proxy
\li Proxy server URL used by all managers. For usage of the system proxy just pass "system" as value.
\note See the notes in \l{QNetworkProxyFactory::systemProxyForQuery()} for further information.
\row
- \li mapping.host
+ \li here.mapping.host
\li Base map tile service URL used by mapping manager.
\row
- \li mapping.host.aerial
+ \li here.mapping.host.aerial
\li Aerial map tile service URL used by mapping manager. For all satellite, hybrid and terrain schemes.
\row
- \li mapping.cache.directory
+ \li here.mapping.cache.directory
\li Absolute path to map tile cache directory used as network disk cache.
Default place for the cache is "QtLocation" directory in \l {QStandardPaths::writableLocation()} {QStandardPaths::writableLocation}(\l{QStandardPaths::GenericCacheLocation}).
\row
- \li mapping.cache.disk.size
+ \li here.mapping.cache.disk.size
\li Map tile disk cache size in bytes. Default size of the cache is 20MB.
\row
- \li mapping.cache.memory.size
+ \li here.mapping.cache.memory.size
\li Map tile memory cache size in bytes. Default size of the cache is 3MB.
\row
- \li mapping.cache.texture.size
+ \li here.mapping.cache.texture.size
\li Map tile texture cache size in bytes. Default size of the cache is 6MB. Note that the texture cache has a hard minimum size which depends on the size of the map viewport (it must contain enough data to display the tiles currently visible on the display). This value is the amount of cache to be used in addition to the bare minimum.
\row
- \li geocoding.host
+ \li here.geocoding.host
\li Geocoding service URL used by geocoding manager.
\row
- \li routing.host
+ \li here.routing.host
\li Routing service URL used by routing manager.
\row
- \li places.host
+ \li here.places.host
\li Search service URL used by search manager.
\row
- \li places.api_version
+ \li here.places.api_version
\li Version of the REST API used by the places manager. Currently versions 1 and 2 are
supported. The version 1 is deprecated and will not be part of the final Qt release. The default is version 2.
\endtable
@@ -124,8 +128,8 @@ authentication.
\code
Plugin {
name: "here"
- PluginParameter { name: "app_id"; value: "myapp" }
- PluginParameter { name: "token"; value: "abcdefg12345" }
+ PluginParameter { name: "here.app_id"; value: "myapp" }
+ PluginParameter { name: "here.token"; value: "abcdefg12345" }
}
\endcode
@@ -133,8 +137,8 @@ Plugin {
\code
QMap<QString,QVariant> params;
-params["app_id"] = "myapp";
-params["token"] = "abcdefg12345";
+params["here.app_id"] = "myapp";
+params["here.token"] = "abcdefg12345";
QGeoServiceProvider *gsp = new QGeoServiceProvider("here", params);
\endcode