Struct CredentialsAuthSession 

pub struct CredentialsAuthSession { /* private fields */ }

An authentication session started with a username and password.

Implementations

impl CredentialsAuthSession

pub fn steam_id(&self) -> SteamID

SteamID of the account logging in. Only set if the credentials were correct.

pub async fn send_steam_guard_code( &self, code: &str, code_type: EAuthSessionGuardType, ) -> Result<(), SteamError>

Sends a Steam Guard code of the given type for this session.

pub fn authenticator(&self) -> Option<&Arc<dyn IAuthenticator>>

The authenticator used for 2-factor authentication, if any.

pub fn client_id(&self) -> u64

Unique id of the requestor. Also used for routing, and part of the QR code.

pub fn request_id(&self) -> &[u8]

Request id to present when polling.

pub fn polling_interval(&self) -> Duration

How often to call poll_auth_session_status.

pub fn allowed_confirmations(&self) -> &[CAuthenticationAllowedConfirmation]

The confirmation types that can confirm the request.

pub async fn polling_wait_for_result( &self, cancellation: CancellationToken, ) -> Result<AuthPollResult, SteamError>

Handles any 2-factor authentication and polls until authentication succeeds.

pub async fn poll_auth_session_status( &self, ) -> Result<Option<AuthPollResult>, SteamError>

Polls the authentication status once.

Trait Implementations

impl Debug for CredentialsAuthSession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.