Base class for platform specific implementations of the local user system component.
More...
#include <LocalUserSystemComponent.h>
Base class for platform specific implementations of the local user system component.
◆ Implementation()
LocalUser::LocalUserSystemComponent::Implementation::Implementation |
( |
| ) |
|
|
inline |
Constructor
- Parameters
-
[in] | localUserSystemComponent | Reference to the parent being implemented |
◆ Create()
static Implementation * LocalUser::LocalUserSystemComponent::Implementation::Create |
( |
| ) |
|
|
static |
Default factory create function
- Parameters
-
[in] | localUserSystemComponent | Reference 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] | localUserId | The 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] | localUserId | The 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] | localUserId | The 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:
- Gems/LocalUser/Code/Source/LocalUserSystemComponent.h