#include <LocalUserProfile.h>
Abstract class that represents a local user profile, uniquely identified by a local user id. Please note that on some platforms there does not exist any concept of a local user profile.
◆ LocalUserProfile()
LocalUser::LocalUserProfile::LocalUserProfile |
( |
AzFramework::LocalUserId |
locaUserId | ) |
|
|
inlineexplicit |
Constructor
- Parameters
-
[in] | localUserId | The local user id that uniquely identifies the local user profile |
◆ GetLocalUserId()
AzFramework::LocalUserId LocalUser::LocalUserProfile::GetLocalUserId |
( |
| ) |
const |
|
inline |
Get the local user id that uniquely identifies this local user profile on the system.
- Returns
- The local user id that uniquely identifies this local user profile on the system.
◆ GetUserName()
virtual AZStd::string LocalUser::LocalUserProfile::GetUserName |
( |
| ) |
const |
|
pure virtual |
Query the user name associated with this local user profile.
- Returns
- A UTF-8 string containing this local user's user name.
◆ IsSignedIn()
virtual bool LocalUser::LocalUserProfile::IsSignedIn |
( |
| ) |
const |
|
pure virtual |
Query whether this local user profile is currently signed in.
- Returns
- True if this local user profile is currently signed in, false otherwise.
The documentation for this class was generated from the following file:
- Gems/LocalUser/Code/Include/LocalUser/LocalUserProfile.h