Struct steam_mobile::SteamAuthenticator

pub struct SteamAuthenticator<AuthState, MaFileState> { /* private fields */ }

Main authenticator. We use it to spawn and act as our “mobile” client. Responsible for accepting/denying trades, and some other operations that may or not be related to mobile operations.

Example: Fetch mobile notifications

use steam_mobile::SteamAuthenticator;
use steam_mobile::User;

Implementations

impl<MaFileState> SteamAuthenticator<Unauthenticated, MaFileState>

where MaFileState: 'static + Send + Sync + Clone,

pub fn new(user: SteamUser<MaFileState>) -> Self

Returns current user API Key.

Will return None if you are not logged in.

pub async fn login( self ) -> Result<SteamAuthenticator<Authenticated, MaFileState>, AuthError>

Log on into Steam website and populates the inner client with cookies for the Steam Store, Steam community and Steam help domains.

Automatically unlocks parental control if user uses it, but it need to be included inside the SteamUser builder.

The mobile client also has a very simple exponential retry strategy for errors that are probably caused by fast requests, so we retry it. For errors such as bad credentials, or inserting captcha the proper errors are raised by AuthError.

Also caches the API Key, if the user wants to use it for any operation later.

The cookies are inside the [MobileClient] inner cookie storage.

impl<M> SteamAuthenticator<Authenticated, M>

pub fn api_key(&self) -> Option<String>

Returns account’s API Key, if authenticator managed to cache it.

pub async fn steam_guard_status(&self) -> Result<QueryStatusResponse, AuthError>

Returns this account SteamGuard information.

pub async fn add_authenticator( &self, current_step: AddAuthenticatorStep, phone_number: &str ) -> Result<AddAuthenticatorStep, AuthError>

Add an authenticator to the account. Note that this makes various assumptions about the account.

The first argument is an enum of AddAuthenticatorStep to help you automate the process of adding an authenticator to the account.

First call this method with AddAuthenticatorStep::InitialStep. This requires the account to be already connected with a verified email address. After this step is finished, you will receive an email about the phone confirmation.

Once you confirm it, you will call this method with AddAuthenticatorStep::EmailConfirmation.

This will return a AddAuthenticatorStep::MobileAuthenticatorFile now, with your maFile inside the variant. For more complete example, you can check the CLI Tool, that performs the inclusion of an authenticator interactively.

pub async fn finalize_authenticator( &self, mafile: &MobileAuthFile, sms_code: &str ) -> Result<(), AuthError>

Finalize the authenticator process, enabling SteamGuard for the account. This method wraps up the whole process, finishing the registration of the phone number into the account.

• EXTREMELY IMPORTANT *

Call this method ONLY after saving your maFile, because otherwise you WILL lose access to your account.

pub async fn remove_authenticator( &self, revocation_code: &str, remove_authenticator_scheme: RemoveAuthenticatorScheme ) -> Result<(), AuthError>

Remove an authenticator from a Steam Account.

Sets account to use SteamGuard email confirmation codes or even remove it completely.

pub async fn request_custom_endpoint<T>( &self, url: String, method: Method, custom_headers: Option<HeaderMap>, data: Option<T> ) -> Result<Response, InternalError>

where T: Serialize + Send + Sync,

You can request custom operations for any Steam operation that requires logging in.

The authenticator will take care sending session cookies and keeping the session operational.

pub fn dump_cookie( &self, steam_domain_host: &str, steam_cookie_name: &str ) -> Option<String>

impl SteamAuthenticator<Authenticated, PresentMaFile>

pub async fn fetch_confirmations(&self) -> Result<Confirmations, AuthError>

Fetch all confirmations available with the authenticator.

pub async fn handle_confirmations<'a, 'b, F>( &self, operation: ConfirmationAction, f: F ) -> Result<(), AuthError>

where F: Fn(Confirmations) -> Box<dyn Iterator<Item = Confirmation> + Send> + Send,

Fetches confirmations and process them.

f is a function which you can use it to filter confirmations at the moment of the query.

pub async fn process_confirmations<I>( &self, operation: ConfirmationAction, confirmations: I ) -> Result<(), AuthError>

where I: IntoIterator<Item = Confirmation> + Send,

Accept or deny confirmations.

Panics

Will panic if not logged in with SteamAuthenticator first.

Trait Implementations

impl<AuthState: Debug, MaFileState: Debug> Debug for SteamAuthenticator<AuthState, MaFileState>

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

Formats the value using the given formatter.