Commit 5a4d028c authored by Zeeshan Ali's avatar Zeeshan Ali

docs: Add documentation for Agent interface

parent 656898e8
......@@ -36,6 +36,8 @@ docs-org.freedesktop.GeoClue2.Client.xml:
cp $(top_srcdir)/src/docs-org.freedesktop.GeoClue2.Client.xml .
docs-org.freedesktop.GeoClue2.Location.xml:
cp $(top_srcdir)/src/docs-org.freedesktop.GeoClue2.Location.xml .
docs-org.freedesktop.GeoClue2.Agent.xml:
cp $(top_srcdir)/src/agent/docs-org.freedesktop.GeoClue2.Agent.xml .
# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
content_files = \
......@@ -43,6 +45,7 @@ content_files = \
docs-org.freedesktop.GeoClue2.Manager.xml \
docs-org.freedesktop.GeoClue2.Client.xml \
docs-org.freedesktop.GeoClue2.Location.xml \
docs-org.freedesktop.GeoClue2.Agent.xml \
$(NULL)
MAINTAINERCLEANFILES = \
......@@ -63,6 +66,7 @@ CLEANFILES += \
docs-org.freedesktop.GeoClue2.Manager.xml \
docs-org.freedesktop.GeoClue2.Client.xml \
docs-org.freedesktop.GeoClue2.Location.xml \
docs-org.freedesktop.GeoClue2.Agent.xml \
$(NULL)
# Version information for marking the documentation
......
......@@ -68,6 +68,17 @@
<xi:include href="docs-org.freedesktop.GeoClue2.Location.xml"/>
</reference>
<reference id="ref-agent-dbus">
<title>Agent D-Bus API Reference</title>
<partintro>
<para>
This part documents the D-Bus interface that application-authorizing
agents must implement.
</para>
</partintro>
<xi:include href="docs-org.freedesktop.GeoClue2.Agent.xml"/>
</reference>
<index>
<title>Index</title>
</index>
......
......@@ -3,7 +3,15 @@ include $(top_srcdir)/Makefile.decl
interfacedir = $(datadir)/geoclue-2.0
interface_DATA = geoclue-agent-interface.xml
CLEANFILES = $(BUILT_SOURCES)
docs-org.freedesktop.GeoClue2.Agent.xml: Makefile.am $(interface_DATA)
$(AM_V_GEN)$(GDBUS_CODEGEN) \
--interface-prefix org.freedesktop.GeoClue2. \
--c-namespace GClue \
--generate-docbook=docs \
$(srcdir)/$(interface_DATA)
noinst_DATA = docs-org.freedesktop.GeoClue2.Agent.xml
CLEANFILES = $(noinst_DATA)
EXTRA_DIST = $(interface_DATA)
-include $(top_srcdir)/git.mk
<!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 Agent Interface Specification
Copyright (C) 2014 Red Hat, Inc.
-->
<node>
<!--
org.freedesktop.GeoClue2.Agent:
@short_description: The GeoClue agent interface
This is the interface all application-authorizing agents must implement.
There must be a separate agent object for every logged-in user on path
"/org/freedesktop/GeoClue2/Agent/${UID}".
-->
<interface name="org.freedesktop.GeoClue2.Agent">
<!--
AuthorizeApp:
@desktop_id: The desktop file id (the basename of the desktop file) of the application requesting location information.
@authorized: Return value indicating if application should be given location information or not.
This is the method that will be called by geoclue to get applications
authorized to be given location information.
-->
<method name="AuthorizeApp">
<arg name="desktop_id" type="s" direction="in"/>
<arg name="authorized" type="b" direction="out"/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment