in.dragonbra.javasteam.steam.handlers.steamuser

Class LogOnDetails

java.lang.Object

in.dragonbra.javasteam.steam.handlers.steamuser.LogOnDetails

public class LogOnDetails
extends java.lang.Object

Represents the details required to log into Steam3 as a user.

Constructor Summary

Constructors

Constructor and Description
LogOnDetails()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessToken() Gets the access token used to log in.
long	getAccountID() Gets the account ID used for connecting clients when using the Console instance.
long	getAccountInstance() Gets the account instance.
java.lang.String	getAuthCode() Gets the Steam Guard auth code used to login.
java.lang.Integer	getCellID() Gets the CellID.
java.lang.String	getClientLanguage() Gets the client language.
EOSType	getClientOSType() Gets the client operating system type.
java.lang.Integer	getLoginID() Gets the LoginID.
java.lang.String	getLoginKey() Deprecated. "Steam no longer sends new login keys as of March 2023, use SteamAuthentication."
java.lang.String	getPassword() Gets the password.
byte[]	getSentryFileHash() Gets the sentry file hash for this logon attempt, or null if no sentry file is available.
java.lang.String	getTwoFactorCode() Gets the 2-factor auth code used to login.
java.lang.String	getUsername() Gets the username.
boolean	isRequestSteam2Ticket() Gets a value indicating whether to request the Steam2 ticket.
boolean	isShouldRememberPassword() Gets the 'Should Remember Password' flag.
void	setAccessToken(java.lang.String accessToken) Sets the access token used to log in.
void	setAccountID(long accountID) Sets the account ID used for connecting clients when using the Console instance.
void	setAccountInstance(long accountInstance) Sets the account instance.
void	setAuthCode(java.lang.String authCode) Sets the Steam Guard auth code used to login.
void	setCellID(int cellID) Sets the CellID.
void	setClientLanguage(java.lang.String clientLanguage) Sets the client language.
void	setClientOSType(EOSType clientOSType) Sets the client operating system type.
void	setLoginID(java.lang.Integer loginID) Sets the LoginID.
void	setLoginKey(java.lang.String loginKey) Deprecated. "Steam no longer sends new login keys as of March 2023, use SteamAuthentication."
void	setPassword(java.lang.String password) Sets the password.
void	setRequestSteam2Ticket(boolean requestSteam2Ticket) Sets a value indicating whether to request the Steam2 ticket.
void	setSentryFileHash(byte[] sentryFileHash) Sets the sentry file hash for this logon attempt, or null if no sentry file is available.
void	setShouldRememberPassword(boolean shouldRememberPassword) Sets the 'Should Remember Password' flag.
void	setTwoFactorCode(java.lang.String twoFactorCode) Sets the 2-factor auth code used to login.
void	setUsername(java.lang.String username) Sets the username.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogOnDetails

public LogOnDetails()

Method Detail

getUsername

public java.lang.String getUsername()

Gets the username.

Returns:

the username.

setUsername

public void setUsername(java.lang.String username)

Sets the username.

Parameters:

username - the username.

getPassword

public java.lang.String getPassword()

Gets the password.

Returns:

the password.

setPassword

public void setPassword(java.lang.String password)

Sets the password.

Parameters:

password - the password.

getCellID

public java.lang.Integer getCellID()

Gets the CellID.

Returns:

the CellID.

setCellID

public void setCellID(int cellID)

Sets the CellID.

Parameters:

cellID - the CellID.

getLoginID

public java.lang.Integer getLoginID()

Gets the LoginID. This number is used for identifying logon session.

Returns:

the LoginID.

setLoginID

public void setLoginID(java.lang.Integer loginID)

Sets the LoginID. This number is used for identifying logon session. The purpose of this field is to allow multiple sessions to the same steam account from the same machine. This is because Steam Network doesn't allow more than one session with the same LoginID to access given account at the same time from the same public IP. If you want to establish more than one active session to given account, you must make sure that every session (to that account) from the same public IP has a unique LoginID. By default, LoginID is automatically generated based on machine's primary bind address, which is the same for all sessions. Null value will cause this property to be automatically generated based on default behaviour. If in doubt, set this property to null.

Parameters:

loginID - the LoginID.

getAuthCode

public java.lang.String getAuthCode()

Gets the Steam Guard auth code used to login. This is the code sent to the user's email.

Returns:

the auth code.

setAuthCode

public void setAuthCode(java.lang.String authCode)

Sets the Steam Guard auth code used to login. This is the code sent to the user's email.

Parameters:

authCode - the auth code.

getTwoFactorCode

public java.lang.String getTwoFactorCode()

Gets the 2-factor auth code used to login. This is the code that can be received from the authenticator apps.

Returns:

the two-factor auth code.

setTwoFactorCode

public void setTwoFactorCode(java.lang.String twoFactorCode)

Sets the 2-factor auth code used to login. This is the code that can be received from the authenticator apps.

Parameters:

twoFactorCode - the two-factor auth code.

getLoginKey

@Deprecated
public java.lang.String getLoginKey()

Deprecated. "Steam no longer sends new login keys as of March 2023, use SteamAuthentication."

Gets the login key used to login. This is a key that has been received in a previous Steam session by a LoginKeyCallback.

Returns:

the login key.

setLoginKey

@Deprecated
public void setLoginKey(java.lang.String loginKey)

Deprecated. "Steam no longer sends new login keys as of March 2023, use SteamAuthentication."

Sets the login key used to login. This is a key that has been received in a previous Steam session by a LoginKeyCallback.

Parameters:

loginKey - the login key.

isShouldRememberPassword

public boolean isShouldRememberPassword()

Gets the 'Should Remember Password' flag. This is used in combination with the login key and LoginKeyCallback for password-less login.

Returns:

the 'Should Remember Password' flag.

setShouldRememberPassword

public void setShouldRememberPassword(boolean shouldRememberPassword)

Sets the 'Should Remember Password' flag. This is used in combination with the login key and LoginKeyCallback for password-less login.

Parameters:

shouldRememberPassword - the 'Should Remember Password' flag.

getSentryFileHash

public byte[] getSentryFileHash()

Gets the sentry file hash for this logon attempt, or null if no sentry file is available.

Returns:

the sentry file hash.

setSentryFileHash

public void setSentryFileHash(byte[] sentryFileHash)

Sets the sentry file hash for this logon attempt, or null if no sentry file is available.

Parameters:

sentryFileHash - the sentry file hash.

getAccessToken

public java.lang.String getAccessToken()

Gets the access token used to log in. This a token that has been provided after a successful login using SteamAuthentication.

Returns:

the access token used to log in.

setAccessToken

public void setAccessToken(java.lang.String accessToken)

Sets the access token used to log in. This a token that has been provided after a successful login using SteamAuthentication.

Parameters:

accessToken - the access token used to log in.

getAccountInstance

public long getAccountInstance()

Gets the account instance. 1 for the PC instance or 2 for the Console (PS3) instance.

See: SteamID.DESKTOP_INSTANCE See: SteamID.CONSOLE_INSTANCE

Returns:

the account instance.

setAccountInstance

public void setAccountInstance(long accountInstance)

Sets the account instance. 1 for the PC instance or 2 for the Console (PS3) instance.

See: SteamID.DESKTOP_INSTANCE See: SteamID.CONSOLE_INSTANCE

Parameters:

accountInstance - the account instance.

getAccountID

public long getAccountID()

Gets the account ID used for connecting clients when using the Console instance.

Returns:

the account ID.

setAccountID

public void setAccountID(long accountID)

Sets the account ID used for connecting clients when using the Console instance.

Parameters:

accountID - the account ID.

isRequestSteam2Ticket

public boolean isRequestSteam2Ticket()

Gets a value indicating whether to request the Steam2 ticket. This is an optional request only needed for Steam2 content downloads.

Returns:

true if the Steam2 ticket should be requested; otherwise, false.

setRequestSteam2Ticket

public void setRequestSteam2Ticket(boolean requestSteam2Ticket)

Sets a value indicating whether to request the Steam2 ticket. This is an optional request only needed for Steam2 content downloads.

Parameters:

requestSteam2Ticket - true if the Steam2 ticket should be requested; otherwise, false.

getClientOSType

public EOSType getClientOSType()

Gets the client operating system type.

Returns:

the client operating system type.

setClientOSType

public void setClientOSType(EOSType clientOSType)

Sets the client operating system type.

Parameters:

clientOSType - the client operating system type.

getClientLanguage

public java.lang.String getClientLanguage()

Gets the client language.

Returns:

the client language.

setClientLanguage

public void setClientLanguage(java.lang.String clientLanguage)

Sets the client language.

Parameters:

clientLanguage - the client language.