components/user_manager/user_info.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 COMPONENTS_USER_MANAGER_USER_INFO_H_
   6 #define COMPONENTS_USER_MANAGER_USER_INFO_H_
   7
   8 #include <string>
   9
  10 #include "base/strings/string16.h"
  11 #include "components/user_manager/user_id.h"
  12 #include "components/user_manager/user_manager_export.h"
  13
  14 namespace gfx {
  15 class ImageSkia;
  16 }
  17
  18 namespace user_manager {
  19
  20 // A class that represents user related info.
  21 class USER_MANAGER_EXPORT UserInfo {
  22  public:
  23   UserInfo();
  24   virtual ~UserInfo();
  25
  26   // Gets the display name for the user.
  27   virtual base::string16 GetDisplayName() const = 0;
  28
  29   // Gets the given name of the user.
  30   virtual base::string16 GetGivenName() const = 0;
  31
  32   // Gets the display email address for the user.
  33   // The display email address might contains some periods in the email name
  34   // as well as capitalized letters. For example: "Foo.Bar@mock.com".
  35   virtual std::string GetEmail() const = 0;
  36
  37   // Gets the user id (sanitized email address) for the user.
  38   // The function would return something like "foobar@mock.com".
  39   virtual UserID GetUserID() const = 0;
  40
  41   // Gets the avatar image for the user.
  42   virtual const gfx::ImageSkia& GetImage() const = 0;
  43 };
  44
  45 }  // namespace user_manager
  46
  47 #endif  // COMPONENTS_USER_MANAGER_USER_INFO_H_