blob: 0dc61ef05a2c1a1b801f2ebf2cee54e263897767 [file] [log] [blame]
// Copyright (c) 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/callback.h"
#include "base/compiler_specific.h"
#include "content/public/common/geoposition.h"
namespace content {
class LocationProvider;
// The interface for providing location information.
class LocationProvider {
virtual ~LocationProvider() {}
typedef base::Callback<void(const LocationProvider*, const Geoposition&)>
// This callback will be used to notify when a new Geoposition becomes
// available.
virtual void SetUpdateCallback(
const LocationProviderUpdateCallback& callback) = 0;
// StartProvider maybe called multiple times, e.g. to alter the
// |high_accuracy| setting. Returns false if a fatal error was encountered
// which prevented the provider from starting.
virtual bool StartProvider(bool high_accuracy) = 0;
// Stops the provider from sending more requests.
// Important: a LocationProvider may be instantiated and StartProvider() may
// be called before the user has granted permission via OnPermissionGranted().
// This is to allow underlying providers to warm up, load their internal
// libraries, etc. No |LocationProviderUpdateCallback| can be run and no
// network requests can be done until OnPermissionGranted() has been called.
virtual void StopProvider() = 0;
// Gets the current best position estimate.
virtual void GetPosition(Geoposition* position) = 0;
// Provides a hint to the provider that new location data is needed as soon
// as possible.
virtual void RequestRefresh() = 0;
// Called everytime permission is granted to a page for using geolocation.
// This may either be through explicit user action (e.g. responding to the
// infobar prompt) or inferred from a persisted site permission.
// Note: See |StartProvider()| for more information.
virtual void OnPermissionGranted() = 0;
} // namespace content