in.dragonbra.javasteam.steam.steamclient.configuration

Class SteamConfiguration

java.lang.Object

in.dragonbra.javasteam.steam.steamclient.configuration.SteamConfiguration

public class SteamConfiguration
extends java.lang.Object

Configuration object to use. This object should not be mutated after it is passed to one or more SteamClient objects.

Method Summary

Modifier and Type	Method and Description
static SteamConfiguration	create(Consumer<ISteamConfigurationBuilder> configurator) Creates a SteamConfiguration, allowing for configuration.
static SteamConfiguration	createDefault()
int	getCellID()
long	getConnectionTimeout()
java.util.EnumSet<EClientPersonaStateFlag>	getDefaultPersonaStateFlags()
okhttp3.OkHttpClient	getHttpClient()
java.util.EnumSet<ProtocolTypes>	getProtocolTypes()
SmartCMServerList	getServerList()
IServerListProvider	getServerListProvider()
EUniverse	getUniverse()
WebAPI	getWebAPI(java.lang.String _interface) Retrieves a handler capable of interacting with the specified interface on the Web API.
java.lang.String	getWebAPIBaseAddress()
java.lang.String	getWebAPIKey()
boolean	isAllowDirectoryFetch()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static SteamConfiguration create(Consumer<ISteamConfigurationBuilder> configurator)

Creates a SteamConfiguration, allowing for configuration.

Parameters:

configurator - A method which is used to configure the configuration.

Returns:

A configuration object.

createDefault

public static SteamConfiguration createDefault()

isAllowDirectoryFetch

public boolean isAllowDirectoryFetch()

Returns:

Whether or not to use the Steam Directory to discover available servers.

getCellID

public int getCellID()

Returns:

The Steam Cell ID to prioritize when connecting.

getConnectionTimeout

public long getConnectionTimeout()

Returns:

The connection timeout used when connecting to Steam serves.

getHttpClient

public okhttp3.OkHttpClient getHttpClient()

Returns:

The http client

getDefaultPersonaStateFlags

public java.util.EnumSet<EClientPersonaStateFlag> getDefaultPersonaStateFlags()

Returns:

The default persona state flags used when requesting information for a new friend, or when calling SteamFriends.RequestFriendInfo without specifying flags.

getProtocolTypes

public java.util.EnumSet<ProtocolTypes> getProtocolTypes()

Returns:

The supported protocol types to use when attempting to connect to Steam.

getServerListProvider

public IServerListProvider getServerListProvider()

Returns:

The server list provider to use.

getUniverse

public EUniverse getUniverse()

Returns:

The Universe to connect to. This should always be EUniverse.Public unless you work at Valve and are using this internally. If this is you, hello there.

getWebAPIBaseAddress

public java.lang.String getWebAPIBaseAddress()

Returns:

The base address of the Steam Web API to connect to. Use of "partner.steam-api.com" requires a Partner API key.

getWebAPIKey

public java.lang.String getWebAPIKey()

Returns:

An API key to be used for authorized requests. Keys can be obtained from https://steamcommunity.com/dev or the Steamworks Partner site.

getServerList

public SmartCMServerList getServerList()

Returns:

The server list used for this configuration. If this configuration is used by multiple SteamClient instances, they all share the server list.

getWebAPI

public WebAPI getWebAPI(java.lang.String _interface)

Retrieves a handler capable of interacting with the specified interface on the Web API.

Parameters:

_interface - The interface to retrieve a handler for.

Returns:

A WebAPI object to interact with the Web API.