FOnlineIdentityTwitch

Inheritance Hierarchy

IOnlineIdentity

TSharedFromThis

FOnlineIdentityTwitch

Syntax

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

Remarks

Twitch service implementation of the online identity interface

Constructors

Name Description

Protected function

FOnlineIdentityTwitch()

Default constructor unavailable

Protected function

FOnlineIdentityTwitch

(
    FOnlineSubsystemTwitch * InSubs...
)

Constructor

Destructors

Name Description

Protected function Virtual

~FOnlineIdentityTwitch()

Destructor

Functions

Name Description

Protected function

const FStrin ...

 

GetCurrentLoginNonce()

Protected function

const FTwitc ...

 

GetLoginURLDetails()

Protected function

TSharedPtr < ...

 

GetUserAccountTwitch

(
    const FUniqueNetId & UserId
)

Protected function

void

 

LoginWithAccessToken

(
    int32 LocalUserNum,
    const FString & AccessToken,
    const FOnLoginCompleteDelegate & In...
)

Login with an existing access token

Public function

void

 

SetStatePrefix

(
    const FString & StatePrefix
)

Set the state prefix

Overridden from IOnlineIdentity

Name Description

Public function Virtual

bool

 

AutoLogin

(
    int32 LocalUserNum
)

Logs the player into the online service using parameters passed on the command line.

Public function Virtual

TSharedPtr < ...

 

CreateUniquePlayerId

(
    uint8 * Bytes,
    int32 Size
)

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

Public function Virtual

TSharedPtr < ...

 

CreateUniquePlayerId

(
    const FString & Str
)

Create a unique id from string

Public function Virtual

TArray < TSha ...

 

GetAllUserAccounts()

Obtain list of all known/registered user accounts

Public function Virtual

FString

 

GetAuthToken

(
    int32 LocalUserNum
)

Gets a user's platform specific authentication token to verify their identity

Public function Virtual

FString

 

GetAuthType()

Get the auth type associated with accounts for this platform

Public function Virtual

ELoginStatus ...

 

GetLoginStatus

(
    const FUniqueNetId & UserId
)

Fetches the login status for a given player

Public function Virtual

ELoginStatus ...

 

GetLoginStatus

(
    int32 LocalUserNum
)

Fetches the login status for a given player

Public function Virtual

FPlatformUse ...

 

GetPlatformUserIdFromUniqueNetId

(
    const FUniqueNetId & UniqueNetId
)

Temporary hack to get a corresponding FUniqueNetId from a PlatformUserId

Public function Virtual

FString

 

GetPlayerNickname

(
    const FUniqueNetId & UserId
)

Reads the player's nick name from the online service

Public function Virtual

FString

 

GetPlayerNickname

(
    int32 LocalUserNum
)

Reads the player's nick name from the online service

Public function Virtual

TSharedPtr < ...

 

GetUniquePlayerId

(
    int32 LocalUserNum
)

Gets the platform specific unique id for the specified player

Public function Virtual

TSharedPtr < ...

 

GetUserAccount

(
    const FUniqueNetId & UserId
)

Obtain online account info for a user that has been registered

Public function Virtual

void

 

GetUserPrivilege

(
    const FUniqueNetId & LocalUserId,
    EUserPrivileges::Type Privilege,
    const FOnGetUserPrivilegeCompleteDe ...
)

Gets the status of a user's privilege.

Public function Virtual

bool

 

Login

(
    int32 LocalUserNum,
    const FOnlineAccountCredentials & A...
)

Login/Authenticate with user credentials.

Public function Virtual

bool

 

Logout

(
    int32 LocalUserNum
)

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

Public function Virtual

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

References