LootLocker Unreal SDK 10.4.0
Game backend SDK for Unreal Engine
Loading...
Searching...
No Matches
Authentication

Detailed Description

Start and end player sessions via Guest, Platform, or White Label login.

Three login families are supported:

See also White Label Login and Connected Accounts.

See the LootLocker documentation.

Typedef Documentation

◆ FLootLockerAppleGameCenterSessionResponseDelegate

typedef void(* FLootLockerAppleGameCenterSessionResponseDelegate) (FLootLockerAppleGameCenterSessionResponse)

C++ response callback delegate; receives an FLootLockerAppleGameCenterSessionResponse result.

◆ FLootLockerAppleSessionResponseDelegate

typedef void(* FLootLockerAppleSessionResponseDelegate) (FLootLockerAppleSessionResponse)

C++ response callback delegate; receives an FLootLockerAppleSessionResponse result.

◆ FLootLockerDiscordSessionResponseDelegate

typedef void(* FLootLockerDiscordSessionResponseDelegate) (FLootLockerDiscordSessionResponse)

C++ response callback delegate; receives an FLootLockerDiscordSessionResponse result.

◆ FLootLockerEpicSessionResponseDelegate

typedef void(* FLootLockerEpicSessionResponseDelegate) (FLootLockerEpicSessionResponse)

C++ response callback delegate; receives an FLootLockerEpicSessionResponse result.

◆ FLootLockerGooglePlayGamesSessionResponseDelegate

typedef void(* FLootLockerGooglePlayGamesSessionResponseDelegate) (FLootLockerGooglePlayGamesSessionResponse)

C++ response callback delegate; receives an FLootLockerGooglePlayGamesSessionResponse result.

◆ FLootLockerGoogleSessionResponseDelegate

typedef void(* FLootLockerGoogleSessionResponseDelegate) (FLootLockerGoogleSessionResponse)

C++ response callback delegate; receives an FLootLockerGoogleSessionResponse result.

◆ FLootLockerLoginResponseDelegate

typedef void(* FLootLockerLoginResponseDelegate) (FLootLockerLoginResponse)

C++ response callback delegate; receives an FLootLockerLoginResponse result.

◆ FLootLockerMetaSessionResponseDelegate

typedef void(* FLootLockerMetaSessionResponseDelegate) (FLootLockerMetaSessionResponse)

C++ response callback delegate; receives an FLootLockerMetaSessionResponse result.

◆ FLootLockerSessionResponse

typedef void(* FLootLockerSessionResponse) (FLootLockerAuthenticationResponse)

C++ response callback delegate; receives an FLootLockerAuthenticationResponse result.

◆ FLootLockerWhiteLabelLoginAndSessionResponseDelegate

typedef void(* FLootLockerWhiteLabelLoginAndSessionResponseDelegate) (FLootLockerWhiteLabelLoginAndSessionResponse)

C++ response callback delegate; receives an FLootLockerWhiteLabelLoginAndSessionResponse result.

◆ FLootLockerWhiteLabelVerifySessionDelegate

typedef void(* FLootLockerWhiteLabelVerifySessionDelegate) (FLootLockerWhiteLabelVerifySessionResponse)

C++ response callback delegate; receives an FLootLockerWhiteLabelVerifySessionResponse result.

Enumeration Type Documentation

◆ ELootLockerGoogleClientPlatform

enum class ELootLockerGoogleClientPlatform : uint8
strong

Google OAuth2 Client platform.

Enumerator
Web 
Android 
Ios 
Desktop 

Function Documentation

◆ EndSession()

static FString ULootLockerSDKManager::EndSession ( const FLootLockerDefaultDelegate OnCompletedRequest,
const FString &  ForPlayerWithUlid = "" 
)
static

End the active session (if any).

Terminates the session; subsequent requests with its token return 401. Succeeds if a session existed or none were active.

Parameters
OnCompletedRequestDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ GuestLogin()

static FString ULootLockerSDKManager::GuestLogin ( const FLootLockerSessionResponse OnCompletedRequest,
const FString &  PlayerIdentifier = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a guest session.

Optionally provide a custom unique player identifier (otherwise one will be generated).

Parameters
PlayerIdentifierOptional: Custom unique identifier to associate with this guest player (auto-generated if empty)
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshAppleGameCenterSession() [1/2]

static FString ULootLockerSDKManager::RefreshAppleGameCenterSession ( const FLootLockerAppleGameCenterSessionResponseDelegate OnCompletedRequest,
const FString &  ForPlayerWithUlid = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
inlinestatic

Refresh an existing Apple Game Center session.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Apple platform must be enabled for your game.

Parameters
OnCompletedRequestDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshAppleGameCenterSession() [2/2]

static FString ULootLockerSDKManager::RefreshAppleGameCenterSession ( const FString &  RefreshToken,
const FLootLockerAppleGameCenterSessionResponseDelegate OnRefreshAppleGameCenterSessionCompleted,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Refresh an existing Apple Game Center session using an explicit refresh token.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Apple platform must be enabled for your game.

Parameters
RefreshTokenRefresh token from StartAppleGameCenterSession (resolved from stored data if empty)
OnRefreshAppleGameCenterSessionCompletedDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshAppleSession() [1/2]

static FString ULootLockerSDKManager::RefreshAppleSession ( const FLootLockerAppleSessionResponseDelegate OnCompletedRequest,
const FString &  ForPlayerWithUlid = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
inlinestatic

Refresh an existing Sign in with Apple session.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Apple sign-in platform must be enabled for your game.

Parameters
OnCompletedRequestDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshAppleSession() [2/2]

static FString ULootLockerSDKManager::RefreshAppleSession ( const FString &  RefreshToken,
const FLootLockerAppleSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Refresh an existing Sign in with Apple session using an explicit refresh token.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Apple sign-in platform must be enabled for your game.

Parameters
RefreshTokenRefresh token from StartAppleSession
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshDiscordSession() [1/2]

static FString ULootLockerSDKManager::RefreshDiscordSession ( const FLootLockerDiscordSessionResponseDelegate OnCompletedRequest,
const FString &  ForPlayerWithUlid = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
inlinestatic

Refresh a Discord session.

HTTP 401 means the refresh token expired and a new login is required. Discord platform must be enabled.

Parameters
OnCompletedRequestDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
OptionalsOptional: Additional session options when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshDiscordSession() [2/2]

static FString ULootLockerSDKManager::RefreshDiscordSession ( const FString &  RefreshToken,
const FLootLockerDiscordSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Refresh a Discord session with an explicit refresh token.

HTTP 401 means the refresh token expired and a new login is required.

Parameters
RefreshTokenRefresh token from StartDiscordSession
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshEpicSession() [1/2]

static FString ULootLockerSDKManager::RefreshEpicSession ( const FLootLockerEpicSessionResponseDelegate OnCompletedRequest,
const FString &  ForPlayerWithUlid = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
inlinestatic

Refresh an existing Epic session.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Epic Games platform must be enabled for your game.

Parameters
OnCompletedRequestDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshEpicSession() [2/2]

static FString ULootLockerSDKManager::RefreshEpicSession ( const FString &  RefreshToken,
const FLootLockerEpicSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Refresh an existing Epic session using an explicit refresh token.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Epic Games platform must be enabled for your game.

Parameters
RefreshTokenRefresh token from StartEpicSession (resolved from stored data if empty)
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshGooglePlayGamesSession() [1/2]

static FString ULootLockerSDKManager::RefreshGooglePlayGamesSession ( const FLootLockerGooglePlayGamesSessionResponseDelegate OnCompletedRequest,
const FString &  ForPlayerWithUlid = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
inlinestatic

Refresh an existing Google Play Games session.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Google Play Games platform must be enabled for your game.

Parameters
OnCompletedRequestDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshGooglePlayGamesSession() [2/2]

static FString ULootLockerSDKManager::RefreshGooglePlayGamesSession ( const FString &  RefreshToken,
const FLootLockerGooglePlayGamesSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Refresh an existing Google Play Games session using an explicit refresh token.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Google Play Games platform must be enabled for your game.

Parameters
RefreshTokenRefresh token from StartGooglePlayGamesSession
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshGoogleSession() [1/2]

static FString ULootLockerSDKManager::RefreshGoogleSession ( const FLootLockerGoogleSessionResponseDelegate OnCompletedRequest,
const FString &  ForPlayerWithUlid = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
inlinestatic

Refresh an existing Google session.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Google platform must be enabled for your game.

Parameters
OnCompletedRequestDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshGoogleSession() [2/2]

static FString ULootLockerSDKManager::RefreshGoogleSession ( const FString &  RefreshToken,
const FLootLockerGoogleSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Refresh an existing Google session using an explicit refresh token.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Google platform must be enabled for your game.

Parameters
RefreshTokenRefresh token from StartGoogleSession
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshMetaSession() [1/2]

static FString ULootLockerSDKManager::RefreshMetaSession ( const FLootLockerMetaSessionResponseDelegate OncompletedRequest,
const FString &  ForPlayerWithUlid = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
inlinestatic

Refresh an existing Meta / Oculus session.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Meta platform must be enabled for your game.

Parameters
OncompletedRequestDelegate for handling the server response
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ RefreshMetaSession() [2/2]

static FString ULootLockerSDKManager::RefreshMetaSession ( const FString &  RefreshToken,
const FLootLockerMetaSessionResponseDelegate OncompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Refresh an existing Meta / Oculus session using an explicit refresh token.

HTTP 401 (Unauthorized) indicates the refresh token expired and a new login is required. The Meta platform must be enabled for your game.

Parameters
RefreshTokenRefresh token from StartMetaSession (resolved from stored data if empty)
OncompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartAmazonLunaSession()

static FString ULootLockerSDKManager::StartAmazonLunaSession ( const FString &  AmazonLunaGuid,
const FLootLockerSessionResponse OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for an Amazon Luna user.

A game can support multiple platforms, but each build should typically target only one.

Parameters
AmazonLunaGuidAmazon Luna GUID identifying the player
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartAndroidSession()

static FString ULootLockerSDKManager::StartAndroidSession ( const FString &  DeviceId,
const FLootLockerSessionResponse OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for an Android user.

A game can support multiple platforms, but each build should typically target only one.

Parameters
DeviceIdDevice identifier for the player
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartAppleGameCenterSession()

static FString ULootLockerSDKManager::StartAppleGameCenterSession ( const FString &  BundleId,
const FString &  PlayerId,
const FString &  PublicKeyUrl,
const FString &  Signature,
const FString &  Salt,
const FString &  Timestamp,
const FLootLockerAppleGameCenterSessionResponseDelegate OnStartedAppleGameCenterSessionCompleted,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session using Apple Game Center identity verification.

The Apple platform must be enabled for your game.

Parameters
BundleIdApple Game Center bundle id of your app
PlayerIdApple Game Center player id
PublicKeyUrlPublic key URL from Apple Game Center Identity Verification
SignatureSignature from Apple Game Center Identity Verification
SaltSalt value from Apple Game Center Identity Verification
TimestampTimestamp from Apple Game Center Identity Verification
OnStartedAppleGameCenterSessionCompletedDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartAppleSession()

static FString ULootLockerSDKManager::StartAppleSession ( const FString &  AuthorizationCode,
const FLootLockerAppleSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session using Sign in with Apple.

The Apple sign-in platform must be enabled for your game.

Parameters
AuthorizationCodeAuthorization code provided by Apple
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartDiscordSession()

static FString ULootLockerSDKManager::StartDiscordSession ( const FString &  AccessToken,
const FLootLockerDiscordSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for a Discord user.

The Discord sign-in platform must be enabled for your game.

Parameters
AccessTokenAccess token from Discord OAuth
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartEpicSession()

static FString ULootLockerSDKManager::StartEpicSession ( const FString &  IdToken,
const FLootLockerEpicSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for an Epic Online Services (EOS) user.

The Epic Games platform must be enabled for your game.

Parameters
IdTokenEOS ID token
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartGooglePlayGamesSession()

static FString ULootLockerSDKManager::StartGooglePlayGamesSession ( const FString &  AuthCode,
const FLootLockerGooglePlayGamesSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for a Google Play Games user.

The Google Play Games platform must be enabled for your game.

Parameters
AuthCodeAuthorization code from Google Play Games sign-in
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartGoogleSession()

static FString ULootLockerSDKManager::StartGoogleSession ( const FString &  IdToken,
const FLootLockerGoogleSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for a Google user (default platform).

The Google sign-in platform must be enabled for your game.

Parameters
IdTokenGoogle ID token
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartGoogleSessionForPlatform()

static FString ULootLockerSDKManager::StartGoogleSessionForPlatform ( const FString &  IdToken,
ELootLockerGoogleClientPlatform  Platform,
const FLootLockerGoogleSessionResponseDelegate OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for a Google user targeting a specific Google OAuth2 Client ID platform.

The desired Google platform must be enabled for your game.

Parameters
IdTokenGoogle ID token
PlatformGoogle OAuth2 client platform enum value
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartMetaSession()

static FString ULootLockerSDKManager::StartMetaSession ( const FString &  UserId,
const FString &  Nonce,
const FLootLockerMetaSessionResponseDelegate OncompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for a Meta / Oculus user.

The Meta platform must be enabled for your game.

Parameters
UserIdUser id received from Oculus
NonceNonce received from Oculus
OncompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartNintendoSwitchSession()

static FString ULootLockerSDKManager::StartNintendoSwitchSession ( const FString &  NSAIdToken,
const FLootLockerSessionResponse OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for a Nintendo Switch user.

The Nintendo Switch platform must be enabled for your game.

Parameters
NSAIdTokenNintendo Switch Account (NSA) id token
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartPlaystationNetworkSession()

static FString ULootLockerSDKManager::StartPlaystationNetworkSession ( const FString &  PsnOnlineId,
const FLootLockerSessionResponse OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a PlayStation Network session (Deprecated – use VerifyPlayerAndStartPlaystationNetworkSession).

A game can support multiple platforms, but each build should typically target only one.

Parameters
PsnOnlineIdPSN Online ID of the player
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartSessionManual()

static void ULootLockerSDKManager::StartSessionManual ( const FLootLockerPlayerData ForPlayer)
static

Add a player state manually from externally sourced data (e.g.

after a server token exchange) without performing an authentication call.

Parameters
ForPlayerPlayer state to cache and use for future requests

◆ StartSteamSessionUsingTicket()

static FString ULootLockerSDKManager::StartSteamSessionUsingTicket ( const FString &  SteamSessionTicket,
const FLootLockerSessionResponse OnCompletedRequest,
const FString &  SteamAppId = "",
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for a Steam user using a session ticket.

Optionally specify a Steam App ID if multiple are configured for your game. A game can support multiple platforms, but each build should typically target only one.

Parameters
SteamSessionTicketSteam session ticket token
OnCompletedRequestDelegate for handling the server response
SteamAppIdOptional: Specific Steam App ID to verify against (blank = default)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ StartXboxSession()

static FString ULootLockerSDKManager::StartXboxSession ( const FString &  XboxUserToken,
const FLootLockerSessionResponse OnCompletedRequest,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a LootLocker session for an Xbox user.

The Xbox platform must be enabled for your game.

Parameters
XboxUserTokenXbox user token
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ VerifyPlayer()

static FString ULootLockerSDKManager::VerifyPlayer ( const FString &  PlatformToken,
const FLootLockerDefaultDelegate OnCompletedRequest,
const FString &  Platform = FString(TEXT("")),
const FString &  ForPlayerWithUlid = "" 
)
static

(Deprecated) Verify player identity for a platform before starting a session.

Parameters
PlatformTokenPlatform-specific token
OnCompletedRequestDelegate for handling the server response
PlatformOptional: Explicit platform identifier override
ForPlayerWithUlidOptional: Execute for the specified player ULID (default player if empty)
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ VerifyPlayerAndStartPlaystationNetworkSession()

static FString ULootLockerSDKManager::VerifyPlayerAndStartPlaystationNetworkSession ( const FString &  AuthCode,
const FString &  AccountID,
const FLootLockerSessionResponse OnCompletedRequest,
int  PsnIssuerId = 256,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a PlayStation Network session (v1/v2).

If your token starts with v3 use VerifyPlayerAndStartPlaystationNetworkV3Session. A game can support multiple platforms, but each build should typically target only one.

Parameters
AuthCodeAuthorization code received from PSN after login
AccountIDNumeric account id returned by PSN
OnCompletedRequestDelegate for handling the server response
PsnIssuerIdOptional: PSN issuer id (default 256 = production)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ VerifyPlayerAndStartPlaystationNetworkV3Session()

static FString ULootLockerSDKManager::VerifyPlayerAndStartPlaystationNetworkV3Session ( const FString &  AuthCode,
const FLootLockerSessionResponse OnCompletedRequest,
int  EnvIssuerId = 256,
const FLootLockerSessionOptionals Optionals = FLootLockerSessionOptionals() 
)
static

Start a PlayStation Network session (v3 flow – tokens starting with v3).

A game can support multiple platforms, but each build should typically target only one.

Parameters
AuthCodeAuthorization code received from PSN (v3)
OnCompletedRequestDelegate for handling the server response
EnvIssuerIdOptional: Environment issuer id (default 256 = production)
OptionalsOptional: Additional session options applied when starting the session
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

Typedefs

typedef void(* FLootLockerSessionResponse) (FLootLockerAuthenticationResponse)
 C++ response callback delegate; receives an FLootLockerAuthenticationResponse result.
 
typedef void(* FLootLockerAppleSessionResponseDelegate) (FLootLockerAppleSessionResponse)
 C++ response callback delegate; receives an FLootLockerAppleSessionResponse result.
 
typedef void(* FLootLockerGoogleSessionResponseDelegate) (FLootLockerGoogleSessionResponse)
 C++ response callback delegate; receives an FLootLockerGoogleSessionResponse result.
 
typedef void(* FLootLockerGooglePlayGamesSessionResponseDelegate) (FLootLockerGooglePlayGamesSessionResponse)
 C++ response callback delegate; receives an FLootLockerGooglePlayGamesSessionResponse result.
 
typedef void(* FLootLockerEpicSessionResponseDelegate) (FLootLockerEpicSessionResponse)
 C++ response callback delegate; receives an FLootLockerEpicSessionResponse result.
 
typedef void(* FLootLockerLoginResponseDelegate) (FLootLockerLoginResponse)
 C++ response callback delegate; receives an FLootLockerLoginResponse result.
 
typedef void(* FLootLockerWhiteLabelVerifySessionDelegate) (FLootLockerWhiteLabelVerifySessionResponse)
 C++ response callback delegate; receives an FLootLockerWhiteLabelVerifySessionResponse result.
 
typedef void(* FLootLockerWhiteLabelLoginAndSessionResponseDelegate) (FLootLockerWhiteLabelLoginAndSessionResponse)
 C++ response callback delegate; receives an FLootLockerWhiteLabelLoginAndSessionResponse result.
 
typedef void(* FLootLockerAppleGameCenterSessionResponseDelegate) (FLootLockerAppleGameCenterSessionResponse)
 C++ response callback delegate; receives an FLootLockerAppleGameCenterSessionResponse result.
 
typedef void(* FLootLockerMetaSessionResponseDelegate) (FLootLockerMetaSessionResponse)
 C++ response callback delegate; receives an FLootLockerMetaSessionResponse result.
 
typedef void(* FLootLockerDiscordSessionResponseDelegate) (FLootLockerDiscordSessionResponse)
 C++ response callback delegate; receives an FLootLockerDiscordSessionResponse result.
 

Enumerations

enum class  ELootLockerGoogleClientPlatform : uint8 { ELootLockerGoogleClientPlatform::Web = 0 , ELootLockerGoogleClientPlatform::Android = 1 , ELootLockerGoogleClientPlatform::Ios = 2 , ELootLockerGoogleClientPlatform::Desktop = 3 }
 Google OAuth2 Client platform. More...
 

Functions

static void ULootLockerSDKManager::StartSessionManual (const FLootLockerPlayerData &ForPlayer)
 Add a player state manually from externally sourced data (e.g.
 
static FString ULootLockerSDKManager::StartPlaystationNetworkSession (const FString &PsnOnlineId, const FLootLockerSessionResponse &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a PlayStation Network session (Deprecated – use VerifyPlayerAndStartPlaystationNetworkSession).
 
static FString ULootLockerSDKManager::VerifyPlayerAndStartPlaystationNetworkSession (const FString &AuthCode, const FString &AccountID, const FLootLockerSessionResponse &OnCompletedRequest, int PsnIssuerId=256, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a PlayStation Network session (v1/v2).
 
static FString ULootLockerSDKManager::VerifyPlayerAndStartPlaystationNetworkV3Session (const FString &AuthCode, const FLootLockerSessionResponse &OnCompletedRequest, int EnvIssuerId=256, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a PlayStation Network session (v3 flow – tokens starting with v3).
 
static FString ULootLockerSDKManager::StartAndroidSession (const FString &DeviceId, const FLootLockerSessionResponse &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for an Android user.
 
static FString ULootLockerSDKManager::StartAmazonLunaSession (const FString &AmazonLunaGuid, const FLootLockerSessionResponse &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for an Amazon Luna user.
 
static FString ULootLockerSDKManager::StartSteamSessionUsingTicket (const FString &SteamSessionTicket, const FLootLockerSessionResponse &OnCompletedRequest, const FString &SteamAppId="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for a Steam user using a session ticket.
 
static FString ULootLockerSDKManager::StartNintendoSwitchSession (const FString &NSAIdToken, const FLootLockerSessionResponse &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for a Nintendo Switch user.
 
static FString ULootLockerSDKManager::StartXboxSession (const FString &XboxUserToken, const FLootLockerSessionResponse &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for an Xbox user.
 
static FString ULootLockerSDKManager::StartGoogleSession (const FString &IdToken, const FLootLockerGoogleSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for a Google user (default platform).
 
static FString ULootLockerSDKManager::StartGoogleSessionForPlatform (const FString &IdToken, ELootLockerGoogleClientPlatform Platform, const FLootLockerGoogleSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for a Google user targeting a specific Google OAuth2 Client ID platform.
 
static FString ULootLockerSDKManager::RefreshGoogleSession (const FLootLockerGoogleSessionResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Google session.
 
static FString ULootLockerSDKManager::RefreshGoogleSession (const FString &RefreshToken, const FLootLockerGoogleSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Google session using an explicit refresh token.
 
static FString ULootLockerSDKManager::StartGooglePlayGamesSession (const FString &AuthCode, const FLootLockerGooglePlayGamesSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for a Google Play Games user.
 
static FString ULootLockerSDKManager::RefreshGooglePlayGamesSession (const FLootLockerGooglePlayGamesSessionResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Google Play Games session.
 
static FString ULootLockerSDKManager::RefreshGooglePlayGamesSession (const FString &RefreshToken, const FLootLockerGooglePlayGamesSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Google Play Games session using an explicit refresh token.
 
static FString ULootLockerSDKManager::StartAppleSession (const FString &AuthorizationCode, const FLootLockerAppleSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session using Sign in with Apple.
 
static FString ULootLockerSDKManager::RefreshAppleSession (const FLootLockerAppleSessionResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Sign in with Apple session.
 
static FString ULootLockerSDKManager::RefreshAppleSession (const FString &RefreshToken, const FLootLockerAppleSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Sign in with Apple session using an explicit refresh token.
 
static FString ULootLockerSDKManager::StartAppleGameCenterSession (const FString &BundleId, const FString &PlayerId, const FString &PublicKeyUrl, const FString &Signature, const FString &Salt, const FString &Timestamp, const FLootLockerAppleGameCenterSessionResponseDelegate &OnStartedAppleGameCenterSessionCompleted, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session using Apple Game Center identity verification.
 
static FString ULootLockerSDKManager::RefreshAppleGameCenterSession (const FLootLockerAppleGameCenterSessionResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Apple Game Center session.
 
static FString ULootLockerSDKManager::RefreshAppleGameCenterSession (const FString &RefreshToken, const FLootLockerAppleGameCenterSessionResponseDelegate &OnRefreshAppleGameCenterSessionCompleted, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Apple Game Center session using an explicit refresh token.
 
static FString ULootLockerSDKManager::StartEpicSession (const FString &IdToken, const FLootLockerEpicSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for an Epic Online Services (EOS) user.
 
static FString ULootLockerSDKManager::RefreshEpicSession (const FLootLockerEpicSessionResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Epic session.
 
static FString ULootLockerSDKManager::RefreshEpicSession (const FString &RefreshToken, const FLootLockerEpicSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Epic session using an explicit refresh token.
 
static FString ULootLockerSDKManager::StartMetaSession (const FString &UserId, const FString &Nonce, const FLootLockerMetaSessionResponseDelegate &OncompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for a Meta / Oculus user.
 
static FString ULootLockerSDKManager::RefreshMetaSession (const FLootLockerMetaSessionResponseDelegate &OncompletedRequest, const FString &ForPlayerWithUlid="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Meta / Oculus session.
 
static FString ULootLockerSDKManager::RefreshMetaSession (const FString &RefreshToken, const FLootLockerMetaSessionResponseDelegate &OncompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh an existing Meta / Oculus session using an explicit refresh token.
 
static FString ULootLockerSDKManager::GuestLogin (const FLootLockerSessionResponse &OnCompletedRequest, const FString &PlayerIdentifier="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a guest session.
 
static FString ULootLockerSDKManager::StartDiscordSession (const FString &AccessToken, const FLootLockerDiscordSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a LootLocker session for a Discord user.
 
static FString ULootLockerSDKManager::RefreshDiscordSession (const FLootLockerDiscordSessionResponseDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="", const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh a Discord session.
 
static FString ULootLockerSDKManager::RefreshDiscordSession (const FString &RefreshToken, const FLootLockerDiscordSessionResponseDelegate &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Refresh a Discord session with an explicit refresh token.
 
static FString ULootLockerSDKManager::VerifyPlayer (const FString &PlatformToken, const FLootLockerDefaultDelegate &OnCompletedRequest, const FString &Platform=FString(TEXT("")), const FString &ForPlayerWithUlid="")
 (Deprecated) Verify player identity for a platform before starting a session.
 
static FString ULootLockerSDKManager::EndSession (const FLootLockerDefaultDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
 End the active session (if any).