LootLocker Unreal SDK 10.7.0
Game backend SDK for Unreal Engine
Loading...
Searching...
No Matches
White Label Login

Detailed Description

Custom email/password account system built into your game.

Players sign in with an email address and password unique to your game. Includes customizable reset-password and confirm-account pages that match your game's branding. Integrates with Connected Accounts so that guest players can 'upgrade' to a fully registered account at any time, preserving their existing progress.

See the LootLocker documentation.

Function Documentation

◆ GetWhiteLabelSignUpFields()

FString ULootLockerSDKManager::GetWhiteLabelSignUpFields ( const FLootLockerWhiteLabelSignUpFieldsResponseDelegate & OnCompletedRequest)
static

Retrieve the list of custom sign-up fields configured for this game.

Use the returned fields to build a sign-up form, then pass the player's answers to WhiteLabelCreateAccount.

Parameters
OnCompletedRequestDelegate for handling the server response
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelCreateAccount() [1/2]

FString ULootLockerSDKManager::WhiteLabelCreateAccount ( const FString & Email,
const FString & Password,
const FLootLockerLoginResponseDelegate & OnCompletedRequest )
static

Create a White Label user.

White Label platform must be enabled.

Parameters
EmailUser email
PasswordUser password
OnCompletedRequestDelegate for handling the server response
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelCreateAccount() [2/2]

FString ULootLockerSDKManager::WhiteLabelCreateAccount ( const FString & Email,
const FString & Password,
const TArray< FLootLockerWhiteLabelCustomSignUpFieldValue > & CustomFields,
const FLootLockerLoginResponseDelegate & OnCompletedRequest )
static

Create a new White Label user account including answers to custom sign-up fields.

Call GetWhiteLabelSignUpFields first to retrieve the fields configured for this game, then pass the player's answers.

Parameters
EmailUser email
PasswordUser password
CustomFieldsAnswers to custom sign-up fields configured in the web console
OnCompletedRequestDelegate for handling the server response
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelLogin()

FString ULootLockerSDKManager::WhiteLabelLogin ( const FString & Email,
const FString & Password,
const FLootLockerLoginResponseDelegate & OnCompletedRequest,
const bool Remember = false )
static

Log in a White Label user (without starting session).

Use WhiteLabelLoginAndStartSession unless you need manual control. Set Remember=true to prolong lifetime.

Parameters
EmailAccount email
PasswordAccount password
OnCompletedRequestDelegate for handling the server response
RememberOptional: Prolong session lifetime
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelLoginAndStartSession()

FString ULootLockerSDKManager::WhiteLabelLoginAndStartSession ( const FString & Email,
const FString & Password,
const FLootLockerWhiteLabelLoginAndSessionResponseDelegate & OnCompletedRequest,
const bool Remember = false,
const FLootLockerSessionOptionals & Optionals = FLootLockerSessionOptionals() )
static

Log in and start a session (White Label).

Parameters
EmailAccount email
PasswordAccount password
OnCompletedRequestDelegate for handling the server response
RememberOptional: Prolong session lifetime
OptionalsOptional: Additional session options
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelRequestPasswordReset()

FString ULootLockerSDKManager::WhiteLabelRequestPasswordReset ( const FString & Email,
const FLootLockerDefaultDelegate & OnCompletedRequest )
static

Request password reset email.

Parameters
EmailUser email
OnCompletedRequestDelegate for handling the server response
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelRequestUserVerification()

FString ULootLockerSDKManager::WhiteLabelRequestUserVerification ( const int & UserId,
const FLootLockerDefaultDelegate & OnCompletedRequest )
static

Request account verification email (by user id).

Parameters
UserIdWhite Label user id
OnCompletedRequestDelegate for handling the server response
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelRequestUserVerificationByEmail()

FString ULootLockerSDKManager::WhiteLabelRequestUserVerificationByEmail ( const FString & Email,
const FLootLockerDefaultDelegate & OnCompletedRequest )
static

Request account verification email (by email).

Parameters
EmailUser email
OnCompletedRequestDelegate for handling the server response
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelStartSession()

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

Start a session using cached White Label credentials.

Use WhiteLabelLoginAndStartSession unless manual control required.

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

◆ WhiteLabelStartSessionManual()

FString ULootLockerSDKManager::WhiteLabelStartSessionManual ( const FString & Email,
const FString & WhiteLabelToken,
const FLootLockerSessionResponse & OnCompletedRequest,
const FLootLockerSessionOptionals & Optionals = FLootLockerSessionOptionals() )
static

Start a session using cached White Label credentials.

Use WhiteLabelLoginAndStartSession unless manual control required.

Parameters
EmailAccount email
WhiteLabelTokenWhite Label token
OnCompletedRequestDelegate for handling the server response
OptionalsOptional: Additional session options
Returns
A unique id for this request, use this to match callbacks to requests when you have multiple simultaneous requests outbound

◆ WhiteLabelVerifySession()

FString ULootLockerSDKManager::WhiteLabelVerifySession ( const FLootLockerWhiteLabelVerifySessionDelegate & OnCompletedRequest,
const FString & ForPlayerWithUlid = "" )
static

Verify cached White Label session token.

Use result to decide whether to start a session or prompt for login.

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

Functions

static FString ULootLockerSDKManager::WhiteLabelCreateAccount (const FString &Email, const FString &Password, const FLootLockerLoginResponseDelegate &OnCompletedRequest)
 Create a White Label user.
static FString ULootLockerSDKManager::WhiteLabelCreateAccount (const FString &Email, const FString &Password, const TArray< FLootLockerWhiteLabelCustomSignUpFieldValue > &CustomFields, const FLootLockerLoginResponseDelegate &OnCompletedRequest)
 Create a new White Label user account including answers to custom sign-up fields.
static FString ULootLockerSDKManager::GetWhiteLabelSignUpFields (const FLootLockerWhiteLabelSignUpFieldsResponseDelegate &OnCompletedRequest)
 Retrieve the list of custom sign-up fields configured for this game.
static FString ULootLockerSDKManager::WhiteLabelLogin (const FString &Email, const FString &Password, const FLootLockerLoginResponseDelegate &OnCompletedRequest, const bool Remember=false)
 Log in a White Label user (without starting session).
static FString ULootLockerSDKManager::WhiteLabelStartSession (const FLootLockerSessionResponse &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a session using cached White Label credentials.
static FString ULootLockerSDKManager::WhiteLabelStartSessionManual (const FString &Email, const FString &WhiteLabelToken, const FLootLockerSessionResponse &OnCompletedRequest, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Start a session using cached White Label credentials.
static FString ULootLockerSDKManager::WhiteLabelLoginAndStartSession (const FString &Email, const FString &Password, const FLootLockerWhiteLabelLoginAndSessionResponseDelegate &OnCompletedRequest, const bool Remember=false, const FLootLockerSessionOptionals &Optionals=FLootLockerSessionOptionals())
 Log in and start a session (White Label).
static FString ULootLockerSDKManager::WhiteLabelVerifySession (const FLootLockerWhiteLabelVerifySessionDelegate &OnCompletedRequest, const FString &ForPlayerWithUlid="")
 Verify cached White Label session token.
static FString ULootLockerSDKManager::WhiteLabelRequestUserVerification (const int &UserId, const FLootLockerDefaultDelegate &OnCompletedRequest)
 Request account verification email (by user id).
static FString ULootLockerSDKManager::WhiteLabelRequestUserVerificationByEmail (const FString &Email, const FLootLockerDefaultDelegate &OnCompletedRequest)
 Request account verification email (by email).
static FString ULootLockerSDKManager::WhiteLabelRequestPasswordReset (const FString &Email, const FLootLockerDefaultDelegate &OnCompletedRequest)
 Request password reset email.