summaryrefslogtreecommitdiff
path: root/doc/src/plugins/jsondb.qdoc
blob: 72fc0abb1b7d37546df7465e818f2560d0ced6ca (plain)
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
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page location-plugin-jsondb.html
\title QtLocation JsonDb plugin
\previouspage {QtLocation Module}

\ingroup QtLocation-plugins

\brief Local store for private places.

\section1 Overview

Included with QtLocation is a plugin which stores places in a Json database (aka JsonDb)

The JsonDb GeoServices plugin can be loaded by using the plugin key "nokia_places_jsondb".


\section1 Places
The Nokia JsonDb provider accesses places stored locally on device.
It provides read/write access to the place repository.  The specific
capabiliies are outlined below:

\section2 Capabilities
\table
    \row
        \o Storage
        \o local
    \row
        \o Read/Write
        \o read/write
    \row
        \o Icon url type(see \l {Icon internals} {QPlaceIcon})
        \o full  url
    \row
        \o Text Prediction
        \o no
    \row
        \o Recommendations
        \o no
    \row
        \o Category structure
        \o Hierarchical
    \row
        \o (Rich) Content images
        \o no
    \row
        \o (Rich) Content reviews
        \o no
    \row
        \o (Rich) Content editorials
        \o no
    \row
        \o All details fetched during search
        \o yes
    \row
        \o Paging offset index
        \o yes
    \row
        \o Paging limit
        \o yes
    \row
        \o Distance relevance hint
        \o yes
    \row
        \o Lexical name relevance hint
        \o yes
    \row
        \o Search term corrections
        \o no
    \row
        \o Extended Attributes
        \o no
    \row
        \o Notifications for added/removed places/categories
        \o yes
    \row
        \o visibility scopes
        \o device
\endtable

\section2 Plugin specific behaviours
\section3 Search
The following list shows what core place data is returned during a place search:
\list
\o name
\o location
\o contact information
\o icon
\o categories
\endlist

The JsonDb plugin does not support any other details so all
available details are fetched during a search.  The JsonDb plugin
does not support saving of any other details.

\section3 Icons
The icon urls for the JsonDb plugin take the form of a file path.
There can only be one icon image per icon, hence only the
\l {Icon internals} {full url} is supported.  No icon variations are
supported.

\section3 Visibility scope
The JsonDb plugin only supports places of the QtLocation::PrivateVisibility scope.
Specifying the QtLocation::UnspecifiedVisibility when saving a place will default
to the QtLocation::PrivateVisibility scope.
*/