in.dragonbra.javasteam.steam.steamclient.configuration

Interface ISteamConfigurationBuilder

All Known Implementing Classes:

SteamConfigurationBuilder

public interface ISteamConfigurationBuilder

Interface to configure a SteamConfiguration before it is created. A reference to the underlying object should not be live beyond the configurator function's scope.

Method Summary

Modifier and Type	Method and Description
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(java.util.EnumSet<ProtocolTypes> protocolTypes) Configures how this SteamConfiguration will be used to connect to Steam.
ISteamConfigurationBuilder	withProtocolTypes(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.

Method Detail

withCellID

ISteamConfigurationBuilder withCellID(int cellID)

Configures this SteamConfiguration for a particular Steam cell.

Parameters:

cellID - The Steam Cell ID to prioritize when connecting.

Returns:

A builder with modified configuration.

withConnectionTimeout

ISteamConfigurationBuilder withConnectionTimeout(long connectionTimeout)

Configures this SteamConfiguration with a connection timeout.

Parameters:

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

Returns:

A builder with modified configuration.

withHttpClient

ISteamConfigurationBuilder withHttpClient(okhttp3.OkHttpClient httpClient)

Configures this SteamConfiguration with custom HTTP behaviour.

Parameters:

httpClient - the http client

Returns:

A builder with modified configuration.

withDefaultPersonaStateFlags

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

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

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

ISteamConfigurationBuilder withDefaultPersonaStateFlags(EClientPersonaStateFlag personaStateFlags)

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

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

ISteamConfigurationBuilder withDirectoryFetch(boolean allowDirectoryFetch)

Configures this SteamConfiguration to discover available servers.

Parameters:

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

Returns:

A builder with modified configuration.

withProtocolTypes

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

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

Parameters:

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

Returns:

A builder with modified configuration.

withProtocolTypes

ISteamConfigurationBuilder withProtocolTypes(ProtocolTypes protocolTypes)

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

Parameters:

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

Returns:

A builder with modified configuration.

withServerListProvider

ISteamConfigurationBuilder withServerListProvider(IServerListProvider provider)

Configures the server list provider for this SteamConfiguration.

Parameters:

provider - The server list provider to use..

Returns:

A builder with modified configuration.

withUniverse

ISteamConfigurationBuilder withUniverse(EUniverse universe)

Configures the Universe that this SteamConfiguration belongs to.

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

ISteamConfigurationBuilder withWebAPIBaseAddress(java.lang.String baseAddress)

Configures the Steam Web API address for this SteamConfiguration.

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

ISteamConfigurationBuilder withWebAPIKey(java.lang.String webApiKey)

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

Parameters:

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

Returns:

A builder with modified configuration.