@steambrew/client
Version:
A support library for creating plugins with Millennium.
77 lines (76 loc) • 2.44 kB
TypeScript
import { EResult, JsPbMessage, OperationResponse } from './shared';
import { EOSType } from './system';
export interface Auth {
/**
* @returns a boolean indicating if the operation succeeded.
*/
ClearCachedSignInPin(): Promise<boolean>;
CurrentUserHasCachedSignInPin(): Promise<boolean>;
GetLocalHostname(): Promise<string>;
/**
* @returns a ProtoBuf message. If deserialized, returns {@link CAuthentication_DeviceDetails}.
*/
GetMachineID(): Promise<ArrayBuffer>;
GetRefreshInfo(): Promise<AuthRefreshInfo>;
GetSteamGuardData(param0: string): Promise<SteamGuardData>;
/**
* "Secured" refers to unshared.
*/
IsSecureComputer(): Promise<boolean>;
SetCachedSignInPin(pin: string): Promise<boolean>;
SetLoginToken(refreshToken: string, accountName: string): Promise<OperationResponse>;
SetSteamGuardData(accountName: string, newGuardData: string): void;
StartSignInFromCache(accountName: string, offlineMode: boolean): Promise<OperationResponse | void>;
UserHasCachedSignInPin(accountName: string): Promise<boolean>;
ValidateCachedSignInPin(accountName: string, pin: string): Promise<boolean>;
}
export interface AuthRefreshInfo {
reason: number;
account_name: string;
login_id_token: string;
}
export interface SteamGuardData {
data: string;
eresult: EResult;
}
/**
* `deserializeBinary` argument:
* ```
* [
* await SteamClient.System.GetOSType(),
* await SteamClient.Auth.GetLocalHostname(),
* await SteamClient.Auth.GetMachineID(),
* ];
* ```
*/
export interface CAuthentication_DeviceDetails extends JsPbMessage {
client_count(): number | undefined;
device_friendly_name(): string | undefined;
gaming_device_type(): EGamingDeviceType | undefined;
machine_id(): Uint8Array | string;
os_type(): EOSType | undefined;
platform_type(): EAuthTokenPlatformType | undefined;
set_client_count(): any;
set_device_friendly_name(): any;
set_gaming_device_type(): any;
set_machine_id(): any;
set_os_type(): any;
set_platform_type(): any;
}
export declare enum EAuthTokenPlatformType {
Unknown = 0,
SteamClient = 1,
WebBrowser = 2,
MobileApp = 3
}
export declare enum EGamingDeviceType {
Unknown = 0,
StandardPC = 1,
Console = 256,
PS3 = 272,
Steambox = 288,
Tesla = 320,
Handheld = 512,
Phone = 528,
SteamDeck = 544
}