Class SteamQrPollOutcome

The result of one poll of a QR sign-in session.

Inheritance
object
SteamQrPollOutcome
Inherited Members
Namespace: Serenity.Steam.Application.SignIn
Assembly: Serenity.Steam.Application.dll
Syntax
public sealed class SteamQrPollOutcome
Remarks

Immutable; built through the static factories. ToString() is deliberately redacted: it names the status and how long the refresh token is, never the token or the challenge.

Properties

AccountName

Declaration
public string AccountName { get; }
Property Value
Type Description
string

The signed-in account's name; set only for Approved.

Challenge

Declaration
public SteamQrChallenge Challenge { get; }
Property Value
Type Description
SteamQrChallenge

The rotated challenge for NewChallenge, otherwise the challenge that was polled.

FailureReason

Declaration
public string FailureReason { get; }
Property Value
Type Description
string

Why the poll failed or the session was lost; empty otherwise.

IsTransient

Declaration
public bool IsTransient { get; }
Property Value
Type Description
bool

Whether repeating the poll after a pause is worth it; only ever true for Failed.

RefreshToken

Declaration
public string RefreshToken { get; }
Property Value
Type Description
string

The token that proves the sign-in; set only for Approved.

Status

Declaration
public SteamQrPollStatus Status { get; }
Property Value
Type Description
SteamQrPollStatus

What the poll found out.

Methods

Approved(SteamQrChallenge, string, string)

Creates the outcome for the Approved status.

Declaration
public static SteamQrPollOutcome Approved(SteamQrChallenge polled, string refreshToken, string accountName)
Parameters
Type Name Description
SteamQrChallenge polled
string refreshToken
string accountName
Returns
Type Description
SteamQrPollOutcome

Failed(SteamQrChallenge, bool, string)

Creates the outcome for the Failed status.

Declaration
public static SteamQrPollOutcome Failed(SteamQrChallenge polled, bool isTransient, string reason)
Parameters
Type Name Description
SteamQrChallenge polled
bool isTransient
string reason
Returns
Type Description
SteamQrPollOutcome

NewChallenge(SteamQrChallenge)

Creates the outcome for the NewChallenge status.

Declaration
public static SteamQrPollOutcome NewChallenge(SteamQrChallenge rotated)
Parameters
Type Name Description
SteamQrChallenge rotated
Returns
Type Description
SteamQrPollOutcome

Pending(SteamQrChallenge)

Creates the outcome for the Pending status.

Declaration
public static SteamQrPollOutcome Pending(SteamQrChallenge polled)
Parameters
Type Name Description
SteamQrChallenge polled
Returns
Type Description
SteamQrPollOutcome

Scanned(SteamQrChallenge)

Creates the outcome for the Scanned status.

Declaration
public static SteamQrPollOutcome Scanned(SteamQrChallenge polled)
Parameters
Type Name Description
SteamQrChallenge polled
Returns
Type Description
SteamQrPollOutcome

SessionLost(SteamQrChallenge, string)

Creates the outcome for the SessionLost status.

Declaration
public static SteamQrPollOutcome SessionLost(SteamQrChallenge polled, string reason)
Parameters
Type Name Description
SteamQrChallenge polled
string reason
Returns
Type Description
SteamQrPollOutcome

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides