Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineIdentity

Light Theme

Dark Theme

IOnlineIdentity

Interface for registration/authentication of user identities

Windows

MacOS

Linux

Inheritance Hierarchy

IOnlineIdentity

FOnlineIdentityTwitch

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineIdentityInterface.h
Include	#include "Interfaces/OnlineIdentityInterface.h"

Syntax

class IOnlineIdentity

Remarks

Interface for registration/authentication of user identities

Variables

	Name	Description
FOnControllerPa...	OnControllerPairingChangedDelegates	Delegate called when a controller-user pairing changes
FOnLoginChanged	OnLoginChangedDelegates	Delegate called when a player logs in/out
FOnLoginComplet...	OnLoginCompleteDelegates	Called when user account login has completed after calling Login() or AutoLogin()
FOnLoginFlowLog...	OnLoginFlowLogoutDelegates	Delegate called when the online subsystem requires the login flow to logout and cleanup
FOnLoginStatusC...	OnLoginStatusChangedDelegates	Delegate called when a player's login status changes but doesn't change identity
FOnLogoutComple...	OnLogoutCompleteDelegates	Delegate used in notifying the that manual logout completed

Constructors

	Name	Description
	IOnlineIdentity()

Destructors

	Name	Description
	~IOnlineIdentity()

Functions

	Name	Description
FDelegateHan...	AddOnControllerPairingChangedDelegate_Handle ( const FOnControllerPairingChangedDe... )
FDelegateHan...	AddOnLoginChangedDelegate_Handle ( const FOnLoginChangedDelegate& Del... )
FDelegateHan...	AddOnLoginCompleteDelegate_Handle ( int32 LocalUserNum, const FOnLoginCompleteDelegate& De... )
FDelegateHan...	AddOnLoginFlowLogoutDelegate_Handle ( const FOnLoginFlowLogoutDelegate& ... )
FDelegateHan...	AddOnLoginStatusChangedDelegate_Handle ( int32 LocalUserNum, const FOnLoginStatusChangedDelegate... )
FDelegateHan...	AddOnLogoutCompleteDelegate_Handle ( int32 LocalUserNum, const FOnLogoutCompleteDelegate& D... )
bool	AutoLogin ( int32 LocalUserNum )	Logs the player into the online service using parameters passed on the command line.
void	ClearOnControllerPairingChangedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnControllerPairingChangedDelegates ( void* Object )
void	ClearOnLoginChangedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnLoginChangedDelegates ( void* Object )
void	ClearOnLoginCompleteDelegate_Handle ( int32 LocalUserNum, FDelegateHandle& Handle )
void	ClearOnLoginCompleteDelegates ( int32 LocalUserNum, void* Object )
void	ClearOnLoginFlowLogoutDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnLoginFlowLogoutDelegates ( void* Object )
void	ClearOnLoginStatusChangedDelegate_Handle ( int32 LocalUserNum, FDelegateHandle& Handle )
void	ClearOnLoginStatusChangedDelegates ( int32 LocalUserNum, void* Object )
void	ClearOnLogoutCompleteDelegate_Handle ( int32 LocalUserNum, FDelegateHandle& Handle )
void	ClearOnLogoutCompleteDelegates ( int32 LocalUserNum, void* Object )
TSharedPtr< ...	CreateUniquePlayerId ( uint8* Bytes, int32 Size )	Create a unique id from binary data (used during replication)
TSharedPtr< ...	CreateUniquePlayerId ( const FString& Str )	Create a unique id from string
TArray< TSha...	GetAllUserAccounts()	Obtain list of all known/registered user accounts
FString	GetAuthToken ( int32 LocalUserNum )	Gets a user's platform specific authentication token to verify their identity
FString	GetAuthType()	Get the auth type associated with accounts for this platform
ELoginStatus...	GetLoginStatus ( const FUniqueNetId& UserId )	Fetches the login status for a given player
ELoginStatus...	GetLoginStatus ( int32 LocalUserNum )	Fetches the login status for a given player
FPlatformUse...	GetPlatformUserIdFromUniqueNetId ( const FUniqueNetId& UniqueNetId )	Temporary hack to get a corresponding FUniqueNetId from a PlatformUserId
FString	GetPlayerNickname ( const FUniqueNetId& UserId )	Reads the player's nick name from the online service
FString	GetPlayerNickname ( int32 LocalUserNum )	Reads the player's nick name from the online service
TSharedPtr< ...	GetSponsorUniquePlayerId ( int32 LocalUserNum )	Gets the platform specific unique id for the sponsor of the specified player
TSharedPtr< ...	GetUniquePlayerId ( int32 LocalUserNum )	Gets the platform specific unique id for the specified player
TSharedPtr< ...	GetUserAccount ( const FUniqueNetId& UserId )	Obtain online account info for a user that has been registered
void	GetUserPrivilege ( const FUniqueNetId& LocalUserId, EUserPrivileges::Type Privilege, const FOnGetUserPrivilegeCompleteDe... )	Gets the status of a user's privilege.
bool	Login ( int32 LocalUserNum, const FOnlineAccountCredentials& A... )	Login/Authenticate with user credentials.
bool	Logout ( int32 LocalUserNum )	Signs the player out of the online service Will call OnLogoutComplete() delegate when async task completes
void	RevokeAuthToken ( const FUniqueNetId& LocalUserId, const FOnRevokeAuthTokenCompleteDel... )	Revoke the user's registered auth token.
void	TriggerOnControllerPairingChangedDelegates ( int Param1, FControllerPairingChangedUserInfo P..., FControllerPairingChangedUserInfo P... )
void	TriggerOnLoginChangedDelegates ( int32 Param1 )
void	TriggerOnLoginCompleteDelegates ( int32 LocalUserNum, bool Param1, const FUniqueNetId& Param2, const FString& Param3 )
void	TriggerOnLoginFlowLogoutDelegates ( const TArray< FString >& Param1 )
void	TriggerOnLoginStatusChangedDelegates ( int32 LocalUserNum, ELoginStatus::Type Param1, ELoginStatus::Type Param2, const FUniqueNetId& Param3 )
void	TriggerOnLogoutCompleteDelegates ( int32 LocalUserNum, bool Param1 )

Enums

	Name	Description
	EPrivilegeResults

Typedefs

Name	Description
FOnGetUserPrivilegeCompleteDelegate	Delegate executed when we get a user privilege result.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss