1. Epic GamesDeveloper
  3. IOnlineIdentity

IOnlineIdentity

Interface for registration/authentication of user identities

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

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

  Type Name Description
Public variable FOnControllerPairingChanged OnControllerPairingChangedDelegates Delegate called when a controller-user pairing changes
Public variable FOnLoginChanged OnLoginChangedDelegates Delegate called when a player logs in/out
Public variable FOnLoginComplete[MAX_LOCAL_PLAYERS] OnLoginCompleteDelegates Called when user account login has completed after calling Login() or AutoLogin()
Public variable FOnLoginFlowLogout OnLoginFlowLogoutDelegates Delegate called when the online subsystem requires the login flow to logout and cleanup
Public variable FOnLoginStatusChanged[MAX_LOCAL_PLAYERS] OnLoginStatusChangedDelegates Delegate called when a player's login status changes but doesn't change identity
Public variable FOnLogoutComplete[MAX_LOCAL_PLAYERS] OnLogoutCompleteDelegates Delegate used in notifying the that manual logout completed

Constructors

  Type Name Description
Protected function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function bool

AutoLogin ( int32 LocalUserNum
)

 Logs the player into the online service using parameters passed on the command line.
Public function Virtual void Clear an auth token associated with the user, if one was cached.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

ClearOnLoginChangedDelegates ( void* Object
)

  
Public function Virtual void  
Public function Virtual void

ClearOnLoginCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

ClearOnLoginStatusChangedDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void

ClearOnLogoutCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function FUniqueNetIdPtr

CreateUniquePlayerId ( uint8* Bytes,
int32 Size
)

 Create a unique id from binary data (used during replication)
Public function FUniqueNetIdPtr

CreateUniquePlayerId ( const FString& Str
)

 Create a unique id from string
Public function Const TArray< TSharedPtr< FUserOnlineAccount > > Obtain list of all known/registered user accounts
Public function Const FString

GetAuthToken ( int32 LocalUserNum
)

 Gets a user's platform specific authentication token to verify their identity
Public function Const FString Get the auth type associated with accounts for this platform
Public function Virtual Const void

GetLinkedAccountAuthToken ( int32 LocalUserNum,
const FString& TokenType,
const FOnGetLinkedAccountAuthTokenCompleteDelegate& Delegate
)

 Gets a user's platform specific authentication ticket used to sign into linked account(s)
Public function Virtual Const void  
Public function Virtual Const int32 Converts from a PlatformUserId used by application code to a local user num used by the online system
Public function Const ELoginStatus::Type

GetLoginStatus ( const FUniqueNetId& UserId
)

 Fetches the login status for a given player
Public function Const ELoginStatus::Type

GetLoginStatus ( int32 LocalUserNum
)

 Fetches the login status for a given player
Public function Virtual Const FPlatformUserId Converts from a local user num used by the online system to a PlatformUserId used by application code
Public function Const FPlatformUserId Converts from an online unique id to a PlatformUserId used by application code
Public function Const FString

GetPlayerNickname ( const FUniqueNetId& UserId
)

 Reads the player's nick name from the online service
Public function Const FString

GetPlayerNickname ( int32 LocalUserNum
)

 Reads the player's nick name from the online service
Public function Virtual Const FUniqueNetIdPtr

GetSponsorUniquePlayerId ( int32 LocalUserNum
)

 Gets the platform specific unique id for the sponsor of the specified player
Public function Const FUniqueNetIdPtr

GetUniquePlayerId ( int32 LocalUserNum
)

 Gets the platform specific unique id for the specified player
Public function Const TSharedPtr< FUserOnlineAccount >

GetUserAccount ( const FUniqueNetId& UserId
)

 Obtain online account info for a user that has been registered
Public function void

GetUserPrivilege ( const FUniqueNetId& LocalUserId,
EUserPrivileges::Type Privilege,
const FOnGetUserPrivilegeCompleteDelegate& Delegate,
EShowPrivilegeResolveUI ShowResolveUI
)

 Gets the status of a user's privilege.
Public function bool

Login ( int32 LocalUserNum,
const FOnlineAccountCredentials& AccountCredentials
)

 Login/Authenticate with user credentials.
Public function bool

Logout ( int32 LocalUserNum
)

 Signs the player out of the online service Will call OnLogoutComplete() delegate when async task completes
Public function void

RevokeAuthToken ( const FUniqueNetId& LocalUserId,
const FOnRevokeAuthTokenCompleteDelegate& Delegate
)

 Revoke the user's registered auth token.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

TriggerOnLoginCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FUniqueNetId& Param2,
const FString& Param3
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

TriggerOnLogoutCompleteDelegates ( int32 LocalUserNum,
bool Param1
)

  

Enums

  Type Name Description
Public enum EPrivilegeResults    

Typedefs

Name Description
FOnGetLinkedAccountAuthTokenCompleteDelegate Delegate executed when the user's auth ticket has arrived
FOnGetUserPrivilegeCompleteDelegate Delegate executed when we get a user privilege result.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page