com.ibasco.agql.protocols.valve.steam.webapi.interfaces

Class SteamStoreService

java.lang.Object

com.ibasco.agql.core.AbstractWebApiInterface<SteamWebApiClient,SteamWebApiRequest,SteamWebApiResponse>

com.ibasco.agql.protocols.valve.steam.webapi.SteamWebApiInterface

com.ibasco.agql.protocols.valve.steam.webapi.interfaces.SteamStoreService

public class SteamStoreService
extends SteamWebApiInterface

Field Summary

Fields inherited from class com.ibasco.agql.core.AbstractWebApiInterface

VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

Constructor and Description
SteamStoreService(SteamWebApiClient client) Default Constructor

Method Summary

Modifier and Type	Method and Description
CompletableFuture<SteamStoreAppResponse>	getAppList() Gets a list of apps available on the Steam Store.
CompletableFuture<SteamStoreAppResponse>	getAppList(int maxResults) Gets a list of apps available on the Steam Store.
CompletableFuture<SteamStoreAppResponse>	getAppList(int lastAppId, int maxResults) Gets a list of apps available on the Steam Store.
CompletableFuture<SteamStoreAppResponse>	getAppList(int ifModifiedSince, String haveDescriptionLanguage, boolean includeGames, boolean includeDlc, boolean includeSoftware, boolean includeVideos, boolean includeHardware, int lastAppId, int maxResults) Gets a list of apps available on the Steam Store.
CompletableFuture<List<LocalizedNameTag>>	getLocalizedNameForTags(String language, Collection<Integer> tagIds) Gets tag names in a different language
CompletableFuture<List<PopularTag>>	getPopularTag(String language) Get all whitelisted tags, with localized names.

Methods inherited from class com.ibasco.agql.protocols.valve.steam.webapi.SteamWebApiInterface

getSteamResult

Methods inherited from class com.ibasco.agql.core.AbstractWebApiInterface

asCollectionOf, asListOf, builder, configureBuilder, fromJson, fromJson, handleError, sendRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

SteamStoreService

public SteamStoreService(SteamWebApiClient client)

Default Constructor

Parameters:

client - A SteamWebApiClient instance

Method Detail

getAppList

public CompletableFuture<SteamStoreAppResponse> getAppList()

Gets a list of apps available on the Steam Store.

Returns:

A CompletableFuture with return type of SteamStoreAppResponse

getAppList

public CompletableFuture<SteamStoreAppResponse> getAppList(int lastAppId,
                                                           int maxResults)

Gets a list of apps available on the Steam Store.

Returns:

A CompletableFuture with return type of SteamStoreAppResponse

getAppList

public CompletableFuture<SteamStoreAppResponse> getAppList(int maxResults)

Gets a list of apps available on the Steam Store.

Returns:

A CompletableFuture with return type of SteamStoreAppResponse

getAppList

public CompletableFuture<SteamStoreAppResponse> getAppList(int ifModifiedSince,
                                                           String haveDescriptionLanguage,
                                                           boolean includeGames,
                                                           boolean includeDlc,
                                                           boolean includeSoftware,
                                                           boolean includeVideos,
                                                           boolean includeHardware,
                                                           int lastAppId,
                                                           int maxResults)

Gets a list of apps available on the Steam Store.

Parameters:

ifModifiedSince - Return only items that have been modified since this date.

haveDescriptionLanguage - Return only items that have a description in this language.

includeGames - Include games (defaults to enabled)

includeDlc - Include DLC

includeSoftware - Include software items

includeVideos - Include videos and series

includeHardware - Include hardware

lastAppId - For continuations, this is the last appid returned from the previous call.

maxResults - Number of results to return at a time. Default 10k, max 50k.

Returns:

A CompletableFuture with return type of SteamStoreAppResponse

getLocalizedNameForTags

public CompletableFuture<List<LocalizedNameTag>> getLocalizedNameForTags(String language,
                                                                         Collection<Integer> tagIds)

Gets tag names in a different language

Parameters:

language - The localized language (e.g. russian, english)

tagIds - A collection of tag ids

Returns:

A CompletableFuture with return type of LocalizedNameTag

getPopularTag

public CompletableFuture<List<PopularTag>> getPopularTag(String language)

Get all whitelisted tags, with localized names.

Parameters:

language - The language name (e.g. english)

Returns:

@return A CompletableFuture with return type of PopularTag