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.
Public Member Functions | Static Public Member Functions | List of all members
LocalUser::LocalUserSystemComponent::Implementation Class Referenceabstract

Base class for platform specific implementations of the local user system component. More...

#include <LocalUserSystemComponent.h>

Public Member Functions

 AZ_CLASS_ALLOCATOR (Implementation, AZ::SystemAllocator)
 
 Implementation ()
 
 AZ_DISABLE_COPY_MOVE (Implementation)
 
virtual ~Implementation ()=default
 Default destructor.
 
virtual AZStd::shared_ptr< LocalUserProfile > FindLocalUserProfile (AzFramework::LocalUserId localUserId)=0
 
virtual AZ::u32 GetMaxLocalUsers () const =0
 
virtual bool IsLocalUserSignedIn (AzFramework::LocalUserId localUserId)=0
 
virtual AZStd::string GetLocalUserName (AzFramework::LocalUserId localUserId)=0
 

Static Public Member Functions

static Implementation * Create ()
 

Detailed Description

Base class for platform specific implementations of the local user system component.

Constructor & Destructor Documentation

◆ Implementation()

LocalUser::LocalUserSystemComponent::Implementation::Implementation ( )
inline

Constructor

Parameters
[in]localUserSystemComponentReference to the parent being implemented

Member Function Documentation

◆ Create()

static Implementation * LocalUser::LocalUserSystemComponent::Implementation::Create ( )
static

Default factory create function

Parameters
[in]localUserSystemComponentReference to the parent being implemented

◆ FindLocalUserProfile()

virtual AZStd::shared_ptr< LocalUserProfile > LocalUser::LocalUserSystemComponent::Implementation::FindLocalUserProfile ( AzFramework::LocalUserId  localUserId)
pure virtual

Finds a specific local user profile based on their local user id.

Parameters
[in]localUserIdThe local user id of the local user profile to retrieve.
Returns
A shared pointer to the local user profile if found, otherwise an empty one.

◆ GetLocalUserName()

virtual AZStd::string LocalUser::LocalUserSystemComponent::Implementation::GetLocalUserName ( AzFramework::LocalUserId  localUserId)
pure virtual

Get the user name associated with a local user id.

Parameters
[in]localUserIdThe local user id to query.
Returns
The user name that is associated with localUserId.

◆ GetMaxLocalUsers()

virtual AZ::u32 LocalUser::LocalUserSystemComponent::Implementation::GetMaxLocalUsers ( ) const
pure virtual

Query the maximum number of local uses that can be signed in concurrently.

Returns
The maximum number of local uses that can be signed in concurrently.

◆ IsLocalUserSignedIn()

virtual bool LocalUser::LocalUserSystemComponent::Implementation::IsLocalUserSignedIn ( AzFramework::LocalUserId  localUserId)
pure virtual

Query whether a local user id is signed in.

Parameters
[in]localUserIdThe local user id to query.
Returns
True if localUserId is signed in, false otherwise.
The documentation for this class was generated from the following file: