summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZeeshan Ali (Khattak) <zeeshanak@gnome.org>2015-10-07 22:36:00 +0100
committerZeeshan Ali (Khattak) <zeeshanak@gnome.org>2015-10-09 14:44:41 +0100
commit96f815b059a5f3326ec60b02c0c491739a669816 (patch)
treebe8911d49bd98de1b44584db61ecd25affea8a45
parent93241301b9c47a5e7a61978cf5154752c85bd183 (diff)
downloadgeoclue-96f815b059a5f3326ec60b02c0c491739a669816.tar.gz
dbus: Put each interface in it's own file
This probably makes sense anyway but it will be useful when we add a convenience library in a following patch so that code for each interface could be generated in a separate module to be able to have separate chapters for generated API in the docs. https://bugs.freedesktop.org/show_bug.cgi?id=68658
-rw-r--r--src/Makefile.am4
-rw-r--r--src/org.freedesktop.GeoClue2.Client.xml (renamed from src/org.freedesktop.GeoClue2.xml)116
-rw-r--r--src/org.freedesktop.GeoClue2.Location.xml78
-rw-r--r--src/org.freedesktop.GeoClue2.Manager.xml60
4 files changed, 141 insertions, 117 deletions
diff --git a/src/Makefile.am b/src/Makefile.am
index 3de59b3..b7a8330 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -5,7 +5,9 @@ libexec_PROGRAMS = geoclue
SUBDIRS = public-api agent geocode-glib
interfacedir = $(datadir)/dbus-1/interfaces
-interface_DATA = org.freedesktop.GeoClue2.xml
+interface_DATA = org.freedesktop.GeoClue2.Client.xml \
+ org.freedesktop.GeoClue2.Location.xml \
+ org.freedesktop.GeoClue2.Manager.xml
dbus_built_sources = geoclue-interface.c \
geoclue-interface.h \
diff --git a/src/org.freedesktop.GeoClue2.xml b/src/org.freedesktop.GeoClue2.Client.xml
index 5371104..cff6830 100644
--- a/src/org.freedesktop.GeoClue2.xml
+++ b/src/org.freedesktop.GeoClue2.Client.xml
@@ -10,55 +10,6 @@
<node>
<!--
- org.freedesktop.GeoClue2.Manager:
- @short_description: The GeoClue service manager
-
- This is the interface you use to talk to main GeoClue2 manager object at
- path "/org/freedesktop/GeoClue2/Manager". The only thing you do with this
- interface is to call org.freedesktop.GeoClue2.Manager.GetClient() on it
- to get your application specific client object.
- -->
- <interface name="org.freedesktop.GeoClue2.Manager">
- <!--
- InUse:
-
- Whether service is currently is use by any application.
- -->
- <property name="InUse" type="b" access="read"/>
-
- <!--
- AvailableAccuracyLevel:
-
- The level of available accuracy, as
- <link linkend="GClueAccuracyLevel">GClueAccuracyLevel</link>.
- -->
- <property name="AvailableAccuracyLevel" type="u" access="read"/>
-
- <!--
- GetClient:
- @client: The path for newly created client object
-
- Retrieves a client object which can only be used by the calling
- application only.
- -->
- <method name="GetClient">
- <arg name="client" type="o" direction="out"/>
- </method>
-
- <!--
- AddAgent:
- @id: The Desktop ID (excluding .desktop) of the agent
-
- An API for user authorization agents to register themselves. Each agent
- is responsible for the user it is running as. Application developers
- can and should simply ignore this API.
- -->
- <method name="AddAgent">
- <arg name="id" type="s" direction="in"/>
- </method>
- </interface>
-
- <!--
org.freedesktop.GeoClue2.Client:
@short_description: The Application-specific client API
@@ -151,71 +102,4 @@
<arg name="new" type="o"/>
</signal>
</interface>
-
- <!--
- org.freedesktop.GeoClue2.Location:
- @short_description: The Location interface
-
- This is the interface you use on location objects.
- -->
- <interface name="org.freedesktop.GeoClue2.Location">
-
- <!--
- Latitude:
-
- The latitude of the location, in degrees.
- -->
- <property name="Latitude" type="d" access="read"/>
-
- <!--
- Longitude:
-
- The longitude of the location, in degrees.
- -->
- <property name="Longitude" type="d" access="read"/>
-
- <!--
- Accuracy:
-
- The accuracy of the location fix, in meters.
- -->
- <property name="Accuracy" type="d" access="read"/>
-
- <!--
- Altitude:
-
- The altitude of the location fix, in meters. When unknown, its set to
- minimum double value, -1.7976931348623157e+308.
- -->
- <property name="Altitude" type="d" access="read"/>
-
- <!--
- Speed:
-
- The speed in meters per second. When unknown, it's set to -1.0.
- -->
- <property name="Speed" type="d" access="read"/>
-
- <!--
- Heading:
-
- The heading direction in degrees with respect to North direction, in
- clockwise order. That means North becomes 0 degree, East: 90 degrees,
- South: 180 degrees, West: 270 degrees and so on. When unknown,
- it's set to -1.0.
- -->
- <property name="Heading" type="d" access="read"/>
-
- <!--
- Description:
-
- A human-readable description of the location, if available.
-
- WARNING: Applications should not rely on this property since not all
- sources provide a description. If you really need a description (or
- more details) about current location, use a reverse-geocoding API, e.g
- geocode-glib.
- -->
- <property name="Description" type="s" access="read"/>
- </interface>
</node>
diff --git a/src/org.freedesktop.GeoClue2.Location.xml b/src/org.freedesktop.GeoClue2.Location.xml
new file mode 100644
index 0000000..fd53c79
--- /dev/null
+++ b/src/org.freedesktop.GeoClue2.Location.xml
@@ -0,0 +1,78 @@
+<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+
+<!--
+ GeoClue 2.0 Interface Specification
+
+ Copyright (C) 2013 Red Hat, Inc.
+-->
+
+<node>
+
+ <!--
+ org.freedesktop.GeoClue2.Location:
+ @short_description: The Location interface
+
+ This is the interface you use on location objects.
+ -->
+ <interface name="org.freedesktop.GeoClue2.Location">
+
+ <!--
+ Latitude:
+
+ The latitude of the location, in degrees.
+ -->
+ <property name="Latitude" type="d" access="read"/>
+
+ <!--
+ Longitude:
+
+ The longitude of the location, in degrees.
+ -->
+ <property name="Longitude" type="d" access="read"/>
+
+ <!--
+ Accuracy:
+
+ The accuracy of the location fix, in meters.
+ -->
+ <property name="Accuracy" type="d" access="read"/>
+
+ <!--
+ Altitude:
+
+ The altitude of the location fix, in meters. When unknown, its set to
+ minimum double value, -1.7976931348623157e+308.
+ -->
+ <property name="Altitude" type="d" access="read"/>
+
+ <!--
+ Speed:
+
+ The speed in meters per second. When unknown, it's set to -1.0.
+ -->
+ <property name="Speed" type="d" access="read"/>
+
+ <!--
+ Heading:
+
+ The heading direction in degrees with respect to North direction, in
+ clockwise order. That means North becomes 0 degree, East: 90 degrees,
+ South: 180 degrees, West: 270 degrees and so on. When unknown,
+ it's set to -1.0.
+ -->
+ <property name="Heading" type="d" access="read"/>
+
+ <!--
+ Description:
+
+ A human-readable description of the location, if available.
+
+ WARNING: Applications should not rely on this property since not all
+ sources provide a description. If you really need a description (or
+ more details) about current location, use a reverse-geocoding API, e.g
+ geocode-glib.
+ -->
+ <property name="Description" type="s" access="read"/>
+ </interface>
+</node>
diff --git a/src/org.freedesktop.GeoClue2.Manager.xml b/src/org.freedesktop.GeoClue2.Manager.xml
new file mode 100644
index 0000000..1b71a7f
--- /dev/null
+++ b/src/org.freedesktop.GeoClue2.Manager.xml
@@ -0,0 +1,60 @@
+<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+
+<!--
+ GeoClue 2.0 Interface Specification
+
+ Copyright (C) 2013 Red Hat, Inc.
+-->
+
+<node>
+
+ <!--
+ org.freedesktop.GeoClue2.Manager:
+ @short_description: The GeoClue service manager
+
+ This is the interface you use to talk to main GeoClue2 manager object at
+ path "/org/freedesktop/GeoClue2/Manager". The only thing you do with this
+ interface is to call org.freedesktop.GeoClue2.Manager.GetClient() on it
+ to get your application specific client object.
+ -->
+ <interface name="org.freedesktop.GeoClue2.Manager">
+ <!--
+ InUse:
+
+ Whether service is currently is use by any application.
+ -->
+ <property name="InUse" type="b" access="read"/>
+
+ <!--
+ AvailableAccuracyLevel:
+
+ The level of available accuracy, as
+ <link linkend="GClueAccuracyLevel">GClueAccuracyLevel</link>.
+ -->
+ <property name="AvailableAccuracyLevel" type="u" access="read"/>
+
+ <!--
+ GetClient:
+ @client: The path for newly created client object
+
+ Retrieves a client object which can only be used by the calling
+ application only.
+ -->
+ <method name="GetClient">
+ <arg name="client" type="o" direction="out"/>
+ </method>
+
+ <!--
+ AddAgent:
+ @id: The Desktop ID (excluding .desktop) of the agent
+
+ An API for user authorization agents to register themselves. Each agent
+ is responsible for the user it is running as. Application developers
+ can and should simply ignore this API.
+ -->
+ <method name="AddAgent">
+ <arg name="id" type="s" direction="in"/>
+ </method>
+ </interface>
+</node>