ios/chrome/browser/geolocation/omnibox_geolocation_local_state.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef IOS_CHROME_BROWSER_GEOLOCATION_OMNIBOX_GEOLOCATION_LOCAL_STATE_H_
   6 #define IOS_CHROME_BROWSER_GEOLOCATION_OMNIBOX_GEOLOCATION_LOCAL_STATE_H_
   7
   8 #import <Foundation/Foundation.h>
   9 #include <string>
  10
  11 namespace geolocation {
  12
  13 // These constants indicate whether the user has authorized using geolocation
  14 // for Omnibox queries.
  15 typedef NS_ENUM(int, AuthorizationState) {
  16   // Not yet determined and waiting for the load of the first SRP after N
  17   // Omnibox queries before soliciting the user's authorization.
  18   kAuthorizationStateNotDeterminedWaiting = 0,
  19   // Not yet determined and prompting the user with the iOS system location
  20   // authorization alert.
  21   kAuthorizationStateNotDeterminedSystemPrompt,
  22   // The user explicitly denied using geolocation for Omnibox queries.
  23   kAuthorizationStateDenied,
  24   // The user has authorized using geolocation for Omnibox queries.
  25   kAuthorizationStateAuthorized,
  26 };
  27
  28 }  // geolocation
  29
  30 @class LocationManager;
  31 class PrefRegistrySimple;
  32
  33 // Manages local state preferences for using geolocation for Omnibox queries.
  34 @interface OmniboxGeolocationLocalState : NSObject
  35
  36 // Registers local state preferences.
  37 + (void)registerLocalState:(PrefRegistrySimple*)registry;
  38
  39 // AuthorizationState value stored in local state that records whether user has
  40 // authorized using geolocation for Omnibox queries or the progress towards
  41 // soliciting the user's authorization.
  42 @property(nonatomic, assign) geolocation::AuthorizationState authorizationState;
  43
  44 // String value stored in local state that records the application version when
  45 // we last showed the authorization alert.
  46 @property(nonatomic, assign) std::string lastAuthorizationAlertVersion;
  47
  48 // Designated initializer.
  49 - (instancetype)initWithLocationManager:(LocationManager*)locationManager
  50     NS_DESIGNATED_INITIALIZER;
  51
  52 - (instancetype)init NS_UNAVAILABLE;
  53
  54 @end
  55
  56 #endif  // IOS_CHROME_BROWSER_GEOLOCATION_OMNIBOX_GEOLOCATION_LOCAL_STATE_H_