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 > OnlineSubsystemTwitch > FOnlineIdentityTwitch

Light Theme

Dark Theme

FOnlineIdentityTwitch

Twitch service implementation of the online identity interface

Windows

MacOS

Linux

Inheritance Hierarchy

IOnlineIdentity

TSharedFromThis

FOnlineIdentityTwitch

References

Module	OnlineSubsystemTwitch
Header	/Engine/Plugins/Online/OnlineSubsystemTwitch/Source/Public/OnlineIdentityTwitch.h
Include	#include "OnlineIdentityTwitch.h"

Syntax

class FOnlineIdentityTwitch :
public IOnlineIdentity,
public TSharedFromThis< FOnlineIdentityTwitch, ESPMode::ThreadSafe >

Remarks

Twitch service implementation of the online identity interface

Constructors

	Name	Description
	FOnlineIdentityTwitch()	Default constructor unavailable
	FOnlineIdentityTwitch ( FOnlineSubsystemTwitch* InSubs... )	Constructor

Destructors

	Name	Description
	~FOnlineIdentityTwitch()	Destructor

Functions

	Name	Description
const FStrin...	GetCurrentLoginNonce()
const FTwitc...	GetLoginURLDetails()
TSharedPtr< ...	GetUserAccountTwitch ( const FUniqueNetId& UserId )
void	LoginWithAccessToken ( int32 LocalUserNum, const FString& AccessToken, const FOnLoginCompleteDelegate& In... )	Login with an existing access token
void	SetStatePrefix ( const FString& StatePrefix )	Set the state prefix

Overridden from IOnlineIdentity

	Name	Description
bool	AutoLogin ( int32 LocalUserNum )	Logs the player into the online service using parameters passed on the command line.
FUniqueNetId...	CreateUniquePlayerId ( uint8* Bytes, int32 Size )	Create a unique id from binary data (used during replication)
FUniqueNetId...	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
FUniqueNetId...	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.

Typedefs

Name	Description
FOnValidateAuthTokenComplete	Delegate fired after a Twitch token has been validated

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

Take our survey

Dismiss