Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Interface for registration/authentication of user identities
| Name | IOnlineIdentity |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineIdentityInterface.h |
| Include Path | #include "Interfaces/OnlineIdentityInterface.h" |
Syntax
class IOnlineIdentity
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IOnlineIdentity() |
Interfaces/OnlineIdentityInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOnlineIdentity() |
Interfaces/OnlineIdentityInterface.h |
Enums
Public
| Name | Remarks |
|---|---|
| EPrivilegeResults |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnGetLinkedAccountAuthTokenCompleteDelegate | TBaseDelegate_ThreeParams< void, int32, bool, const FExternalAuthToken & > | Delegate executed when the user's auth ticket has arrived | Interfaces/OnlineIdentityInterface.h |
| FOnGetUserPrivilegeCompleteDelegate | TBaseDelegate_ThreeParams< void, const FUniqueNetId &, EUserPrivileges::Type, uint32 > | Delegate executed when we get a user privilege result. | Interfaces/OnlineIdentityInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnAuthAboutToExpireDelegates | FOnAuthAboutToExpire | Delegate called when an auth session is about to expire and a new auth token is needed. | Interfaces/OnlineIdentityInterface.h | |
| OnControllerPairingChangedDelegates | FOnControllerPairingChanged | Delegate called when a controller-user pairing changes | Interfaces/OnlineIdentityInterface.h | |
| OnLoginChangedDelegates | FOnLoginChanged | Delegate called when a player logs in/out | Interfaces/OnlineIdentityInterface.h | |
| OnLoginCompleteDelegates | FOnLoginComplete | Called when user account login has completed after calling Login() or AutoLogin() | Interfaces/OnlineIdentityInterface.h | |
| OnLoginFlowLogoutDelegates | FOnLoginFlowLogout | Delegate called when the online subsystem requires the login flow to logout and cleanup | Interfaces/OnlineIdentityInterface.h | |
| OnLoginStatusChangedDelegates | FOnLoginStatusChanged | Delegate called when a player's login status changes but doesn't change identity | Interfaces/OnlineIdentityInterface.h | |
| OnLogoutCompleteDelegates | FOnLogoutComplete | Delegate used in notifying the that manual logout completed | Interfaces/OnlineIdentityInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddOnAuthAboutToExpireDelegate_Handle
(
const FOnAuthAboutToExpireDelegate& Delegate |
Interfaces/OnlineIdentityInterface.h | ||
virtual FDelegateHandle AddOnControllerPairingChangedDelegate_Handle
(
const FOnControllerPairingChangedDelegate& Delegate |
Interfaces/OnlineIdentityInterface.h | ||
virtual FDelegateHandle AddOnLoginChangedDelegate_Handle
(
const FOnLoginChangedDelegate& Delegate |
Interfaces/OnlineIdentityInterface.h | ||
virtual FDelegateHandle AddOnLoginCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
virtual FDelegateHandle AddOnLoginFlowLogoutDelegate_Handle
(
const FOnLoginFlowLogoutDelegate& Delegate |
Interfaces/OnlineIdentityInterface.h | ||
virtual FDelegateHandle AddOnLoginStatusChangedDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
virtual FDelegateHandle AddOnLogoutCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
bool AutoLogin
(
int32 LocalUserNum |
Logs the player into the online service using parameters passed on the command line. | Interfaces/OnlineIdentityInterface.h | |
virtual void ClearCachedAuthToken
(
const FUniqueNetId& UserId |
Clear an auth token associated with the user, if one was cached. | Interfaces/OnlineIdentityInterface.h | |
virtual void ClearOnAuthAboutToExpireDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnAuthAboutToExpireDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnControllerPairingChangedDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnControllerPairingChangedDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLoginChangedDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLoginChangedDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLoginCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLoginCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLoginFlowLogoutDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLoginFlowLogoutDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLoginStatusChangedDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLoginStatusChangedDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLogoutCompleteDelegate_Handle
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
virtual void ClearOnLogoutCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
FUniqueNetIdPtr CreateUniquePlayerId
(
uint8* Bytes, |
Create a unique id from binary data (used during replication) | Interfaces/OnlineIdentityInterface.h | |
FUniqueNetIdPtr CreateUniquePlayerId
(
const FString& Str |
Create a unique id from string | Interfaces/OnlineIdentityInterface.h | |
TArray< TSharedPtr< FUserOnlineAccount > > GetAllUserAccounts() |
Obtain list of all known/registered user accounts | Interfaces/OnlineIdentityInterface.h | |
FString GetAuthToken
(
int32 LocalUserNum |
Gets a user's platform specific authentication token to verify their identity | Interfaces/OnlineIdentityInterface.h | |
FString GetAuthType() |
Get the auth type associated with accounts for this platform | Interfaces/OnlineIdentityInterface.h | |
virtual void GetLinkedAccountAuthToken
(
int32 LocalUserNum, |
Gets a user's platform specific authentication ticket used to sign into linked account(s) | Interfaces/OnlineIdentityInterface.h | |
virtual int32 GetLocalUserNumFromPlatformUserId
(
FPlatformUserId PlatformUserId |
Converts from a PlatformUserId used by application code to a local user num used by the online system | Interfaces/OnlineIdentityInterface.h | |
ELoginStatus::Type GetLoginStatus
(
const FUniqueNetId& UserId |
Fetches the login status for a given player | Interfaces/OnlineIdentityInterface.h | |
ELoginStatus::Type GetLoginStatus
(
int32 LocalUserNum |
Fetches the login status for a given player | Interfaces/OnlineIdentityInterface.h | |
virtual FPlatformUserId GetPlatformUserIdFromLocalUserNum
(
int32 LocalUserNum |
Converts from a local user num used by the online system to a PlatformUserId used by application code | Interfaces/OnlineIdentityInterface.h | |
FPlatformUserId GetPlatformUserIdFromUniqueNetId
(
const FUniqueNetId& UniqueNetId |
Converts from an online unique id to a PlatformUserId used by application code | Interfaces/OnlineIdentityInterface.h | |
FString GetPlayerNickname
(
int32 LocalUserNum |
Reads the player's nick name from the online service | Interfaces/OnlineIdentityInterface.h | |
FString GetPlayerNickname
(
const FUniqueNetId& UserId |
Reads the player's nick name from the online service | Interfaces/OnlineIdentityInterface.h | |
virtual FUniqueNetIdPtr GetSponsorUniquePlayerId
(
int32 LocalUserNum |
Gets the platform specific unique id for the sponsor of the specified player | Interfaces/OnlineIdentityInterface.h | |
FUniqueNetIdPtr GetUniquePlayerId
(
int32 LocalUserNum |
Gets the platform specific unique id for the specified player | Interfaces/OnlineIdentityInterface.h | |
TSharedPtr< FUserOnlineAccount > GetUserAccount
(
const FUniqueNetId& UserId |
Obtain online account info for a user that has been registered | Interfaces/OnlineIdentityInterface.h | |
void GetUserPrivilege
(
const FUniqueNetId& LocalUserId, |
Gets the status of a user's privilege. | Interfaces/OnlineIdentityInterface.h | |
bool Login
(
int32 LocalUserNum, |
Login/Authenticate with user credentials. | Interfaces/OnlineIdentityInterface.h | |
bool Logout
(
int32 LocalUserNum |
Signs the player out of the online service Will call OnLogoutComplete() delegate when async task completes | Interfaces/OnlineIdentityInterface.h | |
void RevokeAuthToken
(
const FUniqueNetId& LocalUserId, |
Revoke the user's registered auth token. | Interfaces/OnlineIdentityInterface.h | |
virtual void TriggerOnAuthAboutToExpireDelegates
(
int32 Param1 |
Interfaces/OnlineIdentityInterface.h | ||
virtual void TriggerOnControllerPairingChangedDelegates
(
int Param1, |
Interfaces/OnlineIdentityInterface.h | ||
virtual void TriggerOnLoginChangedDelegates
(
int32 Param1 |
Interfaces/OnlineIdentityInterface.h | ||
virtual void TriggerOnLoginCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
| Interfaces/OnlineIdentityInterface.h | |||
virtual void TriggerOnLoginStatusChangedDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h | ||
virtual void TriggerOnLogoutCompleteDelegates
(
int32 LocalUserNum, |
Interfaces/OnlineIdentityInterface.h |