LootLocker Unity SDK 8.0.0
Game backend SDK for Unity
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

◆ CheckWhiteLabelSession() [1/3]

static void LootLocker.Requests.LootLockerSDKManager.CheckWhiteLabelSession ( Action< bool >  onComplete,
string  forPlayerWithUlid = null 
)
inlinestatic

Checks for a stored session and if that session is valid.

Depending on response of this method the developer can either start a session using the token, or show a login form. White Label platform must be enabled in the web console for this to work.

Parameters
onCompleteonComplete Action bool that returns true if a White Label session exists
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.

◆ CheckWhiteLabelSession() [2/3]

static void LootLocker.Requests.LootLockerSDKManager.CheckWhiteLabelSession ( string  email,
Action< bool >  onComplete 
)
inlinestatic

Checks for a stored session and if that session is valid.

Depending on response of this method the developer can either start a session using the token, or show a login form. White Label platform must be enabled in the web console for this to work.

Parameters
emailThe email to check for a valid white label session
onCompleteonComplete Action bool that returns true if a White Label session exists

◆ CheckWhiteLabelSession() [3/3]

static void LootLocker.Requests.LootLockerSDKManager.CheckWhiteLabelSession ( string  email,
string  token,
Action< bool >  onComplete 
)
inlinestatic

Checks if the provided session token is valid for the provided White Label email.

Depending on response of this method the developer can either start a session using the token, or show a login form. White Label platform must be enabled in the web console for this to work.

Parameters
emailE-mail for the user
tokenThe token is received when starting a White Label session.
onCompleteonComplete Action bool that returns true if a White Label session exists

◆ StartWhiteLabelSession() [1/3]

static void LootLocker.Requests.LootLockerSDKManager.StartWhiteLabelSession ( Action< LootLockerSessionResponse >  onComplete,
string  forPlayerWithUlid = null,
LootLockerSessionOptionals  Optionals = null 
)
inlinestatic

Start a LootLocker Session using the cached White Label token and email if any exist White Label platform must be enabled in the web console for this to work.

Parameters
onCompleteonComplete Action for handling the response of type LootLockerSessionResponse
forPlayerWithUlidOptional : Execute the request for the specified player. If not supplied, the default player will be used.
OptionalsOptional parameters for the session start request

◆ StartWhiteLabelSession() [2/3]

static void LootLocker.Requests.LootLockerSDKManager.StartWhiteLabelSession ( LootLockerWhiteLabelSessionRequest  sessionRequest,
Action< LootLockerSessionResponse >  onComplete 
)
inlinestatic

Start a LootLocker Session using the provided White Label request.

White Label platform must be enabled in the web console for this to work.

Parameters
sessionRequestA White Label Session Request with inner values already set
onCompleteonComplete Action for handling the response of type LootLockerSessionResponse

◆ StartWhiteLabelSession() [3/3]

static void LootLocker.Requests.LootLockerSDKManager.StartWhiteLabelSession ( string  email,
Action< LootLockerSessionResponse >  onComplete,
LootLockerSessionOptionals  Optionals = null 
)
inlinestatic

Start a LootLocker Session using the cached White Label token for the specified email if it exist White Label platform must be enabled in the web console for this to work.

Parameters
emailThe email of the White Label user to start a WL session for
OptionalsOptional parameters for the session start request
onCompleteonComplete Action for handling the response of type LootLockerSessionResponse

◆ WhiteLabelLogin() [1/2]

static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelLogin ( string  email,
string  password,
Action< LootLockerWhiteLabelLoginResponse >  onComplete 
)
inlinestatic

Log in a White Label user with the given email and password combination, verify user, and start a White Label Session.

White Label platform must be enabled in the web console for this to work.

Parameters
emailE-mail for an existing user
passwordPassword for an existing user
onCompleteonComplete Action for handling the response of type LootLockerWhiteLabelLoginResponse

◆ WhiteLabelLogin() [2/2]

static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelLogin ( string  email,
string  password,
bool  remember,
Action< LootLockerWhiteLabelLoginResponse >  onComplete 
)
inlinestatic

Log in a White Label user with the given email and password combination, verify user, and start a White Label Session.

Set remember=true to prolong the session lifetime White Label platform must be enabled in the web console for this to work.

Parameters
emailE-mail for an existing user
passwordPassword for an existing user
rememberSet remember=true to prolong the session lifetime
onCompleteonComplete Action for handling the response of type LootLockerWhiteLabelLoginResponse

◆ WhiteLabelLoginAndStartSession()

static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelLoginAndStartSession ( string  email,
string  password,
bool  rememberMe,
Action< LootLockerWhiteLabelLoginAndStartSessionResponse >  onComplete 
)
inlinestatic

Log in a White Label user with the given email and password combination, verify user, and start a White Label Session.

If that succeeds, then also start a LootLocker Session. The response is nested. The top properties will give the complete success condition and eventual error data. Nested inside the response you can also find the specific responses of the two composite calls using LoginResponse and SessionResponse respectively Set remember=true to prolong the session lifetime White Label platform must be enabled in the web console for this to work.

Parameters
emailE-mail for an existing user
passwordPassword for an existing user
rememberMeSet remember=true to prolong the session lifetime
onCompleteonComplete Action for handling the response

◆ WhiteLabelRequestPassword()

static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelRequestPassword ( string  email,
Action< LootLockerResponse onComplete 
)
inlinestatic

Request a password reset email for the given email address.

White Label platform must be enabled in the web console for this to work.

Parameters
emailE-mail for the user
onCompleteonComplete Action for handling the response of type LootLockerResponse

◆ WhiteLabelRequestVerification() [1/2]

static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelRequestVerification ( int  userID,
Action< LootLockerResponse onComplete 
)
inlinestatic

Request verify account email for the user.

White Label platform must be enabled in the web console for this to work. Account verification must also be enabled.

Parameters
userIDID of the player, will be retrieved when signing up/logging in.
onCompleteonComplete Action for handling the response of type LootLockerResponse

◆ WhiteLabelRequestVerification() [2/2]

static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelRequestVerification ( string  email,
Action< LootLockerResponse onComplete 
)
inlinestatic

Request verify account email for the user.

White Label platform must be enabled in the web console for this to work. Account verification must also be enabled.

Parameters
emailEmail of the player
onCompleteonComplete Action for handling the response of type LootLockerResponse

◆ WhiteLabelSignUp()

static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelSignUp ( string  email,
string  password,
Action< LootLockerWhiteLabelSignupResponse >  onComplete 
)
inlinestatic

Create new user using the White Label login system.

White Label platform must be enabled in the web console for this to work.

Parameters
emailE-mail for the new user
passwordPassword for the new user
onCompleteonComplete Action for handling the response of type LootLockerWhiteLabelSignupResponse

Functions

static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelLogin (string email, string password, Action< LootLockerWhiteLabelLoginResponse > onComplete)
 Log in a White Label user with the given email and password combination, verify user, and start a White Label Session.
 
static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelLogin (string email, string password, bool remember, Action< LootLockerWhiteLabelLoginResponse > onComplete)
 Log in a White Label user with the given email and password combination, verify user, and start a White Label Session.
 
static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelSignUp (string email, string password, Action< LootLockerWhiteLabelSignupResponse > onComplete)
 Create new user using the White Label login system.
 
static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelRequestPassword (string email, Action< LootLockerResponse > onComplete)
 Request a password reset email for the given email address.
 
static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelRequestVerification (int userID, Action< LootLockerResponse > onComplete)
 Request verify account email for the user.
 
static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelRequestVerification (string email, Action< LootLockerResponse > onComplete)
 Request verify account email for the user.
 
static void LootLocker.Requests.LootLockerSDKManager.CheckWhiteLabelSession (Action< bool > onComplete, string forPlayerWithUlid=null)
 Checks for a stored session and if that session is valid.
 
static void LootLocker.Requests.LootLockerSDKManager.CheckWhiteLabelSession (string email, Action< bool > onComplete)
 Checks for a stored session and if that session is valid.
 
static void LootLocker.Requests.LootLockerSDKManager.CheckWhiteLabelSession (string email, string token, Action< bool > onComplete)
 Checks if the provided session token is valid for the provided White Label email.
 
static void LootLocker.Requests.LootLockerSDKManager.StartWhiteLabelSession (Action< LootLockerSessionResponse > onComplete, string forPlayerWithUlid=null, LootLockerSessionOptionals Optionals=null)
 Start a LootLocker Session using the cached White Label token and email if any exist White Label platform must be enabled in the web console for this to work.
 
static void LootLocker.Requests.LootLockerSDKManager.StartWhiteLabelSession (string email, Action< LootLockerSessionResponse > onComplete, LootLockerSessionOptionals Optionals=null)
 Start a LootLocker Session using the cached White Label token for the specified email if it exist White Label platform must be enabled in the web console for this to work.
 
static void LootLocker.Requests.LootLockerSDKManager.StartWhiteLabelSession (LootLockerWhiteLabelSessionRequest sessionRequest, Action< LootLockerSessionResponse > onComplete)
 Start a LootLocker Session using the provided White Label request.
 
static void LootLocker.Requests.LootLockerSDKManager.WhiteLabelLoginAndStartSession (string email, string password, bool rememberMe, Action< LootLockerWhiteLabelLoginAndStartSessionResponse > onComplete)
 Log in a White Label user with the given email and password combination, verify user, and start a White Label Session.