Interface ISteamPartnerSession

The Steam partner-site sign-in held for the current session of whatever hosts it: the cookies per app id and the sign-in token that mints them again. Callers reach Steam's credentials only through this contract, so a test hands them a fake.

Namespace: Serenity.Steam.Application

Assembly: Serenity.Steam.Application.dll

Syntax

public interface ISteamPartnerSession

Properties

ForgetOnWindowClose

Declaration

bool ForgetOnWindowClose { get; set; }

Property Value

Type	Description
bool	Whether the owner of this session clears the cookies and the sign-in token when it ends. Defaults to false: the sign-in outlives its owner and dies with the host process.

SignInToken

Declaration

ISteamSignInTokenStore SignInToken { get; }

Property Value

Type	Description
ISteamSignInTokenStore	The Steam sign-in token that lets a fresh partner cookie be minted without a new QR scan. Not tied to an app id: ClearAll() erases it.

Methods

ClearAll()

Forgets every app id's cookies this session has stored, and the sign-in token.

Declaration

void ClearAll()

Store(string, SteamPartnerCookies)

Stores a cookie pair for one app id.

Declaration

void Store(string appId, SteamPartnerCookies cookies)

Parameters

Type	Name	Description
string	appId	The Steam app id the cookies were copied for.
SteamPartnerCookies	cookies	The cookies to store.

TryGet(string, out SteamPartnerCookies)

Reads back the cookies stored for one app id.

Declaration

bool TryGet(string appId, out SteamPartnerCookies cookies)

Parameters

Type	Name	Description
string	appId	The Steam app id to read cookies for.
SteamPartnerCookies	cookies	The cookies found, or null when nothing is stored for this app id.

Returns

Type	Description
bool	Whether a complete cookie pair is available for this app id.