Class SteamPartnerMintResult
What exchanging a refresh token for a partner-site session came to: new cookies, a dead token, or a failure worth retrying or not.
Inheritance
SteamPartnerMintResult
Assembly: Serenity.Steam.Application.dll
Syntax
public sealed class SteamPartnerMintResult
Properties
Cookies
Declaration
public SteamPartnerCookies Cookies { get; }
Property Value
| Type |
Description |
| SteamPartnerCookies |
The cookies the partner site accepts, or null when minting failed.
|
ExpiresAtUtc
Declaration
public DateTimeOffset? ExpiresAtUtc { get; }
Property Value
| Type |
Description |
| DateTimeOffset? |
The expiry the partner site reported for the sign-in (rtExpiry), or null when it named none.
|
FailureReason
Declaration
public string FailureReason { get; }
Property Value
| Type |
Description |
| string |
Why minting failed, never quoting a token, a nonce or a cookie; empty on success.
|
IsTransient
Declaration
public bool IsTransient { get; }
Property Value
| Type |
Description |
| bool |
Whether the failure is worth repeating after a pause; always false for a success or a dead token.
|
RefreshTokenRejected
Declaration
public bool RefreshTokenRejected { get; }
Property Value
| Type |
Description |
| bool |
Whether the refresh token itself is dead, so it should be forgotten and the author must sign in again.
|
Succeeded
Declaration
public bool Succeeded { get; }
Property Value
| Type |
Description |
| bool |
Whether a partner-site session was minted.
|
Methods
Failure(string, bool)
Minting failed for failureReason although the refresh token may still be good.
Declaration
public static SteamPartnerMintResult Failure(string failureReason, bool isTransient)
Parameters
| Type |
Name |
Description |
| string |
failureReason |
|
| bool |
isTransient |
|
Returns
Success(SteamPartnerCookies, DateTimeOffset?)
A session was minted: cookies are what the partner site accepts.
Declaration
public static SteamPartnerMintResult Success(SteamPartnerCookies cookies, DateTimeOffset? expiresAtUtc)
Parameters
Returns
ToString()
Describes the result without any credential.
Declaration
public override string ToString()
Returns
Overrides
TokenRejected(string)
The refresh token is dead for failureReason, so there is nothing to retry.
Declaration
public static SteamPartnerMintResult TokenRejected(string failureReason)
Parameters
| Type |
Name |
Description |
| string |
failureReason |
|
Returns