de.SweetCode.SteamAPI.method

Class SteamMethod

java.lang.Object

de.SweetCode.SteamAPI.method.SteamMethod

Direct Known Subclasses:

AddItem, AddPromoItem, AddVideo, AssociateWorkshopItems, AuthenticateUser, AuthenticateUserTicket, CancelAppListingsForUser, CancelTradeOffer, CheckAppOwnership, CheckUserStatus, CreateAccount, CreateSession, DeclineTradeOffer, DeleteAccount, DeleteLeaderboard, DeleteSession, DeleteSessionBatch, EndSecureMultiplayerSession, EnumerateSessionsForApp, EnumerateUserPublishedFiles, EnumerateUserSubscribedFiles, ExchangeItem, FindOrCreateLeaderboard, FlushAssetAppearanceCache, FlushContextCache, FlushInventoryCache, GetAccountList, GetAccountPublicInfo, GetAppBetas, GetAppBuilds, GetAppDepotVersions, GetAppList, GetAppPriceInfo, GetAssetID, GetBadges, GetCMList, GetCollectionDetails, GetCommunityBadgeProgress, GetContributors, GetFriendList, GetGameServerPlayerStatsForGame, GetHistoryCommandDetails, GetInventory, GetItemDefs, GetLeaderboardEntries, GetLeaderboardsForGame, GetMarketEligibility, GetNewsForApp, GetNewsForAppAuthed, GetOwnedGames, GetPlayerBans, GetPlayersBanned, GetPlayerSummaries, GetPopular, GetPriceSheet, GetPublishedFileDetails, GetPublisherAppOwnership, GetRecentlyPlayedGames, GetServerInfo, GetServerIPsBySteamID, GetServerList, GetServersAtAddress, GetServerSteamIDsByIP, GetSessionDetailsForApp, GetSteamLevel, GetSupportedAPIList, GetTokenDetails, GetTradeHistory, GetTradeOffer, GetTradeOffers, GetTradeOffersSummary, GetUGCFileDetails, GetUserGroupList, GetUserHistory, GrantPackage, HistoryExecuteCommands, ICheatReportingServiceGetCheatingReports, IsPlayingSharedGame, ISteamAppsGetCheatingReports, PollStatus, PostGameDataFrame, QueryLoginToken, RecordOfflinePlaytime, RemovePlayerGameBan, ReportAbuse, ReportAccountRecoveryData, ReportCheatData, ReportPlayerCheating, RequestNotifications, RequestPlayerGameBan, RequestVacStatusForUser, ResetLeaderboard, ResetLoginToken, ResolveVanityURL, RetrieveAccountRecoveryData, SetAppBuildLive, SetBanStatus, SetClientFilters, SetLeaderboardScore, SetMemo, SetPerformanceStats, SetUGCUsedByGC, SetUserFinished, StartSecureMultiplayerSession, SubscribePublishedFile, SupportGetAssetHistory, UnsubscribePublishedFile, UpdateSession, UpToDateCheck

public abstract class SteamMethod
extends Object

The steam API is divided into interfaces, methods and versions. - This class represents the abstract idea of the Steam Method.

Constructor Summary

Constructors

Constructor and Description
SteamMethod(SteamInterface steamInterface, String name, List<SteamMethodVersion> versions) A constructor to create a SteamMethod.

Method Summary

Modifier and Type	Method and Description
void	execute(SteamHTTPMethod method, SteamHost host, SteamVersion version, SteamVisibility visibility, Input input, SteamResponse callback, boolean async) Executes the method with the provided parameters.
Optional<SteamMethodVersion>	get(SteamHTTPMethod method, SteamHost host, SteamVersion version, SteamVisibility visibility) Gives the SteamMethodVersion belonging to the provided configuration of host and version.
SteamInterface	getInterface() Gives the related SteamInterface.
String	getName() Gives the name of the method which can be directly used in URLs to access the API.
Set<SteamHost>	getSupportedHosts() Gives a set of all supported hosts.
Set<SteamHTTPMethod>	getSupportedMethods() Gives a set of all supported hosts.
Set<SteamVersion>	getSupportedVersions() Gives a set of all supported versions.
Set<SteamVisibility>	getSupportedVisibilities() Gives a set of all supported visibilities.
List<SteamMethodVersion>	getVersions() Gives a list of all supported method versions.
boolean	supports(SteamHost host) Checks if the method supports the host.
boolean	supports(SteamHTTPMethod method) Checks if the method supports the HTTP request method.
boolean	supports(SteamVersion version) Checks if the method supports the version.
boolean	supports(SteamVisibility visibility) Checks if the method supports the visibility.

Methods inherited from class java.lang.Object

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

Constructor Detail

SteamMethod

public SteamMethod(SteamInterface steamInterface,
                   String name,
                   List<SteamMethodVersion> versions)

A constructor to create a SteamMethod.

Parameters:

steamInterface - The SteamInterface the method belongs to.

name - The name of the method which can be directly used in URLs to access the API.

versions - A list with all various method versions the method supports.

Method Detail

getName

public String getName()

Gives the name of the method which can be directly used in URLs to access the API.

Returns:

Always string, never null.

getInterface

public SteamInterface getInterface()

Gives the related SteamInterface.

Returns:

the interface, never null.

getSupportedMethods

public Set<SteamHTTPMethod> getSupportedMethods()

Gives a set of all supported hosts.

Returns:

A set of all supported hosts. Is never null.

getSupportedHosts

public Set<SteamHost> getSupportedHosts()

Gives a set of all supported hosts.

Returns:

A set of all supported hosts. Is never null.

getSupportedVersions

public Set<SteamVersion> getSupportedVersions()

Gives a set of all supported versions.

Returns:

A set of all supported versions. Is never null.

getSupportedVisibilities

public Set<SteamVisibility> getSupportedVisibilities()

Gives a set of all supported visibilities.

Returns:

A set of all supported visibilities. Is never null.

getVersions

public List<SteamMethodVersion> getVersions()

Gives a list of all supported method versions.

Returns:

a list of all supported method variations.

get

public Optional<SteamMethodVersion> get(SteamHTTPMethod method,
                                        SteamHost host,
                                        SteamVersion version,
                                        SteamVisibility visibility)

Gives the SteamMethodVersion belonging to the provided configuration of host and version.

Parameters:

method - The HTTP request of the method.

host - The SteamHost the method can access.

version - The version of the Steam method.

visibility - The visibility of the method.

Returns:

an Optional containing the SteamMethodVersion if they exist for the provided configuration.

supports

public boolean supports(SteamHTTPMethod method)

Checks if the method supports the HTTP request method.

Parameters:

method - The HTTP request method to check.

Returns:

True, if the method supports the HTTP request method, otherwise false.

supports

public boolean supports(SteamHost host)

Checks if the method supports the host.

Parameters:

host - The host to check.

Returns:

True, if the method supports the host, otherwise false.

supports

public boolean supports(SteamVersion version)

Checks if the method supports the version.

Parameters:

version - The version to check.

Returns:

True, if the method supports the version, otherwise false.

supports

public boolean supports(SteamVisibility visibility)

Checks if the method supports the visibility.

Parameters:

visibility - The visibility to check.

Returns:

True, if the method supports the visibility, otherwise false.

execute

public void execute(SteamHTTPMethod method,
                    SteamHost host,
                    SteamVersion version,
                    SteamVisibility visibility,
                    Input input,
                    SteamResponse callback,
                    boolean async)

Executes the method with the provided parameters.

Parameters:

method - The HTTP request method.

host - The host used to perform the request.

version - The version of the method.

visibility - The visibility of the method.

input - The required input.

callback - The callback to onResponse when done.

async - True, if the API should run an async onResponse, otherwise false.