/usr/share/qt5/doc/qtlocation/location-plugin-here.html is in qtlocation5-doc-html 5.5.1-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- nokia.qdoc -->
<title>Qt Location HERE Plugin | Qt Location 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtlocation-index.html">Qt Location</a></li>
<li>Qt Location HERE Plugin</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#overview">Overview</a></li>
<li class="level1"><a href="#parameters">Parameters</a></li>
<li class="level2"><a href="#mandatory-parameters">Mandatory parameters</a></li>
<li class="level2"><a href="#optional-parameters">Optional parameters</a></li>
<li class="level1"><a href="#parameter-usage-example">Parameter Usage Example</a></li>
<li class="level2"><a href="#qml">QML</a></li>
<li class="level2"><a href="#c">C++</a></li>
<li class="level1"><a href="#places">Places</a></li>
<li class="level2"><a href="#capabilities">Capabilities</a></li>
<li class="level2"><a href="#plugin-specific-behaviors-and-limitations">Plugin Specific Behaviors and Limitations.</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Location HERE Plugin</h1>
<span class="subtitle"></span>
<!-- $$$location-plugin-here.html-description -->
<div class="descr"> <a name="details"></a>
<a name="overview"></a>
<h2 id="overview">Overview</h2>
<p>Included with Qt Location is a geo services plugin which accesses the relevant HERE services provided by HERE/Nokia. The use of these services is governed by the terms and conditions available at <a href="https://developer.here.com/terms-conditions">https://developer.here.com/terms-conditions</a>.</p>
<p>Note that accepting the terms and conditions only applies those terms and conditions to the use of the HERE geo services plugin and does not limit the use of the other geo services plugins that may be included with Qt.</p>
<p>The HERE geo services plugin can be loaded by using the plugin key "here".</p>
<p>The online plugin uses the tiled map classes, which caches tile data in heap memory and texture memory.</p>
<a name="parameters"></a>
<h2 id="parameters">Parameters</h2>
<a name="mandatory-parameters"></a>
<h3 >Mandatory parameters</h3>
<p>The following table lists mandatory parameters that <i>must</i> be passed to the HERE plugin.</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Parameter</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >here.app_id</td><td >Client <i>app_id</i> part of the app_id/token pair used for authentication by all managers.</td></tr>
<tr valign="top" class="even"><td >here.token</td><td >Client <i>token</i> part of the app_id/token pair for the service used for authentication by all managers.</td></tr>
</table></div>
<p>The HERE geo services plugin requires an application id and token pair to authenticate the application with the HERE services. To obtain an application id and token pair visit <a href="https://developer.here.com/">https://developer.here.com/</a></p>
<a name="optional-parameters"></a>
<h3 >Optional parameters</h3>
<p>The following table lists optional parameters that can be passed to the HERE plugin.</p>
<p><b>Note: </b>Since Qt 5.5 all parameters below must be prefixed with <code>here</code>. Previous versions did not require a prefix.</p><div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Parameter</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >here.proxy</td><td >Proxy server URL used by all managers. For usage of the system proxy just pass "system" as value.<p><b>Note: </b>See the notes in <a href="../qtnetwork/qnetworkproxyfactory.html#systemProxyForQuery">QNetworkProxyFactory::systemProxyForQuery</a>() for further information.</p></td></tr>
<tr valign="top" class="even"><td >here.mapping.host</td><td >Base map tile service URL used by mapping manager.</td></tr>
<tr valign="top" class="odd"><td >here.mapping.host.aerial</td><td >Aerial map tile service URL used by mapping manager. For all satellite, hybrid and terrain schemes.</td></tr>
<tr valign="top" class="even"><td >here.mapping.cache.directory</td><td >Absolute path to map tile cache directory used as network disk cache.<p>The default place for the cache is <code>QtLocation/here</code> directory in <a href="../qtcore/qstandardpaths.html#writableLocation">QStandardPaths::writableLocation</a>(<a href="../qtcore/qstandardpaths.html#StandardLocation-enum">QStandardPaths::GenericCacheLocation</a>). On systems that have no concept of a shared cache, the application-specific <a href="../qtcore/qstandardpaths.html#StandardLocation-enum">QStandardPaths::CacheLocation</a> is used instead.</p>
</td></tr>
<tr valign="top" class="odd"><td >here.mapping.cache.disk.size</td><td >Map tile disk cache size in bytes. Default size of the cache is 20MB.</td></tr>
<tr valign="top" class="even"><td >here.mapping.cache.memory.size</td><td >Map tile memory cache size in bytes. Default size of the cache is 3MB.</td></tr>
<tr valign="top" class="odd"><td >here.mapping.cache.texture.size</td><td >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.</td></tr>
<tr valign="top" class="even"><td >here.geocoding.host</td><td >Geocoding service URL used by geocoding manager.</td></tr>
<tr valign="top" class="odd"><td >here.routing.host</td><td >Routing service URL used by routing manager.</td></tr>
<tr valign="top" class="even"><td >here.places.host</td><td >Search service URL used by search manager.</td></tr>
<tr valign="top" class="odd"><td >here.places.api_version</td><td >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.</td></tr>
</table></div>
<a name="parameter-usage-example"></a>
<h2 id="parameter-usage-example">Parameter Usage Example</h2>
<p>The following two examples show how to create a HERE plugin instance with parameters supplied for an application id and token, which is required for authentication.</p>
<a name="qml"></a>
<h3 >QML</h3>
<pre class="cpp">Plugin {
name: <span class="string">"here"</span>
PluginParameter { name: <span class="string">"here.app_id"</span>; value: <span class="string">"myapp"</span> }
PluginParameter { name: <span class="string">"here.token"</span>; value: <span class="string">"abcdefg12345"</span> }
}</pre>
<a name="c"></a>
<h3 >C++</h3>
<pre class="cpp"><span class="type"><a href="../qtcore/qmap.html">QMap</a></span><span class="operator"><</span><span class="type"><a href="../qtcore/qstring.html">QString</a></span><span class="operator">,</span><span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span><span class="operator">></span> params;
params<span class="operator">[</span><span class="string">"here.app_id"</span><span class="operator">]</span> <span class="operator">=</span> <span class="string">"myapp"</span>;
params<span class="operator">[</span><span class="string">"here.token"</span><span class="operator">]</span> <span class="operator">=</span> <span class="string">"abcdefg12345"</span>;
<span class="type"><a href="qgeoserviceprovider.html">QGeoServiceProvider</a></span> <span class="operator">*</span>gsp <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qgeoserviceprovider.html">QGeoServiceProvider</a></span>(<span class="string">"here"</span><span class="operator">,</span> params);</pre>
<a name="places"></a>
<h2 id="places">Places</h2>
<p>The HERE provider remotely accesses places (read-only) from a REST based server. The specific capabilities and behaviours are outlined below:</p>
<a name="capabilities"></a>
<h3 >Capabilities</h3>
<div class="table"><table class="generic">
<tr valign="top" class="odd"><td >Storage</td><td >remote</td></tr>
<tr valign="top" class="even"><td >Read/Write</td><td >read-only</td></tr>
<tr valign="top" class="odd"><td >Icons</td><td >yes</td></tr>
<tr valign="top" class="even"><td >Search term suggestions</td><td >yes</td></tr>
<tr valign="top" class="odd"><td >Recommendations</td><td >yes</td></tr>
<tr valign="top" class="even"><td >Category structure</td><td >Hierarchical</td></tr>
<tr valign="top" class="odd"><td >(Rich) Content images</td><td >yes</td></tr>
<tr valign="top" class="even"><td >(Rich) Content reviews</td><td >yes</td></tr>
<tr valign="top" class="odd"><td >(Rich) Content editorials</td><td >yes</td></tr>
<tr valign="top" class="even"><td >All details fetched during search</td><td >no</td></tr>
<tr valign="top" class="odd"><td >Paging offset index</td><td >no</td></tr>
<tr valign="top" class="even"><td >Paging limit</td><td >yes</td></tr>
<tr valign="top" class="odd"><td >Distance relevance hint</td><td >no</td></tr>
<tr valign="top" class="even"><td >Lexical name relevance hint</td><td >no</td></tr>
<tr valign="top" class="odd"><td >Extended Attributes</td><td >yes</td></tr>
<tr valign="top" class="even"><td >Notifications for added/removed places/categories</td><td >no</td></tr>
<tr valign="top" class="odd"><td >visibility scopes</td><td >public</td></tr>
<tr valign="top" class="even"><td >favorites matching/(usable as favoritesPlugin)</td><td >no</td></tr>
</table></div>
<a name="plugin-specific-behaviors-and-limitations"></a>
<h3 >Plugin Specific Behaviors and Limitations.</h3>
<a name="search"></a>
<h4 >Search</h4>
<p>The following list shows what core place data is returned during a place search:</p>
<ul>
<li>name</li>
<li>location</li>
<li>contact information</li>
<li>attribution</li>
<li>categories</li>
<li>rating</li>
<li>visibility</li>
</ul>
<p>The following list shows further details that may be retrieved via QPlaceManager::getDetails()</p>
<ul>
<li>supplier</li>
<li>extended attributes</li>
</ul>
<a name="searching-for-places"></a>
<h4 >Searching for Places</h4>
<a name="search-term-and-categories"></a>
<h5 >Search Term and Categories</h5>
<p>The HERE plugin supports searching with a <i>search term</i> and <i>category or categories</i>, however both are not supported simultaneously.</p>
<ul>
<li>Valid usage: <i>search term</i> + <i>search center</i></li>
<li>Valid usage: <i>category</i> + <i>search center</i></li>
<li>Invalid usage: <i>search term</i> + <i>category</i> + <i>search center</i></li>
</ul>
<p>This limitation applies when using the HERE plugin with <a href="qml-qtlocation-placesearchmodel.html">PlaceSearchModel</a> and <a href="qplacemanager.html#search">QPlaceManager::search</a>().</p>
<a name="search-area"></a>
<h5 >Search Area</h5>
<p>The HERE plugin only supports provision of a <i>search center</i> when searching for places via <a href="qml-qtlocation-placesearchmodel.html">PlaceSearchModel</a> and <a href="qplacemanager.html#search">QPlaceManager::search</a>(). A search center can be provided via a bounding circle, however the radius should be kept at the default value of -1. Typically a developer should not have to set the radius at all. If a developer sets a radius, it is ignored by the plugin and the boundaries are not honored.</p>
<p>In a similar manner only the center of a bounding box is taken into consideration when searching. The boundaries of the box are not honored.</p>
<p>A search center <i>must</i> be provided for all searches.</p>
<a name="relevancy-hints"></a>
<h5 >Relevancy Hints</h5>
<p>The HERE plugin does not support relevancy hints. Any relevancy hints supplied to a search request are consequently ignored.</p>
<a name="search-term-suggestions"></a>
<h4 >Search Term suggestions</h4>
<p>Only a partial <i>search term</i> and <i>search center</i> is supported when retrieving suggestions. This limitation applies when using the HERE plugin with the <a href="qml-qtlocation-placesearchsuggestionmodel.html">PlaceSearchSuggestionModel</a> and <a href="qplacemanager.html#searchSuggestions">QPlaceManager::searchSuggestions</a>().</p>
<p>Both search term and search center <i>must</i> be provided when retrieving search term suggestions.</p>
<a name="recommendations"></a>
<h4 >Recommendations</h4>
<p>Only a given <i>place identifier</i> is supported as a parameter for a recommendations. No other parameters such as limit, offset, and search area are supported. This limitation applies when using the HERE plugin with <a href="qml-qtlocation-placesearchmodel.html">PlaceSearchModel</a> and <a href="qplacemanager.html#search">QPlaceManager::search</a>().</p>
<a name="extended-attributes"></a>
<h4 >Extended Attributes</h4>
<p>The supported set of attributes provided by the HERE plugin are not fixed and may grow over time. Also the attributes provided may vary according to a place by place basis, e.g one place may provide opening hours while another does not. At the time of writing, it is known that some places provide <code>openingHours</code> (<a href="qplaceattribute.html#OpeningHours-var">QPlaceAttribute::OpeningHours</a>) and <code>payment</code> (<a href="qplaceattribute.html#Payment-var">QPlaceAttribute::Payment</a>) methods but other attributes may be made available by the backend server. All places provided by the plugin will have the <code>x_provider</code> (<a href="qplaceattribute.html#Provider-var">QPlaceAttribute::Provider</a>) attribute set to <code>here</code>.</p>
<a name="restrictions-of-usage-extendedattributes-and-content"></a>
<h4 >Restrictions of Usage - ExtendedAttributes and Content</h4>
<p>The extended attributes and rich content of places are not permitted to be saved. For QML this is related to <a href="qml-qtlocation-place.html#extendedAttributes-prop">Place::extendedAttributes</a>, <a href="qml-qtlocation-imagemodel.html">ImageModel</a>, <a href="qml-qtlocation-reviewmodel.html">ReviewModel</a>, and <a href="qml-qtlocation-editorialmodel.html">EditorialModel</a>. For C++ this relates to <a href="qplace.html#extendedAttribute">QPlace::extendedAttribute</a>(), <a href="qplace.html#content">QPlace::content</a>() and <a href="qplacemanager.html#getPlaceContent">QPlaceManager::getPlaceContent</a>().</p>
<p>(Note that the HERE plugin is a read-only source of places and does not support saving functionality at all.)</p>
</div>
<!-- @@@location-plugin-here.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> 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. </p>
</div>
</body>
</html>
|