summaryrefslogtreecommitdiff
path: root/interface/org.freedesktop.GeoClue2.Manager.xml
blob: 8e8f1425fd041f6cf957fdd2789155d737f34773 (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
<!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 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() or
      org.freedesktop.GeoClue2.Manager.CreateClient() on it to get your
      application specific client object(s).
  -->
  <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 the client object

        Retrieves a client object which can only be used by the calling
        application only. On the first call from a specific D-Bus peer, this
        method will create the client object but subsequent calls will return
        the path of the existing client.
    -->
    <method name="GetClient">
      <arg name="client" type="o" direction="out"/>
    </method>

    <!--
        CreateClient:
        @client: The path for the newly created client object

        Creates and retrieves a client object which can only be used by the
        calling application only. Unlike
        org.freedesktop.GeoClue2.Manager.GetClient(), thid method always
        creates a new client.
    -->
    <method name="CreateClient">
      <arg name="client" type="o" direction="out"/>
    </method>

    <!--
        DeleteClient:
        @client: The path of the client object to delete

        Use this method to explicitly destroy a client, created using
        org.freedesktop.GeoClue2.Manager.GetClient() or
        org.freedesktop.GeoClue2.Manager.CreateClient().

        Long-running applications, should either use this to delete associated
        client(s) when not needed, or disconnect from the D-Bus connection used
        for communicating with Geoclue (which is implicit on client process
        termination). 
    -->
    <method name="DeleteClient">
      <arg name="client" type="o" direction="in"/>
    </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>