Package-level declarations

Types

Link copied to clipboard
class AccessTokenGenerateResult(response: SteammessagesAuthSteamclient.CAuthentication_AccessToken_GenerateForApp_Response.Builder)

Represents access token generation result.

Link copied to clipboard
typealias AllowedConfirmations = SteammessagesAuthSteamclient.CAuthentication_AllowedConfirmation
Link copied to clipboard

Thrown when SteamAuthentication fails to authenticate.

Link copied to clipboard
class AuthPollResult(response: SteammessagesAuthSteamclient.CAuthentication_PollAuthSessionStatus_Response.Builder)

Represents authentication poll result.

Link copied to clipboard
open class AuthSession(val authentication: SteamAuthentication, val authenticator: IAuthenticator?, var clientId: Long, val requestId: ByteArray, var allowedConfirmations: List<AllowedConfirmations>, val pollingInterval: Float)

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

Link copied to clipboard

Represents the details required to authenticate on Steam.

Link copied to clipboard
typealias AuthSessionStatusRequest = SteammessagesAuthSteamclient.CAuthentication_PollAuthSessionStatus_Request
Link copied to clipboard
typealias AuthSessionStatusResponse = SteammessagesAuthSteamclient.CAuthentication_PollAuthSessionStatus_Response
Link copied to clipboard
typealias AuthSessionStatusResponseBuilder = SteammessagesAuthSteamclient.CAuthentication_PollAuthSessionStatus_Response.Builder
Link copied to clipboard
class CredentialsAuthSession(val authentication: SteamAuthentication, val authenticator: IAuthenticator?, response: SteammessagesAuthSteamclient.CAuthentication_BeginAuthSessionViaCredentials_Response.Builder) : AuthSession

Credentials based authentication session.

Link copied to clipboard
interface IAuthenticator

Represents an authenticator to be used with SteamAuthentication.

Link copied to clipboard
fun interface IChallengeUrlChanged

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

Link copied to clipboard
class QrAuthSession(val authentication: SteamAuthentication, val authenticator: IAuthenticator?, response: SteammessagesAuthSteamclient.CAuthentication_BeginAuthSessionViaQR_Response.Builder) : AuthSession

QR code based authentication session.

Link copied to clipboard
typealias SessionGuardType = SteammessagesAuthSteamclient.EAuthSessionGuardType
Link copied to clipboard
class SteamAuthentication(steamClient: SteamClient)

This handler is used for authenticating on Steam.

Link copied to clipboard

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.