Open 3D Engine LocalUser Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
LocalUser::LocalUserProfile Class Referenceabstract

#include <LocalUserProfile.h>

Public Member Functions

 AZ_CLASS_ALLOCATOR (LocalUserProfile, AZ::SystemAllocator)
 
 AZ_RTTI (LocalUserProfile, "{2A681065-FA77-46CF-9533-04D6C5C5EAF0}")
 
 LocalUserProfile (AzFramework::LocalUserId locaUserId)
 
virtual ~LocalUserProfile ()=default
 Default destructor.
 
AzFramework::LocalUserId GetLocalUserId () const
 
virtual bool IsSignedIn () const =0
 
virtual AZStd::string GetUserName () const =0
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ LocalUserProfile()

LocalUser::LocalUserProfile::LocalUserProfile ( AzFramework::LocalUserId  locaUserId)
inlineexplicit

Constructor

Parameters
[in]localUserIdThe local user id that uniquely identifies the local user profile

Member Function Documentation

◆ 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: