summaryrefslogtreecommitdiff
path: root/src/lib/elocation/gen/org.freedesktop.GeoClue2.xml
diff options
context:
space:
mode:
authorStefan Schmidt <s.schmidt@samsung.com>2014-11-03 16:16:16 +0100
committerStefan Schmidt <s.schmidt@samsung.com>2014-11-21 10:38:39 +0100
commitf5dcadaab5d695a5cba928199a52daee0a94923b (patch)
tree060e931ec4204ba4f38b6bd640e2011af3c1f61c /src/lib/elocation/gen/org.freedesktop.GeoClue2.xml
parentbe4fc157f219420d3699bfb3e200fa290ad9466d (diff)
elocation: Add generated GeoClue2 DBus helper code.
Generated by eldbus-codegen to avoid writing the boilerplate code by hand.
Diffstat (limited to '')
-rw-r--r--src/lib/elocation/gen/org.freedesktop.GeoClue2.xml199
1 files changed, 199 insertions, 0 deletions
diff --git a/src/lib/elocation/gen/org.freedesktop.GeoClue2.xml b/src/lib/elocation/gen/org.freedesktop.GeoClue2.xml
new file mode 100644
index 0000000000..ab14565438
--- /dev/null
+++ b/src/lib/elocation/gen/org.freedesktop.GeoClue2.xml
@@ -0,0 +1,199 @@
1<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
2"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
3
4<!--
5 GeoClue 2.0 Interface Specification
6
7 Copyright (C) 2013 Red Hat, Inc.
8-->
9
10<node>
11
12 <!--
13 org.freedesktop.GeoClue2.Manager:
14 @short_description: The GeoClue service manager
15
16 This is the interface you use to talk to main GeoClue2 manager object at
17 path "/org/freedesktop/GeoClue2/Manager". The only thing you do with this
18 interface is to call org.freedesktop.GeoClue2.Manager.GetClient() on it
19 to get your application specific client object.
20 -->
21 <interface name="org.freedesktop.GeoClue2.Manager">
22 <!--
23 InUse:
24
25 Whether service is currently is use by any application.
26 -->
27 <property name="InUse" type="b" access="read"/>
28
29 <!--
30 AvailableAccuracyLevel:
31
32 The level of available accuracy, as
33 <link linkend="GClueAccuracyLevel">GClueAccuracyLevel</link>.
34 -->
35 <property name="AvailableAccuracyLevel" type="u" access="read"/>
36
37 <!--
38 GetClient:
39 @client: The path for newly created client object
40
41 Retrieves a client object which can only be used by the calling
42 application only.
43 -->
44 <method name="GetClient">
45 <arg name="client" type="o" direction="out"/>
46 </method>
47
48 <!--
49 AddAgent:
50 @id: The Desktop ID (excluding .desktop) of the agent
51
52 An API for user authorization agents to register themselves. Each agent
53 is responsible for the user it is running as. Application developers
54 can and should simply ignore this API.
55 -->
56 <method name="AddAgent">
57 <arg name="id" type="s" direction="in"/>
58 </method>
59 </interface>
60
61 <!--
62 org.freedesktop.GeoClue2.Client:
63 @short_description: The Application-specific client API
64
65 This is the interface you use to retrieve location information and receive
66 location update signals from GeoClue service. You get the client object to
67 use this interface on from org.freedesktop.GeoClue2.Manager.GetClient()
68 method.
69 -->
70 <interface name="org.freedesktop.GeoClue2.Client">
71 <!--
72 Location:
73
74 Current location as path to a #org.freedesktop.GeoClue2.Location object.
75 -->
76 <property name="Location" type="o" access="read"/>
77
78 <!--
79 DistanceThreshold:
80
81 Contains the current distance threshold in meters. This value is used
82 by the service when it gets new location info. If the distance moved is
83 below the threshold, it won't emit the LocationUpdated signal.
84 -->
85 <property name="DistanceThreshold" type="u" access="readwrite"/>
86
87 <!--
88 DesktopId:
89
90 The desktop file id (the basename of the desktop file). This property
91 must be set by applications for authorization to work.
92 -->
93 <property name="DesktopId" type="s" access="readwrite"/>
94
95 <!--
96 RequestedAccuracyLevel:
97
98 The level of accuracy requested by client, as
99 <link linkend="GClueAccuracyLevel">GClueAccuracyLevel</link>.
100
101 Please keep in mind that the actual accuracy of location information is
102 dependent on available hardware on your machine, external resources
103 and/or how much accuracy user agrees to be confortable with.
104 -->
105 <property name="RequestedAccuracyLevel" type="u" access="readwrite"/>
106
107 <!--
108 Active:
109
110 If client is active, i-e started successfully using
111 org.freedesktop.GeoClue2.Client.Start() and receiving location updates.
112
113 Please keep in mind that geoclue can at any time stop and start the
114 client on user (agent) request. Applications that are interested in
115 in these changes, should watch for changes in this property.
116 -->
117 <property name="Active" type="b" access="read"/>
118
119 <!--
120 Start:
121
122 Start receiving events about the current location. Applications should
123 hook-up to #org.freedesktop.GeoClue2.Client::LocationUpdated signal
124 before calling this method.
125 -->
126 <method name="Start"/>
127
128 <!--
129 Stop:
130
131 Stop receiving events about the current location.
132 -->
133 <method name="Stop"/>
134
135 <!--
136 LocationUpdated:
137 @old: old location as path to a #org.freedesktop.GeoClue2.Location object
138 @new: new location as path to a #org.freedesktop.GeoClue2.Location object
139
140 The signal is emitted every time the location changes.
141 The client should set the DistanceThreshold property to control how
142 often this signal is emitted.
143 -->
144 <signal name="LocationUpdated">
145 <arg name="old" type="o"/>
146 <arg name="new" type="o"/>
147 </signal>
148 </interface>
149
150 <!--
151 org.freedesktop.GeoClue2.Location:
152 @short_description: The Location interface
153
154 This is the interface you use on location objects.
155 -->
156 <interface name="org.freedesktop.GeoClue2.Location">
157
158 <!--
159 Latitude:
160
161 The latitude of the location, in degrees.
162 -->
163 <property name="Latitude" type="d" access="read"/>
164
165 <!--
166 Longitude:
167
168 The longitude of the location, in degrees.
169 -->
170 <property name="Longitude" type="d" access="read"/>
171
172 <!--
173 Accuracy:
174
175 The accuracy of the location fix, in meters.
176 -->
177 <property name="Accuracy" type="d" access="read"/>
178
179 <!--
180 Altitude:
181
182 The altitude of the location fix, in meters. When unknown, its set to
183 minimum double value, -1.7976931348623157e+308.
184 -->
185 <property name="Altitude" type="d" access="read"/>
186
187 <!--
188 Description:
189
190 A human-readable description of the location, if available.
191
192 WARNING: Applications should not rely on this property since not all
193 sources provide a description. If you really need a description (or
194 more details) about current location, use a reverse-geocoding API, e.g
195 geocode-glib.
196 -->
197 <property name="Description" type="s" access="read"/>
198 </interface>
199</node>