JavaSteam/in.dragonbra.javasteam.steam.authentication/QrAuthSession

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.

Constructors

QrAuthSession

@JvmOverloads

constructor(authentication: SteamAuthentication, authenticator: IAuthenticator?, response: SteammessagesAuthSteamclient.CAuthentication_BeginAuthSessionViaQR_Response.Builder, defaultScope: CoroutineScope = CoroutineScope(Dispatchers.IO + SupervisorJob()))

Properties

allowedConfirmations

var allowedConfirmations: List<SteammessagesAuthSteamclient.CAuthentication_AllowedConfirmation>

authentication

val authentication: SteamAuthentication

authenticator

val authenticator: IAuthenticator?

challengeUrl

var challengeUrl: String

URL based on client ID, which can be rendered as QR code.

challengeUrlChanged

var challengeUrlChanged: IChallengeUrlChanged?

Called whenever the challenge url is refreshed by Steam.

clientID

var clientID: Long

defaultScope

val defaultScope: CoroutineScope

pollingInterval

val pollingInterval: Float

requestID

val requestID: ByteArray

Functions

pollAuthSessionStatus

@JvmOverloads

fun pollAuthSessionStatus(parentScope: CoroutineScope = defaultScope): CompletableFuture<AuthPollResult?>

Polls for authentication status once. Prefer using pollingWaitForResult instead.

pollingWaitForResult

@JvmOverloads

fun pollingWaitForResult(parentScope: CoroutineScope = defaultScope): CompletableFuture<AuthPollResult>

Handle any 2-factor authentication, and if necessary poll for updates until authentication succeeds.