Package in.dragonbra.javasteam.steam.steamclient.configuration

Class SteamConfigurationBuilder

java.lang.Object

in.dragonbra.javasteam.steam.steamclient.configuration.SteamConfigurationBuilder

All Implemented Interfaces:

ISteamConfigurationBuilder

public class SteamConfigurationBuilder
extends java.lang.Object
implements ISteamConfigurationBuilder

Since:

2018-02-20

Constructor Summary

Constructors

Constructor	Description
SteamConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
SteamConfiguration	build()
static SteamConfigurationState	createDefaultState()
ISteamConfigurationBuilder	withCellID(int cellID)	Configures this SteamConfiguration for a particular Steam cell.
ISteamConfigurationBuilder	withConnectionTimeout(long connectionTimeout)	Configures this SteamConfiguration with a connection timeout.
ISteamConfigurationBuilder	withDefaultPersonaStateFlags(EClientPersonaStateFlag personaStateFlags)	Configures this SteamConfiguration with the default EClientPersonaStateFlags to request from Steam.
ISteamConfigurationBuilder	withDefaultPersonaStateFlags(java.util.EnumSet<EClientPersonaStateFlag> personaStateFlags)	Configures this SteamConfiguration with the default EClientPersonaStateFlags to request from Steam.
ISteamConfigurationBuilder	withDirectoryFetch(boolean allowDirectoryFetch)	Configures this SteamConfiguration to discover available servers.
ISteamConfigurationBuilder	withHttpClient(okhttp3.OkHttpClient httpClient)	Configures this SteamConfiguration with custom HTTP behaviour.
ISteamConfigurationBuilder	withProtocolTypes(ProtocolTypes protocolTypes)	Configures how this SteamConfiguration will be used to connect to Steam.
ISteamConfigurationBuilder	withProtocolTypes(java.util.EnumSet<ProtocolTypes> protocolTypes)	Configures how this SteamConfiguration will be used to connect to Steam.
ISteamConfigurationBuilder	withServerListProvider(IServerListProvider provider)	Configures the server list provider for this SteamConfiguration.
ISteamConfigurationBuilder	withUniverse(EUniverse universe)	Configures the Universe that this SteamConfiguration belongs to.
ISteamConfigurationBuilder	withWebAPIBaseAddress(java.lang.String baseAddress)	Configures the Steam Web API address for this SteamConfiguration.
ISteamConfigurationBuilder	withWebAPIKey(java.lang.String webApiKey)	Configures this SteamConfiguration with a Web API key to attach to requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

SteamConfigurationBuilder

public SteamConfigurationBuilder()

Method Detail

createDefaultState

public static SteamConfigurationState createDefaultState()

build

public SteamConfiguration build()

withCellID

public ISteamConfigurationBuilder withCellID(int cellID)

Description copied from interface: ISteamConfigurationBuilder

Configures this SteamConfiguration for a particular Steam cell.

Specified by:

withCellID in interface ISteamConfigurationBuilder

Parameters:

cellID - The Steam Cell ID to prioritize when connecting.

Returns:

A builder with modified configuration.

withConnectionTimeout

public ISteamConfigurationBuilder withConnectionTimeout(long connectionTimeout)

Description copied from interface: ISteamConfigurationBuilder

Configures this SteamConfiguration with a connection timeout.

Specified by:

withConnectionTimeout in interface ISteamConfigurationBuilder

Parameters:

connectionTimeout - The connection timeout used when connecting to Steam serves.

Returns:

A builder with modified configuration.

withHttpClient

public ISteamConfigurationBuilder withHttpClient(okhttp3.OkHttpClient httpClient)

Description copied from interface: ISteamConfigurationBuilder

Configures this SteamConfiguration with custom HTTP behaviour.

Specified by:

withHttpClient in interface ISteamConfigurationBuilder

Parameters:

httpClient - the http client

Returns:

A builder with modified configuration.

withDefaultPersonaStateFlags

public ISteamConfigurationBuilder withDefaultPersonaStateFlags(java.util.EnumSet<EClientPersonaStateFlag> personaStateFlags)

Description copied from interface: ISteamConfigurationBuilder

Configures this SteamConfiguration with the default EClientPersonaStateFlags to request from Steam.

Specified by:

withDefaultPersonaStateFlags in interface ISteamConfigurationBuilder

Parameters:

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

Returns:

A builder with modified configuration.

withDefaultPersonaStateFlags

public ISteamConfigurationBuilder withDefaultPersonaStateFlags(EClientPersonaStateFlag personaStateFlags)

Description copied from interface: ISteamConfigurationBuilder

Configures this SteamConfiguration with the default EClientPersonaStateFlags to request from Steam.

Specified by:

withDefaultPersonaStateFlags in interface ISteamConfigurationBuilder

Parameters:

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

Returns:

A builder with modified configuration.

withDirectoryFetch

public ISteamConfigurationBuilder withDirectoryFetch(boolean allowDirectoryFetch)

Description copied from interface: ISteamConfigurationBuilder

Configures this SteamConfiguration to discover available servers.

Specified by:

withDirectoryFetch in interface ISteamConfigurationBuilder

Parameters:

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

Returns:

A builder with modified configuration.

withProtocolTypes

public ISteamConfigurationBuilder withProtocolTypes(java.util.EnumSet<ProtocolTypes> protocolTypes)

Description copied from interface: ISteamConfigurationBuilder

Configures how this SteamConfiguration will be used to connect to Steam.

Specified by:

withProtocolTypes in interface ISteamConfigurationBuilder

Parameters:

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

Returns:

A builder with modified configuration.

withProtocolTypes

public ISteamConfigurationBuilder withProtocolTypes(ProtocolTypes protocolTypes)

Description copied from interface: ISteamConfigurationBuilder

Configures how this SteamConfiguration will be used to connect to Steam.

Specified by:

withProtocolTypes in interface ISteamConfigurationBuilder

Parameters:

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

Returns:

A builder with modified configuration.

withServerListProvider

public ISteamConfigurationBuilder withServerListProvider(IServerListProvider provider)

Description copied from interface: ISteamConfigurationBuilder

Configures the server list provider for this SteamConfiguration.

Specified by:

withServerListProvider in interface ISteamConfigurationBuilder

Parameters:

provider - The server list provider to use..

Returns:

A builder with modified configuration.

withUniverse

public ISteamConfigurationBuilder withUniverse(EUniverse universe)

Description copied from interface: ISteamConfigurationBuilder

Configures the Universe that this SteamConfiguration belongs to.

Specified by:

withUniverse in interface ISteamConfigurationBuilder

Parameters:

universe - 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.

Returns:

A builder with modified configuration.

withWebAPIBaseAddress

public ISteamConfigurationBuilder withWebAPIBaseAddress(java.lang.String baseAddress)

Description copied from interface: ISteamConfigurationBuilder

Configures the Steam Web API address for this SteamConfiguration.

Specified by:

withWebAPIBaseAddress in interface ISteamConfigurationBuilder

Parameters:

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

Returns:

A builder with modified configuration.

withWebAPIKey

public ISteamConfigurationBuilder withWebAPIKey(java.lang.String webApiKey)

Description copied from interface: ISteamConfigurationBuilder

Configures this SteamConfiguration with a Web API key to attach to requests.

Specified by:

withWebAPIKey in interface ISteamConfigurationBuilder

Parameters:

webApiKey - An API key to be used for authorized requests. Keys can be obtained from Steam Web API Documentation or the Steamworks Partner site.

Returns:

A builder with modified configuration.