<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="gdbus-org.freedesktop.GeoClue2.Client">
  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-GeoClue2-Client.top_of_page">org.freedesktop.GeoClue2.Client</refentrytitle>
  <indexterm zone="gdbus-interface-org-freedesktop-GeoClue2-Client.top_of_page"><primary sortas="Client">org.freedesktop.GeoClue2.Client</primary></indexterm>
  </refmeta>  <refnamediv>    <refname>org.freedesktop.GeoClue2.Client</refname>    <refpurpose>The Application-specific client API</refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
    <title role="synopsis.title">Methods</title>
    <synopsis>
<link linkend="gdbus-method-org-freedesktop-GeoClue2-Client.Start">Start</link> ();
<link linkend="gdbus-method-org-freedesktop-GeoClue2-Client.Stop">Stop</link>  ();
</synopsis>
  </refsynopsisdiv>
  <refsect1 role="signal_proto">
    <title role="signal_proto.title">Signals</title>
    <synopsis>
<link linkend="gdbus-signal-org-freedesktop-GeoClue2-Client.LocationUpdated">LocationUpdated</link> (o old,
                 o new);
</synopsis>
  </refsect1>
  <refsect1 role="properties">
    <title role="properties.title">Properties</title>
    <synopsis>
<link linkend="gdbus-property-org-freedesktop-GeoClue2-Client.Location">Location</link>                readable   o
<link linkend="gdbus-property-org-freedesktop-GeoClue2-Client.DistanceThreshold">DistanceThreshold</link>       readwrite  u
<link linkend="gdbus-property-org-freedesktop-GeoClue2-Client.DesktopId">DesktopId</link>               readwrite  s
<link linkend="gdbus-property-org-freedesktop-GeoClue2-Client.RequestedAccuracyLevel">RequestedAccuracyLevel</link>  readwrite  u
</synopsis>
  </refsect1>
<refsect1 role="desc" id="gdbus-interface-org-freedesktop-GeoClue2-Client">
  <title role="desc.title">Description</title>
  <para>      This is the interface you use to retrieve location information and receive
      location update signals from GeoClue service. You get the client object to
      use this interface on from <link linkend="gdbus-method-org-freedesktop-GeoClue2-Manager.GetClient">GetClient()</link>
      method.
</para>
</refsect1>
<refsect1 role="details" id="gdbus-methods-org.freedesktop.GeoClue2.Client">
  <title role="details.title">Method Details</title>
<refsect2 role="method" id="gdbus-method-org-freedesktop-GeoClue2-Client.Start">
  <title>The Start() method</title>
  <indexterm zone="gdbus-method-org-freedesktop-GeoClue2-Client.Start"><primary sortas="Client.Start">org.freedesktop.GeoClue2.Client.Start()</primary></indexterm>
<programlisting>
Start ();
</programlisting>
<para>        Start receiving events about the current location. Applications should
        hook-up to <link linkend="gdbus-signal-org-freedesktop-GeoClue2-Client.LocationUpdated">"LocationUpdated"</link> signal
        before calling this method.
</para>
</refsect2>
<refsect2 role="method" id="gdbus-method-org-freedesktop-GeoClue2-Client.Stop">
  <title>The Stop() method</title>
  <indexterm zone="gdbus-method-org-freedesktop-GeoClue2-Client.Stop"><primary sortas="Client.Stop">org.freedesktop.GeoClue2.Client.Stop()</primary></indexterm>
<programlisting>
Stop ();
</programlisting>
<para>        Stop receiving events about the current location.
</para>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-signals-org.freedesktop.GeoClue2.Client">
  <title role="details.title">Signal Details</title>
<refsect2 role="signal" id="gdbus-signal-org-freedesktop-GeoClue2-Client.LocationUpdated">
  <title>The "LocationUpdated" signal</title>
  <indexterm zone="gdbus-signal-org-freedesktop-GeoClue2-Client.LocationUpdated"><primary sortas="Client::LocationUpdated">org.freedesktop.GeoClue2.Client::LocationUpdated</primary></indexterm>
<programlisting>
LocationUpdated (o old,
                 o new);
</programlisting>
<para>        The signal is emitted every time the location changes.
        The client should set the DistanceThreshold property to control how
        often this signal is emitted.
</para>
<variablelist role="params">
<varlistentry>
  <term><literal>o <parameter>old</parameter></literal>:</term>
  <listitem><para>old location as path to a <link linkend="gdbus-interface-org-freedesktop-GeoClue2-Location.top_of_page">org.freedesktop.GeoClue2.Location</link> object</para></listitem>
</varlistentry>
<varlistentry>
  <term><literal>o <parameter>new</parameter></literal>:</term>
  <listitem><para>new location as path to a <link linkend="gdbus-interface-org-freedesktop-GeoClue2-Location.top_of_page">org.freedesktop.GeoClue2.Location</link> object</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-properties-org.freedesktop.GeoClue2.Client">
  <title role="details.title">Property Details</title>
<refsect2 role="property" id="gdbus-property-org-freedesktop-GeoClue2-Client.Location">
  <title>The "Location" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-GeoClue2-Client.Location"><primary sortas="Client:Location">org.freedesktop.GeoClue2.Client:Location</primary></indexterm>
<programlisting>
Location  readable   o
</programlisting>
<para>        Current location as path to a <link linkend="gdbus-interface-org-freedesktop-GeoClue2-Location.top_of_page">org.freedesktop.GeoClue2.Location</link> object.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-GeoClue2-Client.DistanceThreshold">
  <title>The "DistanceThreshold" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-GeoClue2-Client.DistanceThreshold"><primary sortas="Client:DistanceThreshold">org.freedesktop.GeoClue2.Client:DistanceThreshold</primary></indexterm>
<programlisting>
DistanceThreshold  readwrite  u
</programlisting>
<para>        Contains the current distance threshold in meters. This value is used
        by the service when it gets new location info. If the distance moved is
        below the threshold, it won't emit the LocationUpdated signal.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-GeoClue2-Client.DesktopId">
  <title>The "DesktopId" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-GeoClue2-Client.DesktopId"><primary sortas="Client:DesktopId">org.freedesktop.GeoClue2.Client:DesktopId</primary></indexterm>
<programlisting>
DesktopId  readwrite  s
</programlisting>
<para>        The desktop file id (the basename of the desktop file). This property
        must be set by applications for authorization to work.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-GeoClue2-Client.RequestedAccuracyLevel">
  <title>The "RequestedAccuracyLevel" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-GeoClue2-Client.RequestedAccuracyLevel"><primary sortas="Client:RequestedAccuracyLevel">org.freedesktop.GeoClue2.Client:RequestedAccuracyLevel</primary></indexterm>
<programlisting>
RequestedAccuracyLevel  readwrite  u
</programlisting>
<para>        The level of accuracy requested by client, as
        <link linkend="GClueAccuracyLevel">GClueAccuracyLevel</link>.
</para><para>        Please keep in mind that the actual accuracy of location information is
        dependent on available hardware on your machine, external resources
        and/or how much accuracy user agrees to be confortable with.
</para>
</refsect2>
</refsect1>
</refentry>

