LocationManager.java revision 4e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/*
29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project
39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *
49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License");
59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License.
69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at
79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *
89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *      http://www.apache.org/licenses/LICENSE-2.0
99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *
109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software
119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS,
129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and
149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License.
159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */
169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.location;
189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.PendingIntent;
20e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pellyimport android.content.Context;
219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.Intent;
222eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pellyimport android.os.Build;
239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Bundle;
249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Looper;
259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.RemoteException;
269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Handler;
279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Message;
289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Log;
299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3079762a3ee34eb8be5549bcb183af844b6f19c266Mike Lockwood
319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.ArrayList;
329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.HashMap;
339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.List;
349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
356fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pellyimport com.android.internal.location.ProviderProperties;
366fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/**
389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class provides access to the system location services.  These
399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * services allow applications to obtain periodic updates of the
409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * device's geographical location, or to fire an application-specified
419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Intent} when the device enters the proximity of a given
429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * geographical location.
439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *
449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>You do not
459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * instantiate this class directly; instead, retrieve it through
469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Context#getSystemService
479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context.getSystemService(Context.LOCATION_SERVICE)}.
483aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45Joe Fernandez *
494e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * <p>At API version 17 the Location API's were simplified.
504e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * Previously applications would need to explicitly enumerate, select, and
514e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * track Location Providers (such as GPS or Network).
524e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * This has been replaced by the concept of
534e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * <em>Fused Location</em>. Now applications just specify the quality of service
544e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * required for location updates (using the new {@link LocationRequest} class),
554e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * and the system will fuse results from individual location providers
564e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * as necessary before returning the result to the application.
574e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly *
584e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * <p>As a result of this change, the {@link LocationProvider} and
594e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * {@link Criteria} classes have been deprecated, in favor of
604e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * {@link LocationRequest}. Furthermore, all Location Manager
614e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * methods involving Criteria or explicitly named Providers have
624e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * been deprecated, in favor of new variants that use
634e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * {@link LocationRequest}.
644e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly *
654e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * <p>A single {@link LocationRequest} object can trigger the use
664e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * of all providers (including GPS, Network, and the passive) provider
674e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * as necessary. This should result in a lot less work for your application. You
684e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * no longer need to track the status and availability of each
694e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * location provider. Just set the quality of locations required
704e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * in {@link LocationRequest}, and let the system manage the rest.
714e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly *
724e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * <p class="note">Unless noted, all Location API methods require
734e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * the {@link android.Manifest.permission#ACCESS_COARSE_LOCATION} or
744e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * {@link android.Manifest.permission#ACCESS_FINE_LOCATION} permissions.
754e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * If your application only has the Coarse permission then it will still
764e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * receive location results, but the update rate will be throttled and
774e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * the exact location will be obfuscated to a coarse level of accuracy.
784e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly *
794e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * <p> class="note">Before API level 17, the use of 'fine' location
804e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * providers such as GPS required the fine permission. As of API level
814e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * 17, applications with only the coarse permission may use all providers,
824e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * including GPS, but the locations are obfuscated (made coarse) before
834e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly * being sent to the application.
849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */
859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class LocationManager {
869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private static final String TAG = "LocationManager";
87e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly
88e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly    private final Context mContext;
89e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly    private final ILocationManager mService;
909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private final HashMap<GpsStatus.Listener, GpsStatusListenerTransport> mGpsStatusListeners =
919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            new HashMap<GpsStatus.Listener, GpsStatusListenerTransport>();
92b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood    private final HashMap<GpsStatus.NmeaListener, GpsStatusListenerTransport> mNmeaListeners =
93b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            new HashMap<GpsStatus.NmeaListener, GpsStatusListenerTransport>();
949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private final GpsStatus mGpsStatus = new GpsStatus();
959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
974e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Name of the network location provider.
984e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>This provider determines location based on
999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * availability of cell tower and WiFi access points. Results are retrieved
1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * by means of a network lookup.
1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
1024e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
1046fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static final String NETWORK_PROVIDER = "network";
1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
1084e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Name of the GPS location provider.
1094e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
1104e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>This provider determines location using
1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * satellites. Depending on conditions, this provider may take a while to return
1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * a location fix.
1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
1144e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>Before API version 17, this provider required the
1154e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link android.Manifest.permission#ACCESS_FINE_LOCATION} permission.
1164e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * From API version 17 and onwards, this provider can also be used with
1174e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link android.Manifest.permission#ACCESS_COARSE_LOCATION}, however
1184e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * the locations returned will be obfuscated to a coarse level of accuracy.
1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p> The extras Bundle for the GPS location provider can contain the
1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * following key/value pairs:
1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <ul>
1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <li> satellites - the number of satellites used to derive the fix
1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * </ul>
1254e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
1264e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
1286fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static final String GPS_PROVIDER = "gps";
1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
132a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood     * A special location provider for receiving locations without actually initiating
1334e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * a location fix.
1344e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
1354e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>This provider can be used to passively receive location updates
136a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood     * when other applications or services request them without actually requesting
137a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood     * the locations yourself.  This provider will return locations generated by other
138a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood     * providers.  You can query the {@link Location#getProvider()} method to determine
139a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood     * the origin of the location update.
140a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood     *
1414e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>Before API version 17, this provider required the
1424e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link android.Manifest.permission#ACCESS_FINE_LOCATION} permission.
1434e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * From API version 17 and onwards, this provider can also be used with
1444e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link android.Manifest.permission#ACCESS_COARSE_LOCATION}, however
1454e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * the locations returned will be obfuscated to a coarse level of accuracy.
1464e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
1474e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
148a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood     */
1496fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
150a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood    public static final String PASSIVE_PROVIDER = "passive";
151a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood
152a4903f254b4711c8fc0ac5f7e3d605f4dce34f35Mike Lockwood    /**
1534e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Name of the Fused location provider.
1544e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
1554e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>This provider combines inputs for all possible location sources
1564e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * to provide the best possible Location fix. It is implicitly
1574e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * used for all API's that involve the {@link LocationRequest}
1584e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * object.
1596fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly     *
1606fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly     * @hide
1616fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly     */
1626fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public static final String FUSED_PROVIDER = "fused";
1636fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
1646fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    /**
1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Key used for the Bundle extra holding a boolean indicating whether
1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * a proximity alert is entering (true) or exiting (false)..
1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static final String KEY_PROXIMITY_ENTERING = "entering";
1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Key used for a Bundle extra holding an Integer status value
1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * when a status change is broadcast using a PendingIntent.
1734e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
1744e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
1766fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static final String KEY_STATUS_CHANGED = "status";
1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Key used for a Bundle extra holding an Boolean status value
1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * when a provider enabled/disabled event is broadcast using a PendingIntent.
1824e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
1834e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
1856fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static final String KEY_PROVIDER_ENABLED = "providerEnabled";
1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Key used for a Bundle extra holding a Location value
1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * when a location change is broadcast using a PendingIntent.
1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public static final String KEY_LOCATION_CHANGED = "location";
1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
19400b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood    /**
19500b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * Broadcast intent action indicating that the GPS has either been
19600b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * enabled or disabled. An intent extra provides this state as a boolean,
19700b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * where {@code true} means enabled.
19800b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * @see #EXTRA_GPS_ENABLED
19900b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     *
2004e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @hide
20100b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     */
20200b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood    public static final String GPS_ENABLED_CHANGE_ACTION =
20300b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood        "android.location.GPS_ENABLED_CHANGE";
20400b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood
20500b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood    /**
2060c5a04014d3833c9a82772a832d3bc6410fc52acBrad Fitzpatrick     * Broadcast intent action when the configured location providers
2070c5a04014d3833c9a82772a832d3bc6410fc52acBrad Fitzpatrick     * change.
2084e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
2094e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
2100c5a04014d3833c9a82772a832d3bc6410fc52acBrad Fitzpatrick     */
2116fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
2120c5a04014d3833c9a82772a832d3bc6410fc52acBrad Fitzpatrick    public static final String PROVIDERS_CHANGED_ACTION =
2130c5a04014d3833c9a82772a832d3bc6410fc52acBrad Fitzpatrick        "android.location.PROVIDERS_CHANGED";
2140c5a04014d3833c9a82772a832d3bc6410fc52acBrad Fitzpatrick
2150c5a04014d3833c9a82772a832d3bc6410fc52acBrad Fitzpatrick    /**
21600b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * Broadcast intent action indicating that the GPS has either started or
21700b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * stopped receiving GPS fixes. An intent extra provides this state as a
21800b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * boolean, where {@code true} means that the GPS is actively receiving fixes.
21900b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * @see #EXTRA_GPS_ENABLED
22000b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     *
2214e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @hide
22200b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     */
22300b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood    public static final String GPS_FIX_CHANGE_ACTION =
22400b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood        "android.location.GPS_FIX_CHANGE";
22500b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood
22600b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood    /**
22700b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * The lookup key for a boolean that indicates whether GPS is enabled or
22800b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * disabled. {@code true} means GPS is enabled. Retrieve it with
22900b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     * {@link android.content.Intent#getBooleanExtra(String,boolean)}.
23000b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     *
2314e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @hide
23200b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood     */
23300b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood    public static final String EXTRA_GPS_ENABLED = "enabled";
23400b74270c9f136a8727c5f6cda0997a3a905f385Mike Lockwood
2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    // Map from LocationListeners to their associated ListenerTransport objects
2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private HashMap<LocationListener,ListenerTransport> mListeners =
2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        new HashMap<LocationListener,ListenerTransport>();
2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private class ListenerTransport extends ILocationListener.Stub {
2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private static final int TYPE_LOCATION_CHANGED = 1;
2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private static final int TYPE_STATUS_CHANGED = 2;
2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private static final int TYPE_PROVIDER_ENABLED = 3;
2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private static final int TYPE_PROVIDER_DISABLED = 4;
2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private LocationListener mListener;
2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private final Handler mListenerHandler;
2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        ListenerTransport(LocationListener listener, Looper looper) {
2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mListener = listener;
2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (looper == null) {
2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mListenerHandler = new Handler() {
2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    @Override
2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    public void handleMessage(Message msg) {
2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                        _handleMessage(msg);
2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    }
2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                };
2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            } else {
2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mListenerHandler = new Handler(looper) {
2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    @Override
2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    public void handleMessage(Message msg) {
2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                        _handleMessage(msg);
2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    }
2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                };
2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
268e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void onLocationChanged(Location location) {
2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Message msg = Message.obtain();
2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            msg.what = TYPE_LOCATION_CHANGED;
2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            msg.obj = location;
2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mListenerHandler.sendMessage(msg);
2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
276e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void onStatusChanged(String provider, int status, Bundle extras) {
2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Message msg = Message.obtain();
2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            msg.what = TYPE_STATUS_CHANGED;
2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Bundle b = new Bundle();
2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            b.putString("provider", provider);
2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            b.putInt("status", status);
2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (extras != null) {
2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                b.putBundle("extras", extras);
2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            msg.obj = b;
2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mListenerHandler.sendMessage(msg);
2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
290e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void onProviderEnabled(String provider) {
2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Message msg = Message.obtain();
2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            msg.what = TYPE_PROVIDER_ENABLED;
2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            msg.obj = provider;
2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mListenerHandler.sendMessage(msg);
2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
298e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void onProviderDisabled(String provider) {
3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Message msg = Message.obtain();
3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            msg.what = TYPE_PROVIDER_DISABLED;
3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            msg.obj = provider;
3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mListenerHandler.sendMessage(msg);
3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private void _handleMessage(Message msg) {
3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            switch (msg.what) {
3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                case TYPE_LOCATION_CHANGED:
3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    Location location = new Location((Location) msg.obj);
3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    mListener.onLocationChanged(location);
3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    break;
3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                case TYPE_STATUS_CHANGED:
3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    Bundle b = (Bundle) msg.obj;
3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    String provider = b.getString("provider");
3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    int status = b.getInt("status");
3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    Bundle extras = b.getBundle("extras");
3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    mListener.onStatusChanged(provider, status, extras);
3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    break;
3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                case TYPE_PROVIDER_ENABLED:
3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    mListener.onProviderEnabled((String) msg.obj);
3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    break;
3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                case TYPE_PROVIDER_DISABLED:
3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    mListener.onProviderDisabled((String) msg.obj);
3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                    break;
3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
32648f17518223a2917fd82195004fbb206cb9a05a3Mike Lockwood            try {
32748f17518223a2917fd82195004fbb206cb9a05a3Mike Lockwood                mService.locationCallbackFinished(this);
32848f17518223a2917fd82195004fbb206cb9a05a3Mike Lockwood            } catch (RemoteException e) {
32948f17518223a2917fd82195004fbb206cb9a05a3Mike Lockwood                Log.e(TAG, "locationCallbackFinished: RemoteException", e);
33048f17518223a2917fd82195004fbb206cb9a05a3Mike Lockwood            }
3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3334e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly
3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @hide - hide this constructor because it has a parameter
3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * of type ILocationManager, which is a system private class. The
3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * right way to create an instance of this class is using the
3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * factory Context.getSystemService.
3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
340e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly    public LocationManager(Context context, ILocationManager service) {
3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        mService = service;
342e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        mContext = context;
3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3456fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    private LocationProvider createProvider(String name, ProviderProperties properties) {
3466fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        return new LocationProvider(name, properties);
3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3504e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Returns a list of the names of all known location providers.
3514e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>All providers are returned, including ones that are not permitted to
3524e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * be accessed by the calling activity or are currently disabled.
3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
3544e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @return list of Strings containing names of the provider
3554e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
3564e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
3586fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public List<String> getAllProviders() {
3609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return mService.getAllProviders();
3626fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
3636fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return null;
3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3694e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Returns a list of the names of location providers.
3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param enabledOnly if true then only the providers which are currently
3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * enabled are returned.
3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return list of Strings containing names of the providers
3744e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
3754e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
3776fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public List<String> getProviders(boolean enabledOnly) {
3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
38003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood            return mService.getProviders(null, enabledOnly);
3816fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
3826fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return null;
3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Returns the information associated with the location provider of the
3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * given name, or null if no provider exists by that name.
3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param name the provider name
3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return a LocationProvider, or null
3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
3944e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if name is null or does not exist
3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the caller is not permitted to access the
3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * given provider.
3974e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
3984e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4006fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public LocationProvider getProvider(String name) {
4026fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkProvider(name);
4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
4046fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            ProviderProperties properties = mService.getProviderProperties(name);
4056fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            if (properties == null) {
4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                return null;
4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
4086fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            return createProvider(name, properties);
4096fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
4106fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return null;
4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Returns a list of the names of LocationProviders that satisfy the given
4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * criteria, or null if none do.  Only providers that are permitted to be
4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * accessed by the calling activity will be returned.
4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param criteria the criteria that the returned providers must match
4219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param enabledOnly if true then only the providers which are currently
4229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * enabled are returned.
4239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return list of Strings containing names of the providers
4244e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
4254e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4276fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public List<String> getProviders(Criteria criteria, boolean enabledOnly) {
4296fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkCriteria(criteria);
43003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood        try {
43103ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood            return mService.getProviders(criteria, enabledOnly);
4326fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
4336fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
43503ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood        return null;
4369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
4399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Returns the name of the provider that best meets the given criteria. Only providers
4409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * that are permitted to be accessed by the calling activity will be
4419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * returned.  If several providers meet the criteria, the one with the best
4429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * accuracy is returned.  If no provider meets the criteria,
4439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * the criteria are loosened in the following sequence:
4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <ul>
4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <li> power requirement
4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <li> accuracy
4489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <li> bearing
4499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <li> speed
4509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <li> altitude
4519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * </ul>
4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p> Note that the requirement on monetary cost is not removed
4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * in this process.
4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param criteria the criteria that need to be matched
4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param enabledOnly if true then only a provider that is currently enabled is returned
4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return name of the provider that best matches the requirements
4594e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
4604e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4626fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public String getBestProvider(Criteria criteria, boolean enabledOnly) {
4646fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkCriteria(criteria);
46503ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood        try {
46603ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood            return mService.getBestProvider(criteria, enabledOnly);
4676fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
4686fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return null;
4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
4744e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for location updates using the named provider, and a
4754e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * pending intent.
4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
4774e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>See {@link #requestLocationUpdates(long, float, Criteria, PendingIntent)}
4784e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail on how to use this (deprecated) method.
479f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
4809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the name of the provider with which to register
481f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minTime minimum time interval between location updates, in milliseconds
482f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minDistance minimum distance between location updates, in meters
4839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param listener a {#link LocationListener} whose
4849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * {@link LocationListener#onLocationChanged} method will be called for
4859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * each location update
4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
487f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @throws IllegalArgumentException if provider is null or doesn't exist
488f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * on this device
489f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @throws IllegalArgumentException if listener is null
4909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws RuntimeException if the calling thread has no Looper
4914e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
4924e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
4946fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
4956fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void requestLocationUpdates(String provider, long minTime, float minDistance,
4966fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            LocationListener listener) {
4976fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkProvider(provider);
4986fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkListener(listener);
4996fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
5006fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedProvider(
5016fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                provider, minTime, minDistance, false);
5026fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, listener, null, null);
5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
5049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
5064e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for location updates using the named provider, and a callback on
5074e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * the specified looper thread.
508f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
5094e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>See {@link #requestLocationUpdates(long, float, Criteria, PendingIntent)}
5104e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail on how to use this (deprecated) method.
511f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the name of the provider with which to register
513f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minTime minimum time interval between location updates, in milliseconds
514f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minDistance minimum distance between location updates, in meters
5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param listener a {#link LocationListener} whose
5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * {@link LocationListener#onLocationChanged} method will be called for
5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * each location update
5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param looper a Looper object whose message queue will be used to
5194e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * implement the callback mechanism, or null to make callbacks on the calling
5204e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * thread
5219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
5229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if provider is null or doesn't exist
5239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if listener is null
5244e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
5254e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
5264e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
5279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
5286fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
5296fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void requestLocationUpdates(String provider, long minTime, float minDistance,
5306fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            LocationListener listener, Looper looper) {
5316fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkProvider(provider);
5326fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkListener(listener);
5336fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
5346fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedProvider(
5356fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                provider, minTime, minDistance, false);
5366fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, listener, looper, null);
53703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    }
53803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood
53903ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    /**
5404e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for location updates using a Criteria, and a callback
5414e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * on the specified looper thread.
542f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
5434e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>See {@link #requestLocationUpdates(long, float, Criteria, PendingIntent)}
5444e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail on how to use this (deprecated) method.
545f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
546f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minTime minimum time interval between location updates, in milliseconds
547f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minDistance minimum distance between location updates, in meters
54803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param criteria contains parameters for the location manager to choose the
54903ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * appropriate provider and parameters to compute the location
55003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param listener a {#link LocationListener} whose
55103ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * {@link LocationListener#onLocationChanged} method will be called for
55203ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * each location update
55303ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param looper a Looper object whose message queue will be used to
5544e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * implement the callback mechanism, or null to make callbacks on the calling
5554e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * thread
55603ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
55703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if criteria is null
55803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if listener is null
5594e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
5604e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
5614e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
56203ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     */
5636fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
5646fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void requestLocationUpdates(long minTime, float minDistance, Criteria criteria,
5656fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            LocationListener listener, Looper looper) {
5666fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkCriteria(criteria);
5676fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkListener(listener);
5689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
5696fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedCriteria(
5706fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                criteria, minTime, minDistance, false);
5716fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, listener, looper, null);
5729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
5739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
5749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
5754e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for location updates using the named provider, and a
5764e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * pending intent.
5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
5784e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>See {@link #requestLocationUpdates(long, float, Criteria, PendingIntent)}
5794e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail on how to use this (deprecated) method.
5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the name of the provider with which to register
582f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minTime minimum time interval between location updates, in milliseconds
583f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minDistance minimum distance between location updates, in meters
58403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param intent a {#link PendingIntent} to be sent for each location update
5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if provider is null or doesn't exist
587f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * on this device
5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if intent is null
5894e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
5904e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
5914e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
5936fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
5946fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void requestLocationUpdates(String provider, long minTime, float minDistance,
5956fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            PendingIntent intent) {
5966fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkProvider(provider);
5976fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
5986fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
5996fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedProvider(
6006fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                provider, minTime, minDistance, false);
6016fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, null, null, intent);
6029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
6039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
60403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    /**
6054e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for location updates using a Criteria and pending intent.
60603ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
6074e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>The <code>requestLocationUpdates()</code> and
6084e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <code>requestSingleUpdate()</code> methods involving
6094e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * an explicit String provider or {@link Criteria} are deprecated.
6104e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
6114e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>They register the current activity to be updated
6124e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * periodically by the named provider, or by the provider matching
6134e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * the specified {@link Criteria}, with location and status updates.
61403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
615f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * <p> It may take a while to receive the first location update. If
61603ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * an immediate location is required, applications may use the
61703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * {@link #getLastKnownLocation(String)} method.
61803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
6194e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> Location updates are received either by {@link LocationListener}
6204e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * callbacks, or by broadcast intents to a supplied {@link PendingIntent}.
6214e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
6224e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> If the caller supplied a pending intent, then location updates
6234e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * are sent with a key of {@link #KEY_LOCATION_CHANGED} and a
6244e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link android.location.Location} value.
6254e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
6264e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> The location update interval can be controlled using the minTime parameter.
627f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * The elapsed time between location updates will never be less than
628f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * minTime, although it can be more depending on the Location Provider
629f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * implementation and the update interval requested by other applications.
630f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
631f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * <p> Choosing a sensible value for minTime is important to conserve
632f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * battery life. Each location update requires power from
633f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * GPS, WIFI, Cell and other radios. Select a minTime value as high as
634f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * possible while still providing a reasonable user experience.
635f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * If your application is not in the foreground and showing
636f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * location to the user then your application should avoid using an active
637f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * provider (such as {@link #NETWORK_PROVIDER} or {@link #GPS_PROVIDER}),
638f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * but if you insist then select a minTime of 5 * 60 * 1000 (5 minutes)
639f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * or greater. If your application is in the foreground and showing
640f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * location to the user then it is appropriate to select a faster
641f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * update interval.
642f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
643f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * <p> The minDistance parameter can also be used to control the
644f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * frequency of location updates. If it is greater than 0 then the
645f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * location provider will only send your application an update when
646f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * the location has changed by at least minDistance meters, AND
647f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * at least minTime milliseconds have passed. However it is more
648f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * difficult for location providers to save power using the minDistance
649f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * parameter, so minTime should be the primary tool to conserving battery
650f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * life.
651f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
6524e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> If your application wants to passively observe location
6534e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * updates triggered by other applications, but not consume
6544e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * any additional power otherwise, then use the {@link #PASSIVE_PROVIDER}
6554e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * This provider does not actively turn on or modify active location
6564e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * providers, so you do not need to be as careful about minTime and
6574e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * minDistance. However if your application performs heavy work
6584e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * on a location update (such as network activity) then you should
6594e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * select non-zero values for minTime and/or minDistance to rate-limit
6604e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * your update frequency in the case another application enables a
6614e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * location provider with extremely fast updates.
662f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
6634e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>In case the provider is disabled by the user, updates will stop,
6644e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * and a provider availability update will be sent.
6654e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * As soon as the provider is enabled again,
6664e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * location updates will immediately resume and a provider availability
6674e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * update sent. Providers can also send status updates, at any time,
6684e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * with extra's specific to the provider. If a callback was supplied
6694e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * then status and availability updates are via
6704e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link LocationListener#onProviderDisabled},
6714e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link LocationListener#onProviderEnabled} or
6724e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link LocationListener#onStatusChanged}. Alternately, if a
6734e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * pending intent was supplied then status and availability updates
6744e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * are broadcast intents with extra keys of
6754e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link #KEY_PROVIDER_ENABLED} or {@link #KEY_STATUS_CHANGED}.
6764e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
6774e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> If a {@link LocationListener} is used but with no Looper specified
6784e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * then the calling thread must already
6794e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * be a {@link android.os.Looper} thread such as the main thread of the
6804e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * calling Activity. If a Looper is specified with a {@link LocationListener}
6814e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * then callbacks are made on the supplied Looper thread.
682f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
683f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * <p class="note"> Prior to Jellybean, the minTime parameter was
684f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * only a hint, and some location provider implementations ignored it.
685f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * From Jellybean and onwards it is mandatory for Android compatible
686f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * devices to observe both the minTime and minDistance parameters.
687f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     *
688f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minTime minimum time interval between location updates, in milliseconds
689f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @param minDistance minimum distance between location updates, in meters
69003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param criteria contains parameters for the location manager to choose the
69103ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * appropriate provider and parameters to compute the location
69203ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param intent a {#link PendingIntent} to be sent for each location update
69303ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
694f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly     * @throws IllegalArgumentException if criteria is null
69503ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if intent is null
6964e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
6974e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
6984e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
69903ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     */
7006fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
701f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly    public void requestLocationUpdates(long minTime, float minDistance, Criteria criteria,
702f1be6861daea57ba0a1595739a899d05229d6d15Nick Pelly            PendingIntent intent) {
7036fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkCriteria(criteria);
7046fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7066fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedCriteria(
7076fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                criteria, minTime, minDistance, false);
7086fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, null, null, intent);
7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
7109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
7119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
7124e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for a single location update using the named provider and
7134e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * a callback.
71403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
7154e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>See {@link #requestLocationUpdates(long, float, Criteria, PendingIntent)}
7164e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail on how to use this (deprecated) method.
71703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
71803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param provider the name of the provider with which to register
71903ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param listener a {#link LocationListener} whose
720e23fc8ee13605dace4a7abcdf85caec639407786Amith Yamasani     * {@link LocationListener#onLocationChanged} method will be called when
721e23fc8ee13605dace4a7abcdf85caec639407786Amith Yamasani     * the location update is available
72203ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param looper a Looper object whose message queue will be used to
7234e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * implement the callback mechanism, or null to make callbacks on the calling
7244e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * thread
72503ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
72603ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if provider is null or doesn't exist
72703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if listener is null
7284e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
7294e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
7304e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest#setNumUpdates} instead
73103ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     */
7326fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
73303ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    public void requestSingleUpdate(String provider, LocationListener listener, Looper looper) {
7346fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkProvider(provider);
7356fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkListener(listener);
7366fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
7376fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedProvider(
7386fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                provider, 0, 0, true);
7396fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, listener, looper, null);
74003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    }
74103ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood
74203ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    /**
7434e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for a single location update using a Criteria and
7444e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * a callback.
74503ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
7464e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>See {@link #requestLocationUpdates(long, float, Criteria, PendingIntent)}
7474e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail on how to use this (deprecated) method.
74803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
74903ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param criteria contains parameters for the location manager to choose the
75003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * appropriate provider and parameters to compute the location
75103ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param listener a {#link LocationListener} whose
752e23fc8ee13605dace4a7abcdf85caec639407786Amith Yamasani     * {@link LocationListener#onLocationChanged} method will be called when
753e23fc8ee13605dace4a7abcdf85caec639407786Amith Yamasani     * the location update is available
75403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param looper a Looper object whose message queue will be used to
7554e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * implement the callback mechanism, or null to make callbacks on the calling
7564e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * thread
75703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
75803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if criteria is null
75903ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if listener is null
7604e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
7614e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
7624e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest#setNumUpdates} instead
76303ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     */
7646fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
76503ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    public void requestSingleUpdate(Criteria criteria, LocationListener listener, Looper looper) {
7666fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkCriteria(criteria);
7676fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkListener(listener);
7686fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
7696fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedCriteria(
7706fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                criteria, 0, 0, true);
7716fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, listener, looper, null);
77203ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    }
77303ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood
77403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    /**
7754e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for a single location update using a named provider and pending intent.
77603ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
7774e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>See {@link #requestLocationUpdates(long, float, Criteria, PendingIntent)}
7784e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail on how to use this (deprecated) method.
779e23fc8ee13605dace4a7abcdf85caec639407786Amith Yamasani     *
78003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param provider the name of the provider with which to register
78103ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param intent a {#link PendingIntent} to be sent for the location update
78203ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
78303ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if provider is null or doesn't exist
78403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if intent is null
7854e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
7864e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
7874e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest#setNumUpdates} instead
78803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     */
7896fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
79003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    public void requestSingleUpdate(String provider, PendingIntent intent) {
7916fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkProvider(provider);
7926fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
7936fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
7946fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedProvider(
7956fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                provider, 0, 0, true);
7966fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, null, null, intent);
79703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    }
79803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood
79903ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    /**
8004e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for a single location update using a Criteria and pending intent.
80103ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
8024e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>See {@link #requestLocationUpdates(long, float, Criteria, PendingIntent)}
8034e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail on how to use this (deprecated) method.
804e23fc8ee13605dace4a7abcdf85caec639407786Amith Yamasani     *
80503ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param criteria contains parameters for the location manager to choose the
80603ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * appropriate provider and parameters to compute the location
80703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @param intent a {#link PendingIntent} to be sent for the location update
80803ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     *
80903ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if provider is null or doesn't exist
81003ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     * @throws IllegalArgumentException if intent is null
8114e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
8124e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8134e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest#setNumUpdates} instead
81403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood     */
8156fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
81603ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    public void requestSingleUpdate(Criteria criteria, PendingIntent intent) {
8176fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkCriteria(criteria);
8186fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
8196fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
8206fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedCriteria(
8216fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                criteria, 0, 0, true);
8226fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, null, null, intent);
8236fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
8246fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
8254e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    /**
8264e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for fused location updates using a LocationRequest and callback.
8274e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8284e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>The system will automatically select and enable the best providers
8294e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * to compute a location for your application. It may use only passive
8304e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * locations, or just a single location source, or it may fuse together
8314e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * multiple location sources in order to produce the best possible
8324e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * result, depending on the quality of service requested in the
8334e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link LocationRequest}.
8344e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8354e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>LocationRequest can be null, in which case the system will choose
8364e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * default, low power parameters for location updates. You will occasionally
8374e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * receive location updates as available, without a major power impact on the
8384e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * system. If your application just needs an occasional location update
8394e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * without any strict demands, then pass a null LocationRequest.
8404e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8414e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>Only one LocationRequest can be registered for each unique callback
8424e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * or pending intent. So a subsequent request with the same callback or
8434e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * pending intent will over-write the previous LocationRequest.
8444e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8454e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> If a pending intent is supplied then location updates
8464e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * are sent with a key of {@link #KEY_LOCATION_CHANGED} and a
8474e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link android.location.Location} value. If a callback is supplied
8484e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * then location updates are made using the
8494e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link LocationListener#onLocationChanged} callback, on the specified
8504e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Looper thread. If a {@link LocationListener} is used
8514e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * but with a null Looper then the calling thread must already
8524e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * be a {@link android.os.Looper} thread (such as the main thread) and
8534e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * callbacks will occur on this thread.
8544e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8554e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> Provider status updates and availability updates are deprecated
8564e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * because the system is performing provider fusion on the applications
8574e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * behalf. So {@link LocationListener#onProviderDisabled},
8584e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link LocationListener#onProviderEnabled}, {@link LocationListener#onStatusChanged}
8594e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * will not be called, and intents with extra keys of
8604e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link #KEY_PROVIDER_ENABLED} or {@link #KEY_STATUS_CHANGED} will not
8614e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * be received.
8624e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8634e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param request quality of service required, null for default low power
8644e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param listener a {#link LocationListener} whose
8654e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link LocationListener#onLocationChanged} method will be called when
8664e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * the location update is available
8674e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param looper a Looper object whose message queue will be used to
8684e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * implement the callback mechanism, or null to make callbacks on the calling
8694e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * thread
8704e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8714e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if listener is null
8724e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
8734e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     */
8746fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void requestLocationUpdates(LocationRequest request, LocationListener listener,
8756fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Looper looper) {
8766fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkListener(listener);
8776fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, listener, looper, null);
8786fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
8796fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
8804e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly
8814e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    /**
8824e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Register for fused location updates using a LocationRequest and a pending intent.
8834e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8844e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> See {@link #requestLocationUpdates(LocationRequest, LocationListener, Looper)}
8854e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * for more detail.
8864e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8874e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param request quality of service required, null for default low power
8884e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param intent a {#link PendingIntent} to be sent for the location update
8894e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
8904e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if intent is null
8914e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
8924e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     */
8936fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void requestLocationUpdates(LocationRequest request, PendingIntent intent) {
8946fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
8956fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        requestLocationUpdates(request, null, null, intent);
8966fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
8976fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
8986fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    private ListenerTransport wrapListener(LocationListener listener, Looper looper) {
8996fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (listener == null) return null;
9006fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        synchronized (mListeners) {
9016fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            ListenerTransport transport = mListeners.get(listener);
9026fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            if (transport == null) {
9036fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                transport = new ListenerTransport(listener, looper);
9046fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            }
9056fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mListeners.put(listener, transport);
9066fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            return transport;
90703ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood        }
9086fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
9096fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
9106fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    private void requestLocationUpdates(LocationRequest request, LocationListener listener,
9116fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Looper looper, PendingIntent intent) {
9126fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
9136fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        String packageName = mContext.getPackageName();
9146fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
9156fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        // wrap the listener class
9166fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        ListenerTransport transport = wrapListener(listener, looper);
9176fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
9186fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        try {
9196fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.requestLocationUpdates(request, transport, intent, packageName);
9206fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly       } catch (RemoteException e) {
9216fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly           Log.e(TAG, "RemoteException", e);
9226fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly       }
92303ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    }
92403ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood
92503ca216ac19ea4e7afcb183c20c7c780f0d97756Mike Lockwood    /**
9264e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Removes all location updates for the specified LocationListener.
9274e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
9284e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>Following this call, updates will no longer
9299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * occur for this listener.
9309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9314e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param listener listener object that no longer needs location updates
9329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if listener is null
9339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
9349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void removeUpdates(LocationListener listener) {
9356fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkListener(listener);
9366fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        String packageName = mContext.getPackageName();
9376fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
9386fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        ListenerTransport transport;
9396fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        synchronized (mListeners) {
9406fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            transport = mListeners.remove(listener);
9419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
9426fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (transport == null) return;
9436fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
9449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
9456fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.removeUpdates(transport, null, packageName);
9466fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
9476fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
9489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
9499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
9509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
9519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
9524e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Removes all location updates for the specified pending intent.
9534e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
9544e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>Following this call, updates will no longer for this pending intent.
9559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9564e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param intent pending intent object that no longer needs location updates
9579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if intent is null
9589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
9599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void removeUpdates(PendingIntent intent) {
9606fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
9616fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        String packageName = mContext.getPackageName();
9626fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
9639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
9646fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.removeUpdates(null, intent, packageName);
9656fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
9666fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
9679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
9689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
9699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
9709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
9714e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Set a proximity alert for the location given by the position
9724e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * (latitude, longitude) and the given radius.
9734e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
9744e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> When the device
9759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * detects that it has entered or exited the area surrounding the
9769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * location, the given PendingIntent will be used to create an Intent
9779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * to be fired.
9789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p> The fired Intent will have a boolean extra added with key
9809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * {@link #KEY_PROXIMITY_ENTERING}. If the value is true, the device is
9819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * entering the proximity region; if false, it is exiting.
9829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p> Due to the approximate nature of position estimation, if the
9849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * device passes through the given area briefly, it is possible
9859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * that no Intent will be fired.  Similarly, an Intent could be
9869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * fired if the device passes very close to the given area but
9879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * does not actually enter it.
9889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p> After the number of milliseconds given by the expiration
9909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * parameter, the location manager will delete this proximity
9919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * alert and no longer monitor it.  A value of -1 indicates that
9929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * there should be no expiration time.
9939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p> Internally, this method uses both {@link #NETWORK_PROVIDER}
9959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * and {@link #GPS_PROVIDER}.
9969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
9979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param latitude the latitude of the central point of the
9989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * alert region
9999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param longitude the longitude of the central point of the
10009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * alert region
10019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param radius the radius of the central point of the
10029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * alert region, in meters
10039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param expiration time for this proximity alert, in milliseconds,
10049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or -1 to indicate no expiration
10059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param intent a PendingIntent that will be used to generate an Intent to
10069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * fire when entry to or exit from the alert region is detected
10079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
10084e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
10094e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10104e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} and {@link Geofence} instead
10119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
10126fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
10136fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void addProximityAlert(double latitude, double longitude, float radius, long expiration,
10146fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            PendingIntent intent) {
10156fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
10166fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (expiration < 0) expiration = Long.MAX_VALUE;
10176fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
10186fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        Geofence fence = Geofence.createCircle(latitude, longitude, radius);
10196fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = new LocationRequest().setExpireIn(expiration);
10206fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        try {
10216fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.requestGeofence(request, fence, intent, mContext.getPackageName());
10226fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
10236fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
10249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
10256fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
10266fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
10274e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    /**
10284e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Add a geofence with the specified LocationRequest quality of service.
10294e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10304e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> When the device
10314e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * detects that it has entered or exited the area surrounding the
10324e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * location, the given PendingIntent will be used to create an Intent
10334e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * to be fired.
10344e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10354e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> The fired Intent will have a boolean extra added with key
10364e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link #KEY_PROXIMITY_ENTERING}. If the value is true, the device is
10374e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * entering the proximity region; if false, it is exiting.
10384e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10394e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> The geofence engine fuses results from all location providers to
10404e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * provide the best balance between accuracy and power. Applications
10414e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * can choose the quality of service required using the
10424e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link LocationRequest} object. If it is null then a default,
10434e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * low power geo-fencing implementation is used. It is possible to cross
10444e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * a geo-fence without notification, but the system will do its best
10454e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * to detect, using {@link LocationRequest} as a hint to trade-off
10464e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * accuracy and power.
10474e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10484e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> The power required by the geofence engine can depend on many factors,
10494e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * such as quality and interval requested in {@link LocationRequest},
10504e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * distance to nearest geofence and current device velocity.
10514e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10524e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param request quality of service required, null for default low power
10534e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param fence a geographical description of the geofence area
10544e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param intent pending intent to receive geofence updates
10554e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10564e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if fence is null
10574e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if intent is null
10584e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
10594e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     */
10604e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    public void addGeofence(LocationRequest request, Geofence fence, PendingIntent intent) {
10616fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
10626fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkGeofence(fence);
10636fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
10649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
10656fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.requestGeofence(request, fence, intent, mContext.getPackageName());
10666fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
10676fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
10689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
10699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
10709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
10719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
10729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Removes the proximity alert with the given PendingIntent.
10739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
10749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param intent the PendingIntent that no longer needs to be notified of
10759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * proximity alerts
10764e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10774e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if intent is null
10784e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
10794e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10804e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} and {@link Geofence} instead
10819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
10826fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
10839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void removeProximityAlert(PendingIntent intent) {
10846fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
10856fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        String packageName = mContext.getPackageName();
10866fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
10876fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        try {
10886fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.removeGeofence(null, intent, packageName);
10896fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
10906fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
10919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
10926fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
10936fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
10944e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    /**
10954e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Remove a single geofence.
10964e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
10974e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>This removes only the specified geofence associated with the
10984e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * specified pending intent. All other geofences remain unchanged.
10994e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11004e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param fence a geofence previously passed to {@link #addGeofence}
11014e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param intent a pending intent previously passed to {@link #addGeofence}
11024e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11034e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if fence is null
11044e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if intent is null
11054e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
11064e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     */
11076fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void removeGeofence(Geofence fence, PendingIntent intent) {
11086fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
11096fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkGeofence(fence);
11106fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        String packageName = mContext.getPackageName();
11116fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
11129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
11136fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.removeGeofence(fence, intent, packageName);
11146fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
11156fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
11166fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
11176fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
11186fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
11194e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    /**
11204e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Remove all geofences registered to the specified pending intent.
11214e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11224e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @param intent a pending intent previously passed to {@link #addGeofence}
11234e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11244e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws IllegalArgumentException if intent is null
11254e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
11264e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     */
11276fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    public void removeAllGeofences(PendingIntent intent) {
11286fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkPendingIntent(intent);
11296fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        String packageName = mContext.getPackageName();
11306fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
11316fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        try {
11326fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.removeGeofence(null, intent, packageName);
11336fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
11346fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
11359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
11369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
11379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
11389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
11394e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Returns the current enabled/disabled status of the given provider.
11404e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11414e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>If the user has enabled this provider in the Settings menu, true
11424e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * is returned otherwise false is returned
11439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
11449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the name of the provider
11459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true if the provider is enabled
11469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
1147f4d207b1c2212d6e9adc3e7954a8d14c6b9abc51Mike Lockwood     * @throws IllegalArgumentException if provider is null
11484e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
11494e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11504e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
11519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
11526fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
11539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean isProviderEnabled(String provider) {
11546fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkProvider(provider);
11556fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
11569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
11579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return mService.isProviderEnabled(provider);
11586fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
11596fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
11609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return false;
11619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
11629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
11639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
11644e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    /**
11654e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * Get the last known location.
11664e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11674e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>This location could be very old so use
11684e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * {@link Location#getElapsedRealtimeNano} to calculate its age. It can
11694e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * also return null if no previous location is available.
11704e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11714e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p>Always returns immediately.
11724e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11734e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @return The last known location, or null if not available
11744e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
11754e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     */
11764e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    public Location getLastLocation() {
11776fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        try {
11784e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly            return mService.getLastLocation(null);
11796fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
11806fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
11816fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            return null;
11826fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
11836fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
11846fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
11859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
11869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Returns a Location indicating the data from the last known
11874e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * location fix obtained from the given provider.
11884e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
11894e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * <p> This can be done
11909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * without starting the provider.  Note that this location could
11919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * be out-of-date, for example if the device was turned off and
11929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * moved to another location.
11939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
11949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * <p> If the provider is currently disabled, null is returned.
11959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
11969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the name of the provider
11979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return the last known location for the provider, or null
11989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
11994e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @throws SecurityException if no suitable permission is present
12009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if provider is null or doesn't exist
12014e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
12024e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link #getLastLocation} instead
12039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
12046fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
12059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public Location getLastKnownLocation(String provider) {
12066fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        checkProvider(provider);
12076fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
12086fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        LocationRequest request = LocationRequest.createFromDeprecatedProvider(
12096fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                provider, 0, 0, true);
12106fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
12116fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        try {
12126fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            return mService.getLastLocation(request);
12136fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
12146fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
12156fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            return null;
12169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
12176fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
12186fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
12194e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    // --- Mock provider support ---
12204e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    // TODO: It would be fantastic to deprecate mock providers entirely, and replace
12214e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    // with something closer to LocationProviderBase.java
12229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
12239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
12249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Creates a mock location provider and adds it to the set of active providers.
12259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
12269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param name the provider name
12279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
12289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_MOCK_LOCATION permission is not present
12299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or the {@link android.provider.Settings.Secure#ALLOW_MOCK_LOCATION
12309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Settings.Secure.ALLOW_MOCK_LOCATION} system setting is not enabled
12319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if a provider with the given name already exists
12324e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
12334e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated requesting location providers by name is deprecated
12349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
12356fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
12369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void addTestProvider(String name, boolean requiresNetwork, boolean requiresSatellite,
12376fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            boolean requiresCell, boolean hasMonetaryCost, boolean supportsAltitude,
12386fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            boolean supportsSpeed, boolean supportsBearing, int powerRequirement, int accuracy) {
12396fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        ProviderProperties properties = new ProviderProperties(requiresNetwork,
12406fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                requiresSatellite, requiresCell, hasMonetaryCost, supportsAltitude, supportsSpeed,
12416fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                supportsBearing, powerRequirement, accuracy);
12426fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (name.matches(LocationProvider.BAD_CHARS_REGEX)) {
12436fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            throw new IllegalArgumentException("provider name contains illegal character: " + name);
12446fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
12456fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
12469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
12476fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            mService.addTestProvider(name, properties);
12486fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
12496fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
12509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
12519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
12529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
12539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
12549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Removes the mock location provider with the given name.
12559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
12569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the provider name
12579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
12589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_MOCK_LOCATION permission is not present
12599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or the {@link android.provider.Settings.Secure#ALLOW_MOCK_LOCATION
12609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Settings.Secure.ALLOW_MOCK_LOCATION}} system setting is not enabled
12619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if no provider with the given name exists
12624e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
12634e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated requesting location providers by name is deprecated
12649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
12656fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
12669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void removeTestProvider(String provider) {
12679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
12689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mService.removeTestProvider(provider);
12696fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
12706fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
12719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
12729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
12739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
12749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
12752eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly     * Sets a mock location for the given provider.
12762eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly     * <p>This location will be used in place of any actual location from the provider.
12772eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly     * The location object must have a minimum number of fields set to be
12782eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly     * considered a valid LocationProvider Location, as per documentation
12792eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly     * on {@link Location} class.
12809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
12819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the provider name
12829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param loc the mock location
12839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
12849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_MOCK_LOCATION permission is not present
12859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or the {@link android.provider.Settings.Secure#ALLOW_MOCK_LOCATION
12869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Settings.Secure.ALLOW_MOCK_LOCATION}} system setting is not enabled
12879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if no provider with the given name exists
12882eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly     * @throws IllegalArgumentException if the location is incomplete
12894e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
12904e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated requesting location providers by name is deprecated
12919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
12926fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
12939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void setTestProviderLocation(String provider, Location loc) {
12942eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly        if (!loc.isComplete()) {
12956fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            IllegalArgumentException e = new IllegalArgumentException(
12966fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                    "Incomplete location object, missing timestamp or accuracy? " + loc);
12972eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly            if (mContext.getApplicationInfo().targetSdkVersion <= Build.VERSION_CODES.JELLY_BEAN) {
12986fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                // just log on old platform (for backwards compatibility)
12996fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                Log.w(TAG, e);
13002eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly                loc.makeComplete();
13012eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly            } else {
13026fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                // really throw it!
13036fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                throw e;
13042eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly            }
13052eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly        }
13062eeeec248a38ff33999c83f4b8d5bab7d50e79d2Nick Pelly
13079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
13089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mService.setTestProviderLocation(provider, loc);
13096fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
13106fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
13119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
13129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
13139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
13159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Removes any mock location associated with the given provider.
13169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the provider name
13189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_MOCK_LOCATION permission is not present
13209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or the {@link android.provider.Settings.Secure#ALLOW_MOCK_LOCATION
13219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Settings.Secure.ALLOW_MOCK_LOCATION}} system setting is not enabled
13229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if no provider with the given name exists
13234e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
13244e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated requesting location providers by name is deprecated
13259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
13266fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
13279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void clearTestProviderLocation(String provider) {
13289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
13299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mService.clearTestProviderLocation(provider);
13306fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
13316fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
13329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
13339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
13349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
13369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Sets a mock enabled value for the given provider.  This value will be used in place
13379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * of any actual value from the provider.
13389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the provider name
13409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param enabled the mock enabled value
13419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_MOCK_LOCATION permission is not present
13439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or the {@link android.provider.Settings.Secure#ALLOW_MOCK_LOCATION
13449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Settings.Secure.ALLOW_MOCK_LOCATION}} system setting is not enabled
13459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if no provider with the given name exists
13464e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
13474e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated requesting location providers by name is deprecated
13489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
13496fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
13509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void setTestProviderEnabled(String provider, boolean enabled) {
13519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
13529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mService.setTestProviderEnabled(provider, enabled);
13536fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
13546fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
13559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
13569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
13579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
13599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Removes any mock enabled value associated with the given provider.
13609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the provider name
13629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_MOCK_LOCATION permission is not present
13649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or the {@link android.provider.Settings.Secure#ALLOW_MOCK_LOCATION
13659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Settings.Secure.ALLOW_MOCK_LOCATION}} system setting is not enabled
13669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if no provider with the given name exists
13674e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
13684e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated requesting location providers by name is deprecated
13699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
13706fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
13719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void clearTestProviderEnabled(String provider) {
13729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
13739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mService.clearTestProviderEnabled(provider);
13746fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
13756fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
13769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
13779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
13789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
13799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
13809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Sets mock status values for the given provider.  These values will be used in place
13819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * of any actual values from the provider.
13829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the provider name
13849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param status the mock status
13859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param extras a Bundle containing mock extras
13869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param updateTime the mock update time
13879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
13889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_MOCK_LOCATION permission is not present
13899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or the {@link android.provider.Settings.Secure#ALLOW_MOCK_LOCATION
13909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Settings.Secure.ALLOW_MOCK_LOCATION}} system setting is not enabled
13919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if no provider with the given name exists
13924e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
13934e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated requesting location providers by name is deprecated
13949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
13956fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
13969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void setTestProviderStatus(String provider, int status, Bundle extras, long updateTime) {
13979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
13989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mService.setTestProviderStatus(provider, status, extras, updateTime);
13996fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
14006fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
14019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
14029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
14039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
14059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Removes any mock status values associated with the given provider.
14069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
14079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider the provider name
14089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
14099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_MOCK_LOCATION permission is not present
14109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * or the {@link android.provider.Settings.Secure#ALLOW_MOCK_LOCATION
14119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Settings.Secure.ALLOW_MOCK_LOCATION}} system setting is not enabled
14129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws IllegalArgumentException if no provider with the given name exists
14134e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
14144e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated requesting location providers by name is deprecated
14159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
14166fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
14179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void clearTestProviderStatus(String provider) {
14189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
14199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mService.clearTestProviderStatus(provider);
14206fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        } catch (RemoteException e) {
14216fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            Log.e(TAG, "RemoteException", e);
14229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
14239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
14249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14254e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly    // --- GPS-specific support ---
14269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    // This class is used to send GPS status events to the client's main thread.
14289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    private class GpsStatusListenerTransport extends IGpsStatusListener.Stub {
14299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private final GpsStatus.Listener mListener;
1431b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        private final GpsStatus.NmeaListener mNmeaListener;
1432b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
1433b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        // This must not equal any of the GpsStatus event IDs
1434b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        private static final int NMEA_RECEIVED = 1000;
1435b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
1436b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        private class Nmea {
1437b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            long mTimestamp;
1438b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            String mNmea;
1439b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
1440b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            Nmea(long timestamp, String nmea) {
1441b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mTimestamp = timestamp;
1442b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mNmea = nmea;
1443b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            }
1444b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        }
1445b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        private ArrayList<Nmea> mNmeaBuffer;
14469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
14479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        GpsStatusListenerTransport(GpsStatus.Listener listener) {
14489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            mListener = listener;
1449b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            mNmeaListener = null;
1450b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        }
1451b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
1452b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        GpsStatusListenerTransport(GpsStatus.NmeaListener listener) {
1453b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            mNmeaListener = listener;
1454b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            mListener = null;
1455b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            mNmeaBuffer = new ArrayList<Nmea>();
14569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
14579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1458e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
14599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void onGpsStarted() {
1460b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            if (mListener != null) {
1461b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                Message msg = Message.obtain();
1462b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                msg.what = GpsStatus.GPS_EVENT_STARTED;
1463b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsHandler.sendMessage(msg);
1464b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            }
14659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
14669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1467e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
14689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void onGpsStopped() {
1469b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            if (mListener != null) {
1470b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                Message msg = Message.obtain();
1471b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                msg.what = GpsStatus.GPS_EVENT_STOPPED;
1472b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsHandler.sendMessage(msg);
1473b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            }
14749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
14759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1476e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
14779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void onFirstFix(int ttff) {
1478b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            if (mListener != null) {
1479b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsStatus.setTimeToFirstFix(ttff);
1480b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                Message msg = Message.obtain();
1481b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                msg.what = GpsStatus.GPS_EVENT_FIRST_FIX;
1482b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsHandler.sendMessage(msg);
1483b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            }
14849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
14859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1486e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
14879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        public void onSvStatusChanged(int svCount, int[] prns, float[] snrs,
14889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                float[] elevations, float[] azimuths, int ephemerisMask,
14899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                int almanacMask, int usedInFixMask) {
1490b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            if (mListener != null) {
1491b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsStatus.setStatus(svCount, prns, snrs, elevations, azimuths,
1492b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                        ephemerisMask, almanacMask, usedInFixMask);
1493b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
1494b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                Message msg = Message.obtain();
1495b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                msg.what = GpsStatus.GPS_EVENT_SATELLITE_STATUS;
1496b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                // remove any SV status messages already in the queue
1497b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsHandler.removeMessages(GpsStatus.GPS_EVENT_SATELLITE_STATUS);
1498b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsHandler.sendMessage(msg);
1499b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            }
1500b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        }
15019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1502e0fd693c6098f59004f9e96ad75c058e26c337b0Nick Pelly        @Override
1503b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        public void onNmeaReceived(long timestamp, String nmea) {
1504b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            if (mNmeaListener != null) {
1505b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                synchronized (mNmeaBuffer) {
1506b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                    mNmeaBuffer.add(new Nmea(timestamp, nmea));
1507b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                }
1508b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                Message msg = Message.obtain();
1509b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                msg.what = NMEA_RECEIVED;
1510b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                // remove any NMEA_RECEIVED messages already in the queue
1511b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsHandler.removeMessages(NMEA_RECEIVED);
1512b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mGpsHandler.sendMessage(msg);
1513b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            }
15149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
15159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        private final Handler mGpsHandler = new Handler() {
15179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            @Override
15189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            public void handleMessage(Message msg) {
1519b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                if (msg.what == NMEA_RECEIVED) {
1520b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                    synchronized (mNmeaBuffer) {
1521b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                        int length = mNmeaBuffer.size();
1522b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                        for (int i = 0; i < length; i++) {
1523b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                            Nmea nmea = mNmeaBuffer.get(i);
1524b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                            mNmeaListener.onNmeaReceived(nmea.mTimestamp, nmea.mNmea);
1525b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                        }
1526b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                        mNmeaBuffer.clear();
1527b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                    }
1528b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                } else {
1529b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                    // synchronize on mGpsStatus to ensure the data is copied atomically.
1530b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                    synchronized(mGpsStatus) {
1531b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                        mListener.onGpsStatusChanged(msg.what);
1532b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                    }
15339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                }
15349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
15359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        };
15369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
15379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
15399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Adds a GPS status listener.
15409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
15419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param listener GPS status listener object to register
15429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
15439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true if the listener was successfully added
1544a550bdc84af70babb48091197bfb1b93d3671664Daisuke Miyakawa     *
15459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @throws SecurityException if the ACCESS_FINE_LOCATION permission is not present
15469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
15479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean addGpsStatusListener(GpsStatus.Listener listener) {
15489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        boolean result;
15499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (mGpsStatusListeners.get(listener) != null) {
15519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            // listener is already registered
15529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return true;
15539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
15549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
15559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            GpsStatusListenerTransport transport = new GpsStatusListenerTransport(listener);
15569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            result = mService.addGpsStatusListener(transport);
15579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (result) {
15589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mGpsStatusListeners.put(listener, transport);
15599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
15609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (RemoteException e) {
15619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Log.e(TAG, "RemoteException in registerGpsStatusListener: ", e);
15629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            result = false;
15639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
15649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        return result;
15669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
15679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
15689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
15699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Removes a GPS status listener.
15709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
15719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param listener GPS status listener object to remove
15729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
15739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public void removeGpsStatusListener(GpsStatus.Listener listener) {
15749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
15759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            GpsStatusListenerTransport transport = mGpsStatusListeners.remove(listener);
15769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            if (transport != null) {
15779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project                mService.removeGpsStatusListener(transport);
15789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            }
15799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (RemoteException e) {
15809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Log.e(TAG, "RemoteException in unregisterGpsStatusListener: ", e);
15819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
15829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
15839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
1584b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood    /**
1585b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     * Adds an NMEA listener.
1586b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     *
1587640992dec96fa88f0bbd42c6a02902640a000b35Mike Lockwood     * @param listener a {#link GpsStatus.NmeaListener} object to register
1588b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     *
1589b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     * @return true if the listener was successfully added
1590b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     *
1591b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     * @throws SecurityException if the ACCESS_FINE_LOCATION permission is not present
1592b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     */
1593b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood    public boolean addNmeaListener(GpsStatus.NmeaListener listener) {
1594b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        boolean result;
1595b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
1596b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        if (mNmeaListeners.get(listener) != null) {
1597b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            // listener is already registered
1598b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            return true;
1599b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        }
1600b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        try {
1601b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            GpsStatusListenerTransport transport = new GpsStatusListenerTransport(listener);
1602b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            result = mService.addGpsStatusListener(transport);
1603b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            if (result) {
1604b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mNmeaListeners.put(listener, transport);
1605b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            }
1606b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        } catch (RemoteException e) {
1607b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            Log.e(TAG, "RemoteException in registerGpsStatusListener: ", e);
1608b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            result = false;
1609b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        }
1610b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
1611b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        return result;
1612b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood    }
1613b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
1614b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood    /**
1615b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     * Removes an NMEA listener.
1616b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     *
1617640992dec96fa88f0bbd42c6a02902640a000b35Mike Lockwood     * @param listener a {#link GpsStatus.NmeaListener} object to remove
1618b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood     */
1619b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood    public void removeNmeaListener(GpsStatus.NmeaListener listener) {
1620b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        try {
1621b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            GpsStatusListenerTransport transport = mNmeaListeners.remove(listener);
1622b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            if (transport != null) {
1623b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood                mService.removeGpsStatusListener(transport);
1624b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            }
1625b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        } catch (RemoteException e) {
1626b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood            Log.e(TAG, "RemoteException in unregisterGpsStatusListener: ", e);
1627b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood        }
1628b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood    }
1629b16e7800be4f879135f239f1f8f586f3712df01eMike Lockwood
16309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     /**
16319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Retrieves information about the current status of the GPS engine.
16329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * This should only be called from the {@link GpsStatus.Listener#onGpsStatusChanged}
16339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * callback to ensure that the data is copied atomically.
16349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
16359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * The caller may either pass in a {@link GpsStatus} object to set with the latest
16369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * status information, or pass null to create a new {@link GpsStatus} object.
16379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
16389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param status object containing GPS status details, or null.
16399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return status object containing updated GPS status.
16409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
16419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public GpsStatus getGpsStatus(GpsStatus status) {
16429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        if (status == null) {
16439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            status = new GpsStatus();
16449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project       }
16459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project       status.setStatus(mGpsStatus);
16469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project       return status;
16479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
16489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project
16499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    /**
16509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Sends additional commands to a location provider.
16519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * Can be used to support provider specific extensions to the Location Manager API
16529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
16539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param provider name of the location provider.
16549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param command name of the command to send to the provider.
16559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @param extras optional arguments for the command (or null).
16569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * The provider may optionally fill the extras Bundle with results from the command.
16579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     *
16589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     * @return true if the command succeeds.
16594e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     *
16604e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @deprecated Use {@link LocationRequest} instead, see notes on {@link LocationManager}
16619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project     */
16626fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    @Deprecated
16639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    public boolean sendExtraCommand(String provider, String command, Bundle extras) {
16649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        try {
16659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return mService.sendExtraCommand(provider, command, extras);
16669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        } catch (RemoteException e) {
16679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            Log.e(TAG, "RemoteException in sendExtraCommand: ", e);
16689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project            return false;
16699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project        }
16709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project    }
1671a550bdc84af70babb48091197bfb1b93d3671664Daisuke Miyakawa
167222d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie    /**
167322d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie     * Used by NetInitiatedActivity to report user response
167422d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie     * for network initiated GPS fix requests.
167522d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie     *
16764e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly     * @hide
167722d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie     */
167822d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie    public boolean sendNiResponse(int notifId, int userResponse) {
167922d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie    	try {
168022d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie            return mService.sendNiResponse(notifId, userResponse);
168122d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie        } catch (RemoteException e) {
168222d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie            Log.e(TAG, "RemoteException in sendNiResponse: ", e);
168322d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie            return false;
168422d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie        }
168522d1f9fb23015471de6af1a70e40fb5c82ecb665Danke Xie    }
1686a550bdc84af70babb48091197bfb1b93d3671664Daisuke Miyakawa
16876fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    private static void checkProvider(String provider) {
16886fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (provider == null) {
16896fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            throw new IllegalArgumentException("invalid provider: " + provider);
16906fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
16916fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
16926fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
16936fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    private static void checkCriteria(Criteria criteria) {
16946fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (criteria == null) {
16956fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            throw new IllegalArgumentException("invalid criteria: " + criteria);
16966fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
16976fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
16984e31c4fffbc42b4c2b5dca6431cfeef9e078f5b4Nick Pelly
16996fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    private static void checkListener(LocationListener listener) {
17006fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (listener == null) {
17016fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            throw new IllegalArgumentException("invalid listener: " + listener);
17026fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
17036fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
17046fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
17056fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    private void checkPendingIntent(PendingIntent intent) {
17066fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (intent == null) {
17076fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            throw new IllegalArgumentException("invalid pending intent: " + intent);
17086fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
17096fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (!intent.isTargetedToPackage()) {
17106fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            IllegalArgumentException e = new IllegalArgumentException(
17116fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                    "pending intent msut be targeted to package");
17126fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            if (mContext.getApplicationInfo().targetSdkVersion > Build.VERSION_CODES.JELLY_BEAN) {
17136fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                throw e;
17146fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            } else {
17156fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly                Log.w(TAG, e);
17166fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            }
17176fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
17186fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
17196fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly
17206fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    private static void checkGeofence(Geofence fence) {
17216fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        if (fence == null) {
17226fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly            throw new IllegalArgumentException("invalid geofence: " + fence);
17236fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly        }
17246fa9ad4afcd762aea519ff61811386c23d18ddb2Nick Pelly    }
17259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project}
1726