components/proximity_auth/proximity_auth_client.h

   1 // Copyright 2015 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 COMPONENTS_PROXIMITY_AUTH_CLIENT_H_
   6 #define COMPONENTS_PROXIMITY_AUTH_CLIENT_H_
   7
   8 #include <string>
   9
  10 #include "components/proximity_auth/screenlock_state.h"
  11
  12 namespace proximity_auth {
  13
  14 // An interface that needs to be supplied to the Proximity Auth component by its
  15 // embedder. There should be one |ProximityAuthClient| per
  16 // |content::BrowserContext|.
  17 class ProximityAuthClient {
  18  public:
  19   virtual ~ProximityAuthClient() {}
  20
  21   // Returns the authenticated username.
  22   virtual std::string GetAuthenticatedUsername() const = 0;
  23
  24   // Updates the user pod on the signin or lock screen to reflect the provided
  25   // screenlock state.
  26   virtual void UpdateScreenlockState(ScreenlockState state) = 0;
  27
  28   // Finalizes an unlock attempt initiated by the user. If |success| is true,
  29   // the screen is unlocked; otherwise, the auth attempt is rejected. An auth
  30   // attempt must be in progress before calling this function.
  31   virtual void FinalizeUnlock(bool success) = 0;
  32
  33   // Finalizes a sign-in attempt initiated by the user. If |success| is true,
  34   // the user is signed in; otherwise, the auth attempt is rejected. An auth
  35   // attempt must be in progress before calling this function.
  36   virtual void FinalizeSignin(const std::string& secret) = 0;
  37 };
  38
  39 }  // namespace proximity_auth
  40
  41 #endif  // COMPONENTS_PROXIMITY_AUTH_CLIENT_H_