chrome/browser/extensions/api/hotword_private/hotword_private_api.h

   1 // Copyright 2014 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 CHROME_BROWSER_EXTENSIONS_API_HOTWORD_PRIVATE_HOTWORD_PRIVATE_API_H_
   6 #define CHROME_BROWSER_EXTENSIONS_API_HOTWORD_PRIVATE_HOTWORD_PRIVATE_API_H_
   7
   8 #include "base/prefs/pref_change_registrar.h"
   9 #include "base/values.h"
  10 #include "chrome/browser/extensions/chrome_extension_function.h"
  11 #include "chrome/common/extensions/api/hotword_private.h"
  12 #include "extensions/browser/browser_context_keyed_api_factory.h"
  13 #include "extensions/browser/extension_event_histogram_value.h"
  14
  15 class Profile;
  16
  17 namespace extensions {
  18
  19 // Listens for changes in disable/enabled state and forwards as an extension
  20 // event.
  21 class HotwordPrivateEventService : public BrowserContextKeyedAPI {
  22  public:
  23   explicit HotwordPrivateEventService(content::BrowserContext* context);
  24   ~HotwordPrivateEventService() override;
  25
  26   // BrowserContextKeyedAPI implementation.
  27   void Shutdown() override;
  28   static BrowserContextKeyedAPIFactory<HotwordPrivateEventService>*
  29       GetFactoryInstance();
  30   static const char* service_name();
  31
  32   void OnEnabledChanged(const std::string& pref_name);
  33
  34   void OnHotwordSessionRequested();
  35
  36   void OnHotwordSessionStopped();
  37
  38   void OnHotwordTriggered();
  39
  40   void OnFinalizeSpeakerModel();
  41
  42   void OnSpeakerModelSaved();
  43
  44   void OnDeleteSpeakerModel();
  45
  46   void OnSpeakerModelExists();
  47
  48   void OnMicrophoneStateChanged(bool enabled);
  49
  50  private:
  51   friend class BrowserContextKeyedAPIFactory<HotwordPrivateEventService>;
  52
  53   void SignalEvent(events::HistogramValue histogram_value,
  54                    const std::string& event_name);
  55   void SignalEvent(events::HistogramValue histogram_value,
  56                    const std::string& event_name,
  57                    scoped_ptr<base::ListValue> args);
  58
  59   Profile* profile_;
  60   PrefChangeRegistrar pref_change_registrar_;
  61 };
  62
  63
  64 class HotwordPrivateSetEnabledFunction : public ChromeSyncExtensionFunction {
  65  public:
  66   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.setEnabled",
  67                              HOTWORDPRIVATE_SETENABLED)
  68
  69  protected:
  70   ~HotwordPrivateSetEnabledFunction() override {}
  71
  72   // ExtensionFunction:
  73   bool RunSync() override;
  74 };
  75
  76 class HotwordPrivateSetAudioLoggingEnabledFunction
  77     : public ChromeSyncExtensionFunction {
  78  public:
  79   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.setAudioLoggingEnabled",
  80                              HOTWORDPRIVATE_SETAUDIOLOGGINGENABLED)
  81
  82  protected:
  83   ~HotwordPrivateSetAudioLoggingEnabledFunction() override {}
  84
  85   // ExtensionFunction:
  86   bool RunSync() override;
  87 };
  88
  89 class HotwordPrivateSetHotwordAlwaysOnSearchEnabledFunction
  90     : public ChromeSyncExtensionFunction {
  91  public:
  92   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.setHotwordAlwaysOnSearchEnabled",
  93                              HOTWORDPRIVATE_SETHOTWORDALWAYSONSEARCHENABLED)
  94
  95  protected:
  96   ~HotwordPrivateSetHotwordAlwaysOnSearchEnabledFunction() override {}
  97
  98   // ExtensionFunction:
  99   bool RunSync() override;
 100 };
 101
 102 class HotwordPrivateGetStatusFunction : public ChromeSyncExtensionFunction {
 103  public:
 104   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.getStatus",
 105                              HOTWORDPRIVATE_GETSTATUS)
 106
 107  protected:
 108   ~HotwordPrivateGetStatusFunction() override {}
 109
 110   // ExtensionFunction:
 111   bool RunSync() override;
 112 };
 113
 114 class HotwordPrivateSetHotwordSessionStateFunction
 115     : public ChromeSyncExtensionFunction {
 116  public:
 117   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.setHotwordSessionState",
 118                              HOTWORDPRIVATE_SETHOTWORDSESSIONSTATE);
 119
 120  protected:
 121   ~HotwordPrivateSetHotwordSessionStateFunction() override {}
 122
 123   // ExtensionFunction:
 124   bool RunSync() override;
 125 };
 126
 127 class HotwordPrivateNotifyHotwordRecognitionFunction
 128     : public ChromeSyncExtensionFunction {
 129  public:
 130   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.notifyHotwordRecognition",
 131                              HOTWORDPRIVATE_NOTIFYHOTWORDRECOGNITION);
 132
 133  protected:
 134   ~HotwordPrivateNotifyHotwordRecognitionFunction() override {}
 135
 136   // ExtensionFunction:
 137   bool RunSync() override;
 138 };
 139
 140 class HotwordPrivateGetLaunchStateFunction :
 141     public ChromeSyncExtensionFunction {
 142  public:
 143   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.getLaunchState",
 144                              HOTWORDPRIVATE_GETLAUNCHSTATE)
 145
 146  protected:
 147   ~HotwordPrivateGetLaunchStateFunction() override {}
 148
 149   // ExtensionFunction:
 150   bool RunSync() override;
 151 };
 152
 153 class HotwordPrivateStartTrainingFunction :
 154     public ChromeSyncExtensionFunction {
 155  public:
 156   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.startTraining",
 157                              HOTWORDPRIVATE_STARTTRAINING)
 158
 159  protected:
 160   ~HotwordPrivateStartTrainingFunction() override {}
 161
 162   // ExtensionFunction:
 163   bool RunSync() override;
 164 };
 165
 166 class HotwordPrivateFinalizeSpeakerModelFunction :
 167     public ChromeSyncExtensionFunction {
 168  public:
 169   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.finalizeSpeakerModel",
 170                              HOTWORDPRIVATE_FINALIZESPEAKERMODEL)
 171
 172  protected:
 173   ~HotwordPrivateFinalizeSpeakerModelFunction() override {}
 174
 175   // ExtensionFunction:
 176   bool RunSync() override;
 177 };
 178
 179 class HotwordPrivateNotifySpeakerModelSavedFunction :
 180     public ChromeSyncExtensionFunction {
 181  public:
 182   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.notifySpeakerModelSaved",
 183                              HOTWORDPRIVATE_NOTIFYSPEAKERMODELSAVED)
 184
 185  protected:
 186   ~HotwordPrivateNotifySpeakerModelSavedFunction() override {}
 187
 188   // ExtensionFunction:
 189   bool RunSync() override;
 190 };
 191
 192 class HotwordPrivateStopTrainingFunction :
 193     public ChromeSyncExtensionFunction {
 194  public:
 195   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.stopTraining",
 196                              HOTWORDPRIVATE_STOPTRAINING)
 197
 198  protected:
 199   ~HotwordPrivateStopTrainingFunction() override {}
 200
 201   // ExtensionFunction:
 202   bool RunSync() override;
 203 };
 204
 205 class HotwordPrivateGetLocalizedStringsFunction
 206     : public ChromeSyncExtensionFunction {
 207  public:
 208   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.getLocalizedStrings",
 209                              HOTWORDPRIVATE_GETLOCALIZEDSTRINGS)
 210
 211  protected:
 212   ~HotwordPrivateGetLocalizedStringsFunction() override {}
 213
 214   // ExtensionFunction:
 215   bool RunSync() override;
 216 };
 217
 218 class HotwordPrivateSetAudioHistoryEnabledFunction
 219     : public ChromeAsyncExtensionFunction {
 220  public:
 221   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.setAudioHistoryEnabled",
 222                              HOTWORDPRIVATE_SETAUDIOHISTORYENABLED)
 223
 224  protected:
 225   ~HotwordPrivateSetAudioHistoryEnabledFunction() override {}
 226
 227   // ExtensionFunction:
 228   bool RunAsync() override;
 229
 230   void SetResultAndSendResponse(bool success, bool new_enabled_value);
 231 };
 232
 233 class HotwordPrivateGetAudioHistoryEnabledFunction
 234     : public ChromeAsyncExtensionFunction {
 235  public:
 236   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.getAudioHistoryEnabled",
 237                              HOTWORDPRIVATE_GETAUDIOHISTORYENABLED)
 238
 239  protected:
 240   ~HotwordPrivateGetAudioHistoryEnabledFunction() override {}
 241
 242   // ExtensionFunction:
 243   bool RunAsync() override;
 244
 245   void SetResultAndSendResponse(bool success, bool new_enabled_value);
 246 };
 247
 248 class HotwordPrivateSpeakerModelExistsResultFunction :
 249     public ChromeSyncExtensionFunction {
 250  public:
 251   DECLARE_EXTENSION_FUNCTION("hotwordPrivate.speakerModelExistsResult",
 252                              HOTWORDPRIVATE_SPEAKERMODELEXISTSRESULT)
 253
 254  protected:
 255   ~HotwordPrivateSpeakerModelExistsResultFunction() override {}
 256
 257   // ExtensionFunction:
 258   bool RunSync() override;
 259 };
 260
 261 }  // namespace extensions
 262
 263 #endif  // CHROME_BROWSER_EXTENSIONS_API_HOTWORD_PRIVATE_HOTWORD_PRIVATE_API_H_