JavaSteam/in.dragonbra.javasteam.steam.authentication

Package-level declarations

Types

class AccessTokenGenerateResult(response: SteammessagesAuthSteamclient.CAuthentication_AccessToken_GenerateForApp_Response.Builder)

Represents access token generation result.

AuthenticationException

class AuthenticationException : Exception

Thrown when SteamAuthentication fails to authenticate.

AuthPollResult

class AuthPollResult(response: SteammessagesAuthSteamclient.CAuthentication_PollAuthSessionStatus_Response.Builder)

Represents authentication poll result.

AuthSession

open class AuthSession(val authentication: SteamAuthentication, val authenticator: IAuthenticator?, var clientID: Long, val requestID: ByteArray, var allowedConfirmations: List<SteammessagesAuthSteamclient.CAuthentication_AllowedConfirmation>, val pollingInterval: Float, val defaultScope: CoroutineScope)

Represents an authentication session which can be used to finish the authentication and get access tokens.

AuthSessionDetails

class AuthSessionDetails

Represents the details required to authenticate on Steam.

CredentialsAuthSession

class CredentialsAuthSession @JvmOverloads constructor(val authentication: SteamAuthentication, val authenticator: IAuthenticator?, response: SteammessagesAuthSteamclient.CAuthentication_BeginAuthSessionViaCredentials_Response.Builder, val defaultScope: CoroutineScope = CoroutineScope(Dispatchers.IO + SupervisorJob())) : AuthSession

Credentials based authentication session.

IAuthenticator

interface IAuthenticator

Represents an authenticator to be used with SteamAuthentication.

IChallengeUrlChanged

fun interface IChallengeUrlChanged

Interface to tell the listening class that the QR Challenge URL has changed.

QrAuthSession

class QrAuthSession @JvmOverloads constructor(val authentication: SteamAuthentication, val authenticator: IAuthenticator?, response: SteammessagesAuthSteamclient.CAuthentication_BeginAuthSessionViaQR_Response.Builder, val defaultScope: CoroutineScope = CoroutineScope(Dispatchers.IO + SupervisorJob())) : AuthSession

QR code based authentication session.

SteamAuthentication

class SteamAuthentication(steamClient: SteamClient)

This handler is used for authenticating on Steam.

UserConsoleAuthenticator

class UserConsoleAuthenticator : IAuthenticator

This is a default implementation of IAuthenticator to ease of use. This implementation will prompt user to enter 2-factor authentication codes in the console. or inform to use the Mobile App to approve sign in.